Method: corpora.documents.list

Corpus में मौजूद सभी Document की सूची बनाता है.

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

GET https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

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

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

पैरामीटर
parent

string

ज़रूरी है. उस Corpus का नाम जिसमें Document हैं. उदाहरण: corpora/my-corpus-123

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

पैरामीटर
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)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
documents[]

object (Document)

लौटाए गए Document सेकंड.
nextPageToken

string

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

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

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

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

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