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

Ressource: KI-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,
  "sharingConfig": {
    object (SharingConfig)
  },

  // 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 KI-Agenten. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}
displayName

string

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

string

Erforderlich. Eine für Menschen lesbare 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 KI-Agenten in der Benutzeroberfläche darstellt.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann dieser KI-Agent erstellt 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".
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann dieser KI-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. Nicht mehr unterstützt: Verwenden Sie stattdessen Agent.authorization_config. Liste der erforderlichen Autorisierungen für diesen KI-Agenten.
authorizationConfig

object (AuthorizationConfig)

Optional. Die vom KI-Agenten benötigten Autorisierungen.
dataStoreSpecs

object (DataStoreSpecs)

Optional. DataStoreSpecs, die dem KI-Agenten zugeordnet sind. Wenn dieses Feld nicht festgelegt wird, werden alle Datenspeicher in der Engine verwendet.
state

enum (State)

Nur Ausgabe. Der Lebenszyklusstatus des KI-Agenten.
toolSettings
(deprecated)

object (AgentToolSettings)

Optional. NICHT MEHR UNTERSTÜTZT: 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 KI-Agenten angezeigt werden.
customPlaceholderText

string

Optional. Der benutzerdefinierte Platzhaltertext, der im Textfeld angezeigt wird, bevor der Nutzer Text eingibt.
sharingConfig

object (SharingConfig)

Optional. Die Freigabekonfiguration des KI-Agenten.
Union-Feld definition. Die Definition des KI-Agenten. LINT.IfChange(definition) definition kann nur einer der folgenden Werte sein:
adkAgentDefinition

object (AdkAgentDefinition)

Optional. Das Verhalten des KI-Agenten ist als ADK-Agent definiert.
managedAgentDefinition

object (ManagedAgentDefinition)

Optional. Das Verhalten des von Google verwalteten KI-Agenten.
a2aAgentDefinition

object (A2AAgentDefinition)

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

object (DialogflowAgentDefinition)

Optional. Das Verhalten des KI-Agenten ist als Dialogflow-Agent definiert.
Union-Feld agent_state_reason. Der Grund für den aktuellen Status des KI-Agenten. 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-Agenten. Wird nur festgelegt, wenn der Status SUSPENDED ist.
rejectionReason

string

Nur Ausgabe. Der Grund, warum der KI-Agent abgelehnt wurde. Wird nur festgelegt, wenn der Status PRIVATE ist und durch Ablehnung erreicht wurde.
deploymentFailureReason

string

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

AdkAgentDefinition

Speichert die Definition eines KI-Agenten, der das ADK verwendet und in der Agent Engine (früher Reasoning Engine) bereitgestellt wird.

JSON-Darstellung 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "provisionedReasoningEngine": {
    object (ProvisionedReasoningEngine)
  },
  "authorizations": [
    string
  ]
}
Felder
toolSettings

object (AgentToolSettings)

Optional. Die Parameter, die definieren, wie der KI-Agent dem Planer-LLM präsentiert wird.
provisionedReasoningEngine

object (ProvisionedReasoningEngine)

Optional. Die Reasoning Engine, mit der der KI-Agent verbunden ist.
authorizations[]
(deprecated)

string

Optional. NICHT MEHR UNTERSTÜTZT: Verwenden Sie stattdessen Agent.authorizations. Ressourcennamen der erforderlichen Autorisierungen. Wenn der Nutzer nicht autorisiert ist, gibt der Dienst einige Autorisierungs-URIs zurück, die der Nutzer in einem Browser öffnen und autorisieren muss. Sobald alle Autorisierungen erteilt wurden, kann der Nutzer die Abfrage noch einmal versuchen. Die Autorisierungen werden dann an den Agent weitergeleitet.

Format: projects/{project}/locations/{location}/authorizations/{authorization}

AgentToolSettings

Einstellungen für das Tool, das den KI-Agenten für das Agentspace-Planer-LLM darstellt.

JSON-Darstellung 
{
  "toolDescription": string,
  "inputParameterName": string,
  "inputParameterDescription": string
}
Felder
toolDescription

string

Erforderlich. Dies kann von einem LLM verwendet werden, um zu beschreiben, wann der KI-Agent verwendet werden sollte.
inputParameterName

string

Optional. Parametername für den Funktionsaufruf. Dieser Parametername gibt dem LLM einen Hinweis darauf, welche Art von Inhalt der Parameter voraussichtlich enthalten wird, z. B. eine „Frage“, einen „Befehl“, eine „searchQuery“ usw.
inputParameterDescription

string

Optional. Parameterbeschreibung für den Funktionsaufruf. Diese Beschreibung gibt dem LLM weitere Informationen zum Parameter, z. B. welche Art von Inhalt voraussichtlich übergeben wird und welche Aktionen dafür ausgeführt werden sollen.

ProvisionedReasoningEngine

Erfasst die Reasoning Engine, mit der der KI-Agent verbunden ist. Diese Nachricht ist nicht dazu gedacht, den Lebenszyklus des KI-Agenten zu verfolgen. Stattdessen wird sie nur verwendet, um Parameter für die Verbindung mit dem KI-Agenten zu definieren, der bereits in einer Reasoning Engine bereitgestellt wurde.

JSON-Darstellung 
{
  "reasoningEngine": string
}
Felder
reasoningEngine

string

Erforderlich. Die Reasoning Engine, mit der der KI-Agent verbunden ist. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

ManagedAgentDefinition

Speichert die Definition eines von Google verwalteten KI-Agenten.

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

object (AgentToolSettings)

Optional. Die Parameter, die definieren, wie der KI-Agent dem Planer-LLM präsentiert wird.
authorizations[]
(deprecated)

string

Optional. NICHT MEHR UNTERSTÜTZT: Verwenden Sie stattdessen Agent.authorizations. Ressourcennamen der erforderlichen Autorisierungen. Wenn der Nutzer nicht autorisiert ist, gibt der Dienst einige Autorisierungs-URIs zurück, die der Nutzer in einem Browser öffnen und autorisieren muss. Sobald alle Autorisierungen erteilt wurden, kann der Nutzer die Abfrage noch einmal versuchen. Die Autorisierungen werden dann an den Agent weitergeleitet.

Format: projects/{project}/locations/{location}/authorizations/{authorization}
deploymentInfo

object (DeploymentInfo)

Nur Ausgabe. Informationen zur automatischen Bereitstellung für den KI-Agenten.
Union-Feld agent_config. KI-Agentenspezifische Konfiguration. Für agent_config ist nur einer der folgenden Werte zulässig:
dataScienceAgentConfig

object (DataScienceAgentConfig)

Optional. Konfiguration speziell für vorgefertigte Data Science Agents von Google. Diese Datenstruktur ist für die Speicherung der Konfiguration für die Bereitstellung und Anfragezeit des KI-Agenten vorgesehen.

DataScienceAgentConfig

Konfiguration speziell für vorgefertigte Data Science Agents von Google. Diese Datenstruktur ist für die Speicherung der Konfiguration für die Bereitstellung und Anfragezeit des KI-Agenten vorgesehen.

JSON-Darstellung 
{
  "bqProjectId": string,
  "bqDatasetId": string,
  "blocklistTables": [
    string
  ],
  "allowlistTables": [
    string
  ],
  "nlQueryConfig": {
    object (NlQueryConfig)
  }
}
Felder
bqProjectId

string

Erforderlich. Die BigQuery-Projekt-ID, in der sich das Dataset befindet.
bqDatasetId

string

Erforderlich. Die ID des BigQuery-Datasets, das für den KI-Agenten verwendet werden soll. Das Dataset muss sich im Projekt befinden, das durch bqProjectId angegeben wird.
blocklistTables[]

string

Optional. Die BigQuery-Tabellen, deren Verwendung durch den KI-Agenten blockiert werden soll.
allowlistTables[]

string

Optional. Die BigQuery-Tabellen, die vom KI-Agenten verwendet werden dürfen.
nlQueryConfig

object (NlQueryConfig)

Optional. Vom Kunden bereitgestellte Konfiguration.

