Method: corpora.documents.patch

Document से अपडेट होता है.

एचटीटीपी अनुरोध

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

यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ के पैरामीटर

पैरामीटर
document.name

string

इम्यूटेबल. आइडेंटिफ़ायर. Document संसाधन का नाम. आईडी ("corpora/*/documents/" प्रीफ़िक्स को छोड़कर) में 40 वर्ण तक हो सकते हैं, जो अंग्रेज़ी के छोटे अक्षर और डैश (-) होते हैं. आईडी के शुरू या आखिर में डैश नहीं हो सकता. अगर नाम बनाने पर कोई नाम नहीं दिया जाता है, तो displayName से एक यूनीक नाम लिया जाएगा. साथ ही, 12 वर्णों का रैंडम सफ़िक्स भी शामिल किया जाएगा. उदाहरण: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

क्वेरी पैरामीटर

पैरामीटर
updateMask

string (FieldMask format)

ज़रूरी है. अपडेट किए जाने वाले फ़ील्ड की सूची. फ़िलहाल, सिर्फ़ displayName और customMetadata को अपडेट किया जा सकता है.

यह फ़ील्ड के पूरी तरह क्वालिफ़ाइड नामों की कॉमा-सेपरेटेड लिस्ट है. उदाहरण: "user.displayName,photo".

अनुरोध का मुख्य भाग

अनुरोध के मुख्य भाग में Document का उदाहरण है.

जवाब का मुख्य भाग

कामयाब रहने पर, जवाब के मुख्य हिस्से में Document का एक इंस्टेंस शामिल किया जाता है.

अनुमति देने के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.