REST Resource: projects.locations.collections.engines.assistants.cannedQueries

Recurso: CannedQuery

Recurso de consulta automática de Assistant. Ele representa um atalho para o início de uma conversa predefinida.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "defaultTexts": {
    object (CannedQueryTexts)
  },
  "localizedTexts": {
    string: {
      object (CannedQueryTexts)
    },
    ...
  },
  "activationBehavior": enum (ActivationBehavior),
  "requiredCapabilities": [
    {
      object (AssistantCapability)
    }
  ],
  "icon": string,
  "enabled": boolean,
  "googleDefined": boolean
}
Campos
name

string

Imutável. Nome do recurso da consulta predefinida. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}

Precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
displayName

string

O nome de exibição da consulta predefinida. Precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres.
defaultTexts

object (CannedQueryTexts)

Obrigatório. Os valores padrão (não localizados) dos atributos de texto.
localizedTexts

map (key: string, value: object (CannedQueryTexts))

Opcional. As traduções dos atributos de texto. As chaves precisam ser códigos de idioma BCP-47.
activationBehavior
(deprecated)

enum (ActivationBehavior)

O comportamento quando essa consulta predefinida é ativada. Obsoleto.
requiredCapabilities[]

object (AssistantCapability)

Opcional. Os recursos que o Google Assistente precisa ter para usar essa consulta predefinida.
icon

string

O nome do ícone da biblioteca de símbolos do Google para a consulta predefinida.
enabled

boolean

Indica se a consulta predefinida está ativada.
googleDefined

boolean

Apenas saída. Indica se é uma consulta predefinida somente leitura definida pelo Google.

CannedQueryTexts

Os trechos de texto para a consulta predefinida, que podem ser localizados.

Representação JSON 
{
  "title": string,
  "prefix": string,
  "description": string,
  "suggestedPrompts": [
    {
      object (SuggestedPrompt)
    }
  ],

  // Union field start_message can be only one of the following:
  "suggestedUserQuery": string,
  "assistantMessage": string,
  "userQuery": string
  // End of list of possible types for union field start_message.
}
Campos
title

string

Obrigatório. O título para o usuário final.
prefix

string

Opcional. O prefixo com que suggestedPrompts precisa começar.
description
(deprecated)

string

Obrigatório. A descrição para o usuário final. Obsoleto.
suggestedPrompts[]

object (SuggestedPrompt)

Obrigatório. Os comandos que a consulta predefinida vai oferecer ao usuário.
Campo de união start_message. A mensagem que a consulta predefinida vai usar para iniciar a conversa. Obsoleto. Use suggested_prompts. start_message pode ser apenas de um dos tipos a seguir:
suggestedUserQuery
(deprecated)

string

Obsoleto. Use userQuery. O texto predefinido para o primeiro turno sugerido do usuário (por exemplo, "gerar uma imagem de um gato")
assistantMessage
(deprecated)

string

O texto predefinido para o primeiro turno do assistente. Isso será exibido ao usuário, provavelmente pedindo entrada (por exemplo, "Que tipo de conteúdo você quer criar? (por exemplo, e-mail, artigo, apresentação)". Obsoleto.
userQuery
(deprecated)

string

O texto predefinido para o primeiro turno do usuário. Obsoleto. Use suggestedPrompts.

SuggestedPrompt

Um comando sugerido para a consulta predefinida.

Representação JSON 
{
  "promptText": string
}
Campos
promptText

string

Obrigatório. O texto do comando sugerido.

ActivationBehavior

O comportamento quando essa consulta predefinida é ativada. Obsoleto.

Tipos enumerados
ACTIVATION_BEHAVIOR_UNSPECIFIED Valor padrão, não deve ser usado. O padrão é NEW_SESSION.
NEW_SESSION Ao usar essa consulta predefinida, uma nova sessão do assistente é iniciada.
NEW_RESEARCH_ASSISTANT_SESSION Ao usar essa consulta predefinida, uma nova sessão do assistente de pesquisa é iniciada.

AssistantCapability

Capacidade de um assistente necessária para usar essa consulta predefinida.

Representação JSON 
{

  // Union field capability can be only one of the following:
  "actionName": string
  // End of list of possible types for union field capability.
}
Campos
Campo de união capability. Capacidade de um assistente, seja uma ação ou uma ferramenta. capability pode ser apenas de um dos tipos a seguir:
actionName

string

O nome da ação que o Google Assistente precisa configurar para usar essa consulta predefinida.

Métodos

create

 Cria uma CannedQuery.

delete

 Exclui um CannedQuery.

get

 Recebe um CannedQuery.

list

 Lista todos os CannedQuerys em um Assistant.

listActiveCannedQueryUserViews

 Lista os CannedQueryUserViews de todos os CannedQuerys ativos.

patch

 Atualiza um CannedQuery.