REST Resource: projects.locations.collections.engines.assistants.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.

Métodos

create

 Cria um Agent.

delete

 Exclui um Agent.

deploy

 Implanta um Agent.

disableAgent

 Desativa um agente.

enableAgent

 Ativa um agente.

get

 Recebe um Agent.

getAgentView

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

getIamPolicy

 Busca a política de controle de acesso de um recurso de agente.

list

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

patch

 Atualiza um Agent.

rejectAgent

 Rejeita um agente oferecido ao público.

requestAgentReview

 Apresenta um agente aos administradores, disponibilizando-o para revisão.

setIamPolicy

 Define a política de controle de acesso de um recurso de agente.

suspendAgent

 Suspende um agente.

withdrawAgent

 Retira um agente oferecido ao público.