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

Muestra los CannedQueryUserView de todos los CannedQuery activos.

Solicitud HTTP

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

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

Parámetros de ruta

Parámetros
parent

string

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

Los parámetros de consulta

Parámetros
languageCode

string

Opcional. El código de idioma en el que se deben devolver las consultas predefinidas. Si no se especifica aquí o no se encuentra la traducción correspondiente, se devolverán los textos predeterminados.
pageSize

integer

Número máximo de CannedQueryUserViews 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 ListActiveCannedQueryUserViewsResponse.next_page_token, recibido de una llamada CannedQueryService.ListActiveCannedQueryUserViews anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a CannedQueryService.ListActiveCannedQueryUserViews 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.ListActiveCannedQueryUserViews.

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

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

object (CannedQueryUserView)

Los CannedQueryUserView que representan consultas predefinidas activas (existentes, habilitadas y con los requisitos cumplidos).
nextPageToken

string

Token que se puede enviar como ListActiveCannedQueryUserViewsRequest.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.

CannedQueryUserView

Información limitada sobre un CannedQuery que sea suficiente para los usuarios finales.

Representación JSON 
{
  "cannedQuery": string,
  "localizedTexts": {
    object (CannedQueryTexts)
  }
}
Campos
cannedQuery

string

Nombre de recurso del CannedQuery de esta vista. Identifica la consulta predefinida en la solicitud de asistencia.

Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}
localizedTexts

object (CannedQueryTexts)

Textos localizados de la consulta predefinida.