API Gemini поддерживает загрузку медиафайлов отдельно от ввода подсказок, что позволяет повторно использовать ваши медиа в нескольких запросах и нескольких подсказках. Для получения более подробной информации ознакомьтесь с руководством Prompting with media .
Метод: media.upload
Создает File
.
Конечная точка
https: / /generativelanguage.googleapis.com /upload /v1beta /files
https: / /generativelanguage.googleapis.com /v1beta /files
Текст запроса
Тело запроса содержит данные со следующей структурой:
file
object ( File
)
Необязательно. Метаданные для создаваемого файла.
Метод: files.get
Получает метаданные для указанного File
.
Конечная точка
получитьhttps: / /generativelanguage.googleapis.com /v1beta /{name=files /*}
Параметры пути
name
string
Обязательно. Имя File
, который нужно получить. Пример: files/abc-123
Он имеет вид files/{file}
.
Текст запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит экземпляр File
.
Метод: files.list
Перечисляет метаданные для File
, принадлежащих запрашивающему проекту.
Конечная точка
получитьhttps: / /generativelanguage.googleapis.com /v1beta /files
Параметры запроса
pageSize
integer
Необязательно. Максимальное количество File
для возврата на страницу. Если не указано, по умолчанию 10. Максимальный pageSize
равен 100.
string
pageToken
Необязательно. Токен страницы из предыдущего вызова files.list
.
Текст запроса
Тело запроса должно быть пустым.
Тело ответа
Ответ для 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 /*}
Параметры пути
name
string
Обязательно. Имя File
для удаления. Пример: files/abc-123
Он имеет вид files/{file}
.
Текст запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа представляет собой пустой объект JSON.
Ресурс REST: файлы
Ресурс: Файл
Файл загружен в API. Следующий ID: 15
name
string
Неизменяемый. Идентификатор. Имя ресурса File
. Идентификатор (имя без префикса "files/") может содержать до 40 символов, которые являются строчными буквами, цифрами или дефисами (-). Идентификатор не может начинаться или заканчиваться дефисом. Если имя пустое при создании, будет сгенерировано уникальное имя. Пример: files/123-456
displayName
string
Необязательно. Удобочитаемое отображаемое имя для File
. Отображаемое имя должно быть не длиннее 512 символов, включая пробелы. Пример: "Welcome Image"
string
mimeType
Только вывод. MIME-тип файла.
string ( int64 format)
sizeBytes
(формат int64)Только вывод. Размер файла в байтах.
createTime
string ( Timestamp
format)
Только вывод. Метка времени создания File
.
Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
или "2014-10-02T15:01:23+05:30"
.
updateTime
string ( Timestamp
format)
Только вывод. Метка времени последнего обновления File
.
Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
или "2014-10-02T15:01:23+05:30"
.
expirationTime
string ( Timestamp
format)
Только вывод. Временная метка, когда File
будет удален. Устанавливается только в том случае, если File
должен истечь.
Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
или "2014-10-02T15:01:23+05:30"
.
sha256Hash
string ( bytes format)
Только вывод. SHA-256 хэш загруженных байтов.
Строка в кодировке base64.
string
uri
Только вывод. URI File
.
string
downloadUri
Только вывод. URI загрузки File
.
state
enum ( State
)
Только вывод. Состояние обработки файла.
source
enum ( Source
)
Источник файла.
object ( Status )
error
(статус)Только вывод. Статус ошибки, если обработка файла не удалась.
metadata
Union type
metadata
могут быть только одними из следующих:object ( VideoFileMetadata )
videoMetadata
( 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
.
videoDuration
string ( Duration
format)
Продолжительность видео.
Длительность в секундах с дробной частью до девяти цифр, заканчивающаяся на ' s
'. Пример: "3.5s"
.
JSON-представление |
---|
{ "videoDuration": string } |
Состояние
Состояния жизненного цикла файла.
Перечисления | |
---|---|
STATE_UNSPECIFIED | Значение по умолчанию. Это значение используется, если состояние пропущено. |
PROCESSING | Файл обрабатывается и пока не может быть использован для вывода. |
ACTIVE | Файл обработан и доступен для вывода. |
FAILED | Файл не удалось обработать. |
Источник
Перечисления | |
---|---|
SOURCE_UNSPECIFIED | Используется, если источник не указан. |
UPLOADED | Указывает, что файл загружен пользователем. |
GENERATED | Указывает, что файл создан Google. |
Статус
Тип Status
определяет логическую модель ошибок, подходящую для различных сред программирования, включая REST API и RPC API. Он используется gRPC . Каждое сообщение Status
содержит три фрагмента данных: код ошибки, сообщение об ошибке и сведения об ошибке.
Дополнительную информацию об этой модели ошибок и о том, как с ней работать, можно найти в Руководстве по проектированию API .
code
integer
Код состояния, который должен быть значением перечисления 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: ..., ... } ] } |