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

Enumera todos los CannedQuery de un Assistant.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es el nombre del recurso principal. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Parámetros de consulta

Parámetros
filter

string

Es opcional. Es la expresión de filtro.

Campos admitidos:

  • enabled
  • googleDefined

Ejemplos:

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

integer

Es la cantidad máxima de consultas predefinidas que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1,000, y los valores superiores se convertirán a 1,000.
pageToken

string

Es un token de página que se recibió de una llamada a CannedQueryService.ListCannedQueries anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a CannedQueryService.ListCannedQueries deben coincidir con la llamada que proporcionó el token de la página.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para el método CannedQueryService.ListCannedQueries.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "cannedQueries": [
    {
      object (CannedQuery)
    }
  ],
  "nextPageToken": string
}
Campos
cannedQueries[]

object (CannedQuery)

Es la lista de CannedQuerys que coinciden con la solicitud.
nextPageToken

string

Es un token que se puede enviar como ListCannedQueriesRequest.page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.cannedQueries.list

Para obtener más información, consulta la documentación de IAM.