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

Recurso: Assistente

Recurso do assistente do Discovery Engine.

Representação 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

Imutável. Nome do recurso do assistente. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
displayName

string

Obrigatório. O nome a apresentar do assistente.

Tem de ser uma string codificada em UTF-8 com um limite de 128 carateres.
description

string

Opcional. Descrição para informações adicionais. Espera-se que seja apresentado na IU de configuração e não aos utilizadores do assistente.
generationConfig

object (GenerationConfig)

Opcional. Configuração para a geração da resposta do assistente.
googleSearchGroundingEnabled
(deprecated)

boolean

Opcional. Descontinuado. Em alternativa, use webGroundingType.
webGroundingType

enum (WebGroundingType)

Opcional. O tipo de baseamento na Web a usar.
defaultWebGroundingToggleOff

boolean

Opcional. Este campo controla a ativação/desativação da base Web predefinida para os utilizadores finais se webGroundingType estiver definido como WEB_GROUNDING_TYPE_GOOGLE_SEARCH ou WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. Por predefinição, este campo está definido como falso. Se webGroundingType for WEB_GROUNDING_TYPE_GOOGLE_SEARCH ou WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, os utilizadores finais têm a base Web ativada por predefinição na IU. Se for verdadeiro, o botão de ativação/desativação da fundamentação é desativado por predefinição na IU. Os utilizadores finais podem continuar a ativar a verificação da Web na IU se esta estiver ativada.
vertexAiAgentConfigs[]
(deprecated)

object (VertexAiAgentConfig)

Opcional. Descontinuado: vai ser substituído por agentes do Dialogflow no AgentService. Lista de agentes da Vertex AI que podem ser contactados através do assistente.
enabledActions
(deprecated)

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

Opcional. Descontinuado: vai ser substituído por enabledTools. As ações ativadas neste assistente. As chaves são o nome do conetor, por exemplo, "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector. Os valores consistem em ações ativadas pelo administrador em relação à instância do conetor. O administrador pode ativar seletivamente várias ações em qualquer uma das instâncias do conetor que criou no projeto. Por exemplo, {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
enabledTools

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

Opcional. Nota: ainda não implementado. Em alternativa, use enabledActions. As ferramentas ativadas neste assistente. As chaves são o nome do conetor, por exemplo, "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector. Os valores consistem em ferramentas ativadas pelo administrador em relação à instância do conetor. O administrador pode ativar seletivamente várias ferramentas em qualquer uma das instâncias do conetor que criou no projeto. Por exemplo, {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
customerPolicy

object (CustomerPolicy)

Opcional. Política do cliente para o assistente.
vertexAiSearchToolConfig

object (VertexAiSearchToolConfig)

Opcional. Opções de configuração para a ferramenta Vertex AI Search.
styleAndFormattingInstructions
(deprecated)

string

Opcional. Descontinuado. Em alternativa, use [addtional_system_instructions][GenerationConfig.SystemInstruction.additional_system_instructions]. Fragmento de instruções do sistema comum para definir o estilo, o tom e a formatação da conversa. Adicionado a todos os comandos do MDG através do marcador de posição [STYLE_AND_FORMATTING_INSTRUCTIONS].
agentConfigs[]

object (AgentConfig)

Opcional. Lista de agentes que podem ser contactados através do assistente.
enableEndUserAgentCreation

boolean

Opcional. Indica se os utilizadores finais têm autorização para criar agentes no Agentspace.
disableLocationContext

boolean

Opcional. Indica se o contexto de localização do utilizador deve ser desativado. Por predefinição, o contexto de localização do utilizador está ativado.

GenerationConfig

Configuração para a geração da resposta do assistente.

Representação JSON 
{
  "systemInstruction": {
    object (SystemInstruction)
  },
  "defaultLanguage": string
}
Campos
systemInstruction

object (SystemInstruction)

Instrução do sistema, também conhecida como preâmbulo do comando para chamadas de MDIs. Consulte também https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions
defaultLanguage

string

O idioma predefinido a usar para a geração da resposta do assistente. Use um código de idioma ISO 639-1, como en. Se não for especificado, o idioma é detetado automaticamente.

SystemInstruction

Instrução do sistema, também conhecida como preâmbulo do comando para chamadas de MDIs.

Representação JSON 
{
  "additionalSystemInstruction": string
}
Campos
additionalSystemInstruction

string

Opcional. Instrução adicional do sistema que vai ser adicionada à instrução do sistema predefinida.

WebGroundingType

O tipo de baseamento na Web a usar.

