इनपुट मैसेज दिए गए मॉडल से जवाब जनरेट करता है.
एचटीटीपी अनुरोध
POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateText
यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ के पैरामीटर
पैरामीटर | |
---|---|
model |
ज़रूरी है. |
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में इस तरह का डेटा शामिल होता है:
जेएसओएन के काेड में दिखाना |
---|
{ "prompt": { object ( |
फ़ील्ड | |
---|---|
prompt |
ज़रूरी है. मॉडल को प्रॉम्प्ट के तौर पर दिया गया फ़्री-फ़ॉर्म इनपुट टेक्स्ट. प्रॉम्प्ट मिलने पर, यह मॉडल एक Textcomplete रिस्पॉन्स जनरेट करेगा, जिसका अनुमान इनपुट टेक्स्ट के पूरा होने पर लगाया जाएगा. |
safetySettings[] |
ज़रूरी नहीं. असुरक्षित कॉन्टेंट को ब्लॉक करने के लिए, यूनीक जिन्हें |
stopSequences[] |
वर्ण क्रम के सेट (ज़्यादा से ज़्यादा पांच) का सेट, जो आउटपुट बनाना बंद कर देगा. तय किए जाने पर, एपीआई स्टॉप क्रम के पहली बार दिखने पर रुक जाएगा. जवाब के हिस्से में स्टॉप के क्रम को शामिल नहीं किया जाएगा. |
temperature |
ज़रूरी नहीं. आउटपुट की रैंडमनेस को कंट्रोल करता है. ध्यान दें: डिफ़ॉल्ट वैल्यू, मॉडल के हिसाब से अलग-अलग होती है. देखें कि वैल्यू [0.0,1.0] के बीच हो सकती हैं. 1.0 के करीब होने पर ऐसे जवाब मिलेंगे जो ज़्यादा अलग-अलग और क्रिएटिव होंगे, जबकि 0.0 के करीब होने पर मॉडल से ज़्यादा आसान जवाब मिलेंगे. |
candidateCount |
ज़रूरी नहीं. लौटाने के लिए जनरेट की गई प्रतिक्रियाओं की संख्या. यह वैल्यू [1, 8] के बीच होनी चाहिए. अगर यह नीति सेट नहीं है, तो यह डिफ़ॉल्ट रूप से 1 पर सेट होगी. |
maxOutputTokens |
ज़रूरी नहीं. किसी कैंडिडेट में शामिल किए जाने वाले टोकन की ज़्यादा से ज़्यादा संख्या. अगर इसे सेट नहीं किया जाता है, तो यह |
topP |
ज़रूरी नहीं. नमूना लेने के दौरान विचार करने के लिए, टोकन की ज़्यादा से ज़्यादा कुल संभावना. यह मॉडल टॉप-के और न्यूक्लियस सैंपलिंग का इस्तेमाल करता है. टोकन को उनकी असाइन की गई प्रॉबबिलिटी के आधार पर क्रम से लगाया जाता है, ताकि सबसे ज़्यादा संभावना वाले टोकन पर विचार किया जा सके. टॉप-k सैंपलिंग, विचार करने के लिए टोकन की ज़्यादा से ज़्यादा संख्या को सीधे तौर पर सीमित करती है, जबकि Nucleus सैंपलिंग कुल प्रॉबबिलिटी के आधार पर टोकन की संख्या को सीमित करती है. ध्यान दें: डिफ़ॉल्ट वैल्यू, मॉडल के हिसाब से अलग-अलग होती है. देखें कि |
topK |
ज़रूरी नहीं. सैंपल करते समय, शामिल किए जाने वाले टोकन की ज़्यादा से ज़्यादा संख्या. यह मॉडल टॉप-के और न्यूक्लियस सैंपलिंग का इस्तेमाल करता है. टॉप-k सैंपलिंग, ध्यान दें: डिफ़ॉल्ट वैल्यू, मॉडल के हिसाब से अलग-अलग होती है. देखें कि |
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में GenerateTextResponse
का एक इंस्टेंस शामिल किया जाता है.
अनुमति देने के दायरे
इनमें से कोई एक OAuth स्कोप ज़रूरी है:
https://www.googleapis.com/auth/generative-language
https://www.googleapis.com/auth/generative-language.tuning
https://www.googleapis.com/auth/generative-language.tuning.readonly
https://www.googleapis.com/auth/generative-language.retriever
https://www.googleapis.com/auth/generative-language.retriever.readonly
ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.