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

Lista os CannedQueryUserViews de todos os CannedQuerys ativos.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso do assistente principal. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Parâmetros de consulta

Parâmetros
languageCode

string

Opcional. O código do idioma em que as consultas predefinidas devem ser retornadas. Se não for especificado aqui ou se a tradução correspondente não for encontrada, os textos padrão serão retornados.
pageSize

integer

Número máximo de CannedQueryUserViews a serem retornados. Se não for especificado, o padrão será 100. O valor máximo permitido é 1.000. Valores acima disso serão convertidos para 1.000.
pageToken

string

Um token de página ListActiveCannedQueryUserViewsResponse.next_page_token, recebido de uma chamada CannedQueryService.ListActiveCannedQueryUserViews anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para CannedQueryService.ListActiveCannedQueryUserViews precisam corresponder à chamada que forneceu o token da página.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para o método CannedQueryService.ListActiveCannedQueryUserViews.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "cannedQueryUserViews": [
    {
      object (CannedQueryUserView)
    }
  ],
  "nextPageToken": string
}
Campos
cannedQueryUserViews[]

object (CannedQueryUserView)

Os CannedQueryUserViews que representam consultas predefinidas ativas (existentes, ativadas e com recursos atendidos).
nextPageToken

string

Um token que pode ser enviado como ListActiveCannedQueryUserViewsRequest.page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

CannedQueryUserView

Informações limitadas sobre um CannedQuery que são suficientes para os usuários finais.

Representação JSON 
{
  "cannedQuery": string,
  "localizedTexts": {
    object (CannedQueryTexts)
  }
}
Campos
cannedQuery

string

O nome do recurso do CannedQuery a que esta visualização se refere. Isso identifica a consulta predefinida na solicitação de assistência.

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

object (CannedQueryTexts)

Os textos localizados para a consulta automática.