Batch API

Gemini API, बैच एपीआई के साथ काम करता है. इनकी मदद से, एक ही कॉल में कई अनुरोधों को प्रोसेस किया जा सकता है. ज़्यादा जानकारी के लिए, Batch API की गाइड देखें.

मेथड: models.batchGenerateContent

यह फ़ंक्शन, बैच प्रोसेसिंग के लिए models.generateContent अनुरोधों के बैच को लाइन में लगाता है.

एंडपॉइंट

post https://generativelanguage.googleapis.com/v1beta/{batch.model=models/*}:batchGenerateContent

पाथ पैरामीटर

batch.model string

ज़रूरी है. Model का नाम, जिसका इस्तेमाल जवाब जनरेट करने के लिए किया जाएगा.

फ़ॉर्मैट: models/{model}. यह models/{model} के फ़ॉर्म में होता है.

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

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

फ़ील्ड
batch.name string

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

फ़ॉर्मैट: batches/{batchId}.

batch.displayName string

ज़रूरी है. इस बैच का उपयोगकर्ता के तय किया गया नाम.

batch.inputConfig object (InputConfig)

ज़रूरी है. उन इंस्टेंस का इनपुट कॉन्फ़िगरेशन जिन पर बैच प्रोसेसिंग की जाती है.

batch.output object (GenerateContentBatchOutput)

सिर्फ़ आउटपुट के लिए. बैच अनुरोध का आउटपुट.

batch.createTime string (Timestamp format)

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

यह आरएफ़सी 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".

batch.endTime string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह समय जब बैच प्रोसेसिंग पूरी हुई.

यह आरएफ़सी 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".

batch.updateTime string (Timestamp format)

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

यह आरएफ़सी 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".

batch.batchStats object (BatchStats)

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

batch.state enum (BatchState)

सिर्फ़ आउटपुट के लिए. बैच की स्थिति.

batch.priority string (int64 format)

ज़रूरी नहीं. बैच की प्राथमिकता. ज़्यादा प्राथमिकता वाली वैल्यू वाले बैच, कम प्राथमिकता वाली वैल्यू वाले बैच से पहले प्रोसेस किए जाएंगे. नेगेटिव वैल्यू इस्तेमाल की जा सकती हैं. डिफ़ॉल्ट वैल्यू 0 है.

batch.webhookConfig.uris[] string

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

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

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

मेथड: models.asyncBatchEmbedContent

यह कुकी, बैच प्रोसेसिंग के लिए models.embedContent अनुरोधों के बैच को कतार में लगाती है. हमारे पास GenerativeService में models.batchEmbedContents हैंडलर है, लेकिन इसे सिंक किया गया था. इसलिए, हम इस फ़ील्ड का नाम Async रखते हैं, ताकि कोई भ्रम न हो.

एंडपॉइंट

post https://generativelanguage.googleapis.com/v1beta/{batch.model=models/*}:asyncBatchEmbedContent

पाथ पैरामीटर

batch.model string

ज़रूरी है. Model का नाम, जिसका इस्तेमाल जवाब जनरेट करने के लिए किया जाएगा.

फ़ॉर्मैट: models/{model}. यह models/{model} के फ़ॉर्म में होता है.

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

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

फ़ील्ड
batch.name string

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

फ़ॉर्मैट: batches/{batchId}.

batch.displayName string

ज़रूरी है. इस बैच का उपयोगकर्ता के तय किया गया नाम.

batch.inputConfig object (InputEmbedContentConfig)

ज़रूरी है. उन इंस्टेंस का इनपुट कॉन्फ़िगरेशन जिन पर बैच प्रोसेसिंग की जाती है.

batch.output object (EmbedContentBatchOutput)

सिर्फ़ आउटपुट के लिए. बैच अनुरोध का आउटपुट.

batch.createTime string (Timestamp format)

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

यह आरएफ़सी 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".

batch.endTime string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह समय जब बैच प्रोसेसिंग पूरी हुई.

यह आरएफ़सी 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".

batch.updateTime string (Timestamp format)

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

यह आरएफ़सी 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".

batch.batchStats object (EmbedContentBatchStats)

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

batch.state enum (BatchState)

सिर्फ़ आउटपुट के लिए. बैच की स्थिति.

batch.priority string (int64 format)

ज़रूरी नहीं. बैच की प्राथमिकता. ज़्यादा प्राथमिकता वाली वैल्यू वाले बैच, कम प्राथमिकता वाली वैल्यू वाले बैच से पहले प्रोसेस किए जाएंगे. नेगेटिव वैल्यू इस्तेमाल की जा सकती हैं. डिफ़ॉल्ट वैल्यू 0 है.

batch.webhookConfig.uris[] string

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

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

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

मेथड: batches.get

इस तरीके से, ज़्यादा समय तक चलने वाली कार्रवाई की मौजूदा स्थिति मिलती है. क्लाइंट इस तरीके का इस्तेमाल करके, एपीआई सेवा के सुझाए गए इंटरवल पर कार्रवाई के नतीजे को पोल कर सकते हैं.

एंडपॉइंट

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

पाथ पैरामीटर

name string

कार्रवाई के रिसॉर्स का नाम. यह batches/{batches} के फ़ॉर्म में होता है.

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

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

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

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

मेथड: batches.list

अनुरोध में बताए गए फ़िल्टर से मेल खाने वाली कार्रवाइयों की सूची बनाता है. अगर सर्वर इस तरीके के साथ काम नहीं करता है, तो वह UNIMPLEMENTED दिखाता है.

एंडपॉइंट

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

पाथ पैरामीटर

name string

कार्रवाई के पैरंट रिसॉर्स का नाम. यह batches के फ़ॉर्म में होता है.

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

filter string

यह स्टैंडर्ड लिस्ट फ़िल्टर है.

pageSize integer

सूची वाले पेज का स्टैंडर्ड साइज़.

pageToken string

स्टैंडर्ड सूची वाले पेज का टोकन.

returnPartialSuccess boolean

true पर सेट होने पर, पहुंच वाली कार्रवाइयों को सामान्य तौर पर दिखाया जाता है. वहीं, जिन कार्रवाइयों तक नहीं पहुंचा जा सकता उन्हें ListOperationsResponse.unreachable फ़ील्ड में दिखाया जाता है.

ऐसा सिर्फ़ true तब किया जा सकता है, जब अलग-अलग कलेक्शन पढ़े जा रहे हों. उदाहरण के लिए, जब parent को "projects/example/locations/-" पर सेट किया जाता है.

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

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

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

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

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

मेथड: batches.cancel

इस तरीके से, ज़्यादा समय तक चलने वाली कार्रवाई को एसिंक्रोनस तरीके से रद्द किया जाता है. सर्वर, कार्रवाई को रद्द करने की पूरी कोशिश करता है. हालांकि, इस बात की कोई गारंटी नहीं है कि कार्रवाई रद्द हो जाएगी. अगर सर्वर इस तरीके के साथ काम नहीं करता है, तो वह google.rpc.Code.UNIMPLEMENTED दिखाता है. क्लाइंट, Operations.GetOperation या अन्य तरीकों का इस्तेमाल करके यह देख सकते हैं कि रद्द करने की कार्रवाई पूरी हुई है या रद्द करने के बावजूद ऑपरेशन पूरा हो गया है. रद्द करने की कार्रवाई पूरी होने पर, ऑपरेशन नहीं मिटाया जाता. इसके बजाय, यह Operation.error वैल्यू वाला ऑपरेशन बन जाता है. इसकी google.rpc.Status.code वैल्यू 1 होती है, जो Code.CANCELLED से मेल खाती है.

एंडपॉइंट

post https://generativelanguage.googleapis.com/v1beta/{name=batches/*}:cancel

पाथ पैरामीटर

name string

कार्रवाई के उस रिसॉर्स का नाम जिसे रद्द करना है. यह batches/{batches} के फ़ॉर्म में होता है.

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

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

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

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

तरीका: batches.delete

ज़्यादा समय तक चलने वाली कार्रवाई को मिटाता है. इस तरीके से पता चलता है कि क्लाइंट को अब ऑपरेशन के नतीजे में दिलचस्पी नहीं है. इससे कार्रवाई रद्द नहीं होती. अगर सर्वर इस तरीके के साथ काम नहीं करता है, तो यह google.rpc.Code.UNIMPLEMENTED दिखाता है.

एंडपॉइंट

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

पाथ पैरामीटर

name string

मिटाए जाने वाले ऑपरेशन रिसॉर्स का नाम. यह batches/{batches} के फ़ॉर्म में होता है.

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

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

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

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

मेथड: batches.updateGenerateContentBatch

यह फ़ंक्शन, बैच प्रोसेसिंग के लिए GenerateContent अनुरोधों के बैच को अपडेट करता है.

एंडपॉइंट

patch https://generativelanguage.googleapis.com/v1beta/{generateContentBatch.name=batches/*}:updateGenerateContentBatch

PATCH https://generativelanguage.googleapis.com/v1beta/{generateContentBatch.name=batches/*}:updateGenerateContentBatch

पाथ पैरामीटर

generateContentBatch.name string

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

फ़ॉर्मैट: batches/{batchId}. यह batches/{batches} के फ़ॉर्म में होता है.

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

updateMask string (FieldMask format)

ज़रूरी नहीं. अपडेट किए जाने वाले फ़ील्ड की सूची.

यह फ़ील्ड के पूरी तरह क्वालिफ़ाइड नामों की कॉमा लगाकर अलग की गई लिस्ट है. उदाहरण: "user.displayName,photo".

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

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

Fields
model string

ज़रूरी है. ऑटोमैटिक तरीके से पूरा करने की सुविधा जनरेट करने के लिए, Model का नाम.

फ़ॉर्मैट: models/{model}.

displayName string

ज़रूरी है. इस बैच का वह नाम जो उपयोगकर्ता ने तय किया है.

inputConfig object (InputConfig)

ज़रूरी है. उन इंस्टेंस का इनपुट कॉन्फ़िगरेशन जिन पर बैच प्रोसेसिंग की जाती है.

priority string (int64 format)

ज़रूरी नहीं. बैच की प्राथमिकता. ज़्यादा प्राथमिकता वाली वैल्यू वाले बैच, कम प्राथमिकता वाली वैल्यू वाले बैच से पहले प्रोसेस किए जाएंगे. नेगेटिव वैल्यू इस्तेमाल की जा सकती हैं. डिफ़ॉल्ट वैल्यू 0 है.

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

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

GenerateContentRequest

मॉडल से जवाब जनरेट करने का अनुरोध.

Fields
model string

ज़रूरी है. ऑटोमैटिक तरीके से पूरा करने की सुविधा जनरेट करने के लिए, Model का नाम.

फ़ॉर्मैट: models/{model}.

contents[] object (Content)

ज़रूरी है. मॉडल के साथ हुई मौजूदा बातचीत का कॉन्टेंट.

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

tools[] object (Tool)

ज़रूरी नहीं. Tools की एक सूची, जिसका इस्तेमाल Model अगले जवाब को जनरेट करने के लिए कर सकता है.

Tool एक ऐसा कोड होता है जिसकी मदद से सिस्टम, बाहरी सिस्टम के साथ इंटरैक्ट कर पाता है. इससे Model की जानकारी और दायरे से बाहर की कोई कार्रवाई या कार्रवाइयों का सेट किया जा सकता है. Function और codeExecution, Tool के साथ काम करते हैं. ज़्यादा जानने के लिए, फ़ंक्शन कॉलिंग और कोड एक्ज़ीक्यूशन गाइड देखें.

