Method: projects.locations.collections.engines.sessions.patch

Aktualisiert eine Sitzung.

Der Aktionstyp Session kann nicht geändert werden. Wenn die zu aktualisierende Session nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

HTTP-Anfrage

PATCH https://discoveryengine.googleapis.com/v1/{session.name=projects/*/locations/*/collections/*/engines/*/sessions/*}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
session.name

string

Nicht veränderbar. Vollständig qualifizierter Name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*

Abfrageparameter

Parameter
updateMask

string (FieldMask format)

Gibt an, welche Felder im bereitgestellten Session aktualisiert werden sollen. Folgendes wird NICHT unterstützt:

Wenn sie nicht festgelegt oder leer ist, werden alle unterstützten Felder aktualisiert.

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

Anfragetext

Der Anfragetext enthält eine Instanz von Session.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Session.

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.sessions.update

Weitere Informationen finden Sie in der IAM-Dokumentation.