Gemini API از آپلود فایلهای رسانه جدا از ورودی سریع پشتیبانی میکند و به شما اجازه میدهد تا در چندین درخواست و چندین درخواست مجدداً از رسانه شما استفاده شود. برای جزئیات بیشتر، راهنمای درخواست با رسانه را بررسی کنید.
روش: media.upload
یک File
ایجاد می کند.
نقطه پایانی
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
file
object ( File
)
اختیاری. فراداده برای ایجاد فایل
درخواست نمونه
تصویر
پایتون
Node.js
برو
پوسته
صوتی
پایتون
Node.js
برو
پوسته
متن
پایتون
Node.js
برو
پوسته
ویدئو
پایتون
Node.js
برو
پوسته
پایتون
روش: files.get
فراداده را برای File
داده شده دریافت می کند.
نقطه پایانی
https://generativelanguage.googleapis.com/v1beta/{name=files/*} را دریافت کنیدپارامترهای مسیر
string
name
مورد نیاز. نام File
که باید دریافت کنید. مثال: files/abc-123
به شکل files/{file}
است.
درخواست بدن
بدنه درخواست باید خالی باشد.
درخواست نمونه
پایتون
Node.js
برو
پوسته
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از File
است.
روش: files.list
فراداده File
های متعلق به پروژه درخواست کننده را فهرست می کند.
نقطه پایانی
https://generativelanguage.googleapis.com/v1beta/files را دریافت کنیدپارامترهای پرس و جو
pageSize
integer
اختیاری. حداکثر تعداد File
برای بازگشت در هر صفحه. اگر مشخص نشده باشد، پیشفرض 10 است. حداکثر pageSize
100 است.
string
pageToken
اختیاری. نشانه صفحه از تماس قبلی files.list
.
درخواست بدن
بدنه درخواست باید خالی باشد.
درخواست نمونه
پایتون
Node.js
برو
پوسته
بدن پاسخگو
پاسخ برای files.list
.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
files[]
object ( File
)
لیست File
s.
string
nextPageToken
نشانه ای که می تواند به عنوان pageToken
به فراخوانی files.list
بعدی ارسال شود.
نمایندگی JSON |
---|
{
"files": [
{
object ( |
روش: files.delete
File
را حذف می کند.
نقطه پایانی
حذف https://generativelanguage.googleapis.com/v1beta/{name=files/*}پارامترهای مسیر
string
name
مورد نیاز. نام File
برای حذف مثال: files/abc-123
به شکل files/{file}
است.
درخواست بدن
بدنه درخواست باید خالی باشد.
درخواست نمونه
پایتون
Node.js
برو
پوسته
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ خالی است.
منبع REST: فایل ها
منبع: فایل
فایلی که در API آپلود شده است.
string
name
تغییرناپذیر. شناسه. نام منبع File
شناسه (نام بدون پیشوند "files/") میتواند تا 40 کاراکتر داشته باشد که حروف عددی کوچک یا خط تیره (-) هستند. شناسه نمی تواند با خط تیره شروع یا پایان یابد. اگر نام در ایجاد خالی باشد، یک نام منحصر به فرد ایجاد می شود. مثال: files/123-456
string
displayName
اختیاری. نام نمایشی قابل خواندن توسط انسان برای File
. نام نمایشی نباید بیش از 512 کاراکتر به همراه فاصله باشد. مثال: "تصویر خوش آمدگویی"
string
mimeType
فقط خروجی نوع MIME فایل
sizeBytes
string ( int64 format)
فقط خروجی حجم فایل بر حسب بایت
createTime
string ( Timestamp
format)
فقط خروجی مهر زمانی زمانی که File
ایجاد شد.
مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: "2014-10-02T15:01:23Z"
و "2014-10-02T15:01:23.045123456Z"
.
updateTime
string ( Timestamp
format)
فقط خروجی مهر زمانی آخرین بهروزرسانی File
.
مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: "2014-10-02T15:01:23Z"
و "2014-10-02T15:01:23.045123456Z"
.
expirationTime
string ( Timestamp
format)
فقط خروجی مهر زمانی زمانی که File
حذف خواهد شد. فقط در صورتی تنظیم کنید که File
برنامه ریزی شده منقضی شود.
مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: "2014-10-02T15:01:23Z"
و "2014-10-02T15:01:23.045123456Z"
.
sha256Hash
string ( bytes format)
فقط خروجی SHA-256 هش بایت های آپلود شده.
رشته ای با کد base64.
string
uri
فقط خروجی uri of the File
.
state
enum ( State
)
فقط خروجی وضعیت پردازش فایل
error
object ( Status
)
فقط خروجی اگر پردازش فایل انجام نشد، وضعیت خطا.
metadata
میدان اتحادیه فراداده برای فایل metadata
تنها می تواند یکی از موارد زیر باشد: videoMetadata
object ( VideoMetadata
)
فقط خروجی فراداده برای یک ویدیو.
نمایندگی JSON |
---|
{ "name": string, "displayName": string, "mimeType": string, "sizeBytes": string, "createTime": string, "updateTime": string, "expirationTime": string, "sha256Hash": string, "uri": string, "state": enum ( |
داده های ویدیویی
فراداده برای یک File
ویدیویی.
videoDuration
string ( Duration
format)
مدت زمان ویدیو.
مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s
' ختم می شود. مثال: "3.5s"
.
نمایندگی JSON |
---|
{ "videoDuration": string } |
ایالت
وضعیت برای چرخه حیات یک فایل.
Enums | |
---|---|
STATE_UNSPECIFIED | مقدار پیش فرض اگر حالت حذف شود از این مقدار استفاده می شود. |
PROCESSING | فایل در حال پردازش است و هنوز نمی توان از آن برای استنتاج استفاده کرد. |
ACTIVE | فایل پردازش شده و برای استنباط در دسترس است. |
FAILED | فایل پردازش نشد. |
وضعیت
نوع 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: ..., ... } ] } |
Gemini API از آپلود فایلهای رسانه جدا از ورودی سریع پشتیبانی میکند و به شما اجازه میدهد تا در چندین درخواست و چندین درخواست مجدداً از رسانه شما استفاده شود. برای جزئیات بیشتر، راهنمای درخواست با رسانه را بررسی کنید.
روش: media.upload
یک File
ایجاد می کند.
نقطه پایانی
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
file
object ( File
)
اختیاری. فراداده برای ایجاد فایل
درخواست نمونه
تصویر
پایتون
Node.js
برو
پوسته
صوتی
پایتون
Node.js
برو
پوسته
متن
پایتون
Node.js
برو
پوسته
ویدئو
پایتون
Node.js
برو
پوسته
پایتون
روش: files.get
فراداده را برای File
داده شده دریافت می کند.
نقطه پایانی
https://generativelanguage.googleapis.com/v1beta/{name=files/*} را دریافت کنیدپارامترهای مسیر
string
name
مورد نیاز. نام File
که باید دریافت کنید. مثال: files/abc-123
به شکل files/{file}
است.
درخواست بدن
بدنه درخواست باید خالی باشد.
درخواست نمونه
پایتون
Node.js
برو
پوسته
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از File
است.
روش: files.list
فراداده File
های متعلق به پروژه درخواست کننده را فهرست می کند.
نقطه پایانی
https://generativelanguage.googleapis.com/v1beta/files را دریافت کنیدپارامترهای پرس و جو
pageSize
integer
اختیاری. حداکثر تعداد File
برای بازگشت در هر صفحه. اگر مشخص نشده باشد، پیشفرض 10 است. حداکثر pageSize
100 است.
string
pageToken
اختیاری. نشانه صفحه از تماس قبلی files.list
.
درخواست بدن
بدنه درخواست باید خالی باشد.
درخواست نمونه
پایتون
Node.js
برو
پوسته
بدن پاسخگو
پاسخ برای files.list
.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
files[]
object ( File
)
لیست File
s.
string
nextPageToken
نشانه ای که می تواند به عنوان pageToken
به فراخوانی files.list
بعدی ارسال شود.
نمایندگی JSON |
---|
{
"files": [
{
object ( |
روش: files.delete
File
را حذف می کند.
نقطه پایانی
حذف https://generativelanguage.googleapis.com/v1beta/{name=files/*}پارامترهای مسیر
string
name
مورد نیاز. نام File
برای حذف مثال: files/abc-123
به شکل files/{file}
است.
درخواست بدن
بدنه درخواست باید خالی باشد.
درخواست نمونه
پایتون
Node.js
برو
پوسته
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ خالی است.
منبع REST: فایل ها
منبع: فایل
فایلی که در API آپلود شده است.
string
name
تغییرناپذیر. شناسه. نام منبع File
شناسه (نام بدون پیشوند "files/") میتواند تا 40 کاراکتر داشته باشد که حروف عددی کوچک یا خط تیره (-) هستند. شناسه نمی تواند با خط تیره شروع یا پایان یابد. اگر نام در ایجاد خالی باشد، یک نام منحصر به فرد ایجاد می شود. مثال: files/123-456
string
displayName
اختیاری. نام نمایشی قابل خواندن توسط انسان برای File
. نام نمایشی نباید بیش از 512 کاراکتر به همراه فاصله باشد. مثال: "تصویر خوش آمدگویی"
string
mimeType
فقط خروجی نوع MIME فایل
sizeBytes
string ( int64 format)
فقط خروجی حجم فایل بر حسب بایت
createTime
string ( Timestamp
format)
فقط خروجی مهر زمانی زمانی که File
ایجاد شد.
مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: "2014-10-02T15:01:23Z"
و "2014-10-02T15:01:23.045123456Z"
.
updateTime
string ( Timestamp
format)
فقط خروجی مهر زمانی آخرین بهروزرسانی File
.
مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: "2014-10-02T15:01:23Z"
و "2014-10-02T15:01:23.045123456Z"
.
expirationTime
string ( Timestamp
format)
فقط خروجی مهر زمانی زمانی که File
حذف خواهد شد. فقط در صورتی تنظیم کنید که File
برنامه ریزی شده منقضی شود.
مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: "2014-10-02T15:01:23Z"
و "2014-10-02T15:01:23.045123456Z"
.
sha256Hash
string ( bytes format)
فقط خروجی SHA-256 هش بایت های آپلود شده.
رشته ای با کد base64.
string
uri
فقط خروجی uri of the File
.
state
enum ( State
)
فقط خروجی وضعیت پردازش فایل
error
object ( Status
)
فقط خروجی اگر پردازش فایل انجام نشد، وضعیت خطا.
metadata
میدان اتحادیه فراداده برای فایل metadata
تنها می تواند یکی از موارد زیر باشد: videoMetadata
object ( VideoMetadata
)
فقط خروجی فراداده برای یک ویدیو.
نمایندگی JSON |
---|
{ "name": string, "displayName": string, "mimeType": string, "sizeBytes": string, "createTime": string, "updateTime": string, "expirationTime": string, "sha256Hash": string, "uri": string, "state": enum ( |
داده های ویدیویی
فراداده برای یک File
ویدیویی.
videoDuration
string ( Duration
format)
مدت زمان ویدیو.
مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s
' ختم می شود. مثال: "3.5s"
.
نمایندگی JSON |
---|
{ "videoDuration": string } |
ایالت
وضعیت برای چرخه حیات یک فایل.
Enums | |
---|---|
STATE_UNSPECIFIED | مقدار پیش فرض اگر حالت حذف شود از این مقدار استفاده می شود. |
PROCESSING | فایل در حال پردازش است و هنوز نمی توان از آن برای استنتاج استفاده کرد. |
ACTIVE | فایل پردازش شده و برای استنباط در دسترس است. |
FAILED | پردازش فایل ناموفق بود. |
وضعیت
نوع 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: ..., ... } ] } |
Gemini API از آپلود فایلهای رسانه جدا از ورودی سریع پشتیبانی میکند و به شما اجازه میدهد تا در چندین درخواست و چندین درخواست مجدداً از رسانه شما استفاده شود. برای جزئیات بیشتر، راهنمای درخواست با رسانه را بررسی کنید.
روش: media.upload
یک File
ایجاد می کند.
نقطه پایانی
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
file
object ( File
)
اختیاری. فراداده برای ایجاد فایل
درخواست نمونه
تصویر
پایتون
Node.js
برو
پوسته
صوتی
پایتون
Node.js
برو
پوسته
متن
پایتون
Node.js
برو
پوسته
ویدئو
پایتون
Node.js
برو
پوسته
پایتون
روش: files.get
فراداده را برای File
داده شده دریافت می کند.
نقطه پایانی
https://generativelanguage.googleapis.com/v1beta/{name=files/*} را دریافت کنیدپارامترهای مسیر
string
name
مورد نیاز. نام File
که باید دریافت کنید. مثال: files/abc-123
به شکل files/{file}
است.
درخواست بدن
بدنه درخواست باید خالی باشد.
درخواست نمونه
پایتون
Node.js
برو
پوسته
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از File
است.
روش: files.list
فراداده File
های متعلق به پروژه درخواست کننده را فهرست می کند.
نقطه پایانی
https://generativelanguage.googleapis.com/v1beta/files را دریافت کنیدپارامترهای پرس و جو
pageSize
integer
اختیاری. حداکثر تعداد File
برای بازگشت در هر صفحه. اگر مشخص نشده باشد، پیشفرض 10 است. حداکثر pageSize
100 است.
string
pageToken
اختیاری. نشانه صفحه از تماس قبلی files.list
.
درخواست بدن
بدنه درخواست باید خالی باشد.
درخواست نمونه
پایتون
Node.js
برو
پوسته
بدن پاسخگو
پاسخ برای files.list
.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
files[]
object ( File
)
لیست File
s.
string
nextPageToken
نشانه ای که می تواند به عنوان pageToken
به فراخوانی files.list
بعدی ارسال شود.
نمایندگی JSON |
---|
{
"files": [
{
object ( |
روش: files.delete
File
را حذف می کند.
نقطه پایانی
حذف https://generativelanguage.googleapis.com/v1beta/{name=files/*}پارامترهای مسیر
string
name
مورد نیاز. نام File
برای حذف مثال: files/abc-123
به شکل files/{file}
است.
درخواست بدن
بدنه درخواست باید خالی باشد.
درخواست نمونه
پایتون
Node.js
برو
پوسته
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ خالی است.
منبع REST: فایل ها
منبع: فایل
فایلی که در API آپلود شده است.
string
name
تغییرناپذیر. شناسه. نام منبع File
شناسه (نام بدون پیشوند "files/") میتواند تا 40 کاراکتر داشته باشد که حروف عددی کوچک یا خط تیره (-) هستند. شناسه نمی تواند با خط تیره شروع یا پایان یابد. اگر نام در ایجاد خالی باشد، یک نام منحصر به فرد ایجاد می شود. مثال: files/123-456
string
displayName
اختیاری. نام نمایشی قابل خواندن توسط انسان برای File
. نام نمایشی نباید بیش از 512 کاراکتر به همراه فاصله باشد. مثال: "تصویر خوش آمدگویی"
string
mimeType
فقط خروجی نوع MIME فایل
sizeBytes
string ( int64 format)
فقط خروجی حجم فایل بر حسب بایت
createTime
string ( Timestamp
format)
فقط خروجی مهر زمانی زمانی که File
ایجاد شد.
مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: "2014-10-02T15:01:23Z"
و "2014-10-02T15:01:23.045123456Z"
.
updateTime
string ( Timestamp
format)
فقط خروجی مهر زمانی آخرین بهروزرسانی File
.
مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: "2014-10-02T15:01:23Z"
و "2014-10-02T15:01:23.045123456Z"
.
expirationTime
string ( Timestamp
format)
فقط خروجی مهر زمانی زمانی که File
حذف خواهد شد. فقط در صورتی تنظیم کنید که File
برنامه ریزی شده منقضی شود.
مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: "2014-10-02T15:01:23Z"
و "2014-10-02T15:01:23.045123456Z"
.
sha256Hash
string ( bytes format)
فقط خروجی SHA-256 هش بایت های آپلود شده.
رشته ای با کد base64.
string
uri
فقط خروجی uri of the File
.
state
enum ( State
)
فقط خروجی وضعیت پردازش فایل
error
object ( Status
)
فقط خروجی اگر پردازش فایل انجام نشد، وضعیت خطا.
metadata
میدان اتحادیه فراداده برای فایل metadata
تنها می تواند یکی از موارد زیر باشد: videoMetadata
object ( VideoMetadata
)
فقط خروجی فراداده برای یک ویدیو.
نمایندگی JSON |
---|
{ "name": string, "displayName": string, "mimeType": string, "sizeBytes": string, "createTime": string, "updateTime": string, "expirationTime": string, "sha256Hash": string, "uri": string, "state": enum ( |
داده های ویدیویی
فراداده برای یک File
ویدیویی.
videoDuration
string ( Duration
format)
مدت زمان ویدیو.
مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s
' ختم می شود. مثال: "3.5s"
.
نمایندگی JSON |
---|
{ "videoDuration": string } |
ایالت
وضعیت برای چرخه حیات یک فایل.
Enums | |
---|---|
STATE_UNSPECIFIED | مقدار پیش فرض اگر حالت حذف شود از این مقدار استفاده می شود. |
PROCESSING | فایل در حال پردازش است و هنوز نمی توان از آن برای استنتاج استفاده کرد. |
ACTIVE | فایل پردازش شده و برای استنباط در دسترس است. |
FAILED | فایل پردازش نشد. |
وضعیت
نوع 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: ..., ... } ] } |