Method: corpora.documents.patch

Document öğesini günceller.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
document.name

string

Sabit. Tanımlayıcı. Document kaynağının adı. Kimlik ("corpora/*/documents/" öneki hariç), küçük harfli alfanümerik karakterler veya tireler (-) içeren en fazla 40 karakter içerebilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma işleminde ad boş olursa displayName karakterinden 12 karakterlik rastgele bir son ek ile birlikte benzersiz bir ad türetilir. Örnek: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

Sorgu parametreleri

Parametreler
updateMask

string (FieldMask format)

Zorunlu. Güncellenecek alanların listesi. Şu anda, bu özellik yalnızca displayName ve customMetadata güncellenmesini desteklemektedir.

Bu, tam nitelikli alan adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo".

İstek içeriği

İstek metni, Document öğesinin bir örneğini içerir.

Yanıt gövdesi

Başarılıysa yanıt metni, Document öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış bölümüne bakın.