שיטה: media.upload
ייווצר File
.
נקודת קצה
URI להעלאה, לבקשות להעלאת מדיה:`post
https://generativelanguage.googleapis.com/upload/v1beta/files
- URI של מטא-נתונים, לבקשות למטא-נתונים בלבד:
POST https://generativelanguage.googleapis.com/v1beta/files
כתובת ה-URL משתמשת בתחביר המרת קידוד של gRPC.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
file
object (File
)
זה שינוי אופציונלי. המטא-נתונים של הקובץ ליצירה.
דוגמה לבקשה
תמונה
Python
Node.js
אודיו
Python
Node.js
טקסט
Python
Node.js
וידאו
Python
Node.js
שיטה: files.get
הפונקציה מקבלת את המטא-נתונים של File
הנתון.
נקודת קצה
הורדה
https://generativelanguage.googleapis.com/v1beta/{name=files/*}
פרמטרים של נתיב
name
string
חובה. השם של File
שצריך לקבל. לדוגמה: files/abc-123
היא מופיעה בצורה files/{file}
.
גוף הבקשה
גוף הבקשה חייב להיות ריק.
דוגמה לבקשה
Python
Node.js
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של File
.
שיטה: files.list
רשימה של המטא-נתונים של File
בבעלות הפרויקט המבקש.
נקודת קצה
הורדה
https://generativelanguage.googleapis.com/v1beta/files
פרמטרים של שאילתה
pageSize
integer
זה שינוי אופציונלי. המספר המקסימלי של File
שניות להחזרה בכל דף. אם לא צוין ערך, ברירת המחדל תהיה 10. המספר המקסימלי של pageSize
הוא 100.
pageToken
string
זה שינוי אופציונלי. אסימון דף מקריאה קודמת של files.list
.
גוף הבקשה
גוף הבקשה חייב להיות ריק.
דוגמה לבקשה
Python
Node.js
השיטה: files.delete
מתבצעת מחיקה של File
.
נקודת קצה
מחיקה
https://generativelanguage.googleapis.com/v1beta/{name=files/*}
פרמטרים של נתיב
name
string
חובה. השם של File
שרוצים למחוק. לדוגמה: files/abc-123
היא מופיעה בצורה files/{file}
.
גוף הבקשה
גוף הבקשה חייב להיות ריק.
דוגמה לבקשה
Python
Node.js
גוף התשובה
אם הביצוע יהיה תקין, גוף התגובה יהיה ריק.
Resource REST: קבצים
משאב: קובץ
קובץ שהועלה ל-API.
ייצוג JSON |
---|
{ "name": string, "displayName": string, "mimeType": string, "sizeBytes": string, "createTime": string, "updateTime": string, "expirationTime": string, "sha256Hash": string, "uri": string, "state": enum ( |
name
string
בלתי ניתן לשינוי. מזהה. שם המשאב File
. המזהה (שם, מלבד התחילית 'files/') יכול להכיל עד 40 תווים, שהם אותיות קטנות וספרות או מקפים (-). המזהה לא יכול להתחיל או להסתיים במקף. אם השם ריק בזמן היצירה, ייווצר שם ייחודי. לדוגמה: files/123-456
displayName
string
זה שינוי אופציונלי. שם תצוגה קריא לאנשים של File
. השם המוצג יכול להיות באורך של 512 תווים לכל היותר, כולל רווחים. דוגמה: "תמונת פתיחה"
mimeType
string
פלט בלבד. סוג ה-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.
uri
string
פלט בלבד. ה-URI של File
.
state
enum (State
)
פלט בלבד. מצב הקובץ בתהליך עיבוד.
error
object (Status
)
פלט בלבד. סטטוס השגיאה אם עיבוד הקובץ נכשל.
metadata
. מטא-נתונים של הקובץ. metadata
יכול להיות רק אחת מהאפשרויות הבאות:
videoMetadata
object (VideoMetadata
)
פלט בלבד. מטא-נתונים של סרטון.
VideoMetadata
מטא-נתונים של סרטון File
.
ייצוג JSON |
---|
{ "videoDuration": string } |
videoDuration
string (Duration
format)
משך הסרטון.
משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s
'. לדוגמה: "3.5s"
.
מדינה
מצבים במחזור החיים של קובץ.
טיפוסים בני מנייה (enum) | |
---|---|
STATE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה משמש אם לא מציינים את המצב. |
PROCESSING |
הקובץ בתהליך עיבוד ואי אפשר עדיין להשתמש בו לצורך הסקת מסקנות. |
ACTIVE |
הקובץ מעובד וזמין להסקת מסקנות. |
FAILED |
עיבוד הקובץ נכשל. |
סטטוס
הסוג Status
מגדיר מודל שגיאות לוגי שמתאים לסביבות תכנות שונות, כולל ממשקי API ל-REST וממשקי API ל-RPC. הוא נמצא בשימוש של gRPC. כל הודעת Status
מכילה שלושה נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה.
במדריך לעיצוב API אפשר לקרוא מידע נוסף על מודל השגיאות הזה ולהבין איך לעבוד איתו.
ייצוג JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
code
integer
קוד הסטטוס, שצריך להיות ערך enum של google.rpc.Code
.
message
string
הודעת שגיאה שמיועדת למפתחים וצריכה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמשים צריכה להיות מותאמת לשוק המקומי ולשלוח אותה בשדה google.rpc.Status.details
או להתאים אותה לשוק המקומי.
details[]
object
רשימה של הודעות שכוללות את פרטי השגיאה. יש כמה סוגים של הודעות שאפשר להשתמש בהם בממשקי API.
אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type"
מכיל URI המזהה את הסוג. לדוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }
.