Method: corpora.documents.patch

Aktualizuje: Document.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
document.name

string

Niezmienne. Identyfikator. Nazwa zasobu Document. Identyfikator (nazwa bez prefiksu „corpora/*/documents/”) może zawierać do 40 znaków, które są małymi znakami alfanumerycznymi lub myślnikami (-). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa będzie pusta, zostanie pobrana unikalna nazwa z elementu displayName wraz z losowym 12-znakowym sufiksem. Przykład: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

Parametry zapytania

Parametry
updateMask

string (FieldMask format)

To pole jest wymagane. Lista pól do zaktualizowania. Obecnie jest to możliwe tylko w przypadku aktualizacji displayName i customMetadata.

Jest to lista rozdzielonych przecinkami pełnych i jednoznacznych nazw pól. Przykład: "user.displayName,photo".

Treść żądania

Treść żądania zawiera wystąpienie elementu Document.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Document.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.