- HTTP-Anfrage
- Pfadparameter
- Anfragetext
- Antworttext
- Autorisierungsbereiche
- IAM-Berechtigungen
- AgentsSpec
- AgentSpec
- MentionMode
- ToolsSpec
- VertexAiSearchSpec
- WebGroundingSpec
- ImageGenerationSpec
- VideoGenerationSpec
- GenerationSpec
- SessionInfo
- InvokedSkill
- ConnectorAuthError
Unterstützt den Nutzer bei einer Anfrage via Streaming.
HTTP-Anfrage
:
POST https://discoveryengine.googleapis.com/v1beta/{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 |
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: |
userMetadata |
Optional. Informationen zum Nutzer, der die Anfrage initiiert. |
agentsSpec |
Optional. Spezifikation der Agenten, die zur Verarbeitung der Anfrage verwendet werden. |
toolsSpec |
Optional. Spezifikation der Tools, die zur Verarbeitung der Anfrage verwendet werden. |
generationSpec |
Optional. Spezifikation der Generierungskonfiguration 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. |
assistToken |
Eine global eindeutige ID, die das aktuelle Paar aus Anfrage und Antwortstream identifiziert. Wird für Feedback und Support verwendet. |
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.
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 |
|---|
{ "vertexAiSearchSpec": { object ( |
| Felder | |
|---|---|
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. |
VertexAiSearchSpec
Spezifikation des Vertex AI Search-Tools.
| JSON-Darstellung |
|---|
{
"dataStoreSpecs": [
{
object ( |
| Felder | |
|---|---|
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.
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. |
SessionInfo
Informationen zur Sitzung
| JSON-Darstellung |
|---|
{ "session": string } |
| Felder | |
|---|---|
session |
Name der neu generierten oder fortgesetzten Sitzung Format: |
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. |