API Gemini поддерживает загрузку медиафайлов отдельно от ввода приглашения, что позволяет повторно использовать медиафайлы в нескольких запросах и нескольких приглашениях. Для получения более подробной информации ознакомьтесь с руководством «Подсказки с помощью мультимедиа» .
Метод: 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.
nextPageToken
string
PageToken Токен, который можно отправить как 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 «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z"
и "2014-10-02T15:01:23.045123456Z"
.
updateTime
string ( Timestamp
format)
Только вывод. Временная метка последнего обновления File
.
Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z"
и "2014-10-02T15:01:23.045123456Z"
.
expirationTime
string ( Timestamp
format)
Только вывод. Временная метка, когда File
будет удален. Устанавливается только в том случае, если срок действия File
истекает.
Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z"
и "2014-10-02T15:01:23.045123456Z"
.
sha256Hash
string ( bytes format)
Только вывод. SHA-256 хеш загруженных байтов.
Строка в кодировке Base64.
string
uri
Только вывод. URI File
.
state
enum ( State
)
Только вывод. Состояние обработки файла.
error
object ( Status
)
Только вывод. Статус ошибки, если обработка файла не удалась.
metadata
поля объединения. Метаданные для файла. metadata
могут быть только одним из следующих: object ( VideoMetadata )
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 } |
Состояние
Состояния жизненного цикла файла.
Перечисления | |
---|---|
STATE_UNSPECIFIED | Значение по умолчанию. Это значение используется, если состояние опущено. |
PROCESSING | Файл обрабатывается и пока не может быть использован для вывода. |
ACTIVE | Файл обработан и доступен для вывода. |
FAILED | Не удалось обработать файл. |
Статус
Тип Status
определяет логическую модель ошибок, подходящую для различных сред программирования, включая API REST и API RPC. Он используется gRPC . Каждое сообщение Status
содержит три части данных: код ошибки, сообщение об ошибке и сведения об ошибке.
Подробнее об этой модели ошибок и о том, как с ней работать, можно узнать в API Design Guide .
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: ..., ... } ] } |