Enumerações
WEB_GROUNDING_TYPE_UNSPECIFIED Predefinição, definição não especificada. Isto é o mesmo que desativado.
WEB_GROUNDING_TYPE_DISABLED A verificação da Web está desativada.

VertexAiAgentConfig

Descontinuado: em alternativa, use agentes do Dialogflow no AgentService. Representa um agente de IA do Vertex externo que pode ser alcançado através do assistente.

Representação JSON 
{
  "displayName": string,
  "name": string,
  "toolDescription": string
}
Campos
displayName

string

Obrigatório. Nome a apresentar do agente do Vertex AI usado para referência no assistente.
name

string

Obrigatório. Nome do recurso do agente do Vertex AI. Formato: projects/{project}/locations/{location}/agents/{agent}
toolDescription

string

Obrigatório. A descrição da ferramenta do agente da Vertex AI. Esta descrição vai ser usada pelo MDG para decidir se o agente é relevante para a pergunta do utilizador e se a pergunta deve ser encaminhada para o agente.

ActionList

Descontinuado: vai ser substituído por ToolList. As ações ativadas num conetor

Representação JSON 
{
  "actionInfo": [
    {
      object (ActionInfo)
    }
  ]
}
Campos
actionInfo[]

object (ActionInfo)

A lista de ações com as informações de ações correspondentes.

ActionInfo

Descontinuado: vai ser substituído por ToolInfo. Informações para identificar uma ação.

Representação JSON 
{
  "actionName": string,
  "actionDisplayName": string
}
Campos
actionName

string

O nome da ação, conforme definido por DataConnectorService.QueryAvailableActions.
actionDisplayName

string

O nome a apresentar da ação.

ToolList

As ferramentas ativadas num conetor

Representação JSON 
{
  "toolInfo": [
    {
      object (ToolInfo)
    }
  ]
}
Campos
toolInfo[]

object (ToolInfo)

A lista de ferramentas com as informações correspondentes.

ToolInfo

Informações para identificar uma ferramenta.

Representação JSON 
{
  "toolName": string,
  "toolDisplayName": string
}
Campos
toolName

string

O nome da ferramenta, conforme definido por DataConnectorService.QueryAvailableActions. Nota: está a usar action nas APIs DataConnectorService, mas são iguais a tool aqui.
toolDisplayName

string

O nome a apresentar da ferramenta.

CustomerPolicy

Política definida pelo cliente para o assistente.

Representação JSON 
{
  "bannedPhrases": [
    {
      object (BannedPhrase)
    }
  ],
  "modelArmorConfig": {
    object (ModelArmorConfig)
  }
}
Campos
bannedPhrases[]

object (BannedPhrase)

Opcional. Lista de expressões proibidas.
modelArmorConfig

object (ModelArmorConfig)

Opcional. Configuração do Model Armor a ser usada para proteger as instruções do utilizador e as respostas do assistente.

BannedPhrase

Definição de uma expressão proibida definida pelo cliente. Não é permitido que uma expressão proibida apareça na consulta do utilizador ou na resposta do MDG, caso contrário, a resposta é recusada.

Representação JSON 
{
  "phrase": string,
  "matchType": enum (BannedPhraseMatchType),
  "ignoreDiacritics": boolean
}
Campos
phrase

string

Obrigatório. O conteúdo da string não processada a ser banido.
matchType

enum (BannedPhraseMatchType)

Opcional. Tipo de correspondência da expressão proibida.
ignoreDiacritics

boolean

Opcional. Se for verdadeiro, as marcas diacríticas (por exemplo, acentos, trema) são ignoradas quando são encontradas frases proibidas. Por exemplo, "cafe" corresponderia a "café".

BannedPhraseMatchType

O método de correspondência da expressão proibida.

Enumerações
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED A predefinição é SIMPLE_STRING_MATCH.
SIMPLE_STRING_MATCH A expressão proibida corresponde se for encontrada em qualquer parte do texto como uma substring exata.
WORD_BOUNDARY_STRING_MATCH A expressão proibida só corresponde se o padrão encontrado no texto estiver rodeado por delimitadores de palavras. A própria expressão pode continuar a conter delimitadores de palavras.

ModelArmorConfig

Configuração de modelos do Model Armor definidos pelo cliente para serem usados na higienização de comandos do utilizador e respostas do assistente.

Representação JSON 
{
  "userPromptTemplate": string,
  "responseTemplate": string,
  "failureMode": enum (FailureMode)
}
Campos
userPromptTemplate

string

Opcional. O nome do recurso do modelo do Armor para limpar os comandos do utilizador. Formato: projects/{project}/locations/{location}/templates/{templateId}

Se não for especificado, não é aplicada nenhuma higienização ao comando do utilizador.
responseTemplate

