API Gemini поддерживает загрузку медиафайлов отдельно от ввода запроса, что позволяет повторно использовать ваши медиафайлы в нескольких запросах и нескольких запросах. Для получения более подробной информации ознакомьтесь с руководством по работе с медиафайлами в запросах .
Метод: media.upload
Создает File .
Конечная точка
https: / /generativelanguage.googleapis.com /upload /v1beta /fileshttps: / /generativelanguage.googleapis.com /v1beta /files
Текст запроса
Тело запроса содержит данные следующей структуры:
fileobject ( File )Необязательно. Метаданные для создаваемого файла.
Пример запроса
Изображение
Python
Node.js
Идти
Оболочка
Аудио
Python
Node.js
Идти
Оболочка
Текст
Python
Node.js
Идти
Оболочка
Видео
Python
Node.js
Идти
Оболочка
Python
Идти
Метод: files.get
Получает метаданные для заданного File .
Конечная точка
получитьhttps: / /generativelanguage.googleapis.com /v1beta /{name=files /*}Параметры пути
string name Обязательно. Имя File , который нужно получить. Пример: files/abc-123 Формат: files/{file} .
Текст запроса
Тело запроса должно быть пустым.
Пример запроса
Python
Node.js
Идти
Оболочка
Ответный текст
В случае успеха тело ответа содержит экземпляр объекта File .
Метод: files.list
Отображает метаданные File , принадлежащих запрашивающему проекту.
Конечная точка
получитьhttps: / /generativelanguage.googleapis.com /v1beta /filesПараметры запроса
pageSizeinteger Необязательный параметр. Максимальное количество File , возвращаемых на странице. Если не указано, по умолчанию — 10. Максимальный pageSize — 100.
string pageToken Необязательный параметр. Токен страницы из предыдущего вызова files.list .
Текст запроса
Тело запроса должно быть пустым.
Пример запроса
Python
Node.js
Идти
Оболочка
Ответный текст
Ответ для files.list .
В случае успеха тело ответа будет содержать данные следующей структуры:
files[]object ( File ) Список File .
string nextPageToken Токен, который можно передать в качестве pageToken в последующий вызов files.list .
| JSON-представление |
|---|
{
"files": [
{
object ( |
Метод: files.delete
Удаляет File .
Конечная точка
удалитьhttps: / /generativelanguage.googleapis.com /v1beta /{name=files /*}Параметры пути
string name Обязательно. Имя File для удаления. Пример: files/abc-123 Формат: files/{file} .
Текст запроса
Тело запроса должно быть пустым.
Пример запроса
Python
Node.js
Идти
Оболочка
Ответный текст
В случае успеха тело ответа будет представлять собой пустой JSON-объект.
Метод: files.register
Регистрирует файлы из Google Cloud Storage в FileService. Пользователь должен предоставить URI из Google Cloud Storage и получить в ответ ресурс File для каждого URI. Обратите внимание, что файлы не копируются, а только регистрируются в File API. Если регистрация одного файла не удается, весь запрос завершается ошибкой.
Конечная точка
posthttps: / /generativelanguage.googleapis.com /v1beta /files:registerТекст запроса
Тело запроса содержит данные следующей структуры:
uris[]string Обязательно. URI Google Cloud Storage для регистрации. Пример: gs://bucket/object .
Ответный текст
Ответ на запрос files.register .
В случае успеха тело ответа будет содержать данные следующей структуры:
files[]object ( File )Зарегистрированные файлы, которые будут использоваться при вызове функции GenerateContent.
| JSON-представление |
|---|
{
"files": [
{
object ( |
REST-ресурс: файлы
Ресурс: Файл
Файл загружен в API. Следующий ID: 15
string name Неизменяемый. Идентификатор. Имя ресурса File . Идентификатор (имя без префикса "files/") может содержать до 40 символов, состоящих из строчных букв и цифр или дефисов (-). Идентификатор не может начинаться или заканчиваться дефисом. Если имя пустое при создании, будет сгенерировано уникальное имя. Пример: files/123-456
displayNamestring Необязательно. Удобочитаемое отображаемое имя File . Отображаемое имя не должно превышать 512 символов, включая пробелы. Пример: "Welcome Image"
mimeTypestringТолько для вывода. MIME-тип файла.
sizeBytesstring ( int64 format)Только вывод. Размер файла в байтах.
createTimestring ( 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" .
updateTimestring ( 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" .
expirationTimestring ( 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" .
sha256Hashstring ( bytes format)Только вывод. Хэш SHA-256 загруженных байтов.
Строка, закодированная в формате Base64.
string uri Только вывод. URI File .
string downloadUri Только вывод. URI для скачивания File .
stateenum ( State )Только вывод. Состояние обработки файла.
sourceenum ( Source )Источник файла.
errorobject ( Status )Только вывод. Статус ошибки, если обработка файла завершилась неудачей.
metadataUnion typemetadata могут быть только одним из следующих типов:videoMetadataobject ( 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 .
videoDurationstring ( Duration format)Продолжительность видео.
Длительность в секундах, содержащая до девяти знаков после запятой, заканчивающаяся на « s ». Пример: "3.5s" .
| JSON-представление |
|---|
{ "videoDuration": string } |
Состояние
Состояния жизненного цикла файла.
| Перечисления | |
|---|---|
STATE_UNSPECIFIED | Значение по умолчанию. Это значение используется, если состояние не указано. |
PROCESSING | Файл находится в процессе обработки и пока не может быть использован для вывода результатов. |
ACTIVE | Файл обработан и доступен для анализа. |
FAILED | Обработка файла завершилась с ошибкой. |
Источник
| Перечисления | |
|---|---|
SOURCE_UNSPECIFIED | Используется, если источник не указан. |
UPLOADED | Указывает, что файл загружен пользователем. |
GENERATED | Указывает, что файл сгенерирован компанией Google. |
REGISTERED | Указывает на то, что файл зарегистрирован, то есть является файлом Google Cloud Storage. |
Статус
Тип Status определяет логическую модель ошибок, подходящую для различных сред программирования, включая REST API и RPC API. Он используется в gRPC . Каждое сообщение Status содержит три элемента данных: код ошибки, сообщение об ошибке и подробности ошибки.
Более подробную информацию об этой модели ошибок и способах работы с ней вы найдете в Руководстве по проектированию API .
codeinteger Код состояния, который должен быть значением перечисления 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: ..., ... } ] } |