Yöntem: media.upload
File
oluşturur.
Uç nokta
yükleme URI'si, medya yükleme istekleri için:`post
https://generativelanguage.googleapis.com/upload/v1beta/files
- Yalnızca meta veri istekleri için meta veri URI'si:
POST https://generativelanguage.googleapis.com/v1beta/files
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
İstek içeriği
İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:
file
object (File
)
İsteğe bağlı. Oluşturulacak dosyanın meta verileri.
Örnek istek
Resim
Python
Node.js
Ses
Python
Node.js
Metin
Python
Node.js
Video
Python
Node.js
Yöntem: files.get
Belirtilen File
için meta verileri alır.
Uç nokta
indir
https://generativelanguage.googleapis.com/v1beta/{name=files/*}
Yol parametreleri
name
string
Zorunlu. Alınacak File
adı. Örnek: files/abc-123
files/{file}
biçimindedir.
İstek içeriği
İstek metni boş olmalıdır.
Örnek istek
Python
Node.js
Yanıt gövdesi
Başarılıysa yanıt metni, File
öğesinin bir örneğini içerir.
Yöntem: files.list
İstekte bulunan projeye ait File
öğelerinin meta verilerini listeler.
Uç nokta
indir
https://generativelanguage.googleapis.com/v1beta/files
Sorgu parametreleri
pageSize
integer
İsteğe bağlı. Sayfa başına döndürülecek maksimum File
sayısı. Belirtilmemişse varsayılan olarak 10'dur. Maksimum pageSize
100'dür.
pageToken
string
İsteğe bağlı. Önceki bir files.list
çağrısının sayfa jetonu.
İstek içeriği
İstek metni boş olmalıdır.
Örnek istek
Python
Node.js
Yanıt gövdesi
files.list
için yanıt.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
files[]
object (File
)
File
listesi.
nextPageToken
string
Sonraki files.list
çağrısına pageToken
olarak gönderilebilecek jeton.
JSON gösterimi |
---|
{
"files": [
{
object ( |
Yöntem: files.delete
File
öğesini siler.
Uç nokta
sil
https://generativelanguage.googleapis.com/v1beta/{name=files/*}
Yol parametreleri
name
string
Zorunlu. Silinecek File
öğesinin adı. Örnek: files/abc-123
files/{file}
biçimindedir.
İstek içeriği
İstek metni boş olmalıdır.
Örnek istek
Python
Node.js
Yanıt gövdesi
Başarılı olursa yanıt gövdesi boş olur.
REST Kaynağı: dosyalar
Kaynak: Dosya
API'ye yüklenen bir dosya.
JSON gösterimi |
---|
{ "name": string, "displayName": string, "mimeType": string, "sizeBytes": string, "createTime": string, "updateTime": string, "expirationTime": string, "sha256Hash": string, "uri": string, "state": enum ( |
name
string
Sabit. Tanımlayıcı. File
kaynağının adı. Kimlik ("dosyalar/" öneki hariç) en fazla 40 karakter ve küçük harfli alfanümerik veya kısa çizgi (-) içerebilir. Kimlik, tireyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa benzersiz bir ad oluşturulur. Örnek: files/123-456
displayName
string
İsteğe bağlı. File
için kullanıcıların okuyabileceği görünen ad. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Karşılama Resmi"
mimeType
string
Yalnızca çıkış. Dosyanın MIME türü.
sizeBytes
string (int64 format)
Yalnızca çıkış. Dosyanın bayt cinsinden boyutu.
createTime
string (Timestamp
format)
Yalnızca çıkış. File
öğesinin oluşturulduğu zamanı gösteren zaman damgası.
RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z"
ve "2014-10-02T15:01:23.045123456Z"
.
updateTime
string (Timestamp
format)
Yalnızca çıkış. File
öğesinin en son ne zaman güncellendiğine ilişkin zaman damgası.
RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z"
ve "2014-10-02T15:01:23.045123456Z"
.
expirationTime
string (Timestamp
format)
Yalnızca çıkış. File
öğesinin silineceği zamanı gösteren zaman damgası. Yalnızca File
süresi sona erecek şekilde planlandıysa ayarlanır.
RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z"
ve "2014-10-02T15:01:23.045123456Z"
.
sha256Hash
string (bytes format)
Yalnızca çıkış. Yüklenen baytların SHA-256 karması.
base64 kodlu bir dize.
uri
string
Yalnızca çıkış. File
öğesinin URI'sı.
state
enum (State
)
Yalnızca çıkış. Dosyanın işlenme durumu.
error
object (Status
)
Yalnızca çıkış. Dosya işleme başarısız olduğunda hata durumu.
metadata
. Dosyaya ilişkin meta veriler. metadata
şunlardan yalnızca biri olabilir:
videoMetadata
object (VideoMetadata
)
Yalnızca çıkış. Videonun meta verileri.
VideoMetadata
File
başlıklı videonun meta verileri.
JSON gösterimi |
---|
{ "videoDuration": string } |
videoDuration
string (Duration
format)
Videonun süresi.
En fazla dokuz kesir basamağı olan ve "s
" ile biten, saniye cinsinden süre. Örnek: "3.5s"
.
Eyalet
Dosyanın yaşam döngüsüyle ilgili durumlar.
Sıralamalar | |
---|---|
STATE_UNSPECIFIED |
Varsayılan değerdir. Eyalet atlanırsa bu değer kullanılır. |
PROCESSING |
Dosya işleniyor ve henüz çıkarım için kullanılamaz. |
ACTIVE |
Dosya işlendi ve çıkarım için kullanılabilir. |
FAILED |
Dosya işlenemedi. |
Durum
Status
türü, REST API'ler ve RPC API'leri dahil olmak üzere farklı programlama ortamları için uygun bir mantıksal hata modelini tanımlar. gRPC tarafından kullanılır. Her Status
mesajı üç veri parçası içerir: hata kodu, hata mesajı ve hata ayrıntıları.
API Tasarım Kılavuzu'nda bu hata modeli ve bu hata modeliyle nasıl çalışılacağı hakkında daha fazla bilgi edinebilirsiniz.
JSON gösterimi |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
code
integer
google.rpc.Code
sıralama değeri olması gereken durum kodu.
message
string
Geliştiricilere yönelik, İngilizce olması gereken bir hata mesajı. Kullanıcılara yönelik tüm hata mesajları yerelleştirilip google.rpc.Status.details
alanında gönderilmeli veya istemci tarafından yerelleştirilmelidir.
details[]
object
Hata ayrıntılarını içeren mesajların listesi. API'lerin kullandığı bir dizi mesaj türü vardır.
Rastgele türden alanlar içeren nesne. Ek bir "@type"
alanı, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }
.