toolConfig object (ToolConfig)

ज़रूरी नहीं. अनुरोध में बताए गए किसी भी Tool के लिए टूल कॉन्फ़िगरेशन. इस्तेमाल के उदाहरण के लिए, फ़ंक्शन कॉलिंग गाइड देखें.

safetySettings[] object (SafetySetting)

ज़रूरी नहीं. असुरक्षित कॉन्टेंट को ब्लॉक करने के लिए, SafetySetting के यूनीक इंस्टेंस की सूची.

इसे GenerateContentRequest.contents और GenerateContentResponse.candidates पर लागू किया जाएगा. हर SafetyCategory टाइप के लिए, एक से ज़्यादा सेटिंग नहीं होनी चाहिए. एपीआई, उन सभी कॉन्टेंट और जवाबों को ब्लॉक कर देगा जो इन सेटिंग के ज़रिए तय की गई थ्रेशोल्ड वैल्यू को पूरा नहीं करते. यह सूची, safetySettings में बताए गए हर SafetyCategory के लिए डिफ़ॉल्ट सेटिंग को बदल देती है. अगर सूची में दिए गए किसी SafetyCategory के लिए कोई SafetySetting नहीं है, तो एपीआई उस कैटगरी के लिए डिफ़ॉल्ट सुरक्षा सेटिंग का इस्तेमाल करेगा. नुकसान पहुंचाने वाली इन कैटगरी के लिए, जांच की जा सकती है: HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY, HARM_CATEGORY_JAILBREAK. सुरक्षा से जुड़ी उपलब्ध सेटिंग के बारे में ज़्यादा जानकारी के लिए, गाइड देखें. एआई ऐप्लिकेशन में सुरक्षा से जुड़ी बातों को शामिल करने का तरीका जानने के लिए, सुरक्षा से जुड़े दिशा-निर्देश भी पढ़ें.

labels map (key: string, value: string)

ज़रूरी नहीं. अनुरोध के लिए, उपयोगकर्ता के तय किए गए मेटाडेटा वाले लेबल.

ज़रूरी नहीं. लेबल, Cloud के यूनीफ़ाइड लेबल से जुड़ी ज़रूरी शर्तों के मुताबिक होने चाहिए: - लेबल कुंजियों की शुरुआत अक्षर से होनी चाहिए. - लेबल कुंजियों और वैल्यू में 63 से ज़्यादा वर्ण (यूनिकोड कोडपॉइंट) नहीं हो सकते. साथ ही, इनमें सिर्फ़ अंग्रेज़ी के छोटे अक्षर, संख्याएं, अंडरस्कोर, और डैश इस्तेमाल किए जा सकते हैं. - इंटरनैशनल कैरेक्टर के इस्तेमाल की अनुमति है.

इस्तेमाल: - एग्रीगेटर से मिले सुरक्षा आइडेंटिफ़ायर: safety_identifier कुंजी का इस्तेमाल करें (उदाहरण के लिए, {"safety_identifier": "user_session_123"})

एक ऑब्जेक्ट, जिसमें "key": value जोड़े की सूची शामिल हो. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

systemInstruction object (Content)

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

generationConfig object (GenerationConfig)

ज़रूरी नहीं. मॉडल जनरेट करने और आउटपुट के लिए कॉन्फ़िगरेशन के विकल्प.

cachedContent string

ज़रूरी नहीं. कॉन्टेंट का नाम, जिसे अनुमान दिखाने के लिए कॉन्टेक्स्ट के तौर पर इस्तेमाल करने के लिए कैश मेमोरी में सेव किया गया है. फ़ॉर्मैट: cachedContents/{cachedContent}

serviceTier enum (ServiceTier)

ज़रूरी नहीं. अनुरोध का सेवा स्तर.

store boolean

ज़रूरी नहीं. यह कुकी, किसी अनुरोध के लिए लॉगिंग के व्यवहार को कॉन्फ़िगर करती है. अगर इसे सेट किया जाता है, तो यह प्रोजेक्ट-लेवल के लॉगिंग कॉन्फ़िगरेशन से ज़्यादा प्राथमिकता लेता है.

