Method: projects.locations.collections.engines.assistants.assist

Unterstützt den Nutzer bei einer Anfrage.

HTTP-Anfrage

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:assist

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Ressourcenname der Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "query": {
    object (Query)
  },
  "session": string,
  "assistSkippingMode": enum (AssistSkippingMode),
  "fileIds": [
    string
  ],
  "userMetadata": {
    object (AssistUserMetadata)
  },
  "languageCode": string,
  "webGroundingEnabled": boolean,
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "assistGenerationConfig": {
    object (AssistGenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean
}
Felder
query

object (Query)

Optional. Aktuelle Nutzeranfrage.

Leere Abfragen werden nur unterstützt, wenn fileIds angegeben werden. In diesem Fall wird die Antwort auf Grundlage dieser Kontextdateien generiert.
session

string

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 - als Session-ID angegeben oder das Feld leer gelassen wird, wird eine neue Session mit einer automatisch generierten ID erstellt.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
assistSkippingMode

enum (AssistSkippingMode)

Optional. Legt fest, in welchen Fällen der Assistent die Anfrage nicht beantwortet. Wenn die Antwort übersprungen wird, werden die Gründe in AssistAnswer.assist_skipped_reasons innerhalb von AssistResponse.answer aufgeführt.
fileIds[]

string

Optional. Die IDs der Dateien, die zum Beantworten der Anfrage verwendet werden sollen. Beim Hochladen einer Datei wird ihre ID in AddContextFileResponse.file_id zurückgegeben.
userMetadata

object (AssistUserMetadata)

Optional. Informationen zum Nutzer, der die Anfrage initiiert.
languageCode

string

Optional. Sprache, die für die Beantwortung verwendet werden soll, wenn die Spracherkennung fehlschlägt. Wird auch als Sprache für Fehlermeldungen verwendet, die von Aktionen erstellt werden, unabhängig von den Ergebnissen der Spracherkennung.
webGroundingEnabled

boolean

Optional. Wenn auf „true“ gesetzt, wird die Fundierung mit der Websuche aktiviert. Funktioniert nur, wenn Assistant.web_grounding_type [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] oder [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][] ist.
dataStoreSpecs[]

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.

Wenn dieses Feld nicht festgelegt wird, werden alle Datenspeicher in der Engine verwendet, es sei denn, ignoreDataStores ist auf „true“ gesetzt.
assistGenerationConfig

object (AssistGenerationConfig)

Optional. Konfiguration der Generierung auf Anfrageebene. Damit wird die Standardkonfiguration für die Generierung auf Engine-Ebene überschrieben.
googleSearchGroundingEnabled
(deprecated)

boolean

Optional. Verworfen. Verwenden Sie stattdessen webGroundingEnabled.

Antworttext

Antwort für die Methode AssistantService.Assist.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "answer": {
    object (AssistAnswer)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "assistToken": string
}
Felder
answer

object (AssistAnswer)

Die Ressource AssistAnswer, die als Antwort auf die Anfrage generiert wurde.
sessionInfo

object (SessionInfo)

Informationen zur Sitzung.
assistToken

string

Eine global eindeutige ID, die das aktuelle Anfrage-Antwort-Paar identifiziert. Wird für Feedback und Support verwendet.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.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.

AssistSkippingMode

Verfügbare Überspringensweisen 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 Assistant um Antwort bitten Die Antwort kann weiterhin übersprungen werden, wenn die Anfrage gegen Richtlinien verstößt.

SessionInfo

Informationen zur Sitzung.

JSON-Darstellung 
{
  "session": string,
  "queryId": string
}
Felder
session

string

Name der neu generierten oder fortgesetzten Sitzung.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
queryId

string

Die Abfrage-ID, die diesem Assist API-Aufruf entspricht. Eine Sitzung kann mehrere Turns mit jeweils einer eindeutigen Abfrage-ID haben.

Wenn Sie den Sitzungsnamen und diese Abfrage-ID im API-Aufruf „assistants.assist“ angeben, erfolgt die Assist-Anfrage im Kontext der Suchergebnisse dieses Suchaufrufs.