- HTTP-Anfrage
- Pfadparameter
- Anfragetext
- Antworttext
- Autorisierungsbereiche
- IAM-Berechtigungen
- AnswerGenerationMode
- AssistSkippingMode
- BrowserContext
- Tab
- EncryptionMetadata
- AgentsConfig
- NoCodeAgentsConfig
- AgentsSpec
- AgentSpec
- MentionMode
- ToolsSpec
- VertexAiSearchSpec
- WebGroundingSpec
- ImageGenerationSpec
- VideoGenerationSpec
- MapsGroundingSpec
- GenerationSpec
- ActionSpec
- SessionInfo
- StatusUpdate
- ToolResult
- InvokedSkill
- ConnectorAuthError
Unterstützt den Nutzer bei einer Anfrage via Streaming.
HTTP-Anfrage
:
POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:streamAssist Für die URLs wird die Syntax der gRPC-Transcodierung verwendet.
Pfadparameter
| Parameter | |
|---|---|
name |
Erforderlich. Der Ressourcenname des |
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
| JSON-Darstellung |
|---|
{ "query": { object ( |
| Felder | |
|---|---|
query |
Optional. Aktuelle Nutzeranfrage. Leere Abfragen werden nur unterstützt, wenn |
answerGenerationMode |
Optional. Der Modus für die Antwortgenerierung. Wenn nichts angegeben ist, wird standardmäßig |
session |
Optional. Die für die Anfrage zu verwendende Sitzung. Falls angegeben, hat der Assistent Zugriff auf den Sitzungsverlauf und die Anfrage und die Antwort werden dort gespeichert. Wenn Format: |
isSessionLess |
Optional. Gibt an, ob die Anfrage sitzungslos ist. Wenn „true“, wird die Anfrage ohne Sitzung ausgeführt: Es wird keine Sitzung erstellt und die Anfrage wird keiner vorhandenen Sitzung zugeordnet, auch wenn Wenn „true“ und |
assistSkippingMode |
Optional. Legt fest, in welchen Fällen der Assistent die Anfrage nicht beantwortet. Wenn die Antwort übersprungen wird, werden die Gründe in |
fileIds[] |
Optional. Die IDs der Dateien, die zum Beantworten der Anfrage verwendet werden sollen. Beim Hochladen einer Datei wird ihre ID in |
browserContext |
Optional. Kontext zur Seite, die der Nutzer gerade aufruft, z.B. aus der Gemini Enterprise-Seitenleiste in Chrome. |
userMetadata |
Optional. Informationen zum Nutzer, der die Anfrage initiiert. |
languageCode |
Optional. Verworfen. Verwenden Sie stattdessen |
googleSearchGroundingEnabled |
Optional. Verworfen. Bitte verwenden Sie dieses Feld nicht. |
webGroundingEnabled |
Optional. Verworfen. Bitte verwenden Sie dieses Feld nicht. |
dataStoreSpecs[] |
Optional. Nicht mehr unterstützt: Verwenden Sie stattdessen Wenn dieses Feld nicht festgelegt wird, werden alle Datenspeicher in der Engine verwendet, es sei denn, |
agentsConfig |
Optional. Konfiguration der Agenten, die zur Verarbeitung der Anfrage verwendet werden. |
agentsSpec |
Optional. Spezifikation der Agenten, die zur Verarbeitung der Anfrage verwendet werden. |
assistGenerationConfig |
Optional. Verworfen. Verwenden Sie stattdessen |
cannedQuery |
Optional. Der Ressourcenname der Eine Sitzung gilt als neu, wenn eine Wenn der Parameter Format: |
toolsSpec |
Optional. Spezifikation der Tools, die zur Verarbeitung der Anfrage verwendet werden. |
generationSpec |
Optional. Spezifikation der Generierungskonfiguration für die Anfrage. |
actionSpec |
Optional. Spezifikation der Aktionen für die Anfrage. |
Antworttext
Antwort für die Methode AssistantService.StreamAssist.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
| JSON-Darstellung |
|---|
{ "answer": { object ( |
| Felder | |
|---|---|
answer |
Das Antwortressourcen-Objekt „assistants.assist answer resource“ enthält Teile der endgültigen Antwort des Assistenten auf die Anfrage des Nutzers. Nicht vorhanden, wenn die aktuelle Antwort nichts zu den zuvor gesendeten Beobachten Sie den Wenn der Status |
sessionInfo |
Informationen zur Sitzung. Nur in der endgültigen StreamAssistResponse des Antwortstreams enthalten. |
statusUpdates[] |
Optionale Fortschrittsaktualisierungen |
assistToken |
Eine global eindeutige ID, die das aktuelle Paar aus Anfrage und Antwortstream identifiziert. Wird für Feedback und Support verwendet. |
toolResult[] |
Ergebnisse von Tool-Aufrufen. |
finalResultToolInvocationId |
Wenn dieses Feld vorhanden ist, enthält es die ID des Tool-Aufrufs, dessen Ergebnis als endgültige Antwort verwendet wird. |
invocationTools[] |
Die Tool-Namen der aufgerufenen Tools. |
invokedSkills[] |
Die in der Runde ausgeführten Skills. |
connectorAuthErrors[] |
Authentifizierungsfehler pro Connector, die während der Anfrage aufgetreten sind. Wird angezeigt, wenn die Authentifizierung für mindestens einen Connector fehlgeschlagen ist, die Anfrage aber mit den verbleibenden Connectors fortgesetzt wurde. |
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/discoveryengine.assist.readwritehttps://www.googleapis.com/auth/discoveryengine.readwritehttps://www.googleapis.com/auth/discoveryengine.serving.readwrite
Weitere Informationen finden Sie unter Authentication Overview.
IAM-Berechtigungen
Erfordert die folgende IAM-Berechtigung für die Ressource name:
discoveryengine.assistants.assist
Weitere Informationen finden Sie in der IAM-Dokumentation.
AnswerGenerationMode
Verfügbare Modi zur Antwortgenerierung.
| Enums | |
|---|---|
ANSWER_GENERATION_MODE_UNSPECIFIED |
Nicht angegebener Modus für die Antwortgenerierung. |
NORMAL |
Normaler Modus für die Antwortgenerierung. Es kann sein, dass einige Suchanfragen und Aufrufaktionen ausgelöst werden. |
RESEARCH |
Recherchemodus für die Antwortgenerierung. Detaillierte Informationen zur Anfrage, die viele Suchanfragen zu einer Vielzahl von Themen im Zusammenhang mit der Suchanfrage auslösen. |
AGENT |
Direkter Agent-Modus für die Antwortgenerierung. Verwendet einen in agentsConfig definierten Agent, um die Antwort zu generieren. |
AssistSkippingMode
Verfügbare Überspringverhalten für Assist-Anfragen.
| Enums | |
|---|---|
ASSIST_SKIPPING_MODE_UNSPECIFIED |
Standardwert. Die Antwort kann übersprungen werden, wenn in der Anfrage keine Unterstützung gesucht wird. |
REQUEST_ASSIST |
Assistent-Antwort anfragen. Die Antwort kann weiterhin übersprungen werden, wenn die Anfrage gegen Richtlinien verstößt. |
BrowserContext
Kontext zur Seite, die der Nutzer gerade aufruft, z.B. aus der Gemini Enterprise-Seitenleiste in Chrome. Die Dateien, auf die verwiesen wird, werden vom Client verschlüsselt und nicht als Modelleingaben an die Anfrage angehängt. Ein Nutzer liest sie mit encryptionMetadata.
| JSON-Darstellung |
|---|
{ "activeTab": { object ( |
| Felder | |
|---|---|
activeTab |
Optional. Der Tab, den der Nutzer gerade aufruft. Jede Datei-ID bezieht sich auf eine Datei, die zuvor in der Sitzung hochgeladen wurde (ihre ID wird in |
encryptionMetadata |
Optional. Wie die Dateien, auf die in diesem Browserkontext verwiesen wird, verschlüsselt sind. Ein Keyset deckt die gesamte Anfrage ab und nicht nur einen einzelnen Tab. |
Tabulatortaste
Ein Browser-Tab, dessen Kontext an die Anfrage angehängt ist.
| JSON-Darstellung |
|---|
{ "uri": string, "title": string, "selectedText": string, "screenshotFileId": string, "annotatedPageContentFileId": string } |
| Felder | |
|---|---|
uri |
Optional. URI der Seite, die auf dem Tab angezeigt wird. Es muss nicht unbedingt eine http(s)-URL sein: Auf einem Tab kann |
title |
Optional. Titel der Seite, die auf dem Tab angezeigt wird. |
selectedText |
Optional. Text, den der Nutzer auf der Seite ausgewählt hat (falls zutreffend). |
screenshotFileId |
Optional. ID des hochgeladenen Screenshots der sichtbaren Seite. |
annotatedPageContentFileId |
Optional. ID des hochgeladenen Seiteninhalts: eine serialisierte Erfassung von „Annotated Page Content“ (APC), kein vorab gerenderter Text. |
EncryptionMetadata
Wie die Dateien im Browserkontext vom Client verschlüsselt wurden.
| JSON-Darstellung |
|---|
{ "encrypted": boolean, "keyset": string } |
| Felder | |
|---|---|
encrypted |
Optional. Ob die Dateien im Browserkontext verschlüsselt sind. Wenn |
keyset |
Optional. Serialisiertes Tink-Keyset mit dem AEAD-Primitive, das zum Entschlüsseln der Browserkontextdateien verwendet wird. Nur für die Dauer der Anfrage vorhanden und werden nie protokolliert. Ein base64-codierter String. |
AgentsConfig
Konfiguration der Agenten, die zur Verarbeitung der Anfrage verwendet werden.
| JSON-Darstellung |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "noCodeAgentsConfig": { object ( |
| Felder | |
|---|---|
| Konfiguration der verschiedenen Arten von Agenten. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt: | |
noCodeAgentsConfig |
Optional. Verworfen: Konfiguration für No‑Code-Agentspace-Agents. Wenn diese Option festgelegt ist, wird die Anfrage „assistants.assist“ entsprechend der Konfiguration verarbeitet. Verwenden Sie stattdessen |
assistantAgentConfigId |
Optional. ID des Agenten aus |
agent |
Der Name des zu verwendenden Agenten. Format: |
inlineAgent |
Die Inline-Definition des zu verwendenden |
vertexAiAgentId |
Optional. Die ID des Agenten aus |
| Ende der sich gegenseitig ausschließenden Felder. | |
NoCodeAgentsConfig
Verworfen: Konfiguration für No‑Code-Agentspace-Agents. Verwenden Sie stattdessen agent.
| JSON-Darstellung |
|---|
{ "agent": string } |
| Felder | |
|---|---|
agent |
Optional. Der Name des zu verwendenden Agenten. |
AgentsSpec
Spezifikation der Agenten, die zur Verarbeitung der Anfrage verwendet werden.
| JSON-Darstellung |
|---|
{ "agentSpecs": [ { object ( |
| Felder | |
|---|---|
agentSpecs[] |
Optional. Spezifikation der Agenten, die zur Verarbeitung der Anfrage verwendet werden. |
mentionMode |
Optional. So rufen Sie die erwähnten KI-Agenten in |
AgentSpec
Spezifikation eines KI-Agenten
| JSON-Darstellung |
|---|
{ "agentId": string, "inputVariables": { object } } |
| Felder | |
|---|---|
agentId |
Erforderlich. ID zur Identifizierung der Agent-Ressource, die die Anfrage verarbeitet. Dieses Feld muss RFC-1034 entsprechen und darf maximal 63 Zeichen lang sein. |
inputVariables |
Optional. Eingabevariablen, die zum Zeitpunkt des Aufrufs für einen WorkflowAgent bereitgestellt werden. Die Schlüssel sind die deklarierten Namen der Eingabevariablen. Die Werte sind die vom Nutzer oder Aufrufer angegebenen Werte. Für nachgelagerte Knoten als globale Eingaben verfügbar. |
MentionMode
So rufen Sie die erwähnten KI-Agenten in agentSpecs auf.
| Enums | |
|---|---|
MENTION_MODE_UNSPECIFIED |
Die Standardeinstellung ist DIRECT. |
DIRECT |
Der erwähnte KI-Agent wird zum KI-Agenten auf oberster Ebene, der den Turn ausführt. Nur ein Eintrag in agentSpecs ist zulässig. |
TOOL |
Jeder AgentSpec ist als Tool unter einem synthetisierten Orchestrator angehängt. Mehrfachnennung. MVP: Nur Workflow-Agents, letzte veröffentlichte Überarbeitung; version / revisionId nicht festlegen. |
TOOL_WORKFLOW_DIRECT |
Einzelner Workflow-Agent als eigene Chatoberfläche. Genau eine AgentSpec; entweder version = "draft" (Agent-Tabelle) oder revisionId (bestimmte AgentRevision) festlegen. Der Workflow muss eine ManualTrigger haben. |
ToolsSpec
Spezifikation der Tools, die zur Verarbeitung der Anfrage verwendet werden.
| JSON-Darstellung |
|---|
{ "toolRegistry": string, "vertexAiSearchSpec": { object ( |
| Felder | |
|---|---|
toolRegistry |
Optional. Der Name der zu verwendenden Tool-Registry. Format: |
vertexAiSearchSpec |
Optional. Spezifikation des Vertex AI Search-Tools. |
webGroundingSpec |
Optional. Spezifikation des Tools zur Webfundierung. Wenn das Feld vorhanden ist, wird die Fundierung mit der Websuche aktiviert. Funktioniert nur, wenn |
imageGenerationSpec |
Optional. Spezifikation des Tools zur Bildgenerierung. |
videoGenerationSpec |
Optional. Spezifikation des Tools zur Videogenerierung. |
mapsGroundingSpec |
Optional. Spezifikation des Google Maps-Tools zur Fundierung. Wenn das Feld vorhanden ist, wird die Fundierung mit Google Maps aktiviert. |
VertexAiSearchSpec
Spezifikation des Vertex AI Search-Tools.
| JSON-Darstellung |
|---|
{
"disabled": boolean,
"dataStoreSpecs": [
{
object ( |
| Felder | |
|---|---|
disabled |
Optional. Verworfen. Bitte verwenden Sie dieses Feld nicht. Gibt an, ob das Vertex AI Search-Tool deaktiviert ist. Der Standardwert ist „false“. Das Tool ist standardmäßig aktiviert. |
dataStoreSpecs[] |
Optional. Spezifikationen, die |
filter |
Optional. Die Filtersyntax besteht aus einer Ausdruckssprache, mit der ein Prädikat aus einem oder mehreren Feldern der gefilterten Dokumente erstellt wird. Bei Filterausdrücken muss die Groß- und Kleinschreibung beachtet werden. Wenn dieses Feld nicht erkannt wird, wird In Vertex AI Search erfolgt die Filterung durch das Zuordnen des LHS-Filterschlüssels zu einem Schlüsselattribut, das im Vertex AI Search-Backend definiert ist. Diese Zuordnung wird vom Kunden in seinem Schema definiert. Ein Medienkunde hat in seinem Schema möglicherweise das Feld „name“. In diesem Fall würde der Filter so aussehen: filter --> name:'ANY("king kong")' Weitere Informationen zum Filtern, einschließlich Syntax und Filteroperatoren, finden Sie unter Filter. |
WebGroundingSpec
Dieser Typ hat keine Felder.
Spezifikation des Tools zur Webfundierung.
ImageGenerationSpec
Dieser Typ hat keine Felder.
Spezifikation des Tools zur Bildgenerierung.
VideoGenerationSpec
Dieser Typ hat keine Felder.
Spezifikation des Tools zur Videogenerierung.
MapsGroundingSpec
Dieser Typ hat keine Felder.
Spezifikation des Google Maps-Tools zur Fundierung.
GenerationSpec
Spezifikation für die Assistent-Generierung für die Anfrage. Damit kann die Standardkonfiguration für die Generierung auf Engine-Ebene überschrieben werden.
| JSON-Darstellung |
|---|
{ "modelId": string } |
| Felder | |
|---|---|
modelId |
Optional. Die „modelId“ von Vertex AI, die für das generative Modell verwendet wird. Wenn nicht festgelegt, wird das Assistent-Standardmodell verwendet. |
ActionSpec
Spezifikation der Aktionen für die Anfrage.
| JSON-Darstellung |
|---|
{ "actionDisabled": boolean } |
| Felder | |
|---|---|
actionDisabled |
Optional. Bei „true“ werden für die Anfrage keine Aktionen ausgeliefert. Das funktioniert nur in der Enterprise-Version. |
SessionInfo
Informationen zur Sitzung
| JSON-Darstellung |
|---|
{ "session": string, "queryId": string } |
| Felder | |
|---|---|
session |
Name der neu generierten oder fortgesetzten Sitzung Format: |
queryId |
Die Abfrage-ID, die diesem Assist API-Aufruf entspricht. Eine Sitzung kann aus mehreren Runden mit jeweils einer eindeutigen Abfrage-ID bestehen. Wenn Sie den Sitzungsnamen und diese Abfrage-ID im API-Aufruf „assistants.assist“ angeben, erfolgt die Assist-Anfrage im Kontext der Suchergebnisse dieses Suchaufrufs. |
StatusUpdate
Update zum Fortschritt des Assist-Aufrufs
| JSON-Darstellung |
|---|
{ "updateText": string, "invocationId": string } |
| Felder | |
|---|---|
updateText |
Statusaktualisierung als freier Text, z.B. „Starte interne Suche in HR-Dokumenten nach Mitarbeiter-Vorteilen“ oder „Die Websuche nach ‚Mondlandung‘ hat 12 Ergebnisse geliefert“. |
invocationId |
Eindeutige Kennung des Aufrufs, der das Update generiert |
ToolResult
(Teil-)Ergebnis eines Tool-Aufrufs
| JSON-Darstellung |
|---|
{
"toolInvocationId": string,
"result": {
object ( |
| Felder | |
|---|---|
toolInvocationId |
Eindeutige Kennung des Tool-Aufrufs, der das Ergebnis generiert |
result |
Teilinhalt des Ergebnisses |
InvokedSkill
Stellt einen Skill dar, der während des Supportanrufs verwendet wird.
| JSON-Darstellung |
|---|
{ "name": string, "displayName": string } |
| Felder | |
|---|---|
name |
Der Ressourcenname des Skills. |
displayName |
Der Anzeigename des Skills. |
ConnectorAuthError
Beschreibt einen Authentifizierungsfehler für einen bestimmten Daten-Connector.
| JSON-Darstellung |
|---|
{ "dataConnector": string, "errorMessage": string } |
| Felder | |
|---|---|
dataConnector |
Der Ressourcenname des Daten-Connectors, bei dem die Authentifizierung fehlgeschlagen ist. |
errorMessage |
Eine menschenlesbare Fehlermeldung, die den Authentifizierungsfehler beschreibt. |