Corpora

तरीका: corpora.create

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

एंडपॉइंट

post https://generativelanguage.googleapis.com/v1beta/corpora

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

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

फ़ील्ड
name string

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

displayName string

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

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

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

तरीका: corpora.query

यह Corpus पर सिमैंटिक सर्च करता है.

एंडपॉइंट

post 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" से जोड़ा गया हो.

दस्तावेज़ लेवल पर क्वेरी का उदाहरण: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter ऑब्जेक्ट की सूची: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

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

MetadataFilter ऑब्जेक्ट की सूची: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

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

resultsCount integer

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

अगर इसे तय नहीं किया गया है, तो ज़्यादा से ज़्यादा 10 Chunk दिखाए जाएंगे. नतीजों की ज़्यादा से ज़्यादा संख्या 100 है.

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

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

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

Fields
relevantChunks[] object (RelevantChunk)

काम के चंक.

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

तरीका: corpora.list

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

एंडपॉइंट

get 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 के हिसाब से बढ़ते क्रम में लगाया गया है.

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

Fields
corpora[] object (Corpus)

वापस किए गए कॉर्पस.

nextPageToken string

यह एक टोकन है. इसका इस्तेमाल अगले पेज को वापस पाने के लिए, pageToken के तौर पर किया जा सकता है. अगर इस फ़ील्ड को शामिल नहीं किया जाता है, तो इसका मतलब है कि कोई और पेज उपलब्ध नहीं है.

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

तरीका: corpora.get

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

एंडपॉइंट

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

पाथ पैरामीटर

name string

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

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

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

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

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

तरीका: corpora.patch

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

एंडपॉइंट

patch 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 का उदाहरण है.

फ़ील्ड
displayName string

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

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

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

तरीका: corpora.delete

यह कुकी, Corpus को मिटाती है.

एंडपॉइंट

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

पाथ पैरामीटर

name string

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

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

force boolean

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

अगर यह डिफ़ॉल्ट रूप से गलत है, तो FAILED_PRECONDITION में कोई भी Document होने पर, FAILED_PRECONDITION गड़बड़ी दिखेगी.Corpus

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

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

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

अगर अनुरोध पूरा हो जाता है, तो जवाब के मुख्य हिस्से में एक खाली JSON ऑब्जेक्ट होता है.

REST रिसॉर्स: corpora.permissions

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

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

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

इसमें तीन भूमिकाएं होती हैं. हर भूमिका में, पिछली भूमिका के लिए अनुमति वाली कार्रवाइयां शामिल होती हैं:

  • पढ़ने वाला व्यक्ति, अनुमान लगाने के लिए रिसॉर्स (जैसे, ट्यून किया गया मॉडल, कॉर्पस) का इस्तेमाल कर सकता है
  • लेखक के पास दर्शक की अनुमतियां होती हैं. इसके अलावा, वह बदलाव कर सकता है और शेयर कर सकता है
  • मालिक के पास लेखक की अनुमतियां होती हैं. इसके अलावा, वह मिटा भी सकता है
Fields
name string

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

granteeType enum (GranteeType)

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

emailAddress string

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

role enum (Role)

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

JSON के काेड में दिखाना 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

इससे यह तय होता है कि यह अनुमति किसे दी गई है.

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

भूमिका

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

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

MetadataFilter

उपयोगकर्ता ने फ़िल्टर दिया है, ताकि Chunk या Document लेवल के मेटाडेटा की वैल्यू के आधार पर डेटा को सीमित तौर पर वापस पाया जा सके. उदाहरण (genre = drama OR genre = action): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

Fields
key string

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

conditions[] object (Condition)

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

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

शर्त

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

Fields
operation enum (Operator)

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

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

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

numericValue number

मेटाडेटा को फ़िल्टर करने के लिए इस्तेमाल की जाने वाली संख्या वाली वैल्यू.

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

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

ऑपरेटर

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

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

RelevantChunk

किसी क्वेरी से जुड़े किसी हिस्से की जानकारी.

Fields
chunkRelevanceScore number

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

chunk object (Chunk)

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

document object (Document)

Document, जो चंक से जुड़ा है.

JSON के काेड में दिखाना 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  },
  "document": {
    object (Document)
  }
}

REST रिसॉर्स: corpora

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

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

Fields
name string

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

displayName string

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

createTime string (Timestamp format)

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

यह RFC 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

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

यह RFC 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".

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