NlQueryConfig

Definiert die vom Kunden bereitgestellten Konfigurationen, die für die Übersetzung von natürlicher Sprache in SQL-/Python-Code spezifisch sind.

JSON-Darstellung 
{
  "nl2sqlPrompt": string,
  "nl2pyPrompt": string,
  "nl2sqlExamples": [
    {
      object (Nl2SqlExample)
    }
  ],
  "schemaDescription": string,
  "bqSqlGenUseCustomPrompt": boolean
}
Felder
nl2sqlPrompt

string

Optional. Die vom Kunden bereitgestellten NL2SQL-Anweisungen.
nl2pyPrompt

string

Optional. Die vom Kunde bereitgestellten Anweisungen für das LLM, um Python-Code für die Datenanalyse zu schreiben.
nl2sqlExamples[]

object (Nl2SqlExample)

Optional. Die vom Kunden bereitgestellten NL2SQL-Beispiele, einschließlich der Eingabe und erwarteten SQL.
schemaDescription

string

Optional. Die Beschreibung des BigQuery-Dataset-Schemas in natürlicher Sprache.
bqSqlGenUseCustomPrompt

boolean

Optional. Gibt an, ob der benutzerdefinierte Prompt für den BigQuery SQL Gen-Dienst verwendet werden soll.

Nl2SqlExample

Ein einzelnes NL2SQL-Beispiel.

JSON-Darstellung 
{
  "query": string,
  "expectedSql": string,
  "expectedResponse": string
}
Felder
query

string

Optional. Die Abfrage in natürlicher Sprache, die beantwortet werden soll.
expectedSql

string

Optional. Die erwartete SQL-Ausgabe.
expectedResponse

string

Optional. Die erwartete Antwort auf die Anfrage.

DeploymentInfo

Informationen zur automatischen Bereitstellung für den KI-Agenten.

JSON-Darstellung 
{
  "operation": string,
  "finishTime": string
}
Felder
operation

string

Nur Ausgabe. Ressource für den Vorgang mit langer Ausführungszeit für die Bereitstellung. Kann zur Abfrage des Bereitstellungsstatus verwendet werden. Wenn die Bereitstellung abgeschlossen ist, ist dieses Feld leer. Wenn die Bereitstellung fehlschlägt, enthält das Feld den Ressourcennamen des fehlgeschlagenen LRO. Die Vorgangsressource selbst wird jedoch nach einiger Zeit automatisch gelöscht.
finishTime

string (Timestamp format)

Nur Ausgabe. Endzeitpunkt der Bereitstellung – wird nur festgelegt, wenn die Bereitstellung abgeschlossen oder fehlgeschlagen ist.

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

A2AAgentDefinition

Gespeicherte Definition eines KI-Agenten, der A2A verwendet.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld agent_card. Speichert den Namen, die Funktionen, die Autorisierungsinformationen usw. des KI-Agenten. agent_card kann nur einer der folgenden Werte sein:
jsonAgentCard

string

Optional. Die KI-Agentenkarte ist ein JSON-String.
remoteAgentCard

object (RemoteAgentcard)

Optional. Eine Remote-KI-Agentenkarte.

RemoteAgentcard

Definition einer KI-Agentenkarte, die remote gehostet wird.

JSON-Darstellung 
{
  "uri": string
}
Felder
uri

string

Erforderlich. Der URI der KI-Agentenkarte.

DialogflowAgentDefinition

Gespeicherte Definition eines KI-Agenten, der einen Dialogflow-KI-Agenten verwendet.

JSON-Darstellung 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "dialogflowAgent": string
}
Felder
toolSettings

object (AgentToolSettings)

Optional. Die Parameter, die definieren, wie der KI-Agent dem Planer-LLM präsentiert wird.
dialogflowAgent

string

Erforderlich. Ressourcenname des zugrunde liegenden Dialogflow-KI-Agenten. Format: projects/{project}/locations/{location}/agents/{agent}

Bild

Stellt ein Bild dar.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld storage_method. Kann entweder ein URI oder der als Base64-String codierte Inhalt sein. Für storage_method ist nur einer der folgenden Werte zulässig:
uri