JSON के काेड में दिखाना 
{
  "model": string,
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "labels": {
    string: string,
    ...
  },
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  },
  "cachedContent": string,
  "serviceTier": enum (ServiceTier),
  "store": boolean
}

मेथड: batches.updateEmbedContentBatch

यह कुकी, बैच प्रोसेसिंग के लिए EmbedContent अनुरोधों के बैच को अपडेट करती है.

एंडपॉइंट

patch https://generativelanguage.googleapis.com/v1beta/{embedContentBatch.name=batches/*}:updateEmbedContentBatch

PATCH https://generativelanguage.googleapis.com/v1beta/{embedContentBatch.name=batches/*}:updateEmbedContentBatch

पाथ पैरामीटर

embedContentBatch.name string

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

फ़ॉर्मैट: batches/{batchId}. यह batches/{batches} के फ़ॉर्म में होता है.

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

updateMask string (FieldMask format)

ज़रूरी नहीं. अपडेट किए जाने वाले फ़ील्ड की सूची.

यह फ़ील्ड के पूरी तरह क्वालिफ़ाइड नामों की कॉमा लगाकर अलग की गई लिस्ट है. उदाहरण: "user.displayName,photo".

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

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

फ़ील्ड
model string

ज़रूरी है. ऑटोमैटिक तरीके से पूरा करने की सुविधा जनरेट करने के लिए, Model का नाम.

फ़ॉर्मैट: models/{model}.

displayName string

ज़रूरी है. इस बैच का वह नाम जो उपयोगकर्ता ने तय किया है.

inputConfig object (InputEmbedContentConfig)

ज़रूरी है. उन इंस्टेंस का इनपुट कॉन्फ़िगरेशन जिन पर बैच प्रोसेसिंग की जाती है.

priority string (int64 format)

ज़रूरी नहीं. बैच की प्राथमिकता. ज़्यादा प्राथमिकता वाली वैल्यू वाले बैच, कम प्राथमिकता वाली वैल्यू वाले बैच से पहले प्रोसेस किए जाएंगे. नेगेटिव वैल्यू इस्तेमाल की जा सकती हैं. डिफ़ॉल्ट वैल्यू 0 है.

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

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

EmbedContentRequest

मॉडल को एम्बेड करने के लिए, Content वाला अनुरोध.

Fields
model string

ज़रूरी है. मॉडल के संसाधन का नाम. यह मॉडल के लिए आईडी के तौर पर काम करता है.

यह नाम, ListModels तरीके से मिले मॉडल के नाम से मेल खाना चाहिए.

फ़ॉर्मैट: models/{model}

content object (Content)

ज़रूरी है. एम्बेड करने के लिए कॉन्टेंट. सिर्फ़ parts.text फ़ील्ड को गिना जाएगा.

taskType
(deprecated) enum (TaskType)

ज़रूरी नहीं. इस्तेमाल बंद कर दिया गया है: इसके बजाय, कृपया EmbedContentConfig.task_type का इस्तेमाल करें. टास्क का वह टाइप जिसके लिए एम्बेडिंग का इस्तेमाल किया जाएगा. यह ज़रूरी नहीं है. यह सुविधा, पुराने मॉडल (models/embedding-001) पर काम नहीं करती.

title
(deprecated) string

ज़रूरी नहीं. इस्तेमाल बंद कर दिया गया है: इसके बजाय, कृपया EmbedContentConfig.title का इस्तेमाल करें. टेक्स्ट के लिए टाइटल. हालांकि, यह ज़रूरी नहीं है. यह सिर्फ़ तब लागू होता है, जब TaskType RETRIEVAL_DOCUMENT हो.

ध्यान दें: RETRIEVAL_DOCUMENT के लिए title तय करने से, जानकारी वापस पाने के लिए बेहतर क्वालिटी वाले एम्बेड मिलते हैं.