string

Opcional. O nome do recurso do modelo Armor para limpar as respostas do assistente. Formato: projects/{project}/locations/{location}/templates/{templateId}

Se não for especificado, não é aplicada nenhuma higienização à resposta do assistente.
failureMode

enum (FailureMode)

Opcional. Define o modo de falha para a higienização do Model Armor.

FailureMode

Determina o comportamento quando o Model Armor não consegue processar um pedido.

Enumerações
FAILURE_MODE_UNSPECIFIED Modo de falha não especificado. O comportamento predefinido é FAIL_CLOSED.
FAIL_OPEN Em caso de falha de processamento do Model Armor, o pedido pode prosseguir sem alterações.
FAIL_CLOSED Em caso de falha no processamento do Model Armor, o pedido é rejeitado.

VertexAiSearchToolConfig

Opções de configuração para a ferramenta Vertex AI Search que o assistente pode usar ao processar consultas.

Representação JSON 
{
  "llmSystemInstructions": string
}
Campos
llmSystemInstructions
(deprecated)

string

Descontinuado. Evite usar este campo. Instruções do sistema para responder com base nos resultados da pesquisa do Vertex AI Search. Tenha em atenção que a resposta produzida pela ferramenta de pesquisa pode diferir da resposta final do assistente.

Em geral, as instruções do sistema são um conjunto de instruções de linguagem natural que o modelo processa antes de processar os comandos. Indica ao modelo como deve comportar-se e responder aos comandos. Consulte https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions

Exemplo: "Usa apenas informações das fontes para responder. Além disso, certifique-se de que formata bem a resposta com Markdown."

Se não for especificado, é usada a predefinição interna.

AgentConfig

Opções de configuração para os agentes que o assistente pode chamar quando processa consultas.

Representação 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

Obrigatório. Um ID exclusivo e legível para o agente. Tem de corresponder à seguinte expressão regular: [a-z][a-zA-Z0-9_-]*.
displayName

string

Obrigatório. Nome a apresentar do agente usado como referência no assistente.
toolDescription

string

Obrigatório. A descrição da ferramenta do agente. Esta descrição vai ser usada pelo MDG para decidir se o agente é relevante para a pergunta do utilizador e se a pergunta deve ser encaminhada para o agente.
icon

object (Image)

Obrigatório. O ícone que representa o agente na IU.
authorizations[]

string

Opcional. Nomes dos recursos das autorizações necessárias. Se o utilizador não estiver autorizado, o serviço devolve vários URIs de autorização que o utilizador tem de abrir num navegador e autorizar. Assim que todas as autorizações forem concedidas, o utilizador pode tentar novamente a consulta e as autorizações são encaminhadas para o agente.

Formato: projects/{project}/locations/{location}/authorizations/{authorization}
Campo de união connection_info. A configuração da ligação do agente. connection_info só pode ser uma das seguintes opções:
vertexAiSdkAgentConnectionInfo

object (VertexAiSdkAgentConnectionInfo)

Obrigatório. Informações de ligação para um agente do SDK Vertex AI
httpAgentConnectionInfo

object (HttpAgentConnectionInfo)

Obrigatório. Informações de ligação para um agente HTTP.

VertexAiSdkAgentConnectionInfo

Informações de ligação para um agente do SDK Vertex AI. Atualmente, apenas são suportados agentes expostos através de motores de raciocínio.

Representação JSON 
{
  "reasoningEngine": string
}
Campos
reasoningEngine

string

Nome do recurso do motor de raciocínio que expõe o agente. Formato: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

HttpAgentConnectionInfo

Um agente acessível pelo assistente através de HTTP.

Representação JSON 
{
  "httpUri": string
}
Campos
httpUri

string

Obrigatório. O endereço HTTP do agente, por exemplo, "https://example.com/agent1".

Imagem

Representa uma imagem.

Representação 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ão storage_method. Pode ser um URI ou o conteúdo codificado como uma string base64. storage_method só pode ser uma das seguintes opções:
uri

string

Obrigatório. URI da imagem.
content

string

Obrigatório. Conteúdo do ficheiro de imagem codificado em Base64.

Métodos

assist

 Ajuda o utilizador com uma consulta.

create

 Cria um Assistant.

delete

 Elimina um Assistant.

get

 Obtém um Assistant.

list

 Apresenta todos os Assistants num Engine.

listAvailableAgentViews

 Apresenta os dados para apresentar os agentes num Assistant que estão disponíveis para o autor da chamada.

patch

 Atualiza um Assistant

streamAssist

 Ajuda o utilizador com uma consulta de forma contínua.