string

Bild-URI.
content

string

Base64-codierter Inhalt der Bilddatei.

AuthorizationConfig

Beschreibt die erforderlichen Autorisierungen.

JSON-Darstellung 
{
  "toolAuthorizations": [
    string
  ],
  "agentAuthorization": string
}
Felder
toolAuthorizations[]

string

Optional. Liste der erforderlichen Autorisierungen für den Zugriff des KI-Agenten auf andere Ressourcen. Die Autorisierungstokens werden als Teil des Anfragetexts an den KI-Agenten übergeben.
agentAuthorization

string

Optional. Die Autorisierung, die zum Aufrufen des KI-Agenten erforderlich ist. Authentifizierungstokens werden als Teil des Autorisierungsheaders der Anfrage an den KI-Agenten übergeben.

DataStoreSpecs

Stellt eine Reihe von Datenspeicherspezifikationen dar.

JSON-Darstellung 
{
  "specs": [
    {
      object (DataStoreSpec)
    }
  ]
}
Felder
specs[]

object (DataStoreSpec)

Optional. Spezifikationen, die DataStores zum Filtern in einem Suchaufruf und Konfigurationen für diese Datenspeicher definieren. Dies wird nur für Engines mit mehreren Datenspeichern berücksichtigt.

Status

Mögliche Werte für den Lebenszyklusstatus des KI-Agenten.

Enums
STATE_UNSPECIFIED Kein Status angegeben.
CONFIGURED Der KI-Agent ist konfiguriert, aber es wurde noch keine Bereitstellung ausgelöst.
DEPLOYING Der KI-Agent wird bereitgestellt.
DISABLED Der KI-Agent ist nur für Administratoren verfügbar.
DEPLOYMENT_FAILED Die Bereitstellung des KI-Agenten ist fehlgeschlagen.
PRIVATE Der KI-Agent ist nur für den Ersteller verfügbar.
ENABLED Der KI-Agent ist für Nutzer mit Zugriff verfügbar.
SUSPENDED Der KI-Agent ist vorübergehend nicht verfügbar, aber für Nutzer mit Zugriff sichtbar.

StarterPrompt

Der Vorschlag für den Starter-Prompt, der dem Nutzer auf der Landingpage des KI-Agenten angezeigt wird.

JSON-Darstellung 
{
  "text": string
}
Felder
text

string

Erforderlich. Der Text des Starter-Prompts.

SharingConfig

Konfiguration für die Freigabe.

JSON-Darstellung 
{
  "scope": enum (Scope)
}
Felder
scope

enum (Scope)

Optional. Der Freigabebereich des KI-Agenten.

Umfang

Der Freigabebereich des KI-Agenten.

Enums
SCOPE_UNSPECIFIED Standardwert. Verhält sich wie RESTRICTED.
RESTRICTED Der KI-Agent wird basierend auf der IAM-Richtlinie freigegeben.
ALL_USERS Der KI-Agent wird für alle Nutzer freigegeben.

Methoden

create

 Erstellt einen Agent

delete

 Löscht einen Agent.

deploy

 Stellt einen Agent bereit.

disableAgent

 Deaktiviert einen KI-Agenten.

enableAgent

 Aktiviert einen KI-Agenten.

get

 Ruft einen Agent ab.

getAgentView

 Gibt einen AgentView für einen bestimmten Agent zurück, der zusätzliche Informationen zum KI-Agenten enthält.

getIamPolicy

 Ruft die Zugriffssteuerungsrichtlinie für eine KI-Agenten-Ressource ab.

list

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

patch

 Aktualisiert einen Agent.

rejectAgent

 Lehnt einen öffentlich angebotenen KI-Agenten ab.

requestAgentReview

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

setIamPolicy

 Legt die Zugriffssteuerungsrichtlinie für eine KI-Agenten-Ressource fest.

suspendAgent

 Sperrt einen KI-Agenten.

withdrawAgent

 Zieht einen öffentlich angebotenen KI-Agenten zurück.