outputDimensionality
(deprecated) integer

ज़रूरी नहीं. इस्तेमाल बंद कर दिया गया है: इसके बजाय, कृपया EmbedContentConfig.output_dimensionality का इस्तेमाल करें. आउटपुट एम्बेडिंग के लिए, कम किया गया डाइमेंशन (ज़रूरी नहीं). इस विकल्प को सेट करने पर, आउटपुट एम्बेडिंग में मौजूद बहुत ज़्यादा वैल्यू को आखिर से छोटा कर दिया जाता है. यह सुविधा, साल 2024 से सिर्फ़ नए मॉडल पर काम करती है. अगर पहले वाले मॉडल (models/embedding-001) का इस्तेमाल किया जा रहा है, तो इस वैल्यू को सेट नहीं किया जा सकता.

embedContentConfig object (EmbedContentConfig)

ज़रूरी नहीं. EmbedContent अनुरोध के लिए कॉन्फ़िगरेशन.

JSON के काेड में दिखाना 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer,
  "embedContentConfig": {
    object (EmbedContentConfig)
  }
}

REST रिसॉर्स: batches

संसाधन: ऑपरेशन

यह संसाधन, ज़्यादा समय तक चलने वाली कार्रवाई को दिखाता है. यह कार्रवाई, नेटवर्क एपीआई कॉल का नतीजा है.

Fields
name string

सर्वर की ओर से असाइन किया गया नाम. यह नाम सिर्फ़ उसी सेवा के लिए यूनीक होता है जो इसे पहली बार दिखाती है. अगर डिफ़ॉल्ट एचटीटीपी मैपिंग का इस्तेमाल किया जाता है, तो name एक संसाधन का नाम होना चाहिए. इसका आखिरी हिस्सा operations/{unique_id} होना चाहिए.

metadata object

कार्रवाई से जुड़ा, सेवा के हिसाब से मेटाडेटा. आम तौर पर, इसमें प्रोग्रेस की जानकारी और सामान्य मेटाडेटा होता है. जैसे, बनाने का समय. ऐसा हो सकता है कि कुछ सेवाएं इस तरह का मेटाडेटा उपलब्ध न कराएं. लंबे समय तक चलने वाली कार्रवाई को वापस लाने वाले किसी भी तरीके को मेटाडेटा टाइप के बारे में जानकारी देनी चाहिए.

