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

Recurso: Assistant

Es el recurso del asistente de Discovery Engine.

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 del 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 1,024 caracteres.
displayName

string

Obligatorio. Es el nombre visible del asistente.

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

string

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

object (GenerationConfig)

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

boolean

Opcional. Obsoleto. Utiliza webGroundingType en lugar de esta función.
webGroundingType

enum (WebGroundingType)

Opcional. Es el tipo de fundamentación web que se usará.
enabledActions
(deprecated)

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

Opcional. Obsoleto: Se reemplazará por enabledTools. Son las acciones habilitadas en este asistente. Las claves son el nombre del conector, por ejemplo, "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector". Los valores consisten en acciones habilitadas por el administrador hacia la instancia del conector. El administrador puede habilitar de forma selectiva varias acciones en cualquiera de las instancias del conector que creó 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 implementó. Utiliza enabledActions en lugar de esta función. Son las herramientas habilitadas en este asistente. Las claves son el nombre del conector, por ejemplo, "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector". Los valores constan de herramientas habilitadas por el administrador para la instancia del conector. El administrador puede habilitar de forma selectiva varias herramientas en cualquiera de las instancias del conector que creó en el proyecto. Por ejemplo, {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
customerPolicy

object (CustomerPolicy)

Opcional. Política de clientes para el asistente.

GenerationConfig

Es la configuración para la generación de la respuesta del asistente.

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

object (SystemInstruction)

Es una instrucción del sistema, también conocida como preámbulo del prompt para las llamadas al LLM. Consulta también https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions
defaultLanguage

string

Es 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

Es una instrucción del sistema, también conocida como preámbulo del prompt para las llamadas al LLM.

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

string

Opcional. Es una instrucción adicional del sistema que se agregará a la instrucción predeterminada del sistema.

WebGroundingType

Es el tipo de fundamentación web que se usará.

Enums
WEB_GROUNDING_TYPE_UNSPECIFIED Es el parámetro de configuración predeterminado y sin especificar. Es lo mismo que inhabilitado.
WEB_GROUNDING_TYPE_DISABLED La fundamentación web está inhabilitada.

ActionList

Obsoleto: Se reemplazará por ToolList. Son las acciones habilitadas en un conector.

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

object (ActionInfo)

Es la lista de acciones con la información correspondiente.

ActionInfo

Obsoleto: Se reemplazará por ToolInfo. Es 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

Es el nombre visible de la acción.

ToolList

Las herramientas habilitadas en un conector

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

object (ToolInfo)

Es la lista de herramientas con la información correspondiente.

ToolInfo

Es la información para identificar una herramienta.

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

string

Es el nombre de la herramienta tal como lo define DataConnectorService.QueryAvailableActions. Nota: Se usa action en las APIs de DataConnectorService, pero son las mismas que tool aquí.
toolDisplayName

string

Es el nombre visible de la herramienta.

CustomerPolicy

Es la política definida por el cliente para el asistente.

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

object (BannedPhrase)

Opcional. Es la lista de frases prohibidas.
modelArmorConfig

object (ModelArmorConfig)

Opcional. Es la configuración de Model Armor que se usará para limpiar las instrucciones del usuario y las respuestas del asistente.

BannedPhrase

Es la definición de una frase prohibida definida por el cliente. No se permite que aparezca una frase prohibida en la búsqueda 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. Es el contenido de la cadena sin procesar que se prohibirá.
matchType

enum (BannedPhraseMatchType)

Opcional. Es el tipo de concordancia de la frase prohibida.
ignoreDiacritics

boolean

Opcional. Si es verdadero, se ignoran las marcas diacríticas (p.ej., acentos, diéresis) cuando se buscan coincidencias con frases prohibidas. Por ejemplo, "cafe" coincidiría con "café".

BannedPhraseMatchType

Es el método de coincidencia de la frase prohibida.

Enums
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED La configuración predeterminada 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 que se encuentra en el texto está rodeado de delimitadores de palabras. La frase en sí puede contener delimitadores de palabras.

ModelArmorConfig

Es la configuración de las plantillas de Model Armor definidas por el cliente que se usarán para sanear las instrucciones del usuario y las respuestas del asistente.

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

string

Opcional. Es el nombre del recurso de la plantilla de Model Armor para sanear las instrucciones del usuario. Formato: projects/{project}/locations/{location}/templates/{templateId}

Si no se especifica, no se aplicará ninguna limpieza a la instrucción del usuario.
responseTemplate

string

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

Si no se especifica, no se aplicará ninguna limpieza a la respuesta del asistente.
failureMode

enum (FailureMode)

Opcional. Define el modo de falla para el saneamiento de Model Armor.

FailureMode

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

Enums
FAILURE_MODE_UNSPECIFIED Modo de falla no especificado. El comportamiento predeterminado es FAIL_CLOSED.
FAIL_OPEN En caso de que falle el procesamiento de Model Armor, se permite que la solicitud continúe sin cambios.
FAIL_CLOSED En caso de que falle el procesamiento de Model Armor, se rechaza la solicitud.

Métodos

assist

 Ayuda al usuario con una consulta.

create

 Crea un Assistant.

delete

 Borra un Assistant.

get

 Obtiene un Assistant.

list

 Enumera todos los Assistant en un Engine.

patch

 Actualiza un Assistant

streamAssist

 Ayuda al usuario con una consulta de forma continua.