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

AdkAgentDefinition

Speichert die Definition eines Agents, der das ADK verwendet und in 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 Agent dem Planner-LLM präsentiert wird.
provisionedReasoningEngine

object (ProvisionedReasoningEngine)

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

string

Optional. VERWORFEN: Verwenden Sie stattdessen Agent.authorizations. Ressourcennamen der erforderlichen Autorisierungen. Wenn der Nutzer nicht autorisiert ist, gibt der Dienst eine Reihe von Autorisierungs-URIs zurück, die der Nutzer in einem Browser öffnen und autorisieren muss. Sobald alle Autorisierungen erteilt wurden, kann der Nutzer die Anfrage 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 Agenten für das LLM des Agentspace-Planers 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 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 „Suchanfrage“ 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

Hier wird die Reasoning Engine erfasst, mit der der KI-Agent verbunden ist. Diese Nachricht ist nicht dazu gedacht, den Lebenszyklus des Agents zu verfolgen. Stattdessen wird er nur verwendet, um Parameter für die Verbindung mit dem 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 Agent dem Planner-LLM präsentiert wird.
authorizations[]
(deprecated)

string

Optional. VERWORFEN: Verwenden Sie stattdessen Agent.authorizations. Ressourcennamen der erforderlichen Autorisierungen. Wenn der Nutzer nicht autorisiert ist, gibt der Dienst eine Reihe von Autorisierungs-URIs zurück, die der Nutzer in einem Browser öffnen und autorisieren muss. Sobald alle Autorisierungen erteilt wurden, kann der Nutzer die Anfrage 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 Agent.
Union-Feld agent_config. Agentspezifische 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 Agents 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 Agents 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 Agent 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 Agenten blockiert werden soll.
allowlistTables[]

string

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

object (NlQueryConfig)

Optional. Vom Kunden bereitgestellte Konfiguration.

NlQueryConfig

Definieren Sie die vom Kunden bereitgestellten Konfigurationen für die Übersetzung von natürlicher Sprache in SQL-/Python-Code.

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

string

Optional. Vom Kunden bereitgestellte NL2SQL-Anweisungen
nl2pyPrompt

string

Optional. Der Kunde hat Anweisungen für das LLM bereitgestellt, um Python-Code für die Datenanalyse zu schreiben.
nl2sqlExamples[]

object (Nl2SqlExample)

Optional. Der Kunde hat NL2SQL-Beispiele bereitgestellt, einschließlich Eingabe und erwartetem 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 Agent.

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

string

Nur Ausgabe. Ressource für den lang andauernden Vorgang für die Bereitstellung. Kann verwendet werden, um den Deployment-Status abzufragen. Wenn die Bereitstellung abgeschlossen ist, ist dieses Feld leer. Wenn das Deployment 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. Ende des Deployments – wird nur festgelegt, wenn das Deployment 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 Agents, 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 Agents. 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-Agent-Karte.

RemoteAgentcard

Definition einer Agent-Karte, die remote gehostet wird.

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

string

Erforderlich. Der URI der Agentenkarte.

DialogflowAgentDefinition

Gespeicherte Definition eines Agents, der einen Dialogflow-Agent verwendet.

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

object (AgentToolSettings)

Optional. Die Parameter, die definieren, wie der Agent dem Planner-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

Image-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 Agents auf andere Ressourcen. Die Autorisierungstokens werden als Teil des Anfragetexts an den Agent übergeben.
agentAuthorization

string

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

DataStoreSpecs

Stellt eine Reihe von Datenspeicherspezifikationen dar.

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

object (DataStoreSpec)

Optional. Spezifikationen, die DataStores definieren, nach denen in einem Suchaufruf gefiltert werden soll, sowie Konfigurationen für diese Datenspeicher. Dies wird nur für Engines mit mehreren Datenspeichern berücksichtigt.

Bundesland

Mögliche Werte für den Lebenszyklusstatus des Agents.

Enums
STATE_UNSPECIFIED Der Zustand ist unspezifisch.
CONFIGURED Der Agent ist konfiguriert, aber es wurde noch keine Bereitstellung ausgelöst.
DEPLOYING Der Agent wird bereitgestellt.
DISABLED Der Agent ist nur für Administratoren verfügbar.
DEPLOYMENT_FAILED Die Bereitstellung des Agents ist fehlgeschlagen.
PRIVATE Der Agent ist nur für den Ersteller verfügbar.
ENABLED Der 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 Agents angezeigt wird.

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

string

Erforderlich. Der Text des Starter-Prompts.

Methoden

create

 Erstellt ein Agent.

delete

 Löscht ein Agent.

deploy

 Stellt eine Agent bereit.

get

 Ruft ein Agent ab.

getAgentView

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

list

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

patch

 Aktualisiert eine Agent