Gemini API, इमेज, ऑडियो, कोड, टूल वगैरह की मदद से कॉन्टेंट जनरेट करने की सुविधा देता है. इनमें से हर सुविधा के बारे में ज़्यादा जानने के लिए, आगे पढ़ें और टास्क पर फ़ोकस करने वाले सैंपल कोड देखें. इसके अलावा, पूरी जानकारी वाली गाइड भी पढ़ें.
- टेक्स्ट जनरेट करना
- Vision
- ऑडियो
- बड़ा कॉन्टेक्स्ट
- कोड चलाना
- JSON मोड
- फ़ंक्शन कॉल
- सिस्टम से जुड़े निर्देश
तरीका: models.generateContent
किसी इनपुट GenerateContentRequest
के आधार पर, मॉडल का जवाब जनरेट करता है. इस्तेमाल से जुड़ी ज़्यादा जानकारी के लिए, टेक्स्ट जनरेशन गाइड देखें. अलग-अलग मॉडल के लिए इनपुट की सुविधाएं अलग-अलग होती हैं. इनमें ट्यून किए गए मॉडल भी शामिल हैं. ज़्यादा जानकारी के लिए, मॉडल गाइड और ट्यूनिंग गाइड देखें.
एंडपॉइंट
पोस्टhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
model
string
ज़रूरी है. Model
का नाम, जिसका इस्तेमाल पूरा होने की जानकारी जनरेट करने के लिए किया जाएगा.
फ़ॉर्मैट: models/{model}
. यह models/{model}
फ़ॉर्मैट में होता है.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में, नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:
tools[]
object (Tool
)
ज़रूरी नहीं. Tools
की सूची, जिसका इस्तेमाल Model
अगला रिस्पॉन्स जनरेट करने के लिए कर सकता है.
Tool
एक कोड है, जो सिस्टम को बाहरी सिस्टम के साथ इंटरैक्ट करने की सुविधा देता है. इससे सिस्टम, Model
के दायरे और जानकारी के बाहर कोई कार्रवाई या कार्रवाइयों का सेट कर सकता है. Tool
के तौर पर Function
और codeExecution
का इस्तेमाल किया जा सकता है. ज़्यादा जानने के लिए, फ़ंक्शन कॉल करने और कोड लागू करने से जुड़ी गाइड देखें.
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 का इस्तेमाल किया जा सकता है. सुरक्षा से जुड़ी उपलब्ध सेटिंग के बारे में ज़्यादा जानकारी के लिए, गाइड देखें. अपने एआई ऐप्लिकेशन में सुरक्षा से जुड़ी बातों को शामिल करने का तरीका जानने के लिए, सुरक्षा से जुड़े दिशा-निर्देश भी पढ़ें.
systemInstruction
object (Content
)
ज़रूरी नहीं. डेवलपर ने सिस्टम के लिए निर्देश सेट किए हैं. फ़िलहाल, सिर्फ़ टेक्स्ट.
generationConfig
object (GenerationConfig
)
ज़रूरी नहीं. मॉडल जनरेशन और आउटपुट के लिए कॉन्फ़िगरेशन के विकल्प.
cachedContent
string
ज़रूरी नहीं. कैश मेमोरी में सेव किए गए कॉन्टेंट का नाम. इसका इस्तेमाल, अनुमान दिखाने के लिए कॉन्टेक्स्ट के तौर पर किया जाता है. फ़ॉर्मैट: cachedContents/{cachedContent}
अनुरोध का उदाहरण
टेक्स्ट
Python
Node.js
शुरू करें
शेल
Kotlin
Swift
Dart
Java
इमेज
Python
Node.js
शुरू करें
शेल
Kotlin
Swift
Dart
Java
ऑडियो
Python
Node.js
शेल
वीडियो
Python
Node.js
शुरू करें
शेल
Python
शेल
चैट करें
Python
Node.js
शुरू करें
शेल
Kotlin
Swift
Dart
Java
कैश
Python
Node.js
ट्यून किया गया मॉडल
Python
JSON मोड
Python
Node.js
शुरू करें
शेल
Kotlin
Swift
Dart
Java
कोड को चलाना
Python
Kotlin
Java
फ़ंक्शन कॉल करना
Python
Node.js
शेल
Kotlin
Swift
Dart
Java
जनरेशन कॉन्फ़िगरेशन
Python
Node.js
शुरू करें
शेल
Kotlin
Swift
Dart
Java
सुरक्षा सेटिंग
Python
Node.js
शुरू करें
शेल
Kotlin
Swift
Dart
Java
सिस्टम से जुड़े निर्देश
Python
Node.js
शुरू करें
शेल
Kotlin
Swift
Dart
Java
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में GenerateContentResponse
का एक इंस्टेंस शामिल किया जाता है.
तरीका: models.streamGenerateContent
इनपुट GenerateContentRequest
के आधार पर, मॉडल से स्ट्रीम किया गया जवाब जनरेट करता है.
एंडपॉइंट
पोस्टhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
model
string
ज़रूरी है. Model
का नाम, जिसका इस्तेमाल पूरा होने की जानकारी जनरेट करने के लिए किया जाएगा.
फ़ॉर्मैट: models/{model}
. यह models/{model}
फ़ॉर्मैट में होता है.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में, नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:
tools[]
object (Tool
)
ज़रूरी नहीं. Tools
की सूची, जिसका इस्तेमाल Model
अगला रिस्पॉन्स जनरेट करने के लिए कर सकता है.
Tool
एक कोड है, जो सिस्टम को बाहरी सिस्टम के साथ इंटरैक्ट करने की सुविधा देता है. इससे सिस्टम, Model
के दायरे और जानकारी के बाहर कोई कार्रवाई या कार्रवाइयों का सेट कर सकता है. Tool
के तौर पर Function
और codeExecution
का इस्तेमाल किया जा सकता है. ज़्यादा जानने के लिए, फ़ंक्शन कॉल करने और कोड लागू करने से जुड़ी गाइड देखें.
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 का इस्तेमाल किया जा सकता है. सुरक्षा से जुड़ी उपलब्ध सेटिंग के बारे में ज़्यादा जानकारी के लिए, गाइड देखें. अपने एआई ऐप्लिकेशन में सुरक्षा से जुड़ी बातों को शामिल करने का तरीका जानने के लिए, सुरक्षा से जुड़े दिशा-निर्देश भी पढ़ें.
systemInstruction
object (Content
)
ज़रूरी नहीं. डेवलपर ने सिस्टम के लिए निर्देश सेट किए हैं. फ़िलहाल, सिर्फ़ टेक्स्ट.
generationConfig
object (GenerationConfig
)
ज़रूरी नहीं. मॉडल जनरेशन और आउटपुट के लिए कॉन्फ़िगरेशन के विकल्प.
cachedContent
string
ज़रूरी नहीं. कैश मेमोरी में सेव किए गए कॉन्टेंट का नाम. इसका इस्तेमाल, अनुमान दिखाने के लिए कॉन्टेक्स्ट के तौर पर किया जाता है. फ़ॉर्मैट: cachedContents/{cachedContent}
अनुरोध का उदाहरण
टेक्स्ट
Python
Node.js
शुरू करें
शेल
Kotlin
Swift
Dart
Java
इमेज
Python
Node.js
शुरू करें
शेल
Kotlin
Swift
Dart
Java
ऑडियो
Python
शेल
वीडियो
Python
Node.js
शुरू करें
शेल
Python
शेल
चैट करें
Python
Node.js
शुरू करें
शेल
Kotlin
Swift
Dart
Java
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में GenerateContentResponse
इंस्टेंस की स्ट्रीम शामिल होती है.
GenerateContentResponse
मॉडल से मिला जवाब, जिसमें एक से ज़्यादा उम्मीदवारों के जवाब शामिल हैं.
सुरक्षा रेटिंग और कॉन्टेंट फ़िल्टर करने की सुविधा की जानकारी, GenerateContentResponse.prompt_feedback
में मौजूद दोनों प्रॉम्प्ट के लिए दी जाती है. साथ ही, finishReason
और safetyRatings
में मौजूद हर उम्मीदवार के लिए भी यह जानकारी दी जाती है. एपीआई: - अनुरोध किए गए सभी उम्मीदवारों को दिखाता है या कोई भी नहीं दिखाता - सिर्फ़ तब कोई उम्मीदवार नहीं दिखाता, जब प्रॉम्प्ट में कोई गड़बड़ी हो promptFeedback
देखें - finishReason
और safetyRatings
में हर उम्मीदवार के बारे में सुझाव/राय/शिकायत दिखाता है.
candidates[]
object (Candidate
)
मॉडल से मिले उम्मीदवार के जवाब.
promptFeedback
object (PromptFeedback
)
कॉन्टेंट के फ़िल्टर से जुड़े प्रॉम्प्ट का सुझाव/राय या शिकायत दिखाता है.
usageMetadata
object (UsageMetadata
)
सिर्फ़ आउटपुट के लिए. जनरेट करने के अनुरोधों के टोकन के इस्तेमाल से जुड़ा मेटाडेटा.
modelVersion
string
सिर्फ़ आउटपुट के लिए. जवाब जनरेट करने के लिए इस्तेमाल किया गया मॉडल वर्शन.
JSON के काेड में दिखाना |
---|
{ "candidates": [ { object ( |
PromptFeedback
GenerateContentRequest.content
में बताए गए प्रॉम्प्ट के फ़ीडबैक मेटाडेटा का सेट.
blockReason
enum (BlockReason
)
ज़रूरी नहीं. अगर यह सेट है, तो प्रॉम्प्ट को ब्लॉक कर दिया गया था और कोई उम्मीदवार नहीं मिला. प्रॉम्प्ट को फिर से लिखें.
safetyRatings[]
object (SafetyRating
)
प्रॉम्प्ट की सुरक्षा के लिए रेटिंग. हर कैटगरी के लिए ज़्यादा से ज़्यादा एक रेटिंग दी जा सकती है.
JSON के काेड में दिखाना |
---|
{ "blockReason": enum ( |
BlockReason
प्रॉम्प्ट को ब्लॉक किए जाने की वजह बताता है.
Enums | |
---|---|
BLOCK_REASON_UNSPECIFIED |
डिफ़ॉल्ट मान. इस वैल्यू का इस्तेमाल नहीं किया जाता. |
SAFETY |
सुरक्षा से जुड़ी वजहों से, प्रॉम्प्ट को ब्लॉक कर दिया गया है. safetyRatings की जांच करके देखें कि सुरक्षा से जुड़ी किस कैटगरी ने इसे ब्लॉक किया है. |
OTHER |
प्रॉम्प्ट को किसी अज्ञात वजह से ब्लॉक किया गया था. |
BLOCKLIST |
ब्लॉक किए गए शब्दों की सूची में शामिल शब्दों की वजह से, प्रॉम्प्ट को ब्लॉक कर दिया गया था. |
PROHIBITED_CONTENT |
पाबंदी वाले कॉन्टेंट की वजह से प्रॉम्प्ट को ब्लॉक कर दिया गया. |
UsageMetadata
जनरेट करने के अनुरोध के टोकन के इस्तेमाल से जुड़ा मेटाडेटा.
promptTokenCount
integer
प्रॉम्प्ट में टोकन की संख्या. cachedContent
सेट होने पर भी, यह प्रॉम्प्ट का कुल साइज़ होता है. इसका मतलब है कि इसमें कैश मेमोरी में सेव किए गए कॉन्टेंट में मौजूद टोकन की संख्या शामिल होती है.
cachedContentTokenCount
integer
प्रॉम्प्ट के कैश मेमोरी में सेव किए गए हिस्से (कैश मेमोरी में सेव किया गया कॉन्टेंट) में मौजूद टोकन की संख्या
candidatesTokenCount
integer
जनरेट किए गए सभी संभावित जवाबों में मौजूद टोकन की कुल संख्या.
totalTokenCount
integer
जनरेट करने के अनुरोध (प्रॉम्प्ट + जवाब के उम्मीदवार) के लिए टोकन की कुल संख्या.
JSON के काेड में दिखाना |
---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "totalTokenCount": integer } |
उम्मीदवार
- JSON काेड में दिखाना
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- वेब
- GroundingSupport
- सेगमेंट
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- उम्मीदवार
मॉडल से जनरेट किया गया जवाब.
content
object (Content
)
सिर्फ़ आउटपुट के लिए. मॉडल से जनरेट किया गया कॉन्टेंट.
finishReason
enum (FinishReason
)
ज़रूरी नहीं. सिर्फ़ आउटपुट के लिए. मॉडल ने टोकन जनरेट करना क्यों बंद कर दिया.
अगर यह फ़ील्ड खाली है, तो इसका मतलब है कि मॉडल ने टोकन जनरेट करना बंद नहीं किया है.
safetyRatings[]
object (SafetyRating
)
जवाब के लिए चुने गए उम्मीदवार की सुरक्षा से जुड़ी रेटिंग की सूची.
हर कैटगरी के लिए ज़्यादा से ज़्यादा एक रेटिंग दी जा सकती है.
citationMetadata
object (CitationMetadata
)
सिर्फ़ आउटपुट के लिए. मॉडल से जनरेट किए गए उम्मीदवार के लिए, उद्धरण की जानकारी.
content
में शामिल किसी भी टेक्स्ट के लिए, इस फ़ील्ड में पाठ पढ़ने की जानकारी अपने-आप भर सकती है. ये ऐसे पैसेज हैं जिन्हें फ़ाउंडेशनल एलएलएम के ट्रेनिंग डेटा में, कॉपीराइट वाले कॉन्टेंट से "पढ़ा" गया है.
tokenCount
integer
सिर्फ़ आउटपुट के लिए. इस उम्मीदवार के लिए टोकन की संख्या.
groundingAttributions[]
object (GroundingAttribution
)
सिर्फ़ आउटपुट के लिए. सटीक जवाब देने में मदद करने वाले सोर्स के लिए एट्रिब्यूशन की जानकारी.
यह फ़ील्ड, GenerateAnswer
कॉल के लिए पॉप्युलेट होता है.
groundingMetadata
object (GroundingMetadata
)
सिर्फ़ आउटपुट के लिए. उम्मीदवार के लिए ग्राउंडिंग मेटाडेटा.
यह फ़ील्ड, GenerateContent
कॉल के लिए पॉप्युलेट होता है.
avgLogprobs
number
सिर्फ़ आउटपुट के लिए. उम्मीदवार का औसत लॉग प्रॉबबिलिटी स्कोर.
logprobsResult
object (LogprobsResult
)
सिर्फ़ आउटपुट के लिए. जवाब के टोकन और टॉप टोकन के लिए लॉग-लायकलीहुड स्कोर
index
integer
सिर्फ़ आउटपुट के लिए. जवाब देने वाले उम्मीदवारों की सूची में उम्मीदवार का इंडेक्स.
JSON के काेड में दिखाना |
---|
{ "content": { object ( |
FinishReason
इससे यह पता चलता है कि मॉडल ने टोकन जनरेट करना क्यों बंद कर दिया.
Enums | |
---|---|
FINISH_REASON_UNSPECIFIED |
डिफ़ॉल्ट मान. इस वैल्यू का इस्तेमाल नहीं किया जाता. |
STOP |
मॉडल का नैचुरल स्टॉप पॉइंट या दिया गया स्टॉप सीक्वेंस. |
MAX_TOKENS |
अनुरोध में बताई गई टोकन की ज़्यादा से ज़्यादा संख्या तक पहुंच गया. |
SAFETY |
सुरक्षा से जुड़ी वजहों से, जवाब के तौर पर चुने गए कॉन्टेंट को फ़्लैग किया गया था. |
RECITATION |
जवाब के तौर पर सबमिट किए गए कॉन्टेंट को, पाठ के तौर पर इस्तेमाल करने की वजह से फ़्लैग किया गया था. |
LANGUAGE |
जवाब के लिए सबमिट किए गए कॉन्टेंट को, ऐसी भाषा का इस्तेमाल करने की वजह से फ़्लैग किया गया है जो काम नहीं करती. |
OTHER |
वजह की जानकारी नहीं है. |
BLOCKLIST |
टोकन जनरेशन रुक गया है, क्योंकि कॉन्टेंट में पाबंदी वाले शब्द शामिल हैं. |
PROHIBITED_CONTENT |
ऐसा कॉन्टेंट होने की वजह से, टोकन जनरेट करने की प्रोसेस रोक दी गई है जिस पर पाबंदी है. |
SPII |
टोकन जनरेशन की प्रोसेस रोक दी गई है, क्योंकि कॉन्टेंट में संवेदनशील व्यक्तिगत पहचान से जुड़ी जानकारी (एसपीआईआई) हो सकती है. |
MALFORMED_FUNCTION_CALL |
मॉडल से जनरेट किया गया फ़ंक्शन कॉल अमान्य है. |
GroundingAttribution
किसी सोर्स के लिए एट्रिब्यूशन, जिसने जवाब में योगदान दिया है.
sourceId
object (AttributionSourceId
)
सिर्फ़ आउटपुट के लिए. इस एट्रिब्यूशन में योगदान देने वाले सोर्स का आइडेंटिफ़ायर.
content
object (Content
)
इस एट्रिब्यूशन का आधार बनाने वाला सोर्स कॉन्टेंट.
JSON के काेड में दिखाना |
---|
{ "sourceId": { object ( |
AttributionSourceId
इस एट्रिब्यूशन में योगदान देने वाले सोर्स का आइडेंटिफ़ायर.
source
Union type
source
इनमें से कोई एक हो सकता है:groundingPassage
object (GroundingPassageId
)
इनलाइन पैसेज का आइडेंटिफ़ायर.
semanticRetrieverChunk
object (SemanticRetrieverChunk
)
सिमेंटिक रीट्रिवर की मदद से फ़ेच किए गए Chunk
का आइडेंटिफ़ायर.
JSON के काेड में दिखाना |
---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
GroundingPassage
में मौजूद किसी हिस्से का आइडेंटिफ़ायर.
passageId
string
सिर्फ़ आउटपुट के लिए. GenerateAnswerRequest
के GroundingPassage.id
से मैच करने वाले पैसेज का आईडी.
partIndex
integer
सिर्फ़ आउटपुट के लिए. GenerateAnswerRequest
के GroundingPassage.content
में मौजूद पार्ट का इंडेक्स.
JSON के काेड में दिखाना |
---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
SemanticRetrieverConfig
का इस्तेमाल करके GenerateAnswerRequest
में बताए गए सिमेंटिक रीट्रिवर की मदद से, Chunk
को वापस पाने के लिए आइडेंटिफ़ायर.
source
string
सिर्फ़ आउटपुट के लिए. अनुरोध के SemanticRetrieverConfig.source
से मैच करने वाले सोर्स का नाम. उदाहरण: corpora/123
या corpora/123/documents/abc
chunk
string
सिर्फ़ आउटपुट के लिए. एट्रिब्यूट किया गया टेक्स्ट शामिल करने वाले Chunk
का नाम. उदाहरण: corpora/123/documents/abc/chunks/xyz
JSON के काेड में दिखाना |
---|
{ "source": string, "chunk": string } |
GroundingMetadata
ग्राउंडिंग की सुविधा चालू होने पर, क्लाइंट को मेटाडेटा वापस मिलता है.
groundingChunks[]
object (GroundingChunk
)
तथ्यों की पुष्टि करने वाले रेफ़रंस की सूची, जो तय किए गए सोर्स से लिए गए हैं.
groundingSupports[]
object (GroundingSupport
)
ग्राउंडिंग सपोर्ट की सूची.
webSearchQueries[]
string
फ़ॉलो-अप वेब खोज के लिए वेब खोज क्वेरी.
searchEntryPoint
object (SearchEntryPoint
)
ज़रूरी नहीं. फ़ॉलो-अप वेब खोजों के लिए Google Search एंट्री.
retrievalMetadata
object (RetrievalMetadata
)
ग्राउंडिंग फ़्लो में डेटा वापस पाने से जुड़ा मेटाडेटा.
JSON के काेड में दिखाना |
---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
Google Search का एंट्री पॉइंट.
renderedContent
string
ज़रूरी नहीं. वेब कॉन्टेंट स्निपेट, जिसे वेब पेज या ऐप्लिकेशन वेबव्यू में एम्बेड किया जा सकता है.
sdkBlob
string (bytes format)
ज़रूरी नहीं. Base64 में एन्कोड किया गया JSON, जो <search term, search url> ट्यूपल के कलेक्शन को दिखाता है.
base64 कोड में बदली गई स्ट्रिंग.
JSON के काेड में दिखाना |
---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
ग्राउंडिंग चंक.
chunk_type
Union type
chunk_type
इनमें से कोई एक हो सकता है:web
object (Web
)
वेब से मिला ग्राउंडिंग चंक.
JSON के काेड में दिखाना |
---|
{
// chunk_type
"web": {
object ( |
वेब
वेब से लिया गया हिस्सा.
uri
string
चंक का यूआरआई रेफ़रंस.
title
string
चंक का टाइटल.
JSON के काेड में दिखाना |
---|
{ "uri": string, "title": string } |
GroundingSupport
ग्राउंडिंग सपोर्ट.
groundingChunkIndices[]
integer
'grounding_chunk' में इंडेक्स की सूची, जिसमें दावे से जुड़े उद्धरण की जानकारी दी गई है. उदाहरण के लिए, [1,3,4] का मतलब है कि grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] वह कॉन्टेंट है जिसे दावे के लिए वापस पाया गया है.
confidenceScores[]
number
सहायता से जुड़े रेफ़रंस का कॉन्फ़िडेंस स्कोर. यह वैल्यू 0 से 1 के बीच हो सकती है. 1 का मतलब है कि आपका पूरा भरोसा है. इस सूची का साइज़, groundingChunkIndices के साइज़ के बराबर होना चाहिए.
segment
object (Segment
)
इस सहायता से जुड़े कॉन्टेंट का सेगमेंट.
JSON के काेड में दिखाना |
---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"segment": {
object ( |
सेगमेंट
कॉन्टेंट का सेगमेंट.
partIndex
integer
सिर्फ़ आउटपुट के लिए. पैरंट कॉन्टेंट ऑब्जेक्ट में, किसी पार्ट ऑब्जेक्ट का इंडेक्स.
startIndex
integer
सिर्फ़ आउटपुट के लिए. दिए गए हिस्से में इंडेक्स की शुरुआत, जिसे बाइट में मेज़र किया जाता है. शून्य से शुरू होकर, पार्ट की शुरुआत से ऑफ़सेट.
endIndex
integer
सिर्फ़ आउटपुट के लिए. दिए गए हिस्से का आखिरी इंडेक्स, जिसे बाइट में मेज़र किया जाता है. पार्ट की शुरुआत से ऑफ़सेट, शून्य से शुरू होता है.
text
string
सिर्फ़ आउटपुट के लिए. जवाब के सेगमेंट से जुड़ा टेक्स्ट.
JSON के काेड में दिखाना |
---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
ग्राउंडिंग फ़्लो में डेटा वापस पाने से जुड़ा मेटाडेटा.
googleSearchDynamicRetrievalScore
number
ज़रूरी नहीं. यह स्कोर बताता है कि Google Search से मिली जानकारी से प्रॉम्प्ट का जवाब देने में कितनी मदद मिल सकती है. यह स्कोर [0, 1] की रेंज में होता है. 0 का मतलब है कि आपके चैनल पर दर्शकों के आने की संभावना कम है और 1 का मतलब है कि आपके चैनल पर दर्शकों के आने की संभावना ज़्यादा है. यह स्कोर सिर्फ़ तब दिखता है, जब Google Search ग्राउंडिंग और डाइनैमिक रीट्रिवल की सुविधा चालू हो. Google Search को ट्रिगर करने के लिए, इसकी तुलना थ्रेशोल्ड से की जाएगी.
JSON के काेड में दिखाना |
---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
Logprobs का नतीजा
topCandidates[]
object (TopCandidates
)
लंबाई = डिकोड करने के चरणों की कुल संख्या.
chosenCandidates[]
object (Candidate
)
लंबाई = डिकोड करने के चरणों की कुल संख्या. चुने गए उम्मीदवार, topCandidates में हो सकते हैं या नहीं.
JSON के काेड में दिखाना |
---|
{ "topCandidates": [ { object ( |
TopCandidates
डिकोड करने के हर चरण में, सबसे ज़्यादा लॉग संभावना वाले उम्मीदवार.
candidates[]
object (Candidate
)
लॉग प्रॉबबिलिटी के हिसाब से, घटते क्रम में लगाए गए.
JSON के काेड में दिखाना |
---|
{
"candidates": [
{
object ( |
उम्मीदवार
logprobs टोकन और स्कोर के लिए उम्मीदवार.
token
string
उम्मीदवार के टोकन की स्ट्रिंग वैल्यू.
tokenId
integer
उम्मीदवार के टोकन आईडी की वैल्यू.
logProbability
number
उम्मीदवार की लॉग प्रायिकता.
JSON के काेड में दिखाना |
---|
{ "token": string, "tokenId": integer, "logProbability": number } |
CitationMetadata
किसी कॉन्टेंट के लिए सोर्स एट्रिब्यूशन का कलेक्शन.
citationSources[]
object (CitationSource
)
किसी खास जवाब के लिए सोर्स के हवाले.
JSON के काेड में दिखाना |
---|
{
"citationSources": [
{
object ( |
CitationSource
किसी जवाब के हिस्से के लिए सोर्स का कोटेशन.
startIndex
integer
ज़रूरी नहीं. इस सोर्स से मिले रिस्पॉन्स के सेगमेंट की शुरुआत.
इंडेक्स से सेगमेंट की शुरुआत के बारे में पता चलता है. इसे बाइट में मेज़र किया जाता है.
endIndex
integer
ज़रूरी नहीं. एट्रिब्यूट किए गए सेगमेंट के खत्म होने का समय (अलग से उपलब्ध).
uri
string
ज़रूरी नहीं. टेक्स्ट के किसी हिस्से के सोर्स के तौर पर एट्रिब्यूट किया गया यूआरआई.
license
string
ज़रूरी नहीं. उस GitHub प्रोजेक्ट का लाइसेंस जिसे सेगमेंट के सोर्स के तौर पर एट्रिब्यूट किया गया है.
कोड के हवाले के लिए, लाइसेंस की जानकारी देना ज़रूरी है.
JSON के काेड में दिखाना |
---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
GenerationConfig
मॉडल जनरेशन और आउटपुट के लिए कॉन्फ़िगरेशन के विकल्प. हर मॉडल के लिए, सभी पैरामीटर कॉन्फ़िगर नहीं किए जा सकते.
stopSequences[]
string
ज़रूरी नहीं. वर्णों के क्रम का सेट (ज़्यादा से ज़्यादा पांच), जो आउटपुट जनरेशन को रोक देगा. अगर एपीआई को stop_sequence
के दिखने पर रोकना है, तो इसकी जानकारी दें. जवाब के हिस्से के तौर पर, स्टॉप सीक्वेंस शामिल नहीं किया जाएगा.
responseMimeType
string
ज़रूरी नहीं. जनरेट किए गए टेक्स्ट का MIME टाइप. इन एमआईएमई टाइप का इस्तेमाल किया जा सकता है: text/plain
: (डिफ़ॉल्ट) टेक्स्ट आउटपुट. application/json
: जवाब के विकल्पों में JSON रिस्पॉन्स. text/x.enum
: जवाब के विकल्पों में स्ट्रिंग के तौर पर ENUM. काम करने वाले सभी टेक्स्ट MIME टाइप की सूची के लिए, दस्तावेज़ देखें.
responseSchema
object (Schema
)
ज़रूरी नहीं. जनरेट किए गए टेक्स्ट का आउटपुट स्कीमा. स्कीमा, OpenAPI स्कीमा का सबसेट होना चाहिए. साथ ही, ये ऑब्जेक्ट, प्राइमिटिव या कलेक्शन हो सकते हैं.
अगर यह सेट है, तो साथ काम करने वाला responseMimeType
भी सेट होना चाहिए. काम करने वाले MIME टाइप: application/json
: JSON रिस्पॉन्स के लिए स्कीमा. ज़्यादा जानकारी के लिए, JSON टेक्स्ट जनरेट करने से जुड़ी गाइड देखें.
candidateCount
integer
ज़रूरी नहीं. जनरेट किए गए जवाबों की संख्या.
फ़िलहाल, इस वैल्यू को सिर्फ़ 1 पर सेट किया जा सकता है. अगर यह सेट नहीं है, तो यह डिफ़ॉल्ट रूप से 1 पर सेट हो जाएगा.
maxOutputTokens
integer
ज़रूरी नहीं. किसी संभावित जवाब में शामिल किए जाने वाले टोकन की ज़्यादा से ज़्यादा संख्या.
ध्यान दें: डिफ़ॉल्ट वैल्यू, मॉडल के हिसाब से अलग-अलग होती है. getModel
फ़ंक्शन से मिली Model
की Model.output_token_limit
एट्रिब्यूट देखें.
temperature
number
ज़रूरी नहीं. इससे आउटपुट में रैंडमिटी को कंट्रोल किया जाता है.
ध्यान दें: डिफ़ॉल्ट वैल्यू, मॉडल के हिसाब से अलग-अलग होती है. getModel
फ़ंक्शन से मिली Model
की Model.temperature
एट्रिब्यूट देखें.
वैल्यू [0.0, 2.0] के बीच हो सकती हैं.
topP
number
ज़रूरी नहीं. सैंपलिंग के दौरान, टोकन की ज़्यादा से ज़्यादा संभावित संभावना.
यह मॉडल, टॉप-k और टॉप-p (न्यूक्लियस) सैंपलिंग का इस्तेमाल करता है.
टोकन को असाइन की गई संभावनाओं के आधार पर क्रम में लगाया जाता है, ताकि सिर्फ़ सबसे सही टोकन का इस्तेमाल किया जा सके. टॉप-k सैंपलिंग, सीधे तौर पर टोकन की ज़्यादा से ज़्यादा संख्या को सीमित करती है. वहीं, न्यूक्लियस सैंपलिंग, कुल संभावना के आधार पर टोकन की संख्या को सीमित करती है.
ध्यान दें: डिफ़ॉल्ट वैल्यू, Model
के हिसाब से अलग-अलग होती है. इसे getModel
फ़ंक्शन से दिखाए गए Model.top_p
एट्रिब्यूट से तय किया जाता है. खाली topK
एट्रिब्यूट से पता चलता है कि मॉडल, टॉप-क्यू सैंपलिंग लागू नहीं करता और अनुरोधों पर topK
सेट करने की अनुमति नहीं देता.
topK
integer
ज़रूरी नहीं. सैंपलिंग करते समय, टोकन की ज़्यादा से ज़्यादा संख्या.
Gemini मॉडल, Top-p (न्यूक्लियस) सैंपलिंग या Top-k और न्यूक्लियस सैंपलिंग के कॉम्बिनेशन का इस्तेमाल करते हैं. टॉप-k सैंपलिंग में, topK
सबसे संभावित टोकन का सेट शामिल होता है. न्यूक्लियस सैंपलिंग के साथ चलने वाले मॉडल में, टॉपK सेटिंग की अनुमति नहीं है.
ध्यान दें: डिफ़ॉल्ट वैल्यू, Model
के हिसाब से अलग-अलग होती है. इसे getModel
फ़ंक्शन से दिखाए गए Model.top_p
एट्रिब्यूट से तय किया जाता है. खाली topK
एट्रिब्यूट से पता चलता है कि मॉडल, टॉप-क्यू सैंपलिंग लागू नहीं करता और अनुरोधों पर topK
सेट करने की अनुमति नहीं देता.
presencePenalty
number
ज़रूरी नहीं. अगर टोकन, जवाब में पहले से मौजूद है, तो अगले टोकन के लॉगप्रोब पर मौजूदगी की वजह से जुर्माना लगाया जाता है.
यह जुर्माना, बाइनरी मोड में चालू/बंद होता है. यह इस बात पर निर्भर नहीं करता कि टोकन का इस्तेमाल पहली बार के बाद कितनी बार किया गया है. हर बार इस्तेमाल करने पर बढ़ने वाली पेनल्टी के लिए, frequencyPenalty
का इस्तेमाल करें.
सकारात्मक दंड से, उन टोकन का इस्तेमाल कम हो जाएगा जिनका इस्तेमाल जवाब में पहले ही किया जा चुका है. इससे, शब्दावली बढ़ेगी.
नेगेटिव पेनल्टी से, उन टोकन का इस्तेमाल बढ़ावा मिलेगा जिनका इस्तेमाल जवाब में पहले ही किया जा चुका है. इससे शब्दावली कम हो जाएगी.
frequencyPenalty
number
ज़रूरी नहीं. अगले टोकन के लॉगप्रोब्स पर लागू होने वाली फ़्रीक्वेंसी की पेनल्टी को, अब तक रिस्पॉन्स में हर टोकन को देखे जाने की संख्या से गुणा किया जाता है.
पॉज़िटिव पेनल्टी से, पहले से इस्तेमाल किए जा चुके टोक़न का इस्तेमाल कम किया जा सकेगा. यह टोक़न के इस्तेमाल की संख्या के हिसाब से होगा: किसी टोक़न का जितने ज़्यादा इस्तेमाल किया जाता है, मॉडल के लिए उस टोक़न का फिर से इस्तेमाल करना उतना ही मुश्किल होता है. इससे जवाबों की शब्दावली बढ़ती है.
ध्यान दें: नेगेटिव जुर्माने से मॉडल को टोकन का फिर से इस्तेमाल करने के लिए बढ़ावा मिलेगा. यह इस्तेमाल किए गए टोकन की संख्या के हिसाब से होगा. छोटी नेगेटिव वैल्यू से, जवाब में इस्तेमाल होने वाले शब्दों की संख्या कम हो जाएगी. ज़्यादा नेगेटिव वैल्यू से, मॉडल किसी सामान्य टोकन को तब तक दोहराता रहेगा, जब तक वह maxOutputTokens
की सीमा तक नहीं पहुंच जाता.
responseLogprobs
boolean
ज़रूरी नहीं. अगर यह सही है, तो जवाब में logprobs के नतीजे एक्सपोर्ट करें.
logprobs
integer
ज़रूरी नहीं. सिर्फ़ तब मान्य है, जब responseLogprobs=True
हो. इससे Candidate.logprobs_result
में, डिकोडिंग के हर चरण में सबसे ज़्यादा लॉगप्रोब की संख्या तय होती है.
enableEnhancedCivicAnswers
boolean
ज़रूरी नहीं. बेहतर सिविक जवाबों की सुविधा चालू करता है. ऐसा हो सकता है कि यह सुविधा सभी मॉडल के लिए उपलब्ध न हो.
JSON के काेड में दिखाना |
---|
{
"stopSequences": [
string
],
"responseMimeType": string,
"responseSchema": {
object ( |
HarmCategory
रेटिंग की कैटगरी.
इन कैटगरी में, नुकसान की अलग-अलग कैटगरी शामिल होती हैं. डेवलपर इनमें बदलाव कर सकते हैं.
Enums | |
---|---|
HARM_CATEGORY_UNSPECIFIED |
कैटगरी की जानकारी नहीं दी गई है. |
HARM_CATEGORY_DEROGATORY |
PaLM - पहचान और/या सुरक्षित एट्रिब्यूट को टारगेट करने वाली नकारात्मक या नुकसान पहुंचाने वाली टिप्पणियां. |
HARM_CATEGORY_TOXICITY |
PaLM - ऐसा कॉन्टेंट जो असभ्य, अपमानजनक या अपशब्दों वाला हो. |
HARM_CATEGORY_VIOLENCE |
PaLM - किसी व्यक्ति या ग्रुप के ख़िलाफ़ हिंसा दिखाने वाले या खून-खराबे की सामान्य जानकारी देने वाले कॉन्टेंट की पहचान करता है. |
HARM_CATEGORY_SEXUAL |
PaLM - इसमें सेक्शुअल ऐक्ट या अश्लील कॉन्टेंट का ज़िक्र किया गया हो. |
HARM_CATEGORY_MEDICAL |
PaLM - बिना जांचे-परखे डॉक्टर से मिलने वाली सलाह का प्रमोशन करता है. |
HARM_CATEGORY_DANGEROUS |
PaLM - खतरनाक कॉन्टेंट, जो नुकसान पहुंचाने वाली गतिविधियों का प्रमोशन करता है, उन्हें लागू करना आसान बनाता है या उन्हें बढ़ावा देता है. |
HARM_CATEGORY_HARASSMENT |
Gemini - उत्पीड़न करने वाला कॉन्टेंट. |
HARM_CATEGORY_HATE_SPEECH |
Gemini - नफ़रत फैलाने वाली भाषा और कॉन्टेंट. |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
Gemini - साफ़ तौर पर सेक्शुअल ऐक्ट दिखाने वाला कॉन्टेंट. |
HARM_CATEGORY_DANGEROUS_CONTENT |
Gemini - खतरनाक कॉन्टेंट. |
HARM_CATEGORY_CIVIC_INTEGRITY |
Gemini - ऐसा कॉन्टेंट जिसका इस्तेमाल, नागरिकों के भरोसे को नुकसान पहुंचाने के लिए किया जा सकता है. |
SafetyRating
कॉन्टेंट के लिए सुरक्षा रेटिंग.
सुरक्षा रेटिंग में, किसी कॉन्टेंट से होने वाले नुकसान की कैटगरी और उस कैटगरी में नुकसान की संभावना का लेवल शामिल होता है. सुरक्षा के लिहाज़ से, कॉन्टेंट को नुकसान पहुंचाने वाली कई कैटगरी में बांटा जाता है. साथ ही, नुकसान पहुंचाने वाली कैटगरी में कॉन्टेंट को बांटने की संभावना यहां दी गई है.
category
enum (HarmCategory
)
ज़रूरी है. इस रेटिंग की कैटगरी.
probability
enum (HarmProbability
)
ज़रूरी है. इस कॉन्टेंट से नुकसान पहुंचने की संभावना.
blocked
boolean
क्या इस रेटिंग की वजह से इस कॉन्टेंट को ब्लॉक किया गया था?
JSON के काेड में दिखाना |
---|
{ "category": enum ( |
HarmProbability
किसी कॉन्टेंट के नुकसान पहुंचाने की संभावना.
कॉन्टेंट की कैटगरी तय करने वाला सिस्टम, कॉन्टेंट के असुरक्षित होने की संभावना बताता है. इससे यह पता नहीं चलता कि किसी कॉन्टेंट से कितना नुकसान हो सकता है.
Enums | |
---|---|
HARM_PROBABILITY_UNSPECIFIED |
संभावना की जानकारी नहीं दी गई है. |
NEGLIGIBLE |
कॉन्टेंट के असुरक्षित होने की संभावना बहुत कम है. |
LOW |
कॉन्टेंट के असुरक्षित होने की संभावना कम है. |
MEDIUM |
कॉन्टेंट के असुरक्षित होने की संभावना मध्यम है. |
HIGH |
कॉन्टेंट के असुरक्षित होने की संभावना ज़्यादा है. |
SafetySetting
सुरक्षा सेटिंग, जिससे सुरक्षा को ब्लॉक करने के तरीके पर असर पड़ता है.
किसी कैटगरी के लिए सुरक्षा सेटिंग सेट करने पर, कॉन्टेंट के ब्लॉक होने की संभावना में बदलाव होता है.
category
enum (HarmCategory
)
ज़रूरी है. इस सेटिंग की कैटगरी.
threshold
enum (HarmBlockThreshold
)
ज़रूरी है. यह संभावना की सीमा को कंट्रोल करता है, जिस पर नुकसान पहुंचाने वाले कॉन्टेंट को ब्लॉक किया जाता है.
JSON के काेड में दिखाना |
---|
{ "category": enum ( |
HarmBlockThreshold
नुकसान की तय संभावना पर और उससे ज़्यादा होने पर ब्लॉक करें.
Enums | |
---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
थ्रेशोल्ड की जानकारी नहीं दी गई है. |
BLOCK_LOW_AND_ABOVE |
NEGLIGIBLE वाले कॉन्टेंट को अनुमति दी जाएगी. |
BLOCK_MEDIUM_AND_ABOVE |
NEGLIGIBLE और LOW के लेबल वाले कॉन्टेंट को दिखाने की अनुमति होगी. |
BLOCK_ONLY_HIGH |
NEGLIGIBLE, LOW, और MEDIUM के लेवल पर रेटिंग वाले कॉन्टेंट को दिखाने की अनुमति होगी. |
BLOCK_NONE |
सभी तरह के कॉन्टेंट को दिखाने की अनुमति होगी. |
OFF |
सुरक्षा फ़िल्टर बंद करें. |