Gemini API mendukung upload file media secara terpisah dari input perintah, sehingga media Anda dapat digunakan kembali di beberapa permintaan dan beberapa perintah. Untuk mengetahui detail selengkapnya, lihat panduan Memberikan perintah dengan media.
Metode: media.upload
Membuat File
.
Endpoint
- URI upload, untuk permintaan upload media:
https://generativelanguage.googleapis.com/upload/v1beta/files
- URI metadata, khusus untuk permintaan metadata:
https://generativelanguage.googleapis.com/v1beta/files
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
file
object (File
)
Opsional. Metadata untuk file yang akan dibuat.
Metode: files.get
Mendapatkan metadata untuk File
yang ditentukan.
Endpoint
gethttps://generativelanguage.googleapis.com/v1beta/{name=files/*}
Parameter jalur
name
string
Wajib. Nama File
yang akan didapatkan. Contoh: files/abc-123
Berbentuk files/{file}
.
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat instance File
.
Metode: files.list
Mencantumkan metadata untuk File
yang dimiliki oleh project yang meminta.
Endpoint
gethttps://generativelanguage.googleapis.com/v1beta/files
Parameter kueri
pageSize
integer
Opsional. Jumlah maksimum File
yang akan ditampilkan per halaman. Jika tidak ditentukan, defaultnya adalah 10. pageSize
maksimum adalah 100.
pageToken
string
Opsional. Token halaman dari panggilan files.list
sebelumnya.
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Respons untuk files.list
.
Jika berhasil, isi respons memuat data dengan struktur berikut:
files[]
object (File
)
Daftar File
.
nextPageToken
string
Token yang dapat dikirim sebagai pageToken
ke panggilan files.list
berikutnya.
Representasi JSON |
---|
{
"files": [
{
object ( |
Metode: files.delete
Menghapus File
.
Endpoint
deletehttps://generativelanguage.googleapis.com/v1beta/{name=files/*}
Parameter jalur
name
string
Wajib. Nama File
yang akan dihapus. Contoh: files/abc-123
Berbentuk files/{file}
.
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons adalah objek JSON kosong.
Resource REST: file
Resource: File
File yang diupload ke API. ID Berikutnya: 15
name
string
Tidak dapat diubah. ID. Nama resource File
. ID (nama tidak termasuk awalan "files/") dapat berisi maksimal 40 karakter yang berupa alfanumerik huruf kecil atau tanda hubung (-). ID tidak boleh diawali atau diakhiri dengan tanda hubung. Jika nama kosong saat pembuatan, nama unik akan dibuat. Contoh: files/123-456
displayName
string
Opsional. Nama tampilan yang dapat dibaca manusia untuk File
. Panjang nama tampilan tidak boleh lebih dari 512 karakter, termasuk spasi. Contoh: "Gambar Sambutan"
mimeType
string
Hanya output. Jenis MIME file.
sizeBytes
string (int64 format)
Hanya output. Ukuran file dalam byte.
createTime
string (Timestamp
format)
Hanya output. Stempel waktu saat File
dibuat.
Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
, atau "2014-10-02T15:01:23+05:30"
.
updateTime
string (Timestamp
format)
Hanya output. Stempel waktu saat File
terakhir diperbarui.
Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
, atau "2014-10-02T15:01:23+05:30"
.
expirationTime
string (Timestamp
format)
Hanya output. Stempel waktu saat File
akan dihapus. Hanya ditetapkan jika File
dijadwalkan untuk berakhir masa berlakunya.
Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
, atau "2014-10-02T15:01:23+05:30"
.
sha256Hash
string (bytes format)
Hanya output. Hash SHA-256 byte yang diupload.
String berenkode base64.
uri
string
Hanya output. URI File
.
downloadUri
string
Hanya output. URI download File
.
state
enum (State
)
Hanya output. Memproses status File.
source
enum (Source
)
Sumber File.
error
object (Status
)
Hanya output. Status error jika Pemrosesan file gagal.
metadata
Union type
metadata
hanya dapat berupa salah satu dari hal berikut:videoMetadata
object (VideoMetadata
)
Hanya output. Metadata untuk video.
Representasi JSON |
---|
{ "name": string, "displayName": string, "mimeType": string, "sizeBytes": string, "createTime": string, "updateTime": string, "expirationTime": string, "sha256Hash": string, "uri": string, "downloadUri": string, "state": enum ( |
VideoMetadata
Metadata untuk video File
.
videoDuration
string (Duration
format)
Durasi video.
Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's
'. Contoh: "3.5s"
.
Representasi JSON |
---|
{ "videoDuration": string } |
Negara Bagian
Status untuk siklus proses File.
Enum | |
---|---|
STATE_UNSPECIFIED |
Nilai default. Nilai ini digunakan jika status dihilangkan. |
PROCESSING |
File sedang diproses dan belum dapat digunakan untuk inferensi. |
ACTIVE |
File diproses dan tersedia untuk inferensi. |
FAILED |
Pemrosesan file gagal. |
Sumber
Enum | |
---|---|
SOURCE_UNSPECIFIED |
Digunakan jika sumber tidak ditentukan. |
UPLOADED |
Menunjukkan bahwa file diupload oleh pengguna. |
GENERATED |
Menunjukkan bahwa file dibuat oleh Google. |
Status
Jenis Status
menentukan model error logis yang cocok untuk berbagai lingkungan pemrograman, meliputi REST API dan RPC API. Jenis error ini digunakan oleh gRPC. Setiap pesan Status
berisi tiga bagian data: kode error, pesan error, dan detail error.
Anda dapat mencari tahu lebih lanjut tentang model error ini dan cara penanganannya di Panduan Desain API.
code
integer
Kode status, harus berupa nilai enum dari google.rpc.Code
.
message
string
Pesan error yang ditampilkan ke developer dan seharusnya dalam bahasa Inggris. Setiap pesan error yang ditampilkan kepada pengguna harus dilokalkan dan dikirim di kolom google.rpc.Status.details
, atau dilokalkan oleh klien.
details[]
object
Daftar pesan yang membawa detail error. Ada seperangkat jenis pesan umum untuk digunakan API.
Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type"
berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }
.
Representasi JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |