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

Apresenta todos os Assistants num Engine.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

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

Parâmetros de consulta

Parâmetros
pageSize

integer

Número máximo de Assistants a devolver. Se não for especificado, a predefinição é 100. O valor máximo permitido é 1000. Qualquer valor acima deste é forçado a ser 1000.

pageToken

string

Um token de página ListAssistantsResponse.next_page_token, recebido de uma chamada AssistantService.ListAssistants anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a assistants.list têm de corresponder à chamada que forneceu o token da página.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

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

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

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 obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.

Âmbitos de autorização

Requer um dos seguintes âmbitos 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 o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.assistants.list

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