Corpora

तरीका: corpora.create

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

एंडपॉइंट

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

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

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

फ़ील्ड
name string

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

displayName string

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

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

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

तरीका: corpora.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" से जोड़ा जाता है.

दस्तावेज़ के लेवल पर क्वेरी का उदाहरण: (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" सिर्फ़ संख्या वाली वैल्यू के लिए काम करता है. स्ट्रिंग वैल्यू में, एक ही कुंजी के लिए सिर्फ़ "या" का इस्तेमाल किया जा सकता है.

resultsCount integer

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

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

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

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

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

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

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

फ़ील्ड
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 को अपडेट करता है.

एंडपॉइंट

पैच 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 से ज़्यादा वर्ण नहीं होने चाहिए. उदाहरण: "सेमांटिक रीट्रिवर के बारे में दस्तावेज़"

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

कामयाब रहने पर, जवाब के मुख्य हिस्से में 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 और ऑब्जेक्ट भी मिट जाएंगे.

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

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

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

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

अगर एपीआई सही से जुड़ जाता है, तो रिस्पॉन्स बॉडी में खाली JSON ऑब्जेक्ट होता है.

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

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

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

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

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

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

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

granteeType enum (GranteeType)

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

emailAddress string

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

role enum (Role)

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

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

GranteeType

इस अनुमति को पाने वाले लोगों के टाइप तय करता है.

Enums
GRANTEE_TYPE_UNSPECIFIED डिफ़ॉल्ट वैल्यू. इस वैल्यू का इस्तेमाल नहीं किया जाता.
USER किसी उपयोगकर्ता की जानकारी दिखाता है. सेट होने पर, आपको उपयोगकर्ता के लिए emailAddress देना होगा.
GROUP किसी ग्रुप को दिखाता है. सेट करने के बाद, आपको ग्रुप के लिए ईमेल पता देना होगा.
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}]

फ़ील्ड
key string

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

conditions[] object (Condition)

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

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

शर्त

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

फ़ील्ड
operation enum (Operator)

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

value Union type
वैल्यू टाइप, उससे जुड़ी कुंजी के लिए फ़ील्ड में तय किए गए वैल्यू टाइप से मेल खाना चाहिए. अगर वैल्यू टाइप एक जैसे नहीं हैं, तो नतीजा खाली सेट होगा. जब CustomMetadata का वैल्यू टाइप StringList होता है, तो फ़िल्टर करने की शर्त में INCLUDES/EXCLUDES ऑपरेशन के साथ string_value का इस्तेमाल किया जाना चाहिए. ऐसा न करने पर, नतीजा भी खाली सेट होगा. 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

क्वेरी से जुड़े चंक की जानकारी.

फ़ील्ड
chunkRelevanceScore number

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

chunk object (Chunk)

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

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

REST रिसॉर्स: corpora

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

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

फ़ील्ड
name string

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

displayName string

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

createTime string (Timestamp format)

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

आरएफ़सी 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 को आखिरी बार अपडेट किए जाने का टाइमस्टैंप.

आरएफ़सी 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
}