कॉन्टेक्स्ट कैश मेमोरी की सुविधा की मदद से, पहले से कैलकुलेट किए गए उन इनपुट टोकन को सेव किया जा सकता है जिनका आपको बार-बार इस्तेमाल करना है. उदाहरण के लिए, एक ही मीडिया फ़ाइल के बारे में अलग-अलग सवाल पूछते समय. इस्तेमाल के आधार पर, इससे लागत कम हो सकती है और काम तेज़ी से हो सकता है. ज़्यादा जानकारी के लिए, कॉन्टेक्स्ट कैश मेमोरी गाइड देखें.
तरीका: cachedContents.create
यह CachedContent संसाधन बनाता है.
एंडपॉइंट
posthttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में CachedContent का उदाहरण है.
contents[]
object (Content)
ज़रूरी नहीं. सिर्फ़ इनपुट के लिए. इम्यूटेबल. कैश मेमोरी में सेव किया जाने वाला कॉन्टेंट.
tools[]
object (Tool)
ज़रूरी नहीं. सिर्फ़ इनपुट के लिए. इम्यूटेबल. Tools मॉडल, अगला जवाब जनरेट करने के लिए इनका इस्तेमाल कर सकता है
expiration
Union type
expiration इनमें से सिर्फ़ एक हो सकता है:expireTime
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".
ttl
string (Duration format)
सिर्फ़ इनपुट के लिए. इस संसाधन के लिए नया टीटीएल, सिर्फ़ इनपुट करें.
यह सेकंड में अवधि होती है. इसमें नौ दशमलव अंक तक हो सकते हैं. इसके आखिर में 's' होता है. उदाहरण: "3.5s".
displayName
string
ज़रूरी नहीं. इम्यूटेबल. कैश किए गए कॉन्टेंट का यूज़र जनरेटेड डिसप्ले नेम. ज़्यादा से ज़्यादा 128 यूनिकोड वर्ण.
model
string
ज़रूरी है. इम्यूटेबल. कैश किए गए कॉन्टेंट के लिए इस्तेमाल किए जाने वाले Model का नाम फ़ॉर्मैट: models/{model}
systemInstruction
object (Content)
ज़रूरी नहीं. सिर्फ़ इनपुट के लिए. इम्यूटेबल. डेवलपर ने सिस्टम के लिए निर्देश सेट किए हैं. फ़िलहाल, सिर्फ़ टेक्स्ट के तौर पर उपलब्ध है.
toolConfig
object (ToolConfig)
ज़रूरी नहीं. सिर्फ़ इनपुट के लिए. इम्यूटेबल. टूल कॉन्फ़िगरेशन. यह कॉन्फ़िगरेशन सभी टूल के लिए शेयर किया जाता है.
अनुरोध का उदाहरण
सामान्य
Python
Node.js
ऐप पर जाएं
शेल
नाम
Python
Node.js
ऐप पर जाएं
चैट से
Python
Node.js
ऐप पर जाएं
जवाब का मुख्य भाग
अनुरोध पूरा होने पर, जवाब के मुख्य हिस्से में CachedContent का नया इंस्टेंस शामिल किया जाता है.
तरीका: cachedContents.list
Lists CachedContents.
एंडपॉइंट
gethttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
क्वेरी पैरामीटर
pageSize
integer
ज़रूरी नहीं. कैश किए गए ज़्यादा से ज़्यादा कॉन्टेंट वापस लाने की संख्या. ऐसा हो सकता है कि सेवा इस वैल्यू से कम नतीजे दिखाए. अगर इसे तय नहीं किया गया है, तो ज़्यादा से ज़्यादा संख्या के हिसाब से कुछ डिफ़ॉल्ट आइटम दिखाए जाएंगे. इसकी ज़्यादा से ज़्यादा वैल्यू 1,000 हो सकती है. इससे ज़्यादा वैल्यू डालने पर, उसे 1,000 पर सेट कर दिया जाएगा.
pageToken
string
ज़रूरी नहीं. यह एक पेज टोकन है, जो पिछली cachedContents.list कॉल से मिला था. अगला पेज पाने के लिए, यह जानकारी दें.
पेज नंबर के हिसाब से डेटा दिखाने के दौरान, cachedContents.list को दिए गए अन्य सभी पैरामीटर, पेज टोकन देने वाले कॉल से मेल खाने चाहिए.
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
CacheContents की सूची के साथ जवाब.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
cachedContents[]
object (CachedContent)
कैश मेमोरी में सेव किए गए कॉन्टेंट की सूची.
nextPageToken
string
यह एक टोकन है. इसका इस्तेमाल pageToken के तौर पर किया जा सकता है, ताकि अगला पेज वापस पाया जा सके. अगर इस फ़ील्ड को खाली छोड़ा जाता है, तो इसके बाद कोई पेज नहीं होता.
| JSON के काेड में दिखाना |
|---|
{
"cachedContents": [
{
object ( |
तरीका: cachedContents.get
यह CachedContent संसाधन को पढ़ता है.
एंडपॉइंट
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
पाथ पैरामीटर
name
string
ज़रूरी है. कॉन्टेंट की कैश मेमोरी में सेव की गई एंट्री का रेफ़रंस देने वाला संसाधन का नाम. फ़ॉर्मैट: cachedContents/{id} यह cachedContents/{cachedcontent} के फ़ॉर्म में होता है.
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
अनुरोध का उदाहरण
Python
Node.js
ऐप पर जाएं
शेल
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में CachedContent का एक इंस्टेंस शामिल किया जाता है.
तरीका: cachedContents.patch
- एंडपॉइंट
- पाथ पैरामीटर
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- अनुरोध का उदाहरण
यह CachedContent संसाधन को अपडेट करता है. सिर्फ़ खत्म होने की तारीख को अपडेट किया जा सकता है.
एंडपॉइंट
patchhttps: / /generativelanguage.googleapis.com /v1beta /{cachedContent.name=cachedContents /*}
PATCH https://generativelanguage.googleapis.com/v1beta/{cachedContent.name=cachedContents/*}
पाथ पैरामीटर
cachedContent.name
string
सिर्फ़ आउटपुट के लिए. आइडेंटिफ़ायर. कैश मेमोरी में सेव किए गए कॉन्टेंट का संसाधन नाम. फ़ॉर्मैट: cachedContents/{id} यह cachedContents/{cachedcontent} के फ़ॉर्म में होता है.
क्वेरी पैरामीटर
updateMask
string (FieldMask format)
अपडेट किए जाने वाले फ़ील्ड की सूची.
यह फ़ील्ड के पूरी तरह क्वालिफ़ाइड नामों की कॉमा लगाकर अलग की गई लिस्ट है. उदाहरण: "user.displayName,photo".
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में CachedContent का उदाहरण है.
expiration
Union type
expiration इनमें से सिर्फ़ एक हो सकता है:expireTime
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".
ttl
string (Duration format)
सिर्फ़ इनपुट के लिए. इस संसाधन के लिए नया टीटीएल, सिर्फ़ इनपुट करें.
यह सेकंड में अवधि होती है. इसमें नौ दशमलव अंक तक हो सकते हैं. इसके आखिर में 's' होता है. उदाहरण: "3.5s".
अनुरोध का उदाहरण
Python
Node.js
ऐप पर जाएं
शेल
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में CachedContent का एक इंस्टेंस शामिल किया जाता है.
तरीका: cachedContents.delete
यह CachedContent संसाधन को मिटाता है.
एंडपॉइंट
deletehttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
पाथ पैरामीटर
name
string
ज़रूरी है. कॉन्टेंट कैश मेमोरी की एंट्री का रेफ़रंस देने वाला संसाधन का नाम. फ़ॉर्मैट: cachedContents/{id} यह cachedContents/{cachedcontent} के फ़ॉर्म में होता है.
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
अनुरोध का उदाहरण
Python
Node.js
ऐप पर जाएं
शेल
जवाब का मुख्य भाग
अगर अनुरोध पूरा हो जाता है, तो जवाब के मुख्य हिस्से में एक खाली JSON ऑब्जेक्ट होता है.
REST रिसोर्स: cachedContents
- संसाधन: CachedContent
- ToolConfig
- FunctionCallingConfig
- मोड
- RetrievalConfig
- LatLng
- UsageMetadata
- तरीके
संसाधन: CachedContent
ऐसा कॉन्टेंट जिसे पहले से प्रोसेस किया गया हो और जिसका इस्तेमाल, GenerativeService को किए जाने वाले अगले अनुरोध में किया जा सकता हो.
कैश किए गए कॉन्टेंट का इस्तेमाल सिर्फ़ उसी मॉडल के साथ किया जा सकता है जिसके लिए इसे बनाया गया था.
contents[]
object (Content)
ज़रूरी नहीं. सिर्फ़ इनपुट के लिए. इम्यूटेबल. कैश मेमोरी में सेव किया जाने वाला कॉन्टेंट.
tools[]
object (Tool)
ज़रूरी नहीं. सिर्फ़ इनपुट के लिए. इम्यूटेबल. Tools मॉडल, अगला जवाब जनरेट करने के लिए इस सूची का इस्तेमाल कर सकता है
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".
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".
usageMetadata
object (UsageMetadata)
सिर्फ़ आउटपुट के लिए. कैश मेमोरी में सेव किए गए कॉन्टेंट के इस्तेमाल से जुड़ा मेटाडेटा.
expiration
Union type
expiration इनमें से सिर्फ़ एक हो सकता है:expireTime
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".
ttl
string (Duration format)
सिर्फ़ इनपुट के लिए. इस संसाधन के लिए नया टीटीएल, सिर्फ़ इनपुट करें.
यह सेकंड में अवधि होती है. इसमें नौ दशमलव अंक तक हो सकते हैं. इसके आखिर में 's' होता है. उदाहरण: "3.5s".
name
string
सिर्फ़ आउटपुट के लिए. आइडेंटिफ़ायर. कैश मेमोरी में सेव किए गए कॉन्टेंट का संसाधन नाम. फ़ॉर्मैट: cachedContents/{id}
displayName
string
ज़रूरी नहीं. इम्यूटेबल. कैश किए गए कॉन्टेंट का यूज़र जनरेटेड डिसप्ले नेम. ज़्यादा से ज़्यादा 128 यूनिकोड वर्ण.
model
string
ज़रूरी है. इम्यूटेबल. कैश किए गए कॉन्टेंट के लिए इस्तेमाल किए जाने वाले Model का नाम फ़ॉर्मैट: models/{model}
systemInstruction
object (Content)
ज़रूरी नहीं. सिर्फ़ इनपुट के लिए. इम्यूटेबल. डेवलपर ने सिस्टम के लिए निर्देश सेट किए हैं. फ़िलहाल, सिर्फ़ टेक्स्ट के तौर पर उपलब्ध है.
toolConfig
object (ToolConfig)
ज़रूरी नहीं. सिर्फ़ इनपुट के लिए. इम्यूटेबल. टूल कॉन्फ़िगरेशन. यह कॉन्फ़िगरेशन सभी टूल के लिए शेयर किया जाता है.
| JSON के काेड में दिखाना |
|---|
{ "contents": [ { object ( |
ToolConfig
टूल कॉन्फ़िगरेशन में ऐसे पैरामीटर होते हैं जिनसे अनुरोध में Tool के इस्तेमाल के बारे में जानकारी मिलती है.
functionCallingConfig
object (FunctionCallingConfig)
ज़रूरी नहीं. फ़ंक्शन कॉलिंग कॉन्फ़िगरेशन.
retrievalConfig
object (RetrievalConfig)
ज़रूरी नहीं. डेटा वापस पाने का कॉन्फ़िगरेशन.
includeServerSideToolInvocations
boolean
ज़रूरी नहीं. अगर यह वैल्यू सही है, तो एपीआई से मिले जवाब में सर्वर-साइड टूल कॉल और जवाब शामिल होंगे. ये जवाब, Content मैसेज में शामिल होंगे. इससे क्लाइंट, सर्वर के टूल इंटरैक्शन को देख सकते हैं.
| JSON के काेड में दिखाना |
|---|
{ "functionCallingConfig": { object ( |
FunctionCallingConfig
फ़ंक्शन कॉल करने के तरीके के बारे में बताने के लिए कॉन्फ़िगरेशन.
mode
enum (Mode)
ज़रूरी नहीं. यह बताता है कि फ़ंक्शन कॉलिंग किस मोड में काम करनी चाहिए. अगर कोई वैल्यू तय नहीं की जाती है, तो डिफ़ॉल्ट वैल्यू AUTO पर सेट हो जाएगी.
allowedFunctionNames[]
string
ज़रूरी नहीं. फ़ंक्शन के नामों का एक सेट. इसे उपलब्ध कराने पर, मॉडल सिर्फ़ उन फ़ंक्शन को कॉल करेगा.
इसे सिर्फ़ तब सेट किया जाना चाहिए, जब मोड ANY या VALIDATED हो. फ़ंक्शन के नाम, [FunctionDeclaration.name] से मेल खाने चाहिए. इस विकल्प को सेट करने पर, मॉडल सिर्फ़ उन फ़ंक्शन के नाम से फ़ंक्शन कॉल का अनुमान लगाएगा जिनकी अनुमति दी गई है.
| JSON के काेड में दिखाना |
|---|
{
"mode": enum ( |
मोड
यह फ़ंक्शन कॉल करने के तरीके के बारे में बताता है. इसके लिए, यह फ़ंक्शन कॉल करने का मोड तय करता है.
| Enums | |
|---|---|
MODE_UNSPECIFIED |
फ़ंक्शन कॉलिंग मोड की जानकारी नहीं दी गई है. इस वैल्यू का इस्तेमाल नहीं किया जाना चाहिए. |
AUTO |
मॉडल का डिफ़ॉल्ट व्यवहार, मॉडल यह तय करता है कि फ़ंक्शन कॉल का अनुमान लगाना है या नैचुरल लैंग्वेज में जवाब देना है. |
ANY |
मॉडल को हमेशा सिर्फ़ फ़ंक्शन कॉल का अनुमान लगाने के लिए सीमित किया जाता है. अगर "allowedFunctionNames" सेट किए गए हैं, तो अनुमानित फ़ंक्शन कॉल, "allowedFunctionNames" में से किसी एक तक सीमित रहेगा. ऐसा न होने पर, अनुमानित फ़ंक्शन कॉल, उपलब्ध कराए गए "functionDeclarations" में से कोई एक होगा. |
NONE |
मॉडल, किसी भी फ़ंक्शन कॉल का अनुमान नहीं लगाएगा. मॉडल का व्यवहार वैसा ही होता है जैसा फ़ंक्शन के बारे में कोई जानकारी न देने पर होता है. |
VALIDATED |
मॉडल यह तय करता है कि फ़ंक्शन कॉल का अनुमान लगाना है या नैचुरल लैंग्वेज में जवाब देना है. हालांकि, यह फ़ंक्शन कॉल की पुष्टि, सीमित डिकोडिंग की मदद से करेगा. अगर "allowedFunctionNames" सेट किए गए हैं, तो अनुमानित फ़ंक्शन कॉल, "allowedFunctionNames" में से किसी एक तक सीमित रहेगा. ऐसा न होने पर, अनुमानित फ़ंक्शन कॉल, दिए गए "functionDeclarations" में से कोई एक होगा. |
RetrievalConfig
डेटा वापस पाने का कॉन्फ़िगरेशन.
latLng
object (LatLng)
ज़रूरी नहीं. उपयोगकर्ता की जगह.
languageCode
string
ज़रूरी नहीं. उपयोगकर्ता की भाषा का कोड. कॉन्टेंट के लिए भाषा कोड. BCP47 में तय किए गए भाषा टैग का इस्तेमाल करें.
| JSON के काेड में दिखाना |
|---|
{
"latLng": {
object ( |
LatLng
यह ऑब्जेक्ट, अक्षांश/देशांतर की जोड़ी को दिखाता है. इसे डबल के तौर पर दिखाया जाता है, ताकि अक्षांश और देशांतर की डिग्री को दिखाया जा सके. जब तक अलग से कोई जानकारी न दी जाए, तब तक इस ऑब्जेक्ट को WGS84 स्टैंडर्ड के मुताबिक होना चाहिए. वैल्यू, सामान्य की गई रेंज में होनी चाहिए.
latitude
number
डिग्री में अक्षांश. यह [-90.0, +90.0] की रेंज में होना चाहिए.
longitude
number
डिग्री में देशांतर. यह [-180.0, +180.0] की रेंज में होना चाहिए.
| JSON के काेड में दिखाना |
|---|
{ "latitude": number, "longitude": number } |
UsageMetadata
कैश मेमोरी में सेव किए गए कॉन्टेंट के इस्तेमाल से जुड़ा मेटाडेटा.
totalTokenCount
integer
कैश किए गए कॉन्टेंट के लिए इस्तेमाल किए गए टोकन की कुल संख्या.
| JSON के काेड में दिखाना |
|---|
{ "totalTokenCount": integer } |