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

Apresenta todos os CannedQuerys num Assistant.

Pedido HTTP

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

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}/assistants/{assistant}

Parâmetros de consulta

Parâmetros
filter

string

Opcional. A expressão de filtro.

Campos suportados:

  • enabled
  • googleDefined

Exemplos:

  • enabled=true
  • googleDefined=true
  • enabled=true AND googleDefined=true
pageSize

integer

Número máximo de consultas predefinidas 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 recebido de uma chamada CannedQueryService.ListCannedQueries anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a CannedQueryService.ListCannedQueries 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 CannedQueryService.ListCannedQueries.

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

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

object (CannedQuery)

A lista de CannedQuerys que correspondem ao pedido.
nextPageToken

string

Um token que pode ser enviado como ListCannedQueriesRequest.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.