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

Muestra todos los CannedQuerys de un Assistant.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Nombre del recurso superior. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Los parámetros de consulta

Parámetros
filter

string

Opcional. La expresión de filtro.

Campos admitidos:

  • enabled
  • googleDefined

Ejemplos:

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

integer

Número máximo de consultas predefinidas que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1000. Los valores superiores se reducirán a 1000.
pageToken

string

Un token de página recibido de una llamada CannedQueryService.ListCannedQueries anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a CannedQueryService.ListCannedQueries deben ser los mismos que aparecen en 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 del método CannedQueryService.ListCannedQueries.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

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

object (CannedQuery)

Lista de CannedQuerys que coinciden con la solicitud.
nextPageToken

string

Token que se puede enviar como ListCannedQueriesRequest.page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

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