- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति के दायरे
- GroundingPassages
- GroundingPassage
- SemanticRetrieverConfig
- AnswerStyle
- InputFeedback
- BlockReason
GenerateAnswerRequest
इनपुट दिए गए मॉडल से आधार पर जवाब जनरेट करता है.
एचटीटीपी अनुरोध
POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateAnswer
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ के पैरामीटर
पैरामीटर | |
---|---|
model |
ज़रूरी है. तथ्यों के हिसाब से जवाब जनरेट करने के लिए, फ़ॉर्मैट: |
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, इस तरह का डेटा शामिल होता है:
जेएसओएन के काेड में दिखाना |
---|
{ "contents": [ { object ( |
फ़ील्ड | |
---|---|
contents[] |
ज़रूरी है. मॉडल के साथ मौजूदा बातचीत का कॉन्टेंट. सिंगल-टर्न वाली क्वेरी के लिए, सिर्फ़ एक सवाल का जवाब देना. एक से ज़्यादा टर्न वाली क्वेरी के लिए, यह दोहराया गया फ़ील्ड होता है. इसमें बातचीत का इतिहास और सवाल वाली सूची के आखिरी ध्यान दें: model.generateजवाब अभी सिर्फ़ अंग्रेज़ी में क्वेरी के साथ काम करता है. |
answerStyle |
ज़रूरी है. वह शैली जिसमें जवाब दिए जाने चाहिए. |
safetySettings[] |
ज़रूरी नहीं. असुरक्षित कॉन्टेंट को ब्लॉक करने के लिए, इसे |
यूनियन फ़ील्ड grounding_source . ऐसे सोर्स जिसमें जवाब को आधार बनाना है. grounding_source इनमें से सिर्फ़ एक हो सकती है: |
|
inlinePassages |
अनुरोध के हिसाब से पैसेज दिए गए. |
semanticRetriever |
सिमैंटिक रिट्रीवर एपीआई की मदद से बनाए गए संसाधनों से मिला कॉन्टेंट. |
temperature |
ज़रूरी नहीं. आउटपुट की रैंडमनेस को कंट्रोल करता है. वैल्यू [0.0,1.0] के बीच हो सकती हैं. अगर वैल्यू 1.0 के करीब होती है, तो जवाब ज़्यादा अलग-अलग और क्रिएटिव होते हैं. वहीं, 0.0 के करीब होने पर, मॉडल से ज़्यादा आसान रिस्पॉन्स मिलते हैं. आम तौर पर, एट्रिब्यूट किए गए सवाल-जवाब के इस्तेमाल के उदाहरणों के लिए, तापमान कम (~0.2) रखने का सुझाव दिया जाता है. |
जवाब का मुख्य भाग
तथ्यों पर आधारित जवाब के लिए, मॉडल से मिला जवाब.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
जेएसओएन के काेड में दिखाना |
---|
{ "answer": { object ( |
फ़ील्ड | |
---|---|
answer |
मॉडल से उम्मीदवार का जवाब. ध्यान दें: मॉडल हमेशा तथ्यों पर आधारित जवाब देने की कोशिश करता है. भले ही, दिए गए पैसेज में से कोई जवाब दिया जा सकता हो. ऐसे मामले में, कम |
answerableProbability |
सिर्फ़ आउटपुट के लिए. इस बात की संभावना का मॉडल अनुमान कि इसका जवाब सही है और इनपुट पैसेज के आधार पर दिया गया है. कम answerableProbability का मतलब है कि जवाब, सोर्स पर आधारित नहीं है.
|
inputFeedback |
सिर्फ़ आउटपुट के लिए. सवाल के मॉडल से जनरेट किए गए जवाब के बजाय, सवाल का जवाब देने के लिए इस्तेमाल किए गए इनपुट डेटा से जुड़ा सुझाव. "इनपुट डेटा" इनमें से एक या ज़्यादा हो सकता है:
|
अनुमति के दायरे
इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:
https://www.googleapis.com/auth/generative-language
https://www.googleapis.com/auth/generative-language.retriever
https://www.googleapis.com/auth/generative-language.retriever.readonly
https://www.googleapis.com/auth/generative-language.tuning
https://www.googleapis.com/auth/generative-language.tuning.readonly
ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.
GroundingPassages
पैसेज की दोहराई गई सूची.
जेएसओएन के काेड में दिखाना |
---|
{
"passages": [
{
object ( |
फ़ील्ड | |
---|---|
passages[] |
पैसेज की सूची. |
GroundingPassage
पैसेज में ग्राउंडिंग कॉन्फ़िगरेशन के साथ इनलाइन शामिल है.
जेएसओएन के काेड में दिखाना |
---|
{
"id": string,
"content": {
object ( |
फ़ील्ड | |
---|---|
id |
तथ्यों पर आधारित जवाबों में इस पैसेज का एट्रिब्यूट देने के लिए, पैसेज का आइडेंटिफ़ायर. |
content |
पैसेज का कॉन्टेंट. |
SemanticRetrieverConfig
सिमैंटिक रिट्रीवर एपीआई का इस्तेमाल करके बनाए गए Corpus
या Document
से ग्राउंडिंग कॉन्टेंट को वापस पाने के लिए कॉन्फ़िगरेशन.
जेएसओएन के काेड में दिखाना |
---|
{ "source": string, "query": { object ( |
फ़ील्ड | |
---|---|
source |
ज़रूरी है. डेटा वापस पाने के लिए, संसाधन का नाम डालें. जैसे, Corura/123 या Corpara/123/documents/abc. |
query |
ज़रूरी है. दिए गए संसाधन में, समानता |
metadataFilters[] |
ज़रूरी नहीं. संसाधन में से |
maxChunksCount |
ज़रूरी नहीं. फिर से पाने के लिए काम के |
minimumRelevanceScore |
ज़रूरी नहीं. काम के |
AnswerStyle
तथ्यों पर आधारित जवाबों के लिए स्टाइल.
Enums | |
---|---|
ANSWER_STYLE_UNSPECIFIED |
जवाब की स्टाइल नहीं बताई गई है. |
ABSTRACTIVE |
छोटी लेकिन अमूर्त शैली. |
EXTRACTIVE |
यह बहुत छोटा और एक्सट्रैक्टिव स्टाइल है. |
VERBOSE |
ज़्यादा जानकारी सहित वर्बोस शैली. जवाब को वाक्य, पैराग्राफ़, कई पैराग्राफ़ या बुलेट पॉइंट वगैरह के तौर पर फ़ॉर्मैट किया जा सकता है. |
InputFeedback
सवाल के मॉडल से जनरेट किए गए जवाब के बजाय, सवाल का जवाब देने के लिए इस्तेमाल किए गए इनपुट डेटा से जुड़ा सुझाव.
जेएसओएन के काेड में दिखाना |
---|
{ "safetyRatings": [ { object ( |
फ़ील्ड | |
---|---|
safetyRatings[] |
इनपुट की सुरक्षा के लिए रेटिंग. हर कैटगरी के लिए ज़्यादा से ज़्यादा एक रेटिंग है. |
blockReason |
ज़रूरी नहीं. अगर इस नीति को सेट किया जाता है, तो इनपुट को ब्लॉक कर दिया गया था और कोई उम्मीदवार नहीं दिखाया गया. अपने इनपुट को नए तरीके से लिखें. |
BlockReason
इससे पता चलता है कि इनपुट के ब्लॉक होने की वजह क्या थी.
Enums | |
---|---|
BLOCK_REASON_UNSPECIFIED |
डिफ़ॉल्ट मान. इस वैल्यू का इस्तेमाल नहीं किया गया है. |
SAFETY |
सुरक्षा की वजहों से इनपुट ब्लॉक किया गया. safetyRatings की जांच करके, यह पता लगाया जा सकता है कि सुरक्षा की किस कैटगरी ने इसे ब्लॉक किया है. |
OTHER |
अन्य वजहों से इनपुट ब्लॉक किया गया. |