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

Ressource: Agent

Führt eine vordefinierte, spezifische Aufgabe aus.

JSON-Darstellung 
{
  "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.
}
Felder
name

string

ID. Ressourcenname des Agents. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent} oder projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/agents/{agent}
displayName

string

Erforderlich. Anzeigename des Agents. Dies kann von einem LLM verwendet werden, um automatisch einen KI-Agenten auszuwählen, der auf eine Nutzeranfrage antwortet.
description

string

Erforderlich. Menschenlesbare Beschreibung des KI-Agenten. Dies kann von einem LLM verwendet werden, um automatisch einen KI-Agenten auszuwählen, der auf eine Nutzeranfrage antwortet.
icon

object (Image)

Optional. Das Symbol, das den Agent in der Benutzeroberfläche darstellt.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel für die Erstellung dieses Agents.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann dieser Agent zuletzt aktualisiert wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
authorizations[]
(deprecated)

string

Optional. Verworfen: Verwenden Sie stattdessen Agent.authorization_config. Liste der erforderlichen Autorisierungen für diesen Agent.
authorizationConfig

object (AuthorizationConfig)

Optional. Die vom Agent erforderlichen Autorisierungen.
dataStoreSpecs

object (DataStoreSpecs)

Optional. DataStoreSpecs, die dem Agent zugeordnet sind. Wenn Sie dieses Feld nicht festlegen, werden alle Datenspeicher in der Engine verwendet.
state

enum (State)

Nur Ausgabe. Der Lebenszyklusstatus des Agents.
toolSettings
(deprecated)

object (AgentToolSettings)

Optional. VERALTET: Geplante Migration zur AgentCard-Definition.
languageCode

string

Optional. Der Code der Sprache des Texts in den Feldern „description“, „displayName“ und „starterPrompts“.
starterPrompts[]

object (StarterPrompt)

Optional. Die Vorschläge für Starter-Prompts, die dem Nutzer auf der Landingpage des Agents angezeigt werden.
customPlaceholderText

string

Optional. Der benutzerdefinierte Platzhaltertext, der im Textfeld angezeigt wird, bevor der Nutzer Text eingibt.
Union-Feld definition. Die Definition des Agents. LINT.IfChange(definition) definition kann nur einer der folgenden Werte sein:
adkAgentDefinition

object (AdkAgentDefinition)

Optional. Das Verhalten des Agents wird als ADK-Agent definiert.
managedAgentDefinition

object (ManagedAgentDefinition)

Optional. Das Verhalten des von Google verwalteten Agents.
a2aAgentDefinition

object (A2AAgentDefinition)

Optional. Das Verhalten des Agents ist als A2A-Agent definiert.
dialogflowAgentDefinition

object (DialogflowAgentDefinition)

Optional. Das Verhalten des Agents wird als Dialogflow-Agent definiert.
Union-Feld agent_state_reason. Der Grund, warum sich der Agent im aktuellen Status befindet. Für agent_state_reason ist nur einer der folgenden Werte zulässig:
suspensionReason

string

Nur Ausgabe. Der Grund für die Sperrung des KI‑Agents. Wird nur festgelegt, wenn der Status SUSPENDED ist.
rejectionReason

string

Nur Ausgabe. Der Grund, warum der Agent abgelehnt wurde. Wird nur festgelegt, wenn der Status „PRIVATE“ lautet und durch Ablehnung erreicht wurde.
deploymentFailureReason

string

Nur Ausgabe. Der Grund, warum die Agent-Bereitstellung fehlgeschlagen ist. Wird nur festgelegt, wenn der Status DEPLOYMENT_FAILED ist.

Methoden

create

 Erstellt ein Agent.

delete

 Löscht ein Agent.

deploy

 Stellt eine Agent bereit.

disableAgent

 Deaktiviert einen Agent.

enableAgent

 Aktiviert einen Agent.

get

 Ruft ein Agent ab.

getAgentView

 Gibt ein AgentView für ein bestimmtes Agent zurück, das zusätzliche Informationen zum Agent enthält.

getIamPolicy

 Ruft die Zugriffssteuerungsrichtlinie für eine Agent-Ressource ab.

list

 Listet alle Agent unter einem Assistant auf, die vom Aufrufer erstellt wurden.

patch

 Aktualisiert eine Agent

rejectAgent

 Lehnt einen öffentlich angebotenen Agent ab.

requestAgentReview

 Stellt Administratoren einen Agenten vor, indem er zur Überprüfung verfügbar gemacht wird.

setIamPolicy

 Legt die Zugriffssteuerungsrichtlinie für eine Agentenressource fest.

suspendAgent

 Sperrt einen Agent.

withdrawAgent

 Zieht einen öffentlich angebotenen Agent zurück.