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),
  "defaultWebGroundingToggleOff": boolean,
  "vertexAiAgentConfigs": [
    {
      object (VertexAiAgentConfig)
    }
  ],
  "enabledActions": {
    string: {
      object (ActionList)
    },
    ...
  },
  "enabledTools": {
    string: {
      object (ToolList)
    },
    ...
  },
  "customerPolicy": {
    object (CustomerPolicy)
  },
  "vertexAiSearchToolConfig": {
    object (VertexAiSearchToolConfig)
  },
  "styleAndFormattingInstructions": string,
  "agentConfigs": [
    {
      object (AgentConfig)
    }
  ],
  "enableEndUserAgentCreation": boolean,
  "disableLocationContext": boolean
}
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.
defaultWebGroundingToggleOff

boolean

Opcional. Este campo controla el interruptor de grounding web predeterminado para los usuarios finales si webGroundingType se define como WEB_GROUNDING_TYPE_GOOGLE_SEARCH o WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. De forma predeterminada, este campo tiene el valor "false". Si webGroundingType es WEB_GROUNDING_TYPE_GOOGLE_SEARCH o WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, los usuarios finales tendrán habilitada la función de grounding web de forma predeterminada en la interfaz de usuario. Si se le asigna el valor true, el interruptor de acoplamiento se inhabilitará de forma predeterminada en la interfaz de usuario. Los usuarios finales pueden seguir habilitando la base web en la interfaz de usuario si está habilitada.
vertexAiAgentConfigs[]
(deprecated)

object (VertexAiAgentConfig)

Opcional. Obsoleto: se sustituirá por agentes de Dialogflow en AgentService. Lista de agentes de Vertex AI a los que se puede acceder a través del asistente.
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.
vertexAiSearchToolConfig

object (VertexAiSearchToolConfig)

Opcional. Opciones de configuración de la herramienta Vertex AI Search.
styleAndFormattingInstructions
(deprecated)

string

Opcional. Obsoleto. En su lugar, usa [addtional_system_instructions][GenerationConfig.SystemInstruction.additional_system_instructions]. Fragmento de instrucción del sistema habitual para definir el estilo, el tono y el formato de la conversación. Se añade a todas las peticiones de LLMs a través del marcador de posición [STYLE_AND_FORMATTING_INSTRUCTIONS].
agentConfigs[]

object (AgentConfig)

Opcional. Lista de agentes a los que se puede acceder a través del asistente.
enableEndUserAgentCreation

boolean

Opcional. Indica si los usuarios finales pueden crear agentes en el espacio de agentes.
disableLocationContext

boolean

Opcional. Indica si se debe inhabilitar el contexto de la ubicación del usuario. De forma predeterminada, el contexto de la ubicación del usuario está habilitado.

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.

VertexAiAgentConfig

Obsoleto: usa agentes de Dialogflow en AgentService. Representa un agente de Vertex AI externo al que se puede acceder a través del asistente.

Representación JSON 
{
  "displayName": string,
  "name": string,
  "toolDescription": string
}
Campos
displayName

string

Obligatorio. Nombre visible del agente de Vertex AI que se usa como referencia en el asistente.
name

string

Obligatorio. Nombre del recurso del agente de Vertex AI. Formato: projects/{project}/locations/{location}/agents/{agent}
toolDescription

string

Obligatorio. La descripción de la herramienta del agente de Vertex AI. La LLM usará esta descripción para decidir si el agente es pertinente para la pregunta del usuario y si la pregunta debe dirigirse al agente.

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.

VertexAiSearchToolConfig

Opciones de configuración de la herramienta Vertex AI Search que puede usar el asistente al procesar consultas.

Representación JSON 
{
  "llmSystemInstructions": string
}
Campos
llmSystemInstructions
(deprecated)

string

Obsoleto. No utilices este campo. Instrucciones del sistema para responder en función de los resultados de búsqueda de Vertex AI Search. Ten en cuenta que la respuesta generada por la herramienta de búsqueda puede ser diferente de la respuesta final del asistente.

En general, las instrucciones del sistema son un conjunto de instrucciones en lenguaje natural que el modelo procesa antes de procesar las peticiones. Indica al modelo cómo debe comportarse y responder a las peticiones. Consulta https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions.

Por ejemplo: "Usa solo la información de las fuentes para responder. Además, asegúrate de dar un formato adecuado a la respuesta con Markdown".

Si no se especifica, se usará el valor predeterminado interno.

AgentConfig

Opciones de configuración de los agentes a los que puede llamar el asistente al procesar consultas.

Representación JSON 
{
  "id": string,
  "displayName": string,
  "toolDescription": string,
  "icon": {
    object (Image)
  },
  "authorizations": [
    string
  ],

  // Union field connection_info can be only one of the following:
  "vertexAiSdkAgentConnectionInfo": {
    object (VertexAiSdkAgentConnectionInfo)
  },
  "httpAgentConnectionInfo": {
    object (HttpAgentConnectionInfo)
  }
  // End of list of possible types for union field connection_info.
}
Campos
id

string

Obligatorio. Un ID único y legible para el agente. Debe coincidir con la siguiente expresión regular: [a-z][a-zA-Z0-9_-]*.
displayName

string

Obligatorio. Nombre visible del agente que se usa como referencia en el asistente.
toolDescription

string

Obligatorio. La descripción de la herramienta del agente. La LLM usará esta descripción para decidir si el agente es pertinente para la pregunta del usuario y si la pregunta debe dirigirse al agente.
icon

object (Image)

Obligatorio. El icono que representa al agente en la interfaz de usuario.
authorizations[]

string

Opcional. Nombres de recurso de las autorizaciones necesarias. Si el usuario no está autorizado, el servicio devolverá una serie de URIs de autorización que el usuario debe abrir en un navegador y autorizar. Una vez que se hayan concedido todas las autorizaciones, el usuario puede volver a intentar la consulta y las autorizaciones se reenviarán al agente.

Formato: projects/{project}/locations/{location}/authorizations/{authorization}
Campo de unión connection_info. La configuración de conexión del agente. connection_info solo puede ser una de estas dos opciones:
vertexAiSdkAgentConnectionInfo

object (VertexAiSdkAgentConnectionInfo)

Obligatorio. Información de conexión de un agente del SDK de Vertex AI
httpAgentConnectionInfo

object (HttpAgentConnectionInfo)

Obligatorio. Información de conexión de un agente HTTP.

VertexAiSdkAgentConnectionInfo

Información de conexión de un agente del SDK de Vertex AI. Actualmente, solo se admiten los agentes expuestos a través de Reasoning Engines.

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

string

Nombre de recurso del motor de razonamiento que expone el agente. Formato: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

HttpAgentConnectionInfo

Un agente al que el asistente puede acceder a través de HTTP.

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

string

Obligatorio. La dirección HTTP del agente, por ejemplo, "https://example.com/agent1".

Imagen

Representa una imagen.

Representación JSON 
{

  // Union field storage_method can be only one of the following:
  "uri": string,
  "content": string
  // End of list of possible types for union field storage_method.
}
Campos
Campo de unión storage_method. Puede ser un URI o el contenido codificado como una cadena base64. storage_method solo puede ser una de estas dos opciones:
uri

string

Obligatorio. URI de la imagen.
content

string

Obligatorio. Contenido del archivo de imagen codificado en Base64.

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.

listAvailableAgentViews

 Lista los datos para mostrar los agentes de un Assistant que están disponibles para la persona que llama.

patch

 Actualiza un Assistant.

streamAssist

 Ayuda al usuario con una consulta de forma continua.