ذخیره سازی زمینه به شما امکان میدهد تا توکنهای ورودی از پیش محاسبه شدهای را که میخواهید بارها از آنها استفاده کنید، ذخیره و دوباره استفاده کنید، به عنوان مثال هنگام پرسیدن سوالات مختلف در مورد یک فایل رسانهای مشابه. این میتواند بسته به نوع استفاده، منجر به صرفهجویی در هزینه و سرعت شود. برای آشنایی بیشتر، به راهنمای ذخیره سازی زمینه مراجعه کنید.
متد: cachedContents.create
منبع CachedContent را ایجاد میکند.
نقطه پایانی
پستhttps: / /generativelanguage.googleapis.com /v1beta /cachedContentsدرخواست بدنه
بدنه درخواست شامل نمونهای از CachedContent است.
contents[]object ( Content )اختیاری. فقط ورودی. تغییرناپذیر. محتوایی که باید ذخیره شود.
tools[]object ( Tool ) اختیاری. فقط ورودی. تغییرناپذیر. فهرستی از Tools مدل ممکن است برای تولید پاسخ بعدی استفاده کند
Union type expirationexpiration فقط میتواند یکی از موارد زیر باشد: expireTimestring ( Timestamp format)مهر زمانی بر حسب UTC که نشان میدهد این منبع منقضی شده است. این مهر زمانی همیشه در خروجی ارائه میشود، صرف نظر از اینکه چه چیزی در ورودی ارسال شده است.
از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .
ttlstring ( Duration format)فقط ورودی. TTL جدید برای این منبع، فقط ورودی.
مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم میشود. مثال: "3.5s" .
string displayNameاختیاری. تغییرناپذیر. نام نمایشی معنادار تولید شده توسط کاربر برای محتوای ذخیره شده. حداکثر ۱۲۸ کاراکتر یونیکد.
string model الزامی. تغییرناپذیر. نام Model که برای محتوای ذخیرهشده استفاده میشود. قالب: models/{model}
systemInstructionobject ( Content )Optional. Input only. Immutable. Developer set system instruction. Currently text only.
toolConfigobject ( ToolConfig )اختیاری. فقط ورودی. تغییرناپذیر. پیکربندی ابزار. این پیکربندی برای همه ابزارها مشترک است.
درخواست نمونه
پایه
پایتون
نود جی اس
برو
پوسته
از نام
پایتون
نود جی اس
برو
از چت
پایتون
نود جی اس
برو
بدنه پاسخ
در صورت موفقیت، بدنه پاسخ شامل یک نمونه تازه ایجاد شده از CachedContent است.
روش: cachedContents.list
فهرستهای محتویات ذخیرهشده (CachedContents).
نقطه پایانی
دریافتhttps: / /generativelanguage.googleapis.com /v1beta /cachedContentsپارامترهای پرس و جو
integer pageSizeاختیاری. حداکثر تعداد محتویات ذخیره شده برای برگرداندن. سرویس ممکن است کمتر از این مقدار را برگرداند. اگر مشخص نشود، تعداد پیشفرضی (کمتر از حداکثر) از موارد برگردانده میشود. حداکثر مقدار ۱۰۰۰ است؛ مقادیر بالاتر از ۱۰۰۰ به ۱۰۰۰ محدود میشوند.
string pageToken اختیاری. یک توکن صفحه که از فراخوانی قبلی cachedContents.list دریافت شده است. این را برای بازیابی صفحه بعدی ارائه دهید.
هنگام صفحهبندی، تمام پارامترهای دیگر ارائه شده به cachedContents.list باید با فراخوانی که توکن صفحه را ارائه داده است، مطابقت داشته باشند.
درخواست بدنه
بدنه درخواست باید خالی باشد.
بدنه پاسخ
پاسخ با لیست CachedContents.
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
cachedContents[]object ( CachedContent )فهرست محتویات ذخیره شده در حافظه پنهان.
string nextPageToken یک توکن، که میتواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این فیلد حذف شود، صفحات بعدی وجود نخواهند داشت.
| نمایش JSON |
|---|
{
"cachedContents": [
{
object ( |
روش: cachedContents.get
منبع CachedContent را میخواند.
نقطه پایانی
دریافتhttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}پارامترهای مسیر
string name الزامی. نام منبعی که به ورودی حافظه پنهان محتوا اشاره دارد. قالب: cachedContents/{id} به شکل cachedContents/{cachedcontent} است.
درخواست بدنه
بدنه درخواست باید خالی باشد.
درخواست نمونه
پایتون
نود جی اس
برو
پوسته
بدنه پاسخ
در صورت موفقیت، بدنه پاسخ شامل نمونهای از CachedContent است.
روش: cachedContents.patch
منبع CachedContent را بهروزرسانی میکند (فقط تاریخ انقضا قابل بهروزرسانی است).
نقطه پایانی
وصلهhttps: / /generativelanguage.googleapis.com /v1beta /{cachedContent.name=cachedContents /*}PATCH https://generativelanguage.googleapis.com/v1beta/{cachedContent.name=cachedContents/*} پارامترهای مسیر
string cachedContent.name فقط خروجی. شناسه. نام منبعی که به محتوای ذخیره شده اشاره دارد. قالب: cachedContents/{id} به شکل cachedContents/{cachedcontent} است.
پارامترهای پرس و جو
updateMaskstring ( FieldMask format)لیست فیلدهایی که باید بهروزرسانی شوند.
این لیستی از نامهای کامل فیلدها است که با کاما از هم جدا شدهاند. مثال: "user.displayName,photo" .
درخواست بدنه
بدنه درخواست شامل نمونهای از CachedContent است.
Union type expirationexpiration فقط میتواند یکی از موارد زیر باشد: expireTimestring ( Timestamp format)مهر زمانی بر حسب UTC که نشان میدهد این منبع منقضی شده است. این مهر زمانی همیشه در خروجی ارائه میشود، صرف نظر از اینکه چه چیزی در ورودی ارسال شده است.
از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .
ttlstring ( Duration format)فقط ورودی. TTL جدید برای این منبع، فقط ورودی.
مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم میشود. مثال: "3.5s" .
درخواست نمونه
پایتون
نود جی اس
برو
پوسته
بدنه پاسخ
در صورت موفقیت، بدنه پاسخ شامل نمونهای از CachedContent است.
متد: cachedContents.delete
منبع CachedContent را حذف میکند.
نقطه پایانی
حذفhttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}پارامترهای مسیر
string name الزامی. نام منبعی که به ورودی حافظه پنهان محتوا اشاره دارد. قالب: cachedContents/{id} به شکل cachedContents/{cachedcontent} است.
درخواست بدنه
بدنه درخواست باید خالی باشد.
درخواست نمونه
پایتون
نود جی اس
برو
پوسته
بدنه پاسخ
در صورت موفقیت، بدنه پاسخ یک شیء JSON خالی خواهد بود.
منبع REST: cachedContents
- منبع: CachedContent
- پیکربندی ابزار
- پیکربندی فراخوانی تابع
- حالت
- پیکربندی بازیابی
- لاتلنگ
- کاربردفراداده
- روشها
منبع: CachedContent
محتوایی که پیشپردازش شده است و میتواند در درخواستهای بعدی به GenerativeService مورد استفاده قرار گیرد.
محتوای ذخیره شده فقط میتواند با مدلی که برای آن ایجاد شده است، استفاده شود.
contents[]object ( Content )اختیاری. فقط ورودی. تغییرناپذیر. محتوایی که باید ذخیره شود.
tools[]object ( Tool ) اختیاری. فقط ورودی. تغییرناپذیر. فهرستی از Tools مدل ممکن است برای تولید پاسخ بعدی استفاده کند
createTimestring ( Timestamp format)فقط خروجی. زمان ایجاد ورودی کش.
از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .
updateTimestring ( Timestamp format)فقط خروجی. آخرین بهروزرسانی ورودی حافظه پنهان بر اساس زمان UTC چه زمانی بوده است.
از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .
usageMetadataobject ( UsageMetadata )فقط خروجی. فراداده در مورد استفاده از محتوای ذخیره شده.
Union type expirationexpiration فقط میتواند یکی از موارد زیر باشد: expireTimestring ( Timestamp format)مهر زمانی بر حسب UTC که نشان میدهد این منبع منقضی شده است. این مهر زمانی همیشه در خروجی ارائه میشود، صرف نظر از اینکه چه چیزی در ورودی ارسال شده است.
از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .
ttlstring ( Duration format)فقط ورودی. TTL جدید برای این منبع، فقط ورودی.
مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم میشود. مثال: "3.5s" .
string name فقط خروجی. شناسه. نام منبعی که به محتوای ذخیره شده اشاره دارد. قالب: cachedContents/{id}
string displayNameاختیاری. تغییرناپذیر. نام نمایشی معنادار تولید شده توسط کاربر برای محتوای ذخیره شده. حداکثر ۱۲۸ کاراکتر یونیکد.
string model الزامی. تغییرناپذیر. نام Model که برای محتوای ذخیرهشده استفاده میشود. قالب: models/{model}
systemInstructionobject ( Content )Optional. Input only. Immutable. Developer set system instruction. Currently text only.
toolConfigobject ( ToolConfig )اختیاری. فقط ورودی. تغییرناپذیر. پیکربندی ابزار. این پیکربندی برای همه ابزارها مشترک است.
| نمایش JSON |
|---|
{ "contents": [ { object ( |
پیکربندی ابزار
پیکربندی ابزار شامل پارامترهایی برای تعیین استفاده Tool در درخواست.
functionCallingConfigobject ( FunctionCallingConfig )اختیاری. پیکربندی فراخوانی تابع.
retrievalConfigobject ( RetrievalConfig )اختیاری. پیکربندی بازیابی.
includeServerSideToolInvocationsboolean اختیاری. اگر مقدار آن درست باشد، پاسخ API شامل فراخوانیها و پاسخهای ابزار سمت سرور در پیام Content خواهد بود. این به کلاینتها اجازه میدهد تا تعاملات ابزار سرور را مشاهده کنند.
| نمایش JSON |
|---|
{ "functionCallingConfig": { object ( |
پیکربندی فراخوانی تابع
پیکربندی برای مشخص کردن رفتار فراخوانی تابع.
modeenum ( Mode )اختیاری. حالتی را که فراخوانی تابع باید در آن اجرا شود مشخص میکند. اگر مشخص نشود، مقدار پیشفرض روی AUTO تنظیم میشود.
string allowedFunctionNames[]اختیاری. مجموعهای از نامهای تابع که در صورت ارائه، توابعی را که مدل فراخوانی خواهد کرد محدود میکنند.
این فقط باید زمانی تنظیم شود که حالت (Mode) روی ANY یا VALIDATED باشد. نام توابع باید با [FunctionDeclaration.name] مطابقت داشته باشد. وقتی تنظیم شود، مدل فراخوانی تابع را فقط از نامهای تابع مجاز پیشبینی میکند.
| نمایش JSON |
|---|
{
"mode": enum ( |
حالت
با تعریف حالت اجرا، رفتار اجرایی را برای فراخوانی تابع تعریف میکند.
| انومها | |
|---|---|
MODE_UNSPECIFIED | حالت فراخوانی تابع نامشخص. این مقدار نباید استفاده شود. |
AUTO | رفتار پیشفرض مدل، مدل تصمیم میگیرد که یا یک فراخوانی تابع یا یک پاسخ زبان طبیعی را پیشبینی کند. |
ANY | مدل محدود به پیشبینی فقط فراخوانی یک تابع است. اگر "allowedFunctionNames" تنظیم شده باشد، فراخوانی تابع پیشبینیشده به هر یک از "allowedFunctionNames" محدود خواهد شد، در غیر این صورت فراخوانی تابع پیشبینیشده هر یک از "functionDeclarations" ارائه شده خواهد بود. |
NONE | مدل هیچ فراخوانی تابعی را پیشبینی نمیکند. رفتار مدل مانند زمانی است که هیچ اعلان تابعی ارسال نمیشود. |
VALIDATED | مدل تصمیم میگیرد که یا یک فراخوانی تابع یا یک پاسخ زبان طبیعی را پیشبینی کند، اما فراخوانیهای تابع را با رمزگشایی محدود اعتبارسنجی میکند. اگر "allowedFunctionNames" تنظیم شده باشد، فراخوانی تابع پیشبینیشده به هر یک از "allowedFunctionNames" محدود خواهد شد، در غیر این صورت فراخوانی تابع پیشبینیشده هر یک از "functionDeclarations" ارائه شده خواهد بود. |
پیکربندی بازیابی
لاتلنگ
شیءای که یک جفت عرض/طول جغرافیایی را نشان میدهد. این به صورت یک جفت دوتایی بیان میشود تا درجه عرض جغرافیایی و درجه طول جغرافیایی را نشان دهد. مگر اینکه خلاف آن مشخص شده باشد، این شیء باید با استاندارد WGS84 مطابقت داشته باشد. مقادیر باید در محدوده نرمال باشند.
number latitudeعرض جغرافیایی بر حسب درجه. باید در محدوده [-90.0، +90.0] باشد.
number longitudeطول جغرافیایی بر حسب درجه. باید در محدوده [-۱۸۰.۰، +۱۸۰.۰] باشد.
| نمایش JSON |
|---|
{ "latitude": number, "longitude": number } |
کاربردفراداده
فراداده (metadata) در مورد استفاده از محتوای ذخیره شده.
integer totalTokenCountتعداد کل توکنهایی که محتوای ذخیرهشده مصرف میکند.
| نمایش JSON |
|---|
{ "totalTokenCount": integer } |