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

Lista todos os CannedQuerys em um Assistant.

Solicitação HTTP

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

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

Parâmetros de consulta

Parâmetros
filter

string

Opcional. A expressão do filtro.

Campos compatíveis:

  • enabled
  • googleDefined

Exemplos:

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

integer

Número máximo de consultas predefinidas a serem retornadas. 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 recebido de uma chamada CannedQueryService.ListCannedQueries anterior. Forneça isso para recuperar a página subsequente.

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

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

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

object (CannedQuery)

A lista de CannedQuerys que correspondem à solicitação.
nextPageToken

string

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