تتيح لك ميزة "تخزين السياق مؤقتًا" حفظ رموز الإدخال المميزة التي تم احتسابها مسبقًا وإعادة استخدامها بشكل متكرر، مثلاً عند طرح أسئلة مختلفة حول ملف الوسائط نفسه. ويمكن أن يؤدي ذلك إلى توفير التكاليف والوقت، حسب الاستخدام. للحصول على مقدّمة تفصيلية، يُرجى الاطّلاع على دليل التخزين المؤقت للسياق.
الطريقة: 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)
طابع زمني بالتوقيت العالمي المتفق عليه (UTC) يحدّد وقت انتهاء صلاحية هذا المرجع. يتم تقديم هذا الرمز دائمًا في الناتج، بغض النظر عن الرمز الذي تم إرساله في الإدخال.
يستخدم المعيار RFC 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 حرف Unicode.
model
string
الحقل مطلوب. غير قابل للتغيير اسم Model المطلوب استخدامه لتنسيق المحتوى المخزّن مؤقتًا: models/{model}
systemInstruction
object (Content)
اختياريّ. الإدخال فقط غير قابل للتغيير تعليمات النظام التي يضبطها المطوّر تتوفّر حاليًا النصوص فقط.
toolConfig
object (ToolConfig)
اختياريّ. الإدخال فقط غير قابل للتغيير إعدادات الأداة تتم مشاركة هذا الإعداد مع جميع الأدوات.
مثال على الطلب
التذكرة الأساسية
Python
Node.js
Go
محارة
اسم المرسِل
Python
Node.js
Go
من محادثة
Python
Node.js
Go
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نصها على مثال تم إنشاؤه حديثًا CachedContent.
الطريقة: cachedContents.list
Lists CachedContents.
نقطة نهاية
gethttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
مَعلمات طلب البحث
pageSize
integer
اختياريّ. تعرض هذه المَعلمة أكبر عدد ممكن من المحتوى المخزّن مؤقتًا. قد تعرض الخدمة عددًا أقل من هذه القيمة. في حال عدم تحديدها، سيتم عرض عدد تلقائي (أقل من الحد الأقصى) من العناصر. الحد الأقصى للقيمة هو 1000، وسيتم فرض القيمة 1000 على القيم الأعلى من 1000.
pageToken
string
اختياريّ. رمز مميز للصفحة تم تلقّيه من طلب cachedContents.list سابق. يجب تقديم هذا الرمز لاسترداد الصفحة التالية.
عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى cachedContents.list مع الطلب الذي قدّم رمز الصفحة المميّز.
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
ردّ يتضمّن قائمة CachedContents
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
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
Go
محارة
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال 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)
طابع زمني بالتوقيت العالمي المتفق عليه (UTC) يحدّد وقت انتهاء صلاحية هذا المرجع. يتم تقديم هذا الرمز دائمًا في الناتج، بغض النظر عن الرمز الذي تم إرساله في الإدخال.
يستخدم المعيار RFC 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
Go
محارة
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال CachedContent.
الطريقة: cachedContents.delete
تحذف هذه الطريقة مورد CachedContent.
نقطة نهاية
deletehttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
مَعلمات المسار
name
string
الحقل مطلوب. اسم المرجع الذي يشير إلى إدخال ذاكرة التخزين المؤقت للمحتوى، بالتنسيق cachedContents/{id}، ويكون بالتنسيق cachedContents/{cachedcontent}.
نص الطلب
يجب أن يكون نص الطلب فارغًا.
مثال على الطلب
Python
Node.js
Go
محارة
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيكون نص الاستجابة عبارة عن كائن JSON فارغ.
مورد REST: cachedContents
- المورد: CachedContent
- ToolConfig
- FunctionCallingConfig
- الوضع
- RetrievalConfig
- LatLng
- UsageMetadata
- الطُرق
المورد: CachedContent
المحتوى الذي تمت معالجته مسبقًا ويمكن استخدامه في طلب لاحق إلى GenerativeService
لا يمكن استخدام المحتوى المخزّن مؤقتًا إلا مع النموذج الذي تم إنشاؤه من أجله.
contents[]
object (Content)
اختياريّ. الإدخال فقط غير قابل للتغيير المحتوى المطلوب تخزينه مؤقتًا
tools[]
object (Tool)
اختياريّ. الإدخال فقط غير قابل للتغيير قائمة Tools قد يستخدمها النموذج لإنشاء الرد التالي
createTime
string (Timestamp format)
النتائج فقط. وقت إنشاء إدخال ذاكرة التخزين المؤقت
يستخدم المعيار RFC 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)
النتائج فقط. وقت آخر تعديل لإدخال ذاكرة التخزين المؤقت بالتوقيت العالمي المنسّق
يستخدم المعيار RFC 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)
طابع زمني بالتوقيت العالمي المتفق عليه (UTC) يحدّد وقت انتهاء صلاحية هذا المرجع. يتم تقديم هذا الرمز دائمًا في الناتج، بغض النظر عن الرمز الذي تم إرساله في الإدخال.
يستخدم المعيار RFC 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 حرف Unicode.
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 ( |
الوضع
تحدّد هذه السمة سلوك التنفيذ الخاص بميزة "استدعاء الدوال" من خلال تحديد وضع التنفيذ.
| عمليات التعداد | |
|---|---|
MODE_UNSPECIFIED |
وضع طلب الدوال غير محدّد. يجب عدم استخدام هذه القيمة. |
AUTO |
سلوك النموذج التلقائي، يقرّر النموذج التنبؤ إما باستدعاء دالة أو ردّ باللغة الطبيعية. |
ANY |
يقتصر النموذج على توقّع استدعاء دالة فقط. في حال ضبط "allowedFunctionNames"، سيقتصر استدعاء الدالة المتوقّعة على أيّ من "allowedFunctionNames"، وإلا سيكون استدعاء الدالة المتوقّعة أيًّا من "functionDeclarations" المقدَّمة. |
NONE |
لن يتوقّع النموذج أي استدعاء دالة. سلوك النموذج هو نفسه عند عدم تمرير أي تعريفات للدوال. |
VALIDATED |
يقرّر النموذج توقّع إما استدعاء دالة أو ردّ باللغة الطبيعية، ولكنّه سيتحقّق من صحة استدعاءات الدوال باستخدام فك الترميز المقيد. في حال ضبط "allowedFunctionNames"، سيقتصر استدعاء الدالة المتوقّعة على أيّ من "allowedFunctionNames"، وإلا سيكون استدعاء الدالة المتوقّعة أيًّا من "functionDeclarations" المقدَّمة. |
RetrievalConfig
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 } |