Gemini API از بارگذاری فایلهای رسانهای بهصورت جداگانه از ورودی پیامواره پشتیبانی میکند، که به رسانه شما اجازه میدهد در چندین درخواست و چندین پیامواره مجدداً استفاده شود. برای جزئیات بیشتر، راهنمای پیامواره با رسانه را بررسی کنید.
منبع REST: فایلها
منبع: فایل
فایلی در API بارگذاری شد.
name
string
تغییرناپذیر. شناسه. نام منبع File. شناسه (نام بدون پیشوند «files/») میتواند حداکثر ۴۰ نویسه داشته باشد که باید نویسههای الفباعددی کوچک یا خط تیره (-) باشند. شناسه نمیتواند با خط تیره شروع یا تمام شود. اگر نام در زمان ایجاد خالی باشد، نامی منحصربهفرد تولید خواهد شد. نمونه: files/123-456
displayName
string
اختیاری. نام نمایشی قابلخواندن برای انسان برای File. طول نام نمایشی نباید بیشتر از ۵۱۲ نویسه (بااحتساب فاصلهها) باشد. مثال: «تصویر خوشامدگویی»
mimeType
string
فقط خروجی. نوع MIME فایل.
sizeBytes
string (int64 format)
فقط خروجی. اندازه فایل به بایت.
createTime
string (Timestamp format)
فقط خروجی. مُهر زمان ایجاد File.
از RFC 3339 استفاده میکند، که در آن خروجی تولیدشده همیشه Z-نرمالشده است و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده میکند. انحرافهای غیراز «Z» نیز پذیرفته میشود. مثالها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".
updateTime
string (Timestamp format)
فقط خروجی. مُهر زمان آخرین باری که File بهروزرسانی شده است.
از RFC 3339 استفاده میکند، که در آن خروجی تولیدشده همیشه Z-نرمالشده است و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده میکند. انحرافهای غیراز «Z» نیز پذیرفته میشود. مثالها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".
expirationTime
string (Timestamp format)
فقط خروجی. مُهر زمان مربوط به زمانی که File حذف خواهد شد. فقط درصورتی تنظیم میشود که File برای منقضی شدن زمانبندی شده باشد.
از RFC 3339 استفاده میکند، که در آن خروجی تولیدشده همیشه Z-نرمالشده است و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده میکند. انحرافهای غیراز «Z» نیز پذیرفته میشود. مثالها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".
sha256Hash
string (bytes format)
فقط خروجی. درهمسازی SHA-256 بایتهای بارگذاریشده.
رشته کدبندیشده با Base64.
uri
string
فقط خروجی. شناسه منبع یکسان File.
downloadUri
string
فقط خروجی. شناسه منبع یکسان بارگیری File.
state
enum (State)
فقط خروجی. وضعیت پردازش فایل.
source
enum (Source)
منبع فایل.
error
object (Status)
فقط خروجی. وضعیت خطا درصورت ناموفق بودن پردازش فایل.
metadata
Union type
videoMetadata
object (VideoFileMetadata)
فقط خروجی. فراداده برای ویدیو.
| نمایش JSON |
|---|
{ "name": string, "displayName": string, "mimeType": string, "sizeBytes": string, "createTime": string, "updateTime": string, "expirationTime": string, "sha256Hash": string, "uri": string, "downloadUri": string, "state": enum ( |
VideoFileMetadata
فراداده برای ویدیو File.
videoDuration
string (Duration format)
مدت ویدیو.
مدتزمان به ثانیه با حداکثر نه رقم اعشار، که به «s» ختم میشود. مثال: "3.5s".
| نمایش JSON |
|---|
{ "videoDuration": string } |
ایالت
وضعیتهای چرخه حیات «فایل».
| شمارشیها | |
|---|---|
STATE_UNSPECIFIED |
مقدار پیشفرض. اگر ایالت حذف شده باشد، از این مقدار استفاده میشود. |
PROCESSING |
فایل درحال پردازش است و هنوز نمیتوان از آن برای استنتاج استفاده کرد. |
ACTIVE |
فایل پردازش شده و برای استنتاج دردسترس است. |
FAILED |
فایل پردازش نشد. |
منبع
| شمارشیها | |
|---|---|
SOURCE_UNSPECIFIED |
اگر منبع مشخص نشده باشد، استفاده میشود. |
UPLOADED |
نشان میدهد فایل توسط کاربر بارگذاری شده است. |
GENERATED |
نشان میدهد که فایل توسط Google تولید شده است. |
REGISTERED |
نشان میدهد فایل ثبت شده است، یعنی فایل Google Cloud Storage است. |
روش: files.get
فراداده را برای File دادهشده دریافت میکند.
نقطه پایانی
دریافتhttps: / /generativelanguage.googleapis.com /v1beta /{name=files /*}
پارامترهای مسیر
name
string
الزامی. نام File برای دریافت. مثال: files/abc-123 این شناسه بهصورت files/{file} است.
متن درخواست
بدنه درخواست باید خالی باشد.
درخواست نمونه
Python
Node.js
رفتن
صدف
بدنه پاسخ
اگر موفقیتآمیز باشد، بدنه پاسخ حاوی نمونهای از File است.
روش: files.list
فراداده Files متعلق به پروژه درخواستکننده را فهرست میکند.
نقطه پایانی
دریافتhttps: / /generativelanguage.googleapis.com /v1beta /files
پارامترهای پُرسمان
pageSize
integer
اختیاری. حداکثر تعداد File برای برگرداندن در هر صفحه. اگر مشخص نشده باشد، پیشفرض ۱۰ است. حداکثر pageSize ۱۰۰ است.
pageToken
string
اختیاری. یک کد صفحه از تماس files.list قبلی.
متن درخواست
بدنه درخواست باید خالی باشد.
درخواست نمونه
Python
Node.js
رفتن
صدف
بدنه پاسخ
پاسخ برای files.list.
اگر موفقیتآمیز باشد، بدنه پاسخ حاوی دادههایی با ساختار زیر است:
files[]
object (File)
فهرست File.
nextPageToken
string
نشانهای که میتواند بهعنوان pageToken به تماس files.list بعدی ارسال شود.
| نمایش JSON |
|---|
{
"files": [
{
object ( |
روش: files.delete
File را حذف میکند.
نقطه پایانی
حذفhttps: / /generativelanguage.googleapis.com /v1beta /{name=files /*}
پارامترهای مسیر
name
string
الزامی. نام File برای حذف. مثال: files/abc-123 این شناسه بهصورت files/{file} است.
متن درخواست
بدنه درخواست باید خالی باشد.
درخواست نمونه
Python
Node.js
رفتن
صدف
بدنه پاسخ
اگر موفقیتآمیز باشد، بدنه پاسخ یک شیء JSON خالی است.
روش: files.register
فایلهای Google Cloud Storage را با FileService ثبت میکند. انتظار میرود کاربر URIهای Google Cloud Storage را ارائه دهد و درعوض برای هر URI یک منبع «فایل» دریافت خواهد کرد. توجه داشته باشید که فایلها کپی نمیشوند، فقط در File API ثبت میشوند. اگر ثبت یک فایل ناموفق باشد، کل درخواست ناموفق خواهد بود.
نقطه پایانی
پستhttps: / /generativelanguage.googleapis.com /v1beta /files:register
متن درخواست
بدنه درخواست حاوی دادههایی با ساختار زیر است:
uris[]
string
الزامی. Google Cloud Storage URIs برای ثبت. مثال: gs://bucket/object.
روش: media.upload
File ایجاد میکند.
نقطه پایانی
- بارگذاری URI، برای درخواستهای بارگذاری رسانه:
https: / /generativelanguage.googleapis.com /upload /v1beta /files
- شناسه منبع یکسان فراداده، برای درخواستهای فقط فراداده:
https: / /generativelanguage.googleapis.com /v1beta /files
متن درخواست
بدنه درخواست حاوی دادههایی با ساختار زیر است:
file
object (File)
اختیاری. فراداده برای فایلی که باید ایجاد شود.
درخواست نمونه
تصویر
Python
Node.js
رفتن
صدف
صوتی
Python
Node.js
رفتن
صدف
نوشتار
Python
Node.js
رفتن
صدف
ویدیو
Python
Node.js
رفتن
صدف
Python
رفتن
وضعیت
نوع Status مدل خطای منطقیای را تعریف میکند که برای محیطهای برنامهنویسی مختلف، ازجمله میاناهای برنامهسازی کاربردی REST و میاناهای برنامهسازی کاربردی RPC، مناسب است. gRPC از آن استفاده میکند. هر پیام Status حاوی سه بخش داده است: کد خطا، پیام خطا، و جزئیات خطا.
میتوانید درباره این مدل خطا و نحوه کار با آن در راهنمای طراحی میانای برنامهسازی کاربردی بیشتر بدانید.
code
integer
رمز وضعیت که باید مقدار شمارشی google.rpc.Code باشد.
message
string
پیام خطای توسعهدهنده که باید به زبان انگلیسی باشد. هر پیام خطای سَمت کاربر باید بومیسازی شود و در فیلد google.rpc.Status.details ارسال شود، یا توسط کارخواه بومیسازی شود.
details[]
object
فهرستی از پیامها که جزئیات خطا را دربردارند. مجموعه مشترکی از انواع پیام برای استفاده میاناهای برنامهسازی کاربردی وجود دارد.
شیء حاوی فیلدهایی از نوع دلخواه. فیلد اضافی "@type" حاوی URI است که نوع را مشخص میکند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }.
| نمایش JSON |
|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |