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 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.

Métodos

create

 Cria um Agent.

delete

 Elimina um Agent.

deploy

 Implementa um Agent.

disableAgent

 Desativa um agente.

enableAgent

 Ativa um agente.

get

 Obtém um Agent.

getAgentView

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

getIamPolicy

 Obtém a política de controlo de acesso para um recurso de agente.

list

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

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 controlo de acesso para um recurso de agente.

suspendAgent

 Suspende um agente.

withdrawAgent

 Retira um agente oferecido ao público.