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

Enumera los CannedQueryUserViews de todos los CannedQuerys activos.

Solicitud HTTP

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

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

Parámetros de ruta

Parámetros
parent

string

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

Parámetros de consulta

Parámetros
languageCode

string

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

integer

Es la cantidad máxima de CannedQueryUserView 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 ListActiveCannedQueryUserViewsResponse.next_page_token, recibido de una llamada a CannedQueryService.ListActiveCannedQueryUserViews anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a CannedQueryService.ListActiveCannedQueryUserViews 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.ListActiveCannedQueryUserViews.

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

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

object (CannedQueryUserView)

Son los CannedQueryUserView que representan las búsquedas predefinidas activas (existentes, habilitadas y con capacidades cumplidas).
nextPageToken

string

Es un token que se puede enviar como ListActiveCannedQueryUserViewsRequest.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.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

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

CannedQueryUserView

Es la información limitada sobre un CannedQuery que es suficiente para los usuarios finales.

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

string

Es el nombre del recurso del CannedQuery para el que se creó esta vista. Identifica la búsqueda predefinida en la solicitud de asistencia.

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

object (CannedQueryTexts)

Son los textos localizados para la consulta prediseñada.