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

Recurso: agente

Executa uma tarefa específica predefinida.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "icon": {
    object (Image)
  },
  "createTime": string,
  "updateTime": string,
  "authorizations": [
    string
  ],
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "dataStoreSpecs": {
    object (DataStoreSpecs)
  },
  "state": enum (State),
  "toolSettings": {
    object (AgentToolSettings)
  },
  "languageCode": string,
  "starterPrompts": [
    {
      object (StarterPrompt)
    }
  ],
  "customPlaceholderText": string,

  // Union field definition can be only one of the following:
  "adkAgentDefinition": {
    object (AdkAgentDefinition)
  },
  "managedAgentDefinition": {
    object (ManagedAgentDefinition)
  },
  "a2aAgentDefinition": {
    object (A2AAgentDefinition)
  },
  "dialogflowAgentDefinition": {
    object (DialogflowAgentDefinition)
  }
  // End of list of possible types for union field definition.

  // Union field agent_state_reason can be only one of the following:
  "suspensionReason": string,
  "rejectionReason": string,
  "deploymentFailureReason": string
  // End of list of possible types for union field agent_state_reason.
}
Campos
name

string

Identificador. Nome do recurso do agente. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent} ou projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/agents/{agent}
displayName

string

Obrigatório. Nome a apresentar do agente. Isto pode ser usado por um MDG para selecionar automaticamente um agente para responder a uma consulta do utilizador.
description

string

Obrigatório. Descrição do agente legível. Isto pode ser usado por um MDG para selecionar automaticamente um agente para responder a uma consulta do utilizador.
icon

object (Image)

Opcional. O ícone que representa o agente na IU.
createTime

string (Timestamp format)

Apenas saída. Data/hora em que este agente foi criado.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Apenas saída. Data/hora em que este agente foi atualizado mais recentemente.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
authorizations[]
(deprecated)

string

Opcional. Descontinuado: em alternativa, use Agent.authorization_config. Lista de autorizações necessárias para este agente.
authorizationConfig

object (AuthorizationConfig)

Opcional. As autorizações exigidas pelo agente.
dataStoreSpecs

object (DataStoreSpecs)

Opcional. DataStoreSpecs associados ao agente. Se não definir este campo, vai usar todos os arquivos de dados no motor.
state

enum (State)

Apenas saída. O estado do ciclo de vida do agente.
toolSettings
(deprecated)

object (AgentToolSettings)

Opcional. DESCONTINUADO: migração planeada para a definição AgentCard.
languageCode

string

Opcional. O código do idioma do texto nos campos description, displayName e starterPrompts.
starterPrompts[]

object (StarterPrompt)

Opcional. As sugestões de comandos iniciais a apresentar ao utilizador na página de destino do agente.
customPlaceholderText

string

Opcional. O texto do marcador de posição personalizado que aparece na caixa de texto antes de o utilizador introduzir texto.
Campo de união definition. A definição do agente. LINT.IfChange(definition) definition só pode ser uma das seguintes opções:
adkAgentDefinition

object (AdkAgentDefinition)

Opcional. O comportamento do agente é definido como um agente ADK.
managedAgentDefinition

object (ManagedAgentDefinition)

Opcional. O comportamento do agente gerido pela Google.
a2aAgentDefinition

object (A2AAgentDefinition)

Opcional. O comportamento do agente é definido como um agente A2A.
dialogflowAgentDefinition

object (DialogflowAgentDefinition)

Opcional. O comportamento do agente é definido como um agente do Dialogflow.
Campo de união agent_state_reason. O motivo pelo qual o agente se encontra no estado atual. agent_state_reason só pode ser uma das seguintes opções:
suspensionReason

string

Apenas saída. O motivo pelo qual o agente foi suspenso. Definido apenas se o estado for SUSPENSO.
rejectionReason

string

Apenas saída. O motivo pelo qual o agente foi rejeitado. Apenas definido se o estado for PRIVATE e tiver chegado a esse estado através da rejeição.
deploymentFailureReason

string

Apenas saída. O motivo pelo qual a implementação do agente falhou. Definido apenas se o estado for DEPLOYMENT_FAILED.

AdkAgentDefinition

Armazena a definição de um agente que usa o ADK e é implementado no Agent Engine (anteriormente conhecido como Reasoning Engine).

Representação JSON 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "provisionedReasoningEngine": {
    object (ProvisionedReasoningEngine)
  },
  "authorizations": [
    string
  ]
}
Campos
toolSettings

object (AgentToolSettings)

Opcional. Os parâmetros que definem como o agente é apresentado ao MDG do planeador.
provisionedReasoningEngine

object (ProvisionedReasoningEngine)

Opcional. O motor de raciocínio ao qual o agente está ligado.
authorizations[]
(deprecated)

string

Opcional. DESCONTINUADO: em alternativa, use Agent.authorizations. 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}

AgentToolSettings

Definições da ferramenta que representa o agente para o MDG do planeador do Agentspace.

Representação JSON 
{
  "toolDescription": string,
  "inputParameterName": string,
  "inputParameterDescription": string
}
Campos
toolDescription

string

Obrigatório. Isto pode ser usado por um MDG para descrever quando o agente deve ser usado.
inputParameterName

string

Opcional. Nome do parâmetro para a chamada de função. Este nome de parâmetro indica ao MDG que tipo de conteúdo se espera que o parâmetro contenha, por exemplo, uma "pergunta", um "comando", uma "searchQuery", etc.
inputParameterDescription

string

Opcional. Descrição dos parâmetros para a chamada de função. Esta descrição dá ao MDG mais informações sobre o parâmetro, por exemplo, que tipo de conteúdo se espera que seja transmitido e que ações devem ser realizadas no mesmo.

ProvisionedReasoningEngine

Monitoriza o motor de raciocínio ao qual o agente está ligado. Esta mensagem não se destina a acompanhar o ciclo de vida do agente. Em vez disso, é apenas usado para definir parâmetros de ligação ao agente que já está implementado num motor de raciocínio.

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

string

Obrigatório. O motor de raciocínio ao qual o agente está ligado. Formato: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

ManagedAgentDefinition

Armazena a definição de um agente gerido pela Google.

Representação JSON 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "authorizations": [
    string
  ],
  "deploymentInfo": {
    object (DeploymentInfo)
  },

  // Union field agent_config can be only one of the following:
  "dataScienceAgentConfig": {
    object (DataScienceAgentConfig)
  }
  // End of list of possible types for union field agent_config.
}
Campos
toolSettings

object (AgentToolSettings)

Opcional. Os parâmetros que definem como o agente é apresentado ao MDG do planeador.
authorizations[]
(deprecated)

string

Opcional. DESCONTINUADO: em alternativa, use Agent.authorizations. 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}
deploymentInfo

object (DeploymentInfo)

Apenas saída. Informações de implementação automática para o agente.
Campo de união agent_config. Configuração específica do tipo de agente. agent_config só pode ser uma das seguintes opções:
dataScienceAgentConfig

object (DataScienceAgentConfig)

Opcional. Configuração específica dos agentes de ciência de dados predefinidos da Google. Esta estrutura de dados destina-se a armazenar a configuração de tempo de implementação e de pedido do agente.

DataScienceAgentConfig

Configuração específica dos agentes de ciência de dados predefinidos da Google. Esta estrutura de dados destina-se a armazenar a configuração de tempo de implementação e de pedido do agente.

Representação JSON 
{
  "bqProjectId": string,
  "bqDatasetId": string,
  "blocklistTables": [
    string
  ],
  "allowlistTables": [
    string
  ],
  "nlQueryConfig": {
    object (NlQueryConfig)
  }
}
Campos
bqProjectId

string

Obrigatório. O ID do projeto do BigQuery onde o conjunto de dados está localizado.
bqDatasetId

string

Obrigatório. O ID do conjunto de dados do BigQuery a usar para o agente. O conjunto de dados tem de estar no projeto especificado por bqProjectId.
blocklistTables[]

string

Opcional. As tabelas do BigQuery que devem ser bloqueadas para utilização pelo agente.
allowlistTables[]

string

Opcional. As tabelas do BigQuery que o agente pode usar.
nlQueryConfig

object (NlQueryConfig)

Opcional. Configuração fornecida pelo cliente.

NlQueryConfig

Defina as configurações fornecidas pelo cliente específicas da tradução de linguagem natural para código SQL/Python.

Representação JSON 
{
  "nl2sqlPrompt": string,
  "nl2pyPrompt": string,
  "nl2sqlExamples": [
    {
      object (Nl2SqlExample)
    }
  ],
  "schemaDescription": string,
  "bqSqlGenUseCustomPrompt": boolean
}
Campos
nl2sqlPrompt

string

Opcional. O cliente forneceu instruções de NL2SQL
nl2pyPrompt

string

Opcional. O cliente forneceu instruções para o MDG escrever código Python para análise de dados.
nl2sqlExamples[]

object (Nl2SqlExample)

Opcional. O cliente forneceu exemplos de NL2SQL, incluindo a entrada e o SQL esperado.
schemaDescription

string

Opcional. A descrição em linguagem natural do esquema do conjunto de dados do BigQuery.
bqSqlGenUseCustomPrompt

boolean

Opcional. Se deve usar o comando personalizado para o serviço de geração de SQL do BigQuery.

Nl2SqlExample

Um único exemplo de NL2SQL.

Representação JSON 
{
  "query": string,
  "expectedSql": string,
  "expectedResponse": string
}
Campos
query

string

Opcional. A consulta de linguagem natural à qual se vai responder.
expectedSql

string

Opcional. O resultado SQL esperado.
expectedResponse

string

Opcional. A resposta esperada à consulta.

DeploymentInfo

Informações de implementação automática para o agente.

Representação JSON 
{
  "operation": string,
  "finishTime": string
}
Campos
operation

string

Apenas saída. Recurso de operação de longa duração para a implementação. Pode ser usado para verificar o estado da implementação. Quando a implementação terminar, este campo fica vazio. Se a implementação falhar,o campo vai conter o nome do recurso do LRO com falha, mas o próprio recurso de operação é eliminado automaticamente após algum tempo.
finishTime

string (Timestamp format)

Apenas saída. Hora de conclusão da implementação: só é definida se a implementação estiver concluída ou tiver falhado.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

A2AAgentDefinition

Definição armazenada de um agente que usa a API A2A.

Representação JSON 
{

  // Union field agent_card can be only one of the following:
  "jsonAgentCard": string,
  "remoteAgentCard": {
    object (RemoteAgentcard)
  }
  // End of list of possible types for union field agent_card.
}
Campos
Campo de união agent_card. O nome, as capacidades, as informações de autorização, etc., do agente de lojas agent_card só podem ser um dos seguintes:
jsonAgentCard

string

Opcional. O cartão do agente é uma string JSON.
remoteAgentCard

object (RemoteAgentcard)

Opcional. Um cartão de agente remoto.

RemoteAgentcard

Definição de um cartão de agente alojado remotamente.

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

string

Obrigatório. O URI do cartão do agente.

DialogflowAgentDefinition

Definição armazenada de um agente que usa um agente Dialogflow.

Representação JSON 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "dialogflowAgent": string
}
Campos
toolSettings

object (AgentToolSettings)

Opcional. Os parâmetros que definem como o agente é apresentado ao MDG do planeador.
dialogflowAgent

string

Obrigatório. Nome do recurso do agente Dialogflow subjacente. Formato: projects/{project}/locations/{location}/agents/{agent}

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

URI da imagem.
content

string

Conteúdo do ficheiro de imagem codificado em Base64.

AuthorizationConfig

Descreve as autorizações necessárias.

Representação JSON 
{
  "toolAuthorizations": [
    string
  ],
  "agentAuthorization": string
}
Campos
toolAuthorizations[]

string

Opcional. Lista de autorizações necessárias para o agente aceder a outros recursos. Os tokens de autorização são transmitidos ao agente como parte do corpo do pedido.
agentAuthorization

string

Opcional. A autorização necessária para invocar o agente. Os tokens de autorização são transmitidos ao agente como parte do cabeçalho de autorização do pedido.

DataStoreSpecs

Representa um conjunto de especificações de arquivo de dados.

Representação JSON 
{
  "specs": [
    {
      object (DataStoreSpec)
    }
  ]
}
Campos
specs[]

object (DataStoreSpec)

Opcional. Especificações que definem DataStores para filtrar numa chamada de pesquisa e configurações para esses armazenamentos de dados. Isto só é considerado para Engines com várias lojas de dados.

Estado

Valores possíveis para o estado do ciclo de vida do agente.

Enumerações
STATE_UNSPECIFIED O estado não está especificado.
CONFIGURED O agente está configurado, mas ainda não foi acionado nenhuma implementação.
DEPLOYING O agente está a ser implementado.
DISABLED O agente só está disponível para administradores.
DEPLOYMENT_FAILED A implementação do agente falhou.
PRIVATE O agente só está disponível para o respetivo criador.
ENABLED O agente está disponível para utilizadores que têm acesso.
SUSPENDED O agente está temporariamente indisponível, embora seja visível para os utilizadores que têm acesso.

StarterPrompt

A sugestão de comando inicial a apresentar ao utilizador na página de destino do agente.

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

string

Obrigatório. O texto do comando inicial.

Métodos

create

 Cria um Agent.

delete

 Elimina um Agent.

deploy

 Implementa um Agent.

get

 Obtém um Agent.

getAgentView

 Devolve um AgentView para um determinado Agent, que contém informações adicionais sobre o agente.

list

 Apresenta todos os Agents de um Assistant que foram criados pelo autor da chamada.

patch

 Atualiza um Agent