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

Ressource : Agent

Effectue une tâche spécifique prédéfinie.

Représentation 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.
}
Champs
name

string

Identifiant. Nom de ressource de l'agent. Format : 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

Obligatoire. Nom à afficher de l'agent. Un LLM peut l'utiliser pour sélectionner automatiquement un agent afin de répondre à une requête utilisateur.
description

string

Obligatoire. Description de l'agent lisible par l'humain. Un LLM peut l'utiliser pour sélectionner automatiquement un agent afin de répondre à une requête utilisateur.
icon

object (Image)

Facultatif. Icône représentant l'agent dans l'UI.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la création de cet agent.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de cet agent.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
authorizations[]
(deprecated)

string

Facultatif. Obsolète : utilisez plutôt Agent.authorization_config. Liste des autorisations requises pour cet agent.
authorizationConfig

object (AuthorizationConfig)

Facultatif. Autorisations requises par l'agent.
dataStoreSpecs

object (DataStoreSpecs)

Facultatif. DataStoreSpecs associés à l'agent. Si vous ne définissez pas ce champ, tous les data stores du moteur seront utilisés.
state

enum (State)

Uniquement en sortie. État du cycle de vie de l'agent.
toolSettings
(deprecated)

object (AgentToolSettings)

Facultatif. OBSOLÈTE : Migration prévue vers la définition AgentCard.
languageCode

string

Facultatif. Code de la langue du texte dans les champs "description", "displayName" et "starterPrompts".
starterPrompts[]

object (StarterPrompt)

Facultatif. Suggestions de requêtes de démarrage à afficher à l'utilisateur sur la page de destination de l'agent.
customPlaceholderText

string

Facultatif. Texte d'espace réservé personnalisé qui s'affiche dans la zone de texte avant que l'utilisateur ne saisisse du texte.
Champ d'union definition. Définition de l'agent. LINT.IfChange(definition) definition ne peut être que l'un des éléments suivants :
adkAgentDefinition

object (AdkAgentDefinition)

Facultatif. Le comportement de l'agent est défini comme un agent ADK.
managedAgentDefinition

object (ManagedAgentDefinition)

Facultatif. Comportement de l'agent géré par Google.
a2aAgentDefinition

object (A2AAgentDefinition)

Facultatif. Le comportement de l'agent est défini comme un agent A2A.
dialogflowAgentDefinition

object (DialogflowAgentDefinition)

Facultatif. Le comportement de l'agent est défini comme un agent Dialogflow.
Champ d'union agent_state_reason. Raison pour laquelle l'agent est dans son état actuel. agent_state_reason ne peut être qu'un des éléments suivants :
suspensionReason

string

Uniquement en sortie. Raison pour laquelle l'agent a été suspendu. Défini uniquement si l'état est SUSPENDED.
rejectionReason

string

Uniquement en sortie. Raison pour laquelle l'agent a été refusé. Défini uniquement si l'état est "PRIVATE" et qu'il a été atteint après un refus.
deploymentFailureReason

string

Uniquement en sortie. Raison de l'échec du déploiement de l'agent. Défini uniquement si l'état est DEPLOYMENT_FAILED.

Méthodes

create

 Crée un Agent.

delete

 Supprime un Agent.

deploy

 Déploie un Agent.

disableAgent

 Désactive un agent.

enableAgent

 Active un agent.

get

 Récupère un Agent.

getAgentView

 Renvoie un AgentView pour un Agent donné, qui contient des informations supplémentaires sur l'agent.

getIamPolicy

 Récupère la stratégie de contrôle des accès pour une ressource d'agent.

list

 Liste tous les Agent sous un Assistant qui ont été créés par l'appelant.

patch

 Met à jour un Agent.

rejectAgent

 Rejette un agent proposé au public.

requestAgentReview

 Présente un agent aux administrateurs en le rendant disponible pour examen.

setIamPolicy

 Définit la stratégie de contrôle des accès pour une ressource d'agent.

suspendAgent

 Suspend un agent.

withdrawAgent

 Retire un agent proposé au public.