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 de exibição do agente. Isso pode ser usado por um LLM para selecionar automaticamente um agente que responda a uma consulta do usuário.
description

string

Obrigatório. Descrição legível do agente. Isso pode ser usado por um LLM para selecionar automaticamente um agente que responda a uma consulta do usuário.
icon

object (Image)

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

string (Timestamp format)

Apenas saída. Carimbo de data/hora em que este agente foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. 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. Carimbo de data/hora da última atualização deste agente.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. 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: 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 você não definir esse campo, todos os repositórios de dados no mecanismo serão usados.
state

enum (State)

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

object (AgentToolSettings)

Opcional. DESCONTINUADO: migração planejada 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 para mostrar ao usuário na página de destino do agente.
customPlaceholderText

string

Opcional. O texto de marcador de posição personalizado que aparece na caixa de texto antes de o usuário inserir qualquer texto.
Campo de união definition. A definição do agente. LINT.IfChange(definition) definition pode ser apenas uma das seguintes opções:
adkAgentDefinition

object (AdkAgentDefinition)

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

object (ManagedAgentDefinition)

Opcional. O comportamento do agente gerenciado pelo 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 está no estado atual. agent_state_reason pode ser apenas de um dos tipos a seguir:
suspensionReason

string

Apenas saída. O motivo da suspensão do agente. Só é definido se o estado for SUSPENSO.
rejectionReason

string

Apenas saída. O motivo da rejeição do agente. Definido somente se o estado for PRIVATE e tiver sido alcançado por rejeição.
deploymentFailureReason

string

Apenas saída. O motivo da falha na implantação do agente. Definido apenas se o estado for DEPLOYMENT_FAILED.

AdkAgentDefinition

Armazena a definição de um agente que usa o ADK e é implantado no Agent Engine (antigo 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 LLM de planejamento.
provisionedReasoningEngine

object (ProvisionedReasoningEngine)

Opcional. O mecanismo de raciocínio a que o agente está conectado.
authorizations[]
(deprecated)

string

Opcional. OBSOLETO: em vez disso, use Agent.authorizations. 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}

AgentToolSettings

Configurações da ferramenta que representa o agente para o LLM do planejador do Agentspace.

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

string

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

string

Opcional. Nome do parâmetro para a chamada de função. O nome do parâmetro vai informar ao LLM o tipo de conteúdo que ele deve conter, como uma "pergunta", um "comando", uma "searchQuery" etc.
inputParameterDescription

string

Opcional. Descrição do parâmetro para a chamada de função. Essa descrição dará ao LLM mais informações sobre o parâmetro, como que tipo de conteúdo é esperado e quais ações devem ser realizadas nele.

ProvisionedReasoningEngine

Acompanha o mecanismo de raciocínio a que o agente está conectado. Essa mensagem não foi criada para acompanhar o ciclo de vida do agente. Em vez disso, ele é usado apenas para definir parâmetros de conexão com o agente já implantado em um mecanismo de inferência.

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

string

Obrigatório. O mecanismo de raciocínio a que o agente está conectado. Formato: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

ManagedAgentDefinition

Armazena a definição de um agente gerenciado pelo 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 LLM de planejamento.
authorizations[]
(deprecated)

string

Opcional. OBSOLETO: em vez disso, use Agent.authorizations. 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}
deploymentInfo

object (DeploymentInfo)

Apenas saída. Informações de implantação automática do agente.
Campo de união agent_config. Configuração específica do tipo de agente. agent_config pode ser apenas de um dos tipos a seguir:
dataScienceAgentConfig

object (DataScienceAgentConfig)

Opcional. Configuração específica para agentes de ciência de dados pré-criados do Google. Essa estrutura de dados foi criada para armazenar a configuração de implantação e tempo de solicitação do agente.

DataScienceAgentConfig

Configuração específica para agentes de ciência de dados pré-criados do Google. Essa estrutura de dados foi criada para armazenar a configuração de implantação e tempo de solicitação 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 em que o conjunto de dados está localizado.
bqDatasetId

string

Obrigatório. O ID do conjunto de dados do BigQuery a ser usado pelo agente. O conjunto de dados precisa estar no projeto especificado por bqProjectId.
blocklistTables[]

string

Opcional. As tabelas do BigQuery que não podem ser usadas pelo agente.
allowlistTables[]

string

Opcional. As tabelas do BigQuery que podem ser usadas pelo agente.
nlQueryConfig

object (NlQueryConfig)

Opcional. Configuração fornecida pelo cliente.

NlQueryConfig

Defina as configurações fornecidas pelo cliente específicas para a tradução de linguagem natural em 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 que o LLM escrevesse código Python para análise de dados.
nl2sqlExamples[]

object (Nl2SqlExample)

Opcional. O cliente forneceu exemplos de NL2SQL, incluindo entrada e 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 em linguagem natural a ser respondida.
expectedSql

string

Opcional. A saída SQL esperada.
expectedResponse

string

Opcional. A resposta esperada para a consulta.

DeploymentInfo

Informações de implantação automática do agente.

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

string

Apenas saída. Recurso de operação de longa duração para a implantação. Pode ser usado para pesquisar o status da implantação. Quando a implantação terminar, esse campo vai ficar vazio. Se a implantação falhar,o campo vai conter o nome do recurso da LRO com falha, mas o recurso de operação será excluído automaticamente após algum tempo.
finishTime

string (Timestamp format)

Apenas saída. Hora de término da implantação. Só é definida se a implantação for concluída ou falhar.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. 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 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. Armazena o nome, as capacidades, as informações de autenticação etc. do agente. agent_card só pode ser:
jsonAgentCard

string

Opcional. O card do agente é uma string JSON.
remoteAgentCard

object (RemoteAgentcard)

Opcional. Um card de agente remoto.

RemoteAgentcard

Definição de um card de agente hospedado remotamente.

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

string

Obrigatório. O URI do card do agente.

DialogflowAgentDefinition

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

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

object (AgentToolSettings)

Opcional. Os parâmetros que definem como o agente é apresentado ao LLM de planejamento.
dialogflowAgent

string

Obrigatório. Nome do recurso do agente do 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 pode ser apenas de um dos tipos a seguir:
uri

string

URI da imagem.
content

string

Conteúdo do arquivo 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 que o agente acesse outros recursos. Os tokens de autenticação serão transmitidos ao agente como parte do corpo da solicitação.
agentAuthorization

string

Opcional. A autorização necessária para invocar o agente. Os tokens de autenticação serão transmitidos ao agente como parte do cabeçalho de autenticação da solicitação.

DataStoreSpecs

Representa um conjunto de especificações de repositório de dados.

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

object (DataStoreSpec)

Opcional. Especificações que definem DataStores para filtrar em uma chamada de pesquisa e configurações para esses repositórios de dados. Isso só é considerado para Engines com vários repositórios de dados.

Estado

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

Tipos enumerados
STATE_UNSPECIFIED O estado não foi especificado.
CONFIGURED O agente está configurado, mas nenhuma implantação foi acionada ainda.
DEPLOYING O agente está sendo implantado.
DISABLED O agente está disponível apenas para administradores.
DEPLOYMENT_FAILED Falha na implantação do agente.
PRIVATE O agente está disponível apenas para o criador.
ENABLED O agente está disponível para usuários que têm acesso.
SUSPENDED O agente está temporariamente indisponível, mas visível para usuários que têm acesso.

StarterPrompt

A sugestão de comando inicial para mostrar ao usuário 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

 Exclui um Agent.

deploy

 Implanta um Agent.

get

 Recebe um Agent.

getAgentView

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

list

 Lista todos os Agents em um Assistant que foram criados pelo caller.

patch

 Atualiza um Agent.