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

Recurso: CannedQuery

Recurso de consulta predefinida 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. Nombre de 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 1024 caracteres.
displayName

string

Nombre visible de la consulta predefinida. Debe ser una cadena codificada en UTF-8 con una longitud máxima de 128 caracteres.
defaultTexts

object (CannedQueryTexts)

Obligatorio. Los valores predeterminados (no localizados) de los atributos de texto.
localizedTexts

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

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

enum (ActivationBehavior)

El comportamiento cuando se activa esta consulta predefinida. Obsoleto.
requiredCapabilities[]

object (AssistantCapability)

Opcional. Las funciones que debe tener el Asistente para usar esta consulta predefinida.
icon

string

Nombre del icono de la biblioteca de símbolos de Google de la consulta predefinida.
enabled

boolean

Indica si esta consulta predefinida está habilitada.
googleDefined

boolean

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

CannedQueryTexts

Los fragmentos de texto de la consulta predefinida, 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. Título que se muestra al usuario final.
prefix

string

Opcional. El prefijo por el que debe empezar suggestedPrompts.
description
(deprecated)

string

Obligatorio. La descripción que se muestra al usuario final. Obsoleto.
suggestedPrompts[]

object (SuggestedPrompt)

Obligatorio. Las peticiones que ofrecerá la consulta predefinida al usuario.
Campo de unión start_message. El mensaje que usará la consulta predefinida para iniciar la conversación. Obsoleto. En su lugar, usa suggested_prompts. start_message solo puede ser una de estas dos opciones:
suggestedUserQuery
(deprecated)

string

Obsoleto. En su lugar, usa userQuery. El texto predefinido de la primera respuesta sugerida al usuario (por ejemplo, genera una imagen de un gato")
assistantMessage
(deprecated)

string

El texto predefinido de la primera respuesta del asistente. Se mostrará al usuario, probablemente pidiéndole que introduzca datos (por ejemplo, "¿Qué tipo de contenido quieres crear? por ejemplo, correo, artículo o presentación"). Obsoleto.
userQuery
(deprecated)

string

El texto predefinido del primer turno del usuario. Obsoleto. En su lugar, usa suggestedPrompts.

SuggestedPrompt

Una petición sugerida para la consulta estándar.

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

string

Obligatorio. El texto de la petición sugerida.

ActivationBehavior

El comportamiento cuando se activa esta consulta predefinida. Obsoleto.

Enumeraciones
ACTIVATION_BEHAVIOR_UNSPECIFIED Valor predeterminado, no se debe usar. El valor predeterminado es NEW_SESSION (ADMITE VALORES NULL).
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 del asistente de investigación.

AssistantCapability

Capacidad de un asistente necesaria para usar esta consulta 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. Función de un asistente, ya sea una acción o una herramienta. capability solo puede ser una de estas dos opciones:
actionName

string

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

Métodos

create

 Crea un CannedQuery.

delete

 Elimina un CannedQuery.

get

 Obtiene un CannedQuery.

list

 Muestra todos los CannedQuerys de un Assistant.

listActiveCannedQueryUserViews

 Muestra los CannedQueryUserView de todos los CannedQuery activos.

patch

 Actualiza un CannedQuery.