तरीका: corpora.documents.create
खाली Document
बनाता है.
एंडपॉइंट
पोस्टhttps: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /*} /documents
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
parent
string
ज़रूरी है. उस Corpus
का नाम जहां यह Document
बनाया जाएगा. उदाहरण: corpora/my-corpus-123
यह corpora/{corpora}
के तौर पर दिखता है.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में Document
का उदाहरण है.
name
string
इम्यूटेबल. आइडेंटिफ़ायर. Document
रिसॉर्स का नाम. आईडी में ज़्यादा से ज़्यादा 40 वर्ण हो सकते हैं. ये वर्ण, अंग्रेज़ी के छोटे अक्षर, अंक या डैश (-) हो सकते हैं. आईडी की शुरुआत या आखिर में डैश नहीं हो सकता. अगर खाता बनाते समय कोई नाम नहीं दिया जाता है, तो displayName
से एक यूनीक नाम और 12 वर्णों का कोई रैन्डम सफ़िक्स जनरेट किया जाएगा. उदाहरण: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
displayName
string
ज़रूरी नहीं. Document
के लिए, ऐसा डिसप्ले नेम जिसे कोई भी व्यक्ति आसानी से पढ़ सके. डिसप्ले नेम में स्पेस के साथ 512 से ज़्यादा वर्ण नहीं होने चाहिए. उदाहरण: "सेमांटिक रीट्रिवर दस्तावेज़"
customMetadata[]
object (CustomMetadata
)
ज़रूरी नहीं. उपयोगकर्ता से मिला कस्टम मेटाडेटा, की-वैल्यू पेयर के तौर पर स्टोर किया जाता है. इसका इस्तेमाल क्वेरी करने के लिए किया जाता है. किसी Document
में ज़्यादा से ज़्यादा 20 CustomMetadata
हो सकते हैं.
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में Document
का नया इंस्टेंस शामिल किया जाता है.
तरीका: corpora.documents.query
Document
पर सिमेंटिक सर्च करता है.
एंडपॉइंट
पोस्टhttps: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}:query
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
name
string
ज़रूरी है. क्वेरी करने के लिए Document
का नाम. उदाहरण: corpora/my-corpus-123/documents/the-doc-abc
यह corpora/{corpora}/documents/{document}
के तौर पर दिखता है.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:
query
string
ज़रूरी है. सिमेंटिक सर्च करने के लिए क्वेरी स्ट्रिंग.
resultsCount
integer
ज़रूरी नहीं. लौटाए जाने वाले Chunk
की ज़्यादा से ज़्यादा संख्या. ऐसा हो सकता है कि सेवा कम Chunk
दिखाए.
अगर कोई वैल्यू नहीं दी जाती है, तो ज़्यादा से ज़्यादा 10 Chunk
दिखाए जाएंगे. ज़्यादा से ज़्यादा 100 नतीजे दिखाए जा सकते हैं.
metadataFilters[]
object (MetadataFilter
)
ज़रूरी नहीं. Chunk
मेटाडेटा के लिए फ़िल्टर करें. हर MetadataFilter
ऑब्जेक्ट, किसी यूनीक कुंजी से जुड़ा होना चाहिए. एक से ज़्यादा MetadataFilter
ऑब्जेक्ट को लॉजिकल "AND" से जोड़ा जाता है.
ध्यान दें: इस अनुरोध के लिए, Document
-लेवल फ़िल्टरिंग की सुविधा काम नहीं करती, क्योंकि Document
का नाम पहले से तय है.
क्वेरी का उदाहरण: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)
MetadataFilter
ऑब्जेक्ट की सूची: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.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" का इस्तेमाल सिर्फ़ संख्या वाली वैल्यू के लिए किया जा सकता है. स्ट्रिंग वैल्यू में, एक ही कुंजी के लिए सिर्फ़ "या" का इस्तेमाल किया जा सकता है.
जवाब का मुख्य भाग
documents.query
से मिला जवाब, जिसमें काम के हिस्सों की सूची शामिल है.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
relevantChunks[]
object (RelevantChunk
)
काम के चंक.
JSON के काेड में दिखाना |
---|
{
"relevantChunks": [
{
object ( |
तरीका: corpora.documents.list
Corpus
में मौजूद सभी Document
की सूची बनाता है.
एंडपॉइंट
gethttps: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /*} /documents
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
parent
string
ज़रूरी है. Document
वाले Corpus
का नाम. उदाहरण: corpora/my-corpus-123
यह corpora/{corpora}
के तौर पर दिखता है.
क्वेरी पैरामीटर
pageSize
integer
ज़रूरी नहीं. हर पेज पर, ज़्यादा से ज़्यादा कितने Document
दिखाए जाएं. ऐसा हो सकता है कि सेवा कम Document
दिखाए.
अगर कोई वैल्यू नहीं दी जाती है, तो ज़्यादा से ज़्यादा 10 Document
दिखाए जाएंगे. हर पेज पर ज़्यादा से ज़्यादा 20 Document
हो सकते हैं.
pageToken
string
ज़रूरी नहीं. पेज टोकन, जो पिछले documents.list
कॉल से मिला था.
अगला पेज पाने के लिए, रिस्पॉन्स में दिखाए गए nextPageToken
को अगले अनुरोध के आर्ग्युमेंट के तौर पर दें.
पेजेशन करते समय, documents.list
को दिए गए सभी अन्य पैरामीटर, उस कॉल से मेल खाने चाहिए जिसने पेज टोकन दिया था.
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
documents.list
से मिला जवाब, जिसमें पेज के हिसाब से Document
की सूची शामिल है. Document
को बढ़ते document.create_time
के हिसाब से क्रम में लगाया जाता है.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
documents[]
object (Document
)
दिखाए गए Document
.
nextPageToken
string
अगला पेज पाने के लिए, pageToken
के तौर पर भेजा जा सकने वाला टोकन. अगर इस फ़ील्ड को छोड़ा जाता है, तो इसका मतलब है कि कोई और पेज नहीं है.
JSON के काेड में दिखाना |
---|
{
"documents": [
{
object ( |
तरीका: corpora.documents.get
किसी खास Document
के बारे में जानकारी मिलती है.
एंडपॉइंट
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
name
string
ज़रूरी है. जिस Document
को वापस लाना है उसका नाम. उदाहरण: corpora/my-corpus-123/documents/the-doc-abc
यह corpora/{corpora}/documents/{document}
के तौर पर दिखता है.
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य हिस्सा
कामयाब रहने पर, जवाब के मुख्य हिस्से में Document
का एक इंस्टेंस शामिल किया जाता है.
तरीका: corpora.documents.patch
Document
को अपडेट करता है.
एंडपॉइंट
पैचhttps: / /generativelanguage.googleapis.com /v1beta /{document.name=corpora /* /documents /*}
PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
document.name
string
इम्यूटेबल. आइडेंटिफ़ायर. Document
रिसॉर्स का नाम. आईडी में ज़्यादा से ज़्यादा 40 वर्ण हो सकते हैं. ये वर्ण, लोअरकेस अक्षर और अंक या डैश (-) हो सकते हैं. आईडी की शुरुआत या आखिर में डैश नहीं हो सकता. अगर खाता बनाते समय कोई नाम नहीं दिया जाता है, तो displayName
से एक यूनीक नाम और 12 वर्णों का कोई रैन्डम सफ़िक्स जनरेट किया जाएगा. उदाहरण: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
यह corpora/{corpora}/documents/{document}
के तौर पर दिखता है.
क्वेरी पैरामीटर
updateMask
string (FieldMask
format)
ज़रूरी है. अपडेट किए जाने वाले फ़ील्ड की सूची. फ़िलहाल, सिर्फ़ displayName
और customMetadata
को अपडेट किया जा सकता है.
यह फ़ील्ड के पूरी तरह से क्वालिफ़ाइड नामों की सूची है. इसमें नामों को कॉमा लगाकर अलग किया गया है. उदाहरण: "user.displayName,photo"
.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में Document
का उदाहरण है.
displayName
string
ज़रूरी नहीं. Document
के लिए, ऐसा डिसप्ले नेम जिसे कोई भी व्यक्ति आसानी से पढ़ सके. डिसप्ले नेम में स्पेस के साथ 512 से ज़्यादा वर्ण नहीं होने चाहिए. उदाहरण: "सेमांटिक रीट्रिवर दस्तावेज़"
customMetadata[]
object (CustomMetadata
)
ज़रूरी नहीं. उपयोगकर्ता से मिला कस्टम मेटाडेटा, की-वैल्यू पेयर के तौर पर स्टोर किया जाता है. इसका इस्तेमाल क्वेरी करने के लिए किया जाता है. किसी Document
में ज़्यादा से ज़्यादा 20 CustomMetadata
हो सकते हैं.
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में Document
का एक इंस्टेंस शामिल किया जाता है.
तरीका: corpora.documents.delete
Document
मिटाता है.
एंडपॉइंट
deletehttps: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
name
string
ज़रूरी है. मिटाए जाने वाले Document
के रिसॉर्स का नाम. उदाहरण: corpora/my-corpus-123/documents/the-doc-abc
यह corpora/{corpora}/documents/{document}
के तौर पर दिखता है.
क्वेरी पैरामीटर
force
boolean
ज़रूरी नहीं. इसे 'सही' पर सेट करने पर, इस Document
से जुड़े सभी Chunk
और ऑब्जेक्ट भी मिट जाएंगे.
अगर यह वैल्यू गलत (डिफ़ॉल्ट) है, तो Document
में कोई Chunk
होने पर, FAILED_PRECONDITION
गड़बड़ी का मैसेज दिखेगा.
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
अगर एपीआई सही से जुड़ जाता है, तो रिस्पॉन्स बॉडी में खाली JSON ऑब्जेक्ट होता है.
REST रिसॉर्स: corpora.documents
संसाधन: दस्तावेज़
Document
, Chunk
का कलेक्शन होता है. किसी Corpus
में ज़्यादा से ज़्यादा 10,000 Document
हो सकते हैं.
name
string
इम्यूटेबल. आइडेंटिफ़ायर. Document
रिसॉर्स का नाम. आईडी में ज़्यादा से ज़्यादा 40 वर्ण हो सकते हैं. ये वर्ण, अंग्रेज़ी के छोटे अक्षर, अंक या डैश (-) हो सकते हैं. आईडी की शुरुआत या आखिर में डैश नहीं हो सकता. अगर खाता बनाते समय कोई नाम नहीं दिया जाता है, तो displayName
से एक यूनीक नाम और 12 वर्णों का कोई रैन्डम सफ़िक्स जनरेट किया जाएगा. उदाहरण: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
displayName
string
ज़रूरी नहीं. Document
के लिए, ऐसा डिसप्ले नेम जिसे कोई भी व्यक्ति आसानी से पढ़ सके. डिसप्ले नेम में स्पेस के साथ 512 से ज़्यादा वर्ण नहीं होने चाहिए. उदाहरण: "सेमांटिक रीट्रिवर दस्तावेज़"
customMetadata[]
object (CustomMetadata
)
ज़रूरी नहीं. उपयोगकर्ता से मिला कस्टम मेटाडेटा, की-वैल्यू पेयर के तौर पर स्टोर किया जाता है. इसका इस्तेमाल क्वेरी करने के लिए किया जाता है. किसी Document
में ज़्यादा से ज़्यादा 20 CustomMetadata
हो सकते हैं.
updateTime
string (Timestamp
format)
सिर्फ़ आउटपुट के लिए. Document
को आखिरी बार अपडेट किए जाने का टाइमस्टैंप.
आरएफ़सी 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"
.
createTime
string (Timestamp
format)
सिर्फ़ आउटपुट के लिए. Document
बनाने का टाइमस्टैंप.
आरएफ़सी 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,
"customMetadata": [
{
object ( |
CustomMetadata
उपयोगकर्ता से मिला मेटाडेटा, की-वैल्यू पेयर के तौर पर सेव किया जाता है.
key
string
ज़रूरी है. सेव किए जाने वाले मेटाडेटा की कुंजी.
value
Union type
value
इनमें से कोई एक हो सकता है:stringValue
string
स्टोर किए जाने वाले मेटाडेटा की स्ट्रिंग वैल्यू.
stringListValue
object (StringList
)
स्टोर किए जाने वाले मेटाडेटा की StringList वैल्यू.
numericValue
number
सेव किए जाने वाले मेटाडेटा की संख्या वाली वैल्यू.
JSON के काेड में दिखाना |
---|
{
"key": string,
// value
"stringValue": string,
"stringListValue": {
object ( |
StringList
उपयोगकर्ता से मिली स्ट्रिंग वैल्यू, जो किसी एक मेटाडेटा कुंजी को असाइन की गई हैं.
values[]
string
स्टोर किए जाने वाले मेटाडेटा की स्ट्रिंग वैल्यू.
JSON के काेड में दिखाना |
---|
{ "values": [ string ] } |