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

Recurso: Asistente

Recurso de Discovery Engine Assistant.

Representación JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "generationConfig": {
    object (GenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "enabledActions": {
    string: {
      object (ActionList)
    },
    ...
  },
  "enabledTools": {
    string: {
      object (ToolList)
    },
    ...
  },
  "customerPolicy": {
    object (CustomerPolicy)
  }
}
Campos
name

string

Inmutable. Nombre de recurso del asistente. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

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

string

Obligatorio. Nombre visible del asistente.

Debe ser una cadena codificada en UTF-8 con una longitud máxima de 128 caracteres.
description

string

Opcional. Descripción de la información adicional. Se espera que se muestre en la interfaz de configuración, no a los usuarios del asistente.
generationConfig

object (GenerationConfig)

Opcional. Configuración para la generación de la respuesta del asistente.
googleSearchGroundingEnabled
(deprecated)

boolean

Opcional. Obsoleto. En su lugar, usa webGroundingType.
webGroundingType

enum (WebGroundingType)

Opcional. El tipo de base web que se va a usar.
enabledActions
(deprecated)

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

Opcional. Obsoleto: se sustituirá por enabledTools. Las acciones habilitadas en este asistente. Las claves son el nombre del conector (por ejemplo, "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector"). Los valores son las acciones habilitadas por el administrador en la instancia del conector. El administrador puede habilitar de forma selectiva varias acciones en cualquiera de las instancias de conector que haya creado en el proyecto. Por ejemplo, {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
enabledTools

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

Opcional. Nota: Aún no se ha implementado. En su lugar, usa enabledActions. Las herramientas habilitadas en este asistente. Las claves son el nombre del conector (por ejemplo, "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector"). Los valores son las herramientas habilitadas por el administrador para la instancia del conector. Los administradores pueden habilitar de forma selectiva varias herramientas en cualquiera de las instancias de conector que hayan creado en el proyecto. Por ejemplo, {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
customerPolicy

object (CustomerPolicy)

Opcional. Política de clientes del asistente.

GenerationConfig

Configuración para la generación de la respuesta del asistente.

Representación JSON 
{
  "systemInstruction": {
    object (SystemInstruction)
  },
  "defaultLanguage": string
}
Campos
systemInstruction

object (SystemInstruction)

Instrucción del sistema, también conocida como preámbulo de la petición para las llamadas a LLMs. Consulta también https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions.
defaultLanguage

string

El idioma predeterminado que se usará para generar la respuesta del asistente. Usa un código de idioma ISO 639-1, como en. Si no se especifica, el idioma se detectará automáticamente.

SystemInstruction

Instrucción del sistema, también conocida como preámbulo de la petición para las llamadas a LLMs.

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

string

Opcional. Instrucción adicional del sistema que se añadirá a la instrucción predeterminada del sistema.

WebGroundingType

El tipo de base web que se va a usar.

Enumeraciones
WEB_GROUNDING_TYPE_UNSPECIFIED Ajuste predeterminado o sin especificar. Es lo mismo que inhabilitado.
WEB_GROUNDING_TYPE_DISABLED La fundamentación web está inhabilitada.

ActionList

Obsoleto: se sustituirá por ToolList. Las acciones habilitadas en un conector

Representación JSON 
{
  "actionInfo": [
    {
      object (ActionInfo)
    }
  ]
}
Campos
actionInfo[]

object (ActionInfo)

Lista de acciones con la información correspondiente.

ActionInfo

Obsoleto: se sustituirá por ToolInfo. Información para identificar una acción.

Representación JSON 
{
  "actionName": string,
  "actionDisplayName": string
}
Campos
actionName

string

Nombre de la acción tal como la define DataConnectorService.QueryAvailableActions.
actionDisplayName

string

Nombre visible de la acción.

ToolList

Las herramientas habilitadas en un conector

Representación JSON 
{
  "toolInfo": [
    {
      object (ToolInfo)
    }
  ]
}
Campos
toolInfo[]

object (ToolInfo)

La lista de herramientas con la información correspondiente.

ToolInfo

Información para identificar una herramienta.

Representación JSON 
{
  "toolName": string,
  "toolDisplayName": string
}
Campos
toolName

string

El nombre de la herramienta tal como lo define DataConnectorService.QueryAvailableActions. Nota: Se usa action en las APIs de DataConnectorService, pero es lo mismo que tool.
toolDisplayName

string

El nombre visible de la herramienta.

CustomerPolicy

Política definida por el cliente para el asistente.

Representación JSON 
{
  "bannedPhrases": [
    {
      object (BannedPhrase)
    }
  ],
  "modelArmorConfig": {
    object (ModelArmorConfig)
  }
}
Campos
bannedPhrases[]

object (BannedPhrase)

Opcional. Lista de frases prohibidas.
modelArmorConfig

object (ModelArmorConfig)

Opcional. Configuración de Model Armor que se usará para desinfectar las peticiones de los usuarios y las respuestas del asistente.

BannedPhrase

Definición de una frase prohibida definida por el cliente. No se permite que aparezca una frase prohibida en la consulta del usuario ni en la respuesta del LLM. De lo contrario, se rechazará la respuesta.

Representación JSON 
{
  "phrase": string,
  "matchType": enum (BannedPhraseMatchType),
  "ignoreDiacritics": boolean
}
Campos
phrase

string

Obligatorio. El contenido de la cadena sin formato que se va a prohibir.
matchType

enum (BannedPhraseMatchType)

Opcional. Tipo de concordancia de la frase prohibida.
ignoreDiacritics

boolean

Opcional. Si se le asigna el valor true, las marcas diacríticas (por ejemplo, los acentos y las diéresis) se ignoran al buscar coincidencias con frases prohibidas. Por ejemplo, "cafe" coincidiría con "café".

BannedPhraseMatchType

El método de coincidencia de la frase prohibida.

Enumeraciones
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED El valor predeterminado es SIMPLE_STRING_MATCH.
SIMPLE_STRING_MATCH La frase prohibida coincide si se encuentra en cualquier parte del texto como una subcadena exacta.
WORD_BOUNDARY_STRING_MATCH La frase prohibida solo coincide si el patrón encontrado en el texto está rodeado de delimitadores de palabras. La frase en sí puede seguir conteniendo delimitadores de palabras.

ModelArmorConfig

Configuración de las plantillas de Model Armor definidas por el cliente que se usarán para desinfectar las peticiones de los usuarios y las respuestas del asistente.

Representación JSON 
{
  "userPromptTemplate": string,
  "responseTemplate": string,
  "failureMode": enum (FailureMode)
}
Campos
userPromptTemplate

string

Opcional. Nombre de recurso de la plantilla de Model Armor para sanear las peticiones de los usuarios. Formato: projects/{project}/locations/{location}/templates/{templateId}

Si no se especifica, no se aplicará ninguna medida de protección al mensaje del usuario.
responseTemplate

string

Opcional. Nombre de recurso de la plantilla de Model Armor para desinfectar las respuestas del asistente. Formato: projects/{project}/locations/{location}/templates/{templateId}

Si no se especifica, no se aplicará ninguna medida de protección a la respuesta del asistente.
failureMode

enum (FailureMode)

Opcional. Define el modo de fallo de la sanitización de Model Armor.

FailureMode

Determina el comportamiento cuando Model Armor no puede procesar una solicitud.

Enumeraciones
FAILURE_MODE_UNSPECIFIED Modo de fallo no especificado. El comportamiento predeterminado es FAIL_CLOSED.
FAIL_OPEN En caso de que falle el procesamiento de Model Armor, la solicitud podrá continuar sin ningún cambio.
FAIL_CLOSED Si se produce un error de procesamiento de Model Armor, la solicitud se rechaza.

Métodos

assist

 Ayuda al usuario con una consulta.

create

 Crea un Assistant.

delete

 Elimina un Assistant.

get

 Obtiene un Assistant.

list

 Muestra todos los Assistants de un Engine.

patch

 Actualiza un Assistant.

streamAssist

 Ayuda al usuario con una consulta de forma continua.