एक ऑब्जेक्ट, जिसमें आर्बिट्ररी टाइप के अलग-अलग फ़ील्ड शामिल हों. एक ऐसा अतिरिक्त फ़ील्ड "@type" जिसमें टाइप की पहचान करने वाला यूआरआई हो. उदाहरण: { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

अगर वैल्यू false है, तो इसका मतलब है कि कार्रवाई अब भी चल रही है. अगर वैल्यू true है, तो कार्रवाई पूरी हो गई है और error या response उपलब्ध है.

result Union type
कार्रवाई का नतीजा, जो error या मान्य response हो सकता है. अगर वैल्यू done == false है, तो न तो error और न ही response सेट है. अगर वैल्यू done == true है, तो error या response में से सिर्फ़ एक को सेट किया जा सकता है. ऐसा हो सकता है कि कुछ सेवाएं, नतीजे न दिखाएं. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
error object (Status)

अगर कार्रवाई पूरी नहीं होती है या रद्द हो जाती है, तो गड़बड़ी का नतीजा.

response object

कार्रवाई का सामान्य और सही रिस्पॉन्स. अगर मूल तरीके से डेटा नहीं मिलता है, जैसे कि Delete, तो जवाब google.protobuf.Empty होता है. अगर ओरिजनल तरीका स्टैंडर्ड Get/Create/Update है, तो जवाब संसाधन होना चाहिए. अन्य तरीकों के लिए, जवाब में टाइप XxxResponse होना चाहिए. यहां Xxx, मूल तरीके का नाम है. उदाहरण के लिए, अगर मूल तरीके का नाम TakeSnapshot() है, तो अनुमानित जवाब का टाइप TakeSnapshotResponse है.

एक ऑब्जेक्ट, जिसमें आर्बिट्ररी टाइप के अलग-अलग फ़ील्ड शामिल हों. एक ऐसा अतिरिक्त फ़ील्ड "@type" जिसमें टाइप की पहचान करने वाला यूआरआई हो. उदाहरण: { "id": 1234, "@type": "types.example.com/standard/id" }.

एक-दूसरे से अलग फ़ील्ड के आखिर में.
JSON के काेड में दिखाना 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

GenerateContentBatch

GenerateContent अनुरोधों के बैच को दिखाने वाला संसाधन.

Fields
model string

ज़रूरी है. Model का नाम, जिसका इस्तेमाल जवाब जनरेट करने के लिए किया जाएगा.

फ़ॉर्मैट: models/{model}.

name string

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

फ़ॉर्मैट: batches/{batchId}.

displayName string

ज़रूरी है. इस बैच का उपयोगकर्ता के तय किया गया नाम.

inputConfig object (InputConfig)

ज़रूरी है. उन इंस्टेंस का इनपुट कॉन्फ़िगरेशन जिन पर बैच प्रोसेसिंग की जाती है.

output object (GenerateContentBatchOutput)

सिर्फ़ आउटपुट के लिए. बैच अनुरोध का आउटपुट.

createTime string (Timestamp format)

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

यह आरएफ़सी 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".

endTime string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह समय जब बैच प्रोसेसिंग पूरी हुई.

यह आरएफ़सी 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)

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

यह आरएफ़सी 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".

batchStats object (BatchStats)

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

state enum (BatchState)

सिर्फ़ आउटपुट के लिए. बैच की स्थिति.

priority string (int64 format)

ज़रूरी नहीं. बैच की प्राथमिकता. ज़्यादा प्राथमिकता वाली वैल्यू वाले बैच, कम प्राथमिकता वाली वैल्यू वाले बैच से पहले प्रोसेस किए जाएंगे. नेगेटिव वैल्यू इस्तेमाल की जा सकती हैं. डिफ़ॉल्ट वैल्यू 0 है.

JSON के काेड में दिखाना 
{
  "model": string,
  "name": string,
  "displayName": string,
  "inputConfig": {
    object (InputConfig)
  },
  "output": {
    object (GenerateContentBatchOutput)
  },
  "createTime": string,
  "endTime": string,
  "updateTime": string,
  "batchStats": {
    object (BatchStats)
  },
  "state": enum (BatchState),
  "priority": string
}

InputConfig

यह फ़ंक्शन, बैच अनुरोध के लिए इनपुट कॉन्फ़िगर करता है.

फ़ील्ड
source Union type
ज़रूरी है. इनपुट का सोर्स. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
fileName string

File का नाम, जिसमें इनपुट के अनुरोध शामिल हैं.

requests object (InlinedRequests)

बैच में प्रोसेस किए जाने वाले अनुरोध.

एक-दूसरे से अलग फ़ील्ड के आखिर में.
JSON के काेड में दिखाना 
{

  // source
  "fileName": string,
  "requests": {
    object (InlinedRequests)
  }
  // Union type
}

InlinedRequests

अगर बैच बनाने के अनुरोध के साथ अनुरोधों की जानकारी दी गई है, तो बैच में प्रोसेस किए जाने वाले अनुरोध.

Fields
requests[] object (InlinedRequest)

ज़रूरी है. बैच में प्रोसेस किए जाने वाले अनुरोध.

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

InlinedRequest

बैच में प्रोसेस किए जाने का अनुरोध.

Fields
request object (GenerateContentRequest)

ज़रूरी है. बैच में प्रोसेस किए जाने का अनुरोध.

metadata object (Struct format)

ज़रूरी नहीं. अनुरोध से जोड़ा जाने वाला मेटाडेटा.

JSON के काेड में दिखाना 
{
  "request": {
    object (GenerateContentRequest)
  },
  "metadata": {
    object
  }
}

GenerateContentBatchOutput

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

फ़ील्ड
output Union type
बैच अनुरोध का आउटपुट. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
responsesFile string

सिर्फ़ आउटपुट के लिए. जवाबों वाली फ़ाइल का आईडी. यह फ़ाइल JSONL फ़ॉर्मैट में होगी. इसमें हर लाइन में एक जवाब होगा. जवाब, JSON फ़ॉर्मैट में GenerateContentResponse मैसेज के तौर पर मिलेंगे. जवाब, इनपुट अनुरोधों के क्रम में लिखे जाएंगे.

inlinedResponses object (InlinedResponses)

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

एक-दूसरे से अलग फ़ील्ड के आखिर में.
JSON के काेड में दिखाना 
{

  // output
  "responsesFile": string,
  "inlinedResponses": {
    object (InlinedResponses)
  }
  // Union type
}

InlinedResponses

बैच में मौजूद अनुरोधों के जवाब.

Fields
inlinedResponses[] object (InlinedResponse)

सिर्फ़ आउटपुट के लिए. बैच में मौजूद अनुरोधों के जवाब.

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

InlinedResponse

बैच में मौजूद किसी एक अनुरोध का जवाब.

Fields
metadata object (Struct format)

सिर्फ़ आउटपुट के लिए. अनुरोध से जुड़ा मेटाडेटा.

output Union type
अनुरोध का आउटपुट. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
error object (Status)

सिर्फ़ आउटपुट के लिए. अनुरोध को प्रोसेस करते समय हुई गड़बड़ी.

response object (GenerateContentResponse)

सिर्फ़ आउटपुट के लिए. अनुरोध का जवाब.

एक-दूसरे से अलग फ़ील्ड के आखिर में.
JSON के काेड में दिखाना 
{
  "metadata": {
    object
  },

  // output
  "error": {
    object (Status)
  },
  "response": {
    object (GenerateContentResponse)
  }
  // Union type
}

BatchStats

बैच के बारे में आंकड़े.

Fields
requestCount string (int64 format)

सिर्फ़ आउटपुट के लिए. बैच में मौजूद अनुरोधों की संख्या.

successfulRequestCount string (int64 format)

सिर्फ़ आउटपुट के लिए. उन अनुरोधों की संख्या जिन्हें प्रोसेस किया गया.

failedRequestCount string (int64 format)

सिर्फ़ आउटपुट के लिए. उन अनुरोधों की संख्या जिन्हें प्रोसेस नहीं किया जा सका.

pendingRequestCount string (int64 format)

सिर्फ़ आउटपुट के लिए. ऐसे अनुरोधों की संख्या जिन्हें अब भी प्रोसेस किया जाना बाकी है.

JSON के काेड में दिखाना 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

BatchState

बैच की स्थिति.

Enums
BATCH_STATE_UNSPECIFIED बैच के स्टेटस की जानकारी नहीं दी गई है.
BATCH_STATE_PENDING यह सेवा, बैच को चलाने की तैयारी कर रही है.
BATCH_STATE_RUNNING बैच की प्रोसेस जारी है.
BATCH_STATE_SUCCEEDED बैच पूरा हो गया.
BATCH_STATE_FAILED बैच पूरा नहीं हो सका.
BATCH_STATE_CANCELLED बैच रद्द कर दिया गया है.
BATCH_STATE_EXPIRED बैच की समयसीमा खत्म हो गई है.

ServiceTier

अनुरोध का सेवा स्तर.

Enums
unspecified डिफ़ॉल्ट सेवा टियर, जो स्टैंडर्ड है.
standard स्टैंडर्ड सेवा का टियर.
flex Flex सेवा का टियर.
priority प्राथमिकता वाला सर्विस टियर.