Corpora

REST रिसॉर्स: कॉर्पोरा

संसाधन: कॉर्पस

Corpus, Document का एक कलेक्शन होता है. एक प्रोजेक्ट में ज़्यादा से ज़्यादा पांच कॉर्पोरा बनाए जा सकते हैं.

JSON के काेड में दिखाना 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}
फ़ील्ड
name string

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

displayName string

ज़रूरी नहीं. Corpus का डिसप्ले नेम, जिसे कोई भी व्यक्ति आसानी से पढ़ सकता है. डिसप्ले नेम में स्पेस के साथ-साथ 512 से ज़्यादा वर्ण नहीं होने चाहिए. उदाहरण: "सिमैंटिक रिट्रीवर पर Docs"

createTime string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जब Corpus बनाया गया था.

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जब Corpus को आखिरी बार अपडेट किया गया था.

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

तरीका: कॉर्पोरा.create

एक खाली Corpus बनाता है.

एंडपॉइंट

पोस्ट https://generativelanguage.googleapis.com/v1beta/corpora

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

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

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

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

तरीका: Corpara.list

उपयोगकर्ता के मालिकाना हक वाले सभी Corpora की सूची बनाता है.

एंडपॉइंट

पाएं https://generativelanguage.googleapis.com/v1beta/corpora

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

pageSize integer

ज़रूरी नहीं. ज़्यादा से ज़्यादा Corpora आइटम लौटाए जा सकते हैं (हर पेज के हिसाब से). यह सेवा कम Corpora लौटा सकती है.

अगर जानकारी नहीं है, तो ज़्यादा से ज़्यादा 10 Corpora लौटाए जाएंगे. हर पेज के साइज़ की सीमा 20 Corpora से ज़्यादा नहीं होनी चाहिए.

pageToken string

ज़रूरी नहीं. पिछले corpora.list कॉल से मिला पेज टोकन.

अगला पेज वापस पाने के लिए, अगले अनुरोध के लिए तर्क के तौर पर जवाब के तौर पर दिए गए nextPageToken को उपलब्ध कराएं.

पेजों पर नंबर डालते समय, corpora.list को दिए गए अन्य सभी पैरामीटर, पेज टोकन देने वाले कॉल से मैच होने चाहिए.

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

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

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

corpora.list से मिला जवाब, जिसमें Corpora की पेजों वाली सूची शामिल है. नतीजों को corpus.create_time के बढ़ते क्रम में लगाया गया है.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

फ़ील्ड
corpora[] object (Corpus)

लौटाए गए कॉर्पोरा.

nextPageToken string

एक टोकन, जिसे अगला पेज फिर से पाने के लिए pageToken के तौर पर भेजा जा सकता है. अगर इस फ़ील्ड को छोड़ दिया जाता है, तो और पेज नहीं होते हैं.

JSON के काेड में दिखाना 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

तरीका: कॉर्पोरा.query

Corpus पर सिमैंटिक खोज करता है.

एंडपॉइंट

पोस्ट https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

पाथ पैरामीटर

name string

ज़रूरी है. क्वेरी करने के लिए Corpus का नाम. उदाहरण: corpora/my-corpus-123 यह corpora/{corpora} का रूप लेता है.

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

अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:

फ़ील्ड
query string

ज़रूरी है. सिमैंटिक खोज करने के लिए क्वेरी स्ट्रिंग.

metadataFilters[] object (MetadataFilter)

ज़रूरी नहीं. Chunk और Document मेटाडेटा के लिए फ़िल्टर करें. हर MetadataFilter ऑब्जेक्ट एक खास कुंजी से मेल खाना चाहिए. कई MetadataFilter ऑब्जेक्ट, लॉजिकल "AND" से जोड़े जाते हैं.

दस्तावेज़ के लेवल पर क्वेरी का उदाहरण: (साल >= 2020 या साल < 2010) AND (शैली = ड्रामा या शैली = ऐक्शन)

MetadataFilter ऑब्जेक्ट की सूची: मेटाडेटा फ़िल्टर = [ {key = "document.custom_metadata.year" शर्तें = [{int_value = 2020, Operations = GREATER_EQUAL}, {int_value = 2010, Operations = LESS}]}, {key = "document.custom_metadata.year" स्थितियां = [{int_value = 2020,, ऑपरेशन = GREATER_EQUAL}, {int_value = 2010, ऑपरेशन = LESS}]}, {key = "document.custom_metadata.genre" शर्तें = [{stringValue = "ड्रामा", ऑपरेशन = EQUAL}, {stringValue = "action", Operations = EQUAL}]}]

वैल्यू की अंकों वाली रेंज के लिए, हिस्से के लेवल पर क्वेरी का उदाहरण: (साल > 2015 AND साल <= 2020)

MetadataFilter ऑब्जेक्ट की सूची: मेटाडेटा फ़िल्टर = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; शर्तें = [{int_value = 2020, ऑपरेशन = LESS_EQUAL}]}]

ध्यान दें: एक जैसी कुंजी के लिए, "AND" का इस्तेमाल सिर्फ़ अंकों वाली वैल्यू के लिए किया जा सकता है. स्ट्रिंग वैल्यू सिर्फ़ एक कुंजी के लिए "OR" के साथ काम करती हैं.

resultsCount integer

ज़रूरी नहीं. वापस दिए जाने वाले Chunk की ज़्यादा से ज़्यादा संख्या. सेवा से कम Chunk मिल सकते हैं.

अगर जानकारी नहीं दी गई है, तो ज़्यादा से ज़्यादा 10 Chunk दिखाए जाएंगे. अधिकतम 100 परिणाम चुने जा सकते हैं.

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

corpora.query से मिले जवाब में, काम के हिस्सों की सूची शामिल है.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

फ़ील्ड
relevantChunks[] object (RelevantChunk)

काम के हिस्से.

JSON के काेड में दिखाना 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

तरीका: कॉर्पोरा.get

किसी खास Corpus के बारे में जानकारी मिलती है.

एंडपॉइंट

पाएं https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

पाथ पैरामीटर

name string

ज़रूरी है. Corpus का नाम. उदाहरण: corpora/my-corpus-123 यह corpora/{corpora} का रूप लेता है.

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

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य हिस्सा

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

तरीका: कॉर्पोरा.पैच

Corpus को अपडेट करता है.

एंडपॉइंट

पैच https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

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

पाथ पैरामीटर

corpus.name string

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

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

updateMask string (FieldMask format)

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

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

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

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

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

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

तरीका: Corpara.delete

Corpus को मिटाता है.

एंडपॉइंट

मिटाएं https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

पाथ पैरामीटर

name string

ज़रूरी है. Corpus का संसाधन. उदाहरण: corpora/my-corpus-123 यह corpora/{corpora} का रूप लेता है.

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

force boolean

ज़रूरी नहीं. अगर इसे 'सही है' पर सेट किया जाता है, तो इस Corpus से जुड़े Document और ऑब्जेक्ट भी मिटा दिए जाएंगे.

गलत होने पर (डिफ़ॉल्ट तौर पर), अगर Corpus में कोई Document मौजूद होता है, तो FAILED_PRECONDITION गड़बड़ी मिलेगी.

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

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

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

जवाब सही होने पर, जवाब का मुख्य हिस्सा खाली होता है.

REST रिसॉर्स: कॉर्पोरा.permissions

संसाधन: अनुमति

अनुमति देने वाले संसाधन से उपयोगकर्ता, ग्रुप या दुनिया के बाकी लोगों को PaLM API के संसाधन (जैसे, ट्यून किया गया मॉडल, कॉर्पस) का ऐक्सेस मिलता है.

भूमिका, अनुमति वाली कार्रवाइयों का एक कलेक्शन है. इसकी मदद से उपयोगकर्ता, PaLM API के संसाधनों पर खास कार्रवाइयां कर सकते हैं. उपयोगकर्ताओं, ग्रुप या सेवा खातों को उपलब्ध कराने के लिए, आपको भूमिकाएं असाइन करनी होती हैं. कोई भूमिका असाइन करके, वे अनुमतियां दी जाती हैं जो उस भूमिका में होती हैं.

इसमें तीन भूमिकाएं एक-दूसरे से जुड़ी हुई होती हैं. हर भूमिका, पिछली भूमिका की अनुमति वाली कार्रवाइयों का सुपरसेट है:

  • पाठक, अनुमान लगाने के लिए संसाधन (जैसे कि ट्यून किया गया मॉडल, कॉर्पस) का इस्तेमाल कर सकता है
  • लेखक के पास लोगों की अनुमतियां होती हैं. इसके अलावा, वह लेखक के कॉन्टेंट में बदलाव और उसे शेयर भी कर सकता है
  • मालिक के पास लेखक की अनुमतियां हैं और वे दस्तावेज़ को मिटा भी सकते हैं
JSON के काेड में दिखाना 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
फ़ील्ड
name string

सिर्फ़ आउटपुट के लिए. आइडेंटिफ़ायर. अनुमति का नाम. बनाने पर, एक यूनीक नाम जनरेट होगा. उदाहरण: सिर्फ़ TunerModels/{tunedModel}/permissions/{permission} कॉर्पोरा/{corpus}/permissions/{permission} आउटपुट.

granteeType enum (GranteeType)

ज़रूरी नहीं. इम्यूटेबल. अनुदान पाने वाले का टाइप.

emailAddress string

ज़रूरी नहीं. इम्यूटेबल. ग्रुप के उपयोगकर्ता का ईमेल पता जिससे यह अनुमति मिली है. जब अनुमति का अनुदान देने वाला प्रकार EVERYONE होता है, तो फ़ील्ड सेट नहीं होता है.

role enum (Role)

ज़रूरी है. इस अनुमति के ज़रिए दी गई भूमिका.

GranteeType

यह बताता है कि यह अनुमति किस तरह की है.

Enums
GRANTEE_TYPE_UNSPECIFIED डिफ़ॉल्ट वैल्यू. इस वैल्यू का इस्तेमाल नहीं किया गया है.
USER इससे उपयोगकर्ता का प्रतिनिधित्व किया जाता है. सेट होने पर, आपको उपयोगकर्ता के लिए emailAddress देना होगा.
GROUP किसी ग्रुप को दिखाता है. सेट होने पर, आपको ग्रुप का emailAddress देना होगा.
EVERYONE इससे सभी लोगों को ऐक्सेस मिलता है. किसी और जानकारी की ज़रूरत नहीं है.

भूमिका

इस अनुमति से मिलने वाली भूमिका के बारे में बताता है.

Enums
ROLE_UNSPECIFIED डिफ़ॉल्ट वैल्यू. इस वैल्यू का इस्तेमाल नहीं किया गया है.
OWNER मालिक, संसाधन को इस्तेमाल कर सकता है, उसे अपडेट कर सकता है, शेयर कर सकता है, और मिटा सकता है.
WRITER लेखक, संसाधन को इस्तेमाल, अपडेट, और शेयर कर सकता है.
READER लोग इस संसाधन का इस्तेमाल कर सकते हैं.

MetadataFilter

उपयोगकर्ता की ओर से दिया गया फ़िल्टर, Chunk या Document लेवल की मेटाडेटा वैल्यू के आधार पर फ़ाइल वापस लाने की सीमा तय करता है. उदाहरण (शैली = ड्रामा या शैली = कार्रवाई): key = "document.custom_metadata.genre" शर्तें = [{stringValue = "ड्रामा", ऑपरेशन = EQUAL}, {stringValue = "action", Operations = EQUAL}]

JSON के काेड में दिखाना 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}
फ़ील्ड
key string

ज़रूरी है. फ़िल्टर करने के लिए मेटाडेटा की कुंजी.

conditions[] object (Condition)

ज़रूरी है. दी गई कुंजी के लिए Condition, जो इस फ़िल्टर को ट्रिगर करेगी. एक से ज़्यादा Condition को लॉजिकल ओआर से जोड़ा जाता है.

शर्त

फ़िल्टर करने की शर्त एक ही कुंजी पर लागू होती है.

JSON के काेड में दिखाना 
{
  "operation": enum (Operator),

  // Union field value can be only one of the following:
  "stringValue": string,
  "numericValue": number
  // End of list of possible types for union field value.
}
फ़ील्ड
operation enum (Operator)

ज़रूरी है. शर्त को ट्रिगर करने के लिए, ऑपरेटर को दिए गए की-वैल्यू पेयर पर लागू किया जाता है.

यूनियन फ़ील्ड value. वैल्यू का टाइप, फ़ील्ड में उससे जुड़ी कुंजी के लिए तय की गई वैल्यू के टाइप से मेल खाना चाहिए. अगर वैल्यू टाइप एक जैसे नहीं हैं, तो नतीजे के तौर पर कोई खाली सेट मिलेगा. जब CustomMetadata में वैल्यू का टाइप StringList होता है, तो फ़िल्टर करने की शर्त में string_value का इस्तेमाल किया जाना चाहिए. इसे शामिल करने के लिए किसी कार्रवाई को शामिल नहीं किया जाना चाहिए. ऐसा न करने पर, नतीजा भी खाली सेट होगा. value इनमें से सिर्फ़ एक हो सकता है:
stringValue string

स्ट्रिंग की वह वैल्यू जिसके हिसाब से मेटाडेटा को फ़िल्टर करना है.

numericValue number

वह न्यूमेरिक वैल्यू जिसके हिसाब से मेटाडेटा को फ़िल्टर करना है.

ऑपरेटर

यह ऐसे मान्य ऑपरेटर के बारे में बताता है जिन्हें की-वैल्यू पेयर पर लागू किया जा सकता है.

Enums
OPERATOR_UNSPECIFIED डिफ़ॉल्ट वैल्यू. इस वैल्यू का इस्तेमाल नहीं किया गया है.
LESS संख्या के साथ काम करता है.
LESS_EQUAL संख्या के साथ काम करता है.
EQUAL न्यूमेरिक और स्ट्रिंग.
GREATER_EQUAL संख्या के साथ काम करता है.
GREATER संख्या के साथ काम करता है.
NOT_EQUAL न्यूमेरिक और स्ट्रिंग.
INCLUDES स्ट्रिंग का इस्तेमाल तब ही किया जा सकता है, जब दी गई कुंजी के लिए, CustomMetadata वैल्यू टाइप में stringListValue मौजूद हो.
EXCLUDES स्ट्रिंग का इस्तेमाल तब ही किया जा सकता है, जब दी गई कुंजी के लिए, CustomMetadata वैल्यू टाइप में stringListValue मौजूद हो.

RelevantChunk

किसी क्वेरी के लिए काम के हिस्से की जानकारी.

JSON के काेड में दिखाना 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}
फ़ील्ड
chunkRelevanceScore number

Chunk क्वेरी के हिसाब से काम की है या नहीं.

chunk object (Chunk)

क्वेरी से जुड़ा Chunk.