Method: corpora.documents.patch

Aktualisiert eine Document.

HTTP-Anfrage

PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
document.name

string

Nicht veränderbar. Kennung. Der Name der Document-Ressource. Die ID (Name ohne das Präfix „corpora/*/documents/“) kann bis zu 40 Zeichen (in Kleinbuchstaben) oder Bindestriche (-) enthalten. Sie darf nicht mit einem Bindestrich beginnen oder enden. Wenn der Name beim Erstellen leer ist, wird aus displayName ein eindeutiger Name mit einem zufälligen 12-stelligen Suffix abgeleitet. Beispiel: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

Abfrageparameter

Parameter
updateMask

string (FieldMask format)

Erforderlich. Die Liste der zu aktualisierenden Felder. Derzeit können damit nur displayName und customMetadata aktualisiert werden.

Dies ist eine durch Kommas getrennte Liste voll qualifizierter 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 den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/generative-language.retriever

Weitere Informationen finden Sie in der Authentifizierungsübersicht.