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

Elenca tutti i CannedQuery in un Assistant.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa padre. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Parametri di query

Parametri
filter

string

Facoltativo. L'espressione di filtro.

Campi supportati:

  • enabled
  • googleDefined

Esempi:

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

integer

Il numero massimo di query predefinite da restituire. Se non specificato, il valore predefinito è 100. Il valore massimo consentito è 1000; qualsiasi valore superiore verrà forzato a 1000.
pageToken

string

Un token di pagina ricevuto da una precedente chiamata CannedQueryService.ListCannedQueries. Forniscilo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a CannedQueryService.ListCannedQueries devono corrispondere alla chiamata che ha fornito il token di pagina.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per il metodo CannedQueryService.ListCannedQueries.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "cannedQueries": [
    {
      object (CannedQuery)
    }
  ],
  "nextPageToken": string
}
Campi
cannedQueries[]

object (CannedQuery)

L'elenco dei CannedQuery che corrispondono alla richiesta.
nextPageToken

string

Un token che può essere inviato come ListCannedQueriesRequest.page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta Authentication Overview.