رابط برنامهنویسی Gemini از آپلود فایلهای رسانهای جدا از ورودی اعلان پشتیبانی میکند و به شما امکان میدهد از رسانههای خود در چندین درخواست و اعلان مختلف استفاده مجدد کنید. برای جزئیات بیشتر، راهنمای اعلان با رسانه را بررسی کنید.
فایلی در API آپلود شد. شناسه بعدی: ۱۵
string name تغییرناپذیر. شناسه. نام منبع File . شناسه (نام به استثنای پیشوند "files/") میتواند شامل حداکثر ۴۰ کاراکتر باشد که حروف کوچک و عددی یا خط تیره (-) باشند. شناسه نمیتواند با خط تیره شروع یا پایان یابد. اگر نام در هنگام ایجاد خالی باشد، یک نام منحصر به فرد ایجاد میشود. مثال: files/123-456
string displayName اختیاری. نام نمایشی قابل خواندن توسط انسان برای File . نام نمایشی نباید بیش از ۵۱۲ کاراکتر، شامل فاصلهها، باشد. مثال: "تصویر خوش آمدید"
string mimeTypeفقط خروجی. نوع MIME فایل.
sizeBytesstring ( int64 format)فقط خروجی. اندازه فایل بر حسب بایت.
createTimestring ( Timestamp format) فقط خروجی. مهر زمانیِ ایجاد File .
از 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) فقط خروجی. مهر زمانی آخرین بهروزرسانی File .
از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .
string ( Timestamp format) expirationTime فقط خروجی. مهر زمانی که File حذف خواهد شد. فقط در صورتی تنظیم میشود که File برای انقضا برنامهریزی شده باشد.
از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .
sha256Hashstring ( bytes format)فقط خروجی. هش SHA-256 از بایتهای آپلود شده.
یک رشته کدگذاری شده با base64.
string uri فقط خروجی. url File .
downloadUristring فقط خروجی. آدرس دانلود File .
stateenum ( State )فقط خروجی. وضعیت پردازش فایل.
sourceenum ( Source )منبع فایل.
errorobject ( Status )فقط خروجی. وضعیت خطا در صورت عدم موفقیت در پردازش فایل.
Union type metadatametadata میتواند فقط یکی از موارد زیر باشد:videoMetadataobject ( VideoFileMetadata )فقط خروجی. فراداده برای یک ویدیو.
| نمایش JSON |
|---|
{ "name": string, "displayName": string, "mimeType": string, "sizeBytes": string, "createTime": string, "updateTime": string, "expirationTime": string, "sha256Hash": string, "uri": string, "downloadUri": string, "state": enum ( |
فراداده برای یک File ویدیویی.
videoDurationstring ( Duration format)مدت زمان ویدیو.
مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم میشود. مثال: "3.5s" .
| نمایش JSON |
|---|
{ "videoDuration": string } |
حالتهایی برای چرخه حیات یک فایل.
| انومها | |
|---|---|
STATE_UNSPECIFIED | مقدار پیشفرض. این مقدار در صورتی استفاده میشود که state حذف شده باشد. |
PROCESSING | فایل در حال پردازش است و هنوز نمیتوان از آن برای استنتاج استفاده کرد. |
ACTIVE | فایل پردازش شده و برای استنتاج در دسترس است. |
FAILED | پردازش فایل ناموفق بود. |
| انومها | |
|---|---|
SOURCE_UNSPECIFIED | در صورتی که منبع مشخص نشده باشد، استفاده میشود. |
UPLOADED | نشان میدهد که فایل توسط کاربر آپلود شده است. |
GENERATED | نشان میدهد که فایل توسط گوگل ایجاد شده است. |
REGISTERED | نشان میدهد که فایل ثبت شده است، یعنی یک فایل Google Cloud Storage. |
متادیتای File داده شده را دریافت میکند.
https: / /generativelanguage.googleapis.com /v1beta /{name=files /*}string name الزامی. نام File که قرار است دریافت شود. مثال: files/abc-123 این پارامتر به شکل files/{file} است.
بدنه درخواست باید خالی باشد.
در صورت موفقیت، بدنه پاسخ شامل نمونهای از File است.
فرادادههای مربوط به File که متعلق به پروژه درخواستکننده هستند را فهرست میکند.
https: / /generativelanguage.googleapis.com /v1beta /filesinteger pageSize اختیاری. حداکثر تعداد File برای برگرداندن در هر صفحه. اگر مشخص نشود، پیشفرض ۱۰ است. حداکثر pageSize ۱۰۰ است.
string pageToken اختیاری. یک توکن صفحه از فراخوانی قبلی files.list .
بدنه درخواست باید خالی باشد.
پاسخ برای files.list .
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
files[]object ( File ) فهرست File s.
string nextPageToken یک توکن که میتواند به عنوان یک pageToken به فراخوانی بعدی files.list ارسال شود.
| نمایش JSON |
|---|
{
"files": [
{
object ( |
File را حذف میکند.
https: / /generativelanguage.googleapis.com /v1beta /{name=files /*}string name الزامی. نام File که قرار است حذف شود. مثال: files/abc-123 این پارامتر به شکل files/{file} است.
بدنه درخواست باید خالی باشد.
در صورت موفقیت، بدنه پاسخ یک شیء JSON خالی خواهد بود.
یک فایل Google Cloud Storage را با FileService ثبت میکند. از کاربر انتظار میرود که URIهای Google Cloud Storage را ارائه دهد و در عوض برای هر URI یک منبع File دریافت کند. توجه داشته باشید که فایلها کپی نمیشوند، فقط با File API ثبت میشوند. اگر یک فایل ثبت نشود، کل درخواست با شکست مواجه میشود.
https: / /generativelanguage.googleapis.com /v1beta /files:registerبدنه درخواست شامل دادههایی با ساختار زیر است:
string uris[] الزامی. آدرسهای اینترنتی (URI) فضای ذخیرهسازی ابری گوگل برای ثبت. مثال: gs://bucket/object .
یک File ایجاد میکند.
https: / /generativelanguage.googleapis.com /upload /v1beta /fileshttps: / /generativelanguage.googleapis.com /v1beta /files
بدنه درخواست شامل دادههایی با ساختار زیر است:
fileobject ( File )اختیاری. فراداده برای ایجاد فایل.
نوع Status یک مدل خطای منطقی را تعریف میکند که برای محیطهای برنامهنویسی مختلف، از جمله REST APIها و RPC APIها، مناسب است. این مدل توسط gRPC استفاده میشود. هر پیام Status شامل سه بخش داده است: کد خطا، پیام خطا و جزئیات خطا.
میتوانید اطلاعات بیشتری در مورد این مدل خطا و نحوه کار با آن را در راهنمای طراحی API بیابید.
integer code کد وضعیت، که باید یک مقدار شمارشی از google.rpc.Code باشد.
string message یک پیام خطای مربوط به توسعهدهنده که باید به زبان انگلیسی باشد. هرگونه پیام خطای مربوط به کاربر باید بومیسازی شده و در فیلد google.rpc.Status.details ارسال شود، یا توسط کلاینت بومیسازی شود.
details[]objectفهرستی از پیامهایی که جزئیات خطا را در خود دارند. مجموعهای مشترک از انواع پیامها برای استفاده توسط APIها وجود دارد.
یک شیء حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی "@type" حاوی یک URI است که نوع را مشخص میکند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" } .
| نمایش JSON |
|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |