Method: projects.locations.collections.engines.assistants.list

Lista todos os Assistants em um Engine.

Solicitação HTTP

GET https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/assistants

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso pai. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

Parâmetros de consulta

Parâmetros
pageSize

integer

Número máximo de Assistants a serem retornados. Se não for especificado, o padrão será 100. O valor máximo permitido é 1.000. Valores maiores serão convertidos para 1.000.
pageToken

string

Um token de página ListAssistantsResponse.next_page_token recebido de uma chamada AssistantService.ListAssistants anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para assistants.list precisam corresponder à chamada que forneceu o token da página.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para o método AssistantService.ListAssistants.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "assistants": [
    {
      object (Assistant)
    }
  ],
  "nextPageToken": string
}
Campos
assistants[]

object (Assistant)

Todos os Assistants do cliente.
nextPageToken

string

Um token que pode ser enviado como ListAssistantsRequest.page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.assistants.list

Para mais informações, consulte a documentação do IAM.