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),
  "enabledActions": {
    string: {
      object (ActionList)
    },
    ...
  },
  "enabledTools": {
    string: {
      object (ToolList)
    },
    ...
  },
  "customerPolicy": {
    object (CustomerPolicy)
  }
}
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. Deve ser 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.
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.

GenerationConfig

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

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

string

Opcional. O modelo padrão a ser usado para o assistente.
allowedModelIds[]

string

Opcional. A lista de modelos que podem ser usados para o assistente.
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.

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 iguais ao 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 que serão 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.

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.

patch

 Atualiza um Assistant.

streamAssist

 Ajuda o usuário com uma consulta em streaming.