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

Recurso: CannedQuery

Recurso de consulta pré-configurada de Assistant. Representa um atalho para um início de conversa predefinido.

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}

Tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
displayName

string

O nome a apresentar da consulta predefinida. Tem de ser uma string codificada em UTF-8 com um limite de 128 carateres.
defaultTexts

object (CannedQueryTexts)

Obrigatório. Os valores predefinidos (não localizados) para os atributos de texto.
localizedTexts

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

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

enum (ActivationBehavior)

O comportamento quando esta consulta predefinida é ativada. Descontinuado.
requiredCapabilities[]

object (AssistantCapability)

Opcional. As capacidades que o Assistente tem de ter para usar esta consulta predefinida.
icon

string

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

boolean

Se esta consulta pré-configurada está ativada.
googleDefined

boolean

Apenas saída. Indica se se trata de uma consulta predefinida só de leitura definida pela Google.

CannedQueryTexts

Os fragmentos 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 destinado ao utilizador final.
prefix

string

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

string

Obrigatório. A descrição destinada ao utilizador final. Descontinuado.
suggestedPrompts[]

object (SuggestedPrompt)

Obrigatório. Os comandos que a consulta predefinida oferece ao utilizador.
Campo de união start_message. A mensagem que a consulta pré-definida vai usar como início da conversa. Descontinuado. Em alternativa, use suggested_prompts. start_message só pode ser uma das seguintes opções:
suggestedUserQuery
(deprecated)

string

Descontinuado. Em alternativa, use userQuery. O texto predefinido para a primeira interação sugerida do utilizador (por exemplo, "gera uma imagem de um gato")
assistantMessage
(deprecated)

string

O texto predefinido para a primeira vez que o assistente fala. Esta informação é apresentada ao utilizador, provavelmente pedindo-lhe que introduza dados (por exemplo, "Que tipo de conteúdo quer criar? (por exemplo, email, artigo, apresentação)"). Descontinuado.
userQuery
(deprecated)

string

O texto predefinido para a primeira interação do utilizador. Descontinuado. Em alternativa, use suggestedPrompts.

SuggestedPrompt

Um comando sugerido para a consulta pré-configurada.

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

string

Obrigatório. O texto do comando sugerido.

ActivationBehavior

O comportamento quando esta consulta predefinida é ativada. Descontinuado.

Enumerações
ACTIVATION_BEHAVIOR_UNSPECIFIED Valor predefinido, não deve ser usado. A predefinição é NEW_SESSION.
NEW_SESSION Quando usa esta consulta predefinida, é iniciada uma nova sessão do assistente.
NEW_RESEARCH_ASSISTANT_SESSION Quando usa esta consulta predefinida, é iniciada uma nova sessão do assistente de pesquisa.

AssistantCapability

Capacidade de um assistente necessária para usar esta 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 só pode ser uma das seguintes opções:
actionName

string

O nome da ação que o Assistente tem de ter configurado para usar esta consulta predefinida.

Métodos

create

 Cria um CannedQuery.

delete

 Elimina um CannedQuery.

get

 Obtém um CannedQuery.

list

 Apresenta todos os CannedQuerys num Assistant.

listActiveCannedQueryUserViews

 Lista os CannedQueryUserViews de todos os CannedQuerys ativos.

patch

 Atualiza um CannedQuery.