Method: projects.locations.collections.dataStores.branches.documents.patch

Aktualisiert ein Document

HTTP-Anfrage

PATCH https://discoveryengine.googleapis.com/v1/{document.name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
document.name

string

Nicht veränderbar. Der vollständige Ressourcenname des Dokuments. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.

Anfrageparameter

Parameter
allowMissing

boolean

Wenn der Wert auf true gesetzt ist und das Document nicht gefunden wird, wird ein neues Document erstellt.
updateMask

string (FieldMask format)

Gibt an, welche Felder im angegebenen importierten „Document“ aktualisiert werden sollen. Wenn nicht festgelegt, werden standardmäßig alle Felder aktualisiert.

Dies ist eine durch Kommas getrennte Liste mit voll qualifizierten Feldnamen. Beispiel: "user.displayName,photo".

Anfragetext

Der Anfragetext enthält eine Instanz von Document.

Antworttext

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

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource name:

  • discoveryengine.documents.update

Weitere Informationen finden Sie in der IAM-Dokumentation.