Method: corpora.documents.query

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

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

POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query

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

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

पैरामीटर
name

string

ज़रूरी है. क्वेरी करने के लिए Document का नाम. उदाहरण: corpora/my-corpus-123/documents/the-doc-abc

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

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

जेएसओएन के काेड में दिखाना 
{
  "query": string,
  "resultsCount": integer,
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ]
}
फ़ील्ड
query

string

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

integer

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

अगर कोई भी जानकारी नहीं दी जाती है, तो ज़्यादा से ज़्यादा 10 Chunk लौटाए जाएंगे. 100 से ज़्यादा नतीजे नहीं दिखाए जा सकते.
metadataFilters[]

object (MetadataFilter)

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

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

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

MetadataFilter ऑब्जेक्ट सूची: मेटाडेटा फ़िल्टर = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, transaction = GREATER_EQUAL}, {int_value = 2010, action = लेस}}, {key = "chunk.custom_metadata.genre" conditions = [{mastring"Value = QUQUAL) मान

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

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

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}
फ़ील्ड
relevantChunks[]

object (RelevantChunk)

काम के हिस्से लौटाए गए.

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

इनमें से कोई एक OAuth स्कोप ज़रूरी है:

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

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