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

Recurso: CannedQuery

Es el recurso de consulta estándar de Assistant. Representa un acceso directo a un inicio de conversación predefinido.

Representación 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

Inmutable. Es el nombre del recurso de la consulta predefinida. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}

Debe ser una cadena codificada en UTF-8 con un límite de 1,024 caracteres.
displayName

string

Es el nombre visible de la consulta predefinida. Debe ser una cadena codificada en UTF-8 con un límite de 128 caracteres.
defaultTexts

object (CannedQueryTexts)

Obligatorio. Son los valores predeterminados (sin localización) para los atributos de texto.
localizedTexts

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

Opcional. Son las traducciones de los atributos de texto. Las claves deben ser códigos de idioma BCP-47.
activationBehavior
(deprecated)

enum (ActivationBehavior)

Es el comportamiento cuando se activa esta búsqueda predefinida. Obsoleto.
requiredCapabilities[]

object (AssistantCapability)

Opcional. Son las capacidades que debe tener el Asistente para usar esta búsqueda predefinida.
icon

string

Es el nombre del ícono de la biblioteca de símbolos de Google para la búsqueda predeterminada.
enabled

boolean

Indica si esta búsqueda predefinida está habilitada.
googleDefined

boolean

Solo salida. Indica si se trata de una consulta predefinida de solo lectura definida por Google.

CannedQueryTexts

Son los fragmentos de texto de la búsqueda predeterminada, que se pueden localizar.

Representación 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

Obligatorio. Es el título que se muestra al usuario final.
prefix

string

Opcional. Es el prefijo con el que debe comenzar suggestedPrompts.
description
(deprecated)

string

Obligatorio. Es la descripción para el usuario final. Obsoleto.
suggestedPrompts[]

object (SuggestedPrompt)

Obligatorio. Son las instrucciones que ofrecerá la consulta prediseñada al usuario.
Campo de unión start_message. Es el mensaje que usará la consulta predefinida como inicio de la conversación. Obsoleto. En su lugar, usa suggested_prompts. start_message puede ser solo uno de los siguientes:
suggestedUserQuery
(deprecated)

string

Obsoleto. Utiliza userQuery en lugar de esta función. Es el texto predeterminado para el primer turno sugerido del usuario (p.ej., genera una imagen de un gato").
assistantMessage
(deprecated)

string

Es el texto predeterminado del primer turno del asistente. Se mostrará al usuario y, probablemente, le pedirá que ingrese información (p.ej., "¿Qué tipo de contenido te gustaría crear? (p.ej., correo electrónico, artículo, presentación)". Obsoleto.
userQuery
(deprecated)

string

Es el texto predeterminado del primer turno del usuario. Obsoleto. Utiliza suggestedPrompts en lugar de esta función.

SuggestedPrompt

Es una instrucción sugerida para la búsqueda predefinida.

Representación JSON 
{
  "promptText": string
}
Campos
promptText

string

Obligatorio. Es el texto de la instrucción sugerida.

ActivationBehavior

Es el comportamiento cuando se activa esta búsqueda predefinida. Obsoleto.

Enums
ACTIVATION_BEHAVIOR_UNSPECIFIED Es un valor predeterminado que no se debe usar. El valor predeterminado es NEW_SESSION.
NEW_SESSION Cuando se usa esta consulta predefinida, se inicia una nueva sesión del asistente.
NEW_RESEARCH_ASSISTANT_SESSION Cuando se usa esta consulta predefinida, se inicia una nueva sesión de asistente de investigación.

AssistantCapability

Es la capacidad de un asistente que se necesita para usar esta búsqueda predefinida.

Representación 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ón capability. Es la capacidad de un asistente, ya sea una acción o una herramienta. capability puede ser solo uno de los siguientes:
actionName

string

Es el nombre de la acción que debe configurar Asistente para usar esta consulta predefinida.

Métodos

create

 Crea un CannedQuery.

delete

 Borra un CannedQuery.

get

 Obtienes una CannedQuery.

list

 Enumera todos los CannedQuery en un Assistant.

listActiveCannedQueryUserViews

 Enumera los CannedQueryUserViews de todos los CannedQuerys activos.

patch

 Actualiza un CannedQuery.