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

Recurso: Assistant

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}

Precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
displayName

string

Obrigatório. O nome de exibição do assistente.

Precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres.
description

string

Opcional. Descrição para mais informações. É esperado que seja mostrado na UI de configuração, não para os usuários do assistente.
generationConfig

object (GenerationConfig)

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

boolean

Opcional. Obsoleto. Use webGroundingType.
webGroundingType

enum (WebGroundingType)

Opcional. O tipo de embasamento da Web a ser usado.
defaultWebGroundingToggleOff

boolean

Opcional. Esse campo controla a alternância padrão de embasamento na Web para usuários finais se webGroundingType estiver definido como WEB_GROUNDING_TYPE_GOOGLE_SEARCH ou WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. Por padrão, esse campo é definido como "false". Se webGroundingType for WEB_GROUNDING_TYPE_GOOGLE_SEARCH ou WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, os usuários finais terão o embasamento na Web ativado por padrão na UI. Se for "true", a opção de ativar/desativar o embasamento será desativada por padrão na UI. Os usuários finais ainda podem ativar o embasamento da Web na UI se ele estiver ativado.
vertexAiAgentConfigs[]
(deprecated)

object (VertexAiAgentConfig)

Opcional. Descontinuado: será substituído por agentes do Dialogflow em AgentService. Lista de agentes da Vertex AI que podem ser acessados pelo assistente.
enabledActions
(deprecated)

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

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

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

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

object (CustomerPolicy)

Opcional. Política de clientes para o assistente.
vertexAiSearchToolConfig

object (VertexAiSearchToolConfig)

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

string

Opcional. Obsoleto. Use [addtional_system_instructions][GenerationConfig.SystemInstruction.additional_system_instructions] em vez disso. Snippet de instrução comum do sistema para definir estilo, tom e formatação da conversa. Adicionado a todos os comandos de LLM usando o marcador de posição [STYLE_AND_FORMATTING_INSTRUCTIONS].
agentConfigs[]

object (AgentConfig)

Opcional. Lista de agentes que podem ser contatados pelo Google Assistente.
enableEndUserAgentCreation

boolean

Opcional. Indica se os usuários finais podem criar agentes no Agentspace.
disableLocationContext

boolean

Opcional. Indica se é necessário desativar o contexto de localização do usuário. Por padrão, o contexto de local do usuário 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 de comandos para chamadas de LLM. Consulte também https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions
defaultLanguage

string

O idioma padrão usado para gerar a resposta do assistente. Use um código de idioma ISO 639-1, como en. Se não for especificado, o idioma será detectado automaticamente.

SystemInstruction

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

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

string

Opcional. Instrução adicional do sistema que será adicionada à instrução padrão.

WebGroundingType

O tipo de embasamento da Web a ser usado.

Tipos enumerados
WEB_GROUNDING_TYPE_UNSPECIFIED Configuração padrão não especificada. É o mesmo que desativado.
WEB_GROUNDING_TYPE_DISABLED O embasamento da Web está desativado.

VertexAiAgentConfig

Descontinuado: use agentes do Dialogflow em AgentService. Representa um agente externo da Vertex AI que pode ser acessado pelo assistente.

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

string

Obrigatório. Nome de exibição do agente da Vertex AI usado como referência no assistente.
name

string

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

string

Obrigatório. A descrição da ferramenta do agente da Vertex AI. O LLM vai usar essa descrição para decidir se o agente é relevante para a pergunta do usuário e se a pergunta precisa ser encaminhada ao agente.

ActionList

Descontinuado: será substituído por ToolList. As ações ativadas em um conector

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

object (ActionInfo)

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

ActionInfo

Descontinuado: 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 de exibição da ação.

ToolList

As ferramentas ativadas em um conector

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". Observação: ele usa action nas APIs DataConnectorService, mas elas são as mesmas que tool aqui.
toolDisplayName

string

O nome de exibição 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 frases proibidas.
modelArmorConfig

object (ModelArmorConfig)

Opcional. Configuração do Model Armor a ser usada para higienizar comandos do usuário e respostas do assistente.

BannedPhrase

Definição de uma frase proibida definida pelo cliente. Uma frase proibida não pode aparecer na consulta do usuário nem na resposta do LLM. Caso contrário, a resposta será recusada.

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

string

Obrigatório. O conteúdo da string bruta a ser proibido.
matchType

enum (BannedPhraseMatchType)

Opcional. Tipo de correspondência da frase proibida.
ignoreDiacritics

boolean

Opcional. Se for "true", os sinais diacríticos (por exemplo, acentos, trema) serão ignorados ao corresponder a frases proibidas. Por exemplo, "cafe" corresponde a "café".

BannedPhraseMatchType

O método de correspondência para a frase proibida.

Tipos enumerados
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED O padrão é SIMPLE_STRING_MATCH.
SIMPLE_STRING_MATCH A frase proibida corresponde se for encontrada em qualquer lugar do texto como uma substring exata.
WORD_BOUNDARY_STRING_MATCH A frase proibida só corresponde se o padrão encontrado no texto estiver cercado por delimitadores de palavras. A frase em si ainda pode conter delimitadores de palavras.

ModelArmorConfig

Configuração para modelos do Model Armor definidos pelo cliente a serem usados para higienizar comandos do usuário 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 Model Armor para higienizar comandos do usuário. Formato: projects/{project}/locations/{location}/templates/{templateId}

Se não for especificado, nenhuma limpeza será aplicada ao comando do usuário.
responseTemplate

string

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

Se não for especificado, nenhuma limpeza será aplicada à resposta do assistente.
failureMode

enum (FailureMode)

Opcional. Define o modo de falha para a limpeza do Model Armor.

FailureMode

Determina o comportamento quando o Model Armor não consegue processar uma solicitação.

Tipos enumerados
FAILURE_MODE_UNSPECIFIED Modo de falha não especificado. O comportamento padrão é FAIL_CLOSED.
FAIL_OPEN Em caso de falha no processamento do Model Armor, a solicitação pode prosseguir sem alterações.
FAIL_CLOSED Em caso de falha no processamento do Model Armor, a solicitação é rejeitada.

VertexAiSearchToolConfig

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

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

string

Obsoleto. Não use este campo. Instruções do sistema para responder com base nos resultados da Vertex AI para Pesquisa. A resposta produzida pela ferramenta de pesquisa pode ser diferente da resposta final do assistente.

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

Exemplo: "Use apenas as informações das fontes para responder. Além disso, formate a resposta com Markdown."

Se não for especificado, o padrão interno será usado.

AgentConfig

Opções de configuração para os agentes que o assistente pode chamar ao processar 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 do agente que é exclusivo e legível por humanos. Precisa corresponder à seguinte expressão regular: [a-z][a-zA-Z0-9_-]*.
displayName

string

Obrigatório. Nome de exibição do agente usado como referência no assistente.
toolDescription

string

Obrigatório. A descrição da ferramenta do agente. O LLM vai usar essa descrição para decidir se o agente é relevante para a pergunta do usuário e se a pergunta precisa ser encaminhada ao agente.
icon

object (Image)

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

string

Opcional. Nomes de recursos das autorizações necessárias. Se o usuário não estiver autorizado, o serviço vai retornar vários URIs de autorização que ele precisa abrir em um navegador e autorizar. Depois que todas as autorizações forem concedidas, o usuário poderá tentar fazer a consulta novamente, e as autorizações serão encaminhadas ao agente.

Formato: projects/{project}/locations/{location}/authorizations/{authorization}
Campo de união connection_info. A configuração de conexão do agente. connection_info pode ser apenas de um dos tipos a seguir:
vertexAiSdkAgentConnectionInfo

object (VertexAiSdkAgentConnectionInfo)

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

object (HttpAgentConnectionInfo)

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

VertexAiSdkAgentConnectionInfo

Informações de conexão para um agente do SDK da Vertex AI. No momento, apenas agentes expostos por mecanismos de raciocínio são compatíveis.

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

string

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

HttpAgentConnectionInfo

Um agente que pode ser acessado pelo assistente via 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 pode ser apenas de um dos tipos a seguir:
uri

string

Obrigatório. URI da imagem.
content

string

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

Métodos

assist

 Ajuda o usuário com uma consulta.

create

 Cria um Assistant.

delete

 Exclui um Assistant.

get

 Recebe um Assistant.

list

 Lista todos os Assistants em um Engine.

listAvailableAgentViews

 Lista os dados para mostrar os agentes em um Assistant que estão disponíveis para o autor da chamada.

patch

 Atualiza um Assistant.

streamAssist

 Ajuda o usuário com uma consulta em streaming.