API Gemini поддерживает пакетные API, позволяющие обрабатывать несколько запросов за один вызов. Подробнее см. в руководстве по пакетному API .
Метод: models.batchGenerateContent
Ставит в очередь пакет запросов models.generateContent для пакетной обработки.
Конечная точка
постhttps: / /generativelanguage.googleapis.com /v1beta /{batch.model=models /*}:batchGenerateContentПараметры пути
string batch.model Обязательно. Имя Model , используемой для создания дополнения.
Формат: models/{model} . Он имеет вид models/{model} .
Текст запроса
Тело запроса содержит данные со следующей структурой:
string batch.nameТолько вывод. Идентификатор. Имя ресурса пакета.
Формат: batches/{batchId} .
string batch.displayNameОбязательно. Имя этого пакета, заданное пользователем.
batch.inputConfigobject ( InputConfig )Обязательно. Введите конфигурацию экземпляров, на которых выполняется пакетная обработка.
batch.outputobject ( GenerateContentBatchOutput )Только вывод. Вывод пакетного запроса.
batch.createTimestring ( Timestamp format)Только вывод. Время создания партии.
Использует 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" .
batch.endTimestring ( Timestamp format)Только вывод. Время завершения пакетной обработки.
Использует 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" .
batch.updateTimestring ( Timestamp format)Только вывод. Время последнего обновления пакета.
Использует 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" .
object ( BatchStats ) batch.batchStatsТолько вывод. Статистика по партии.
batch.stateenum ( BatchState )Только вывод. Состояние партии.
string ( int64 format) batch.priorityНеобязательно. Приоритет пакета. Пакеты с более высоким приоритетом будут обработаны раньше пакетов с более низким приоритетом. Допускаются отрицательные значения. Значение по умолчанию — 0.
Тело ответа
В случае успеха тело ответа содержит экземпляр Operation .
Метод: models.asyncBatchEmbedContent
Ставит в очередь пакет запросов models.embedContent для пакетной обработки. У нас есть обработчик models.batchEmbedContents в GenerativeService , но он был синхронизирован. Поэтому мы называем его Async , чтобы избежать путаницы.
Конечная точка
постhttps: / /generativelanguage.googleapis.com /v1beta /{batch.model=models /*}:asyncBatchEmbedContentПараметры пути
string batch.model Обязательно. Имя Model , используемой для создания дополнения.
Формат: models/{model} . Он имеет вид models/{model} .
Текст запроса
Тело запроса содержит данные со следующей структурой:
string batch.nameТолько вывод. Идентификатор. Имя ресурса пакета.
Формат: batches/{batchId} .
string batch.displayNameОбязательно. Имя этого пакета, заданное пользователем.
batch.inputConfigobject ( InputEmbedContentConfig )Обязательно. Введите конфигурацию экземпляров, на которых выполняется пакетная обработка.
object ( EmbedContentBatchOutput ) batch.outputТолько вывод. Вывод пакетного запроса.
batch.createTimestring ( Timestamp format)Только вывод. Время создания партии.
Использует 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" .
batch.endTimestring ( Timestamp format)Только вывод. Время завершения пакетной обработки.
Использует 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" .
batch.updateTimestring ( Timestamp format)Только вывод. Время последнего обновления пакета.
Использует 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" .
object ( EmbedContentBatchStats ) batch.batchStatsТолько вывод. Статистика по партии.
batch.stateenum ( BatchState )Только вывод. Состояние партии.
string ( int64 format) batch.priorityНеобязательно. Приоритет пакета. Пакеты с более высоким приоритетом будут обработаны раньше пакетов с более низким приоритетом. Допускаются отрицательные значения. Значение по умолчанию — 0.
Тело ответа
В случае успеха тело ответа содержит экземпляр Operation .
Метод: batches.get
Получает последнее состояние длительной операции. Клиенты могут использовать этот метод для опроса результата операции с интервалами, рекомендованными службой API.
Конечная точка
получитьhttps: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}Параметры пути
string name Имя ресурса операции. Имеет вид batches/{batches} .
Текст запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит экземпляр Operation .
Метод: batches.list
Выводит список операций, соответствующих указанному фильтру в запросе. Если сервер не поддерживает этот метод, он возвращает UNIMPLEMENTED .
Конечная точка
получитьhttps: / /generativelanguage.googleapis.com /v1beta /{name=batches}Параметры пути
string name Имя родительского ресурса операции. Имеет форму batches .
Параметры запроса
string filterСтандартный фильтр списка.
pageSizeintegerСтандартный размер страницы списка.
string pageTokenСтандартный токен страницы списка.
returnPartialSuccessboolean Если установлено значение true , достижимые операции возвращаются как обычно, а недостижимые возвращаются в поле [ListOperationsResponse.unreachable].
Это может быть true только при чтении по коллекциям, например, когда parent установлен на "projects/example/locations/-" .
Это поле по умолчанию не поддерживается и приведет к ошибке UNIMPLEMENTED , если оно установлено, если иное явно не указано в документации по конкретной услуге или продукту.
Текст запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит экземпляр ListOperationsResponse .
Метод: batches.cancel
Запускает асинхронную отмену длительной операции. Сервер прилагает все усилия для отмены операции, но успех не гарантируется. Если сервер не поддерживает этот метод, он возвращает google.rpc.Code.UNIMPLEMENTED . Клиенты могут использовать Operations.GetOperation или другие методы для проверки успешности отмены или завершения операции, несмотря на отмену. В случае успешной отмены операция не удаляется; вместо этого она становится операцией со значением Operation.error и google.rpc.Status.code , равным 1 , что соответствует Code.CANCELLED .
Конечная точка
постhttps: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}:cancelПараметры пути
string name Имя ресурса операции, подлежащего отмене. Имеет вид batches/{batches} .
Текст запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа представляет собой пустой объект JSON.
Метод: batches.delete
Удаляет длительную операцию. Этот метод указывает, что клиент больше не заинтересован в результате операции. Он не отменяет операцию. Если сервер не поддерживает этот метод, он возвращает google.rpc.Code.UNIMPLEMENTED .
Конечная точка
удалитьhttps: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}Параметры пути
string name Имя ресурса операции, который необходимо удалить. Имеет вид batches/{batches} .
Текст запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа представляет собой пустой объект JSON.
GenerateContentBatch
- JSON-представление
- InputConfig
- InlinedRequests
- InlinedRequest
- GenerateContentBatchOutput
- Встроенные ответы
- Встроенный ответ
- BatchStats
Ресурс, представляющий пакет запросов GenerateContent .
string model Обязательно. Имя Model , используемой для создания дополнения.
Формат: models/{model} .
string nameТолько вывод. Идентификатор. Имя ресурса пакета.
Формат: batches/{batchId} .
string displayNameОбязательно. Имя этого пакета, заданное пользователем.
object ( InputConfig ) inputConfigОбязательно. Введите конфигурацию экземпляров, на которых выполняется пакетная обработка.
outputobject ( GenerateContentBatchOutput )Только вывод. Вывод пакетного запроса.
createTimestring ( Timestamp format)Только вывод. Время создания партии.
Использует 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" .
endTimestring ( Timestamp format)Только вывод. Время завершения пакетной обработки.
Использует 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)Только вывод. Время последнего обновления пакета.
Использует 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" .
object ( BatchStats ) batchStatsТолько вывод. Статистика по партии.
stateenum ( BatchState )Только вывод. Состояние партии.
string ( int64 format) priorityНеобязательно. Приоритет пакета. Пакеты с более высоким приоритетом будут обработаны раньше пакетов с более низким приоритетом. Допускаются отрицательные значения. Значение по умолчанию — 0.
| JSON-представление |
|---|
{ "model": string, "name": string, "displayName": string, "inputConfig": { object ( |
InputConfig
Настраивает входные данные для пакетного запроса.
Union type sourcesource может быть только одним из следующих:string fileName Имя File , содержащего входные запросы.
object ( InlinedRequests ) requestsЗапросы, подлежащие обработке в пакете.
| JSON-представление |
|---|
{
// source
"fileName": string,
"requests": {
object ( |
InlinedRequests
Запросы, которые должны быть обработаны в пакете, если они предоставлены как часть запроса на создание пакета.
requests[]object ( InlinedRequest )Обязательно. Запросы, подлежащие пакетной обработке.
| JSON-представление |
|---|
{
"requests": [
{
object ( |
InlinedRequest
Запрос подлежит пакетной обработке.
requestobject ( GenerateContentRequest )Обязательно. Запрос должен быть обработан в пакетном режиме.
metadataobject ( Struct format)Необязательно. Метаданные, которые будут связаны с запросом.
| JSON-представление |
|---|
{
"request": {
object ( |
GenerateContentBatchOutput
Вывод пакетного запроса. Возвращается в поле BatchGenerateContentResponse или GenerateContentBatch.output .
outputUnion typeoutput может быть только одним из следующих: responsesFilestring Только вывод. Идентификатор файла, содержащего ответы. Файл будет представлять собой JSONL-файл с одним ответом в каждой строке. Ответы будут представлять собой сообщения GenerateContentResponse отформатированные как JSON. Ответы будут записаны в том же порядке, что и запросы на входные данные.
inlinedResponsesobject ( InlinedResponses )Только выходные данные. Ответы на запросы в пакете. Возвращается, если пакет был сформирован с использованием встроенных запросов. Ответы будут располагаться в том же порядке, что и входящие запросы.
| JSON-представление |
|---|
{
// output
"responsesFile": string,
"inlinedResponses": {
object ( |
Встроенные ответы
Ответы на запросы в пакете.
inlinedResponses[]object ( InlinedResponse )Только вывод. Ответы на запросы в пакете.
| JSON-представление |
|---|
{
"inlinedResponses": [
{
object ( |
Встроенный ответ
Ответ на один запрос в пакете.
metadataobject ( Struct format)Только вывод. Метаданные, связанные с запросом.
outputUnion typeoutput может быть только одним из следующих:object ( Status ) errorТолько вывод. Ошибка, возникшая при обработке запроса.
responseobject ( GenerateContentResponse )Только вывод. Ответ на запрос.
| JSON-представление |
|---|
{ "metadata": { object }, // output "error": { object ( |
BatchStats
Статистика по партии.
string ( int64 format) requestCountТолько вывод. Количество запросов в пакете.
string ( int64 format) successfulRequestCountТолько вывод. Количество успешно обработанных запросов.
string ( int64 format) failedRequestCountТолько вывод. Количество запросов, которые не удалось обработать.
string ( int64 format) pendingRequestCountТолько вывод. Количество запросов, ожидающих обработки.
| JSON-представление |
|---|
{ "requestCount": string, "successfulRequestCount": string, "failedRequestCount": string, "pendingRequestCount": string } |
Метод: batches.updateEmbedContentBatch
- Конечная точка
- Параметры пути
- Параметры запроса
- Текст запроса
- Тело ответа
- Области авторизации
- EmbedContentRequest
Обновляет пакет запросов EmbedContent для пакетной обработки.
Конечная точка
патчhttps: / /generativelanguage.googleapis.com /v1beta /{embedContentBatch.name=batches /*}:updateEmbedContentBatchPATCH https://generativelanguage.googleapis.com/v1beta/{embedContentBatch.name=batches/*}:updateEmbedContentBatch Параметры пути
embedContentBatch.namestringТолько вывод. Идентификатор. Имя ресурса пакета.
Формат: batches/{batchId} . Он имеет вид batches/{batches} .
Параметры запроса
string ( FieldMask format) updateMaskНеобязательно. Список полей для обновления.
Это список полных имён полей, разделённых запятыми. Пример: "user.displayName,photo" .
Текст запроса
Тело запроса содержит экземпляр EmbedContentBatch .
string model Обязательно. Имя Model , используемой для создания дополнения.
Формат: models/{model} .
string displayNameОбязательно. Имя этого пакета, заданное пользователем.
object ( InputEmbedContentConfig ) inputConfigОбязательно. Введите конфигурацию экземпляров, на которых выполняется пакетная обработка.
string ( int64 format) priorityНеобязательно. Приоритет пакета. Пакеты с более высоким приоритетом будут обработаны раньше пакетов с более низким приоритетом. Допускаются отрицательные значения. Значение по умолчанию — 0.
Тело ответа
В случае успеха тело ответа содержит экземпляр EmbedContentBatch .
EmbedContentRequest
Запрос, содержащий Content для модели для встраивания.
string modelОбязательно. Имя ресурса модели. Служит идентификатором, который будет использовать модель.
Это имя должно совпадать с именем модели, возвращаемым методом ListModels .
Формат: models/{model}
contentobject ( Content ) Обязательно. Содержимое для встраивания. Учитываются только поля parts.text .
taskTypeenum ( TaskType ) Необязательно. Необязательный тип задачи, для которой будут использоваться вложения. Не поддерживается в более ранних моделях ( models/embedding-001 ).
string title Необязательно. Необязательное название текста. Применимо только если TaskType — RETRIEVAL_DOCUMENT .
Примечание: указание title для RETRIEVAL_DOCUMENT обеспечивает более высокое качество встраивания при поиске.
outputDimensionalityinteger Необязательно. Необязательное уменьшенное измерение для выходного эмбеддинга. Если установлено, избыточные значения в выходном эмбеддинге отсекаются с конца. Поддерживается только новыми моделями с 2024 года. Вы не можете установить это значение при использовании более ранней модели ( models/embedding-001 ).
Метод: batches.updateGenerateContentBatch
- Конечная точка
- Параметры пути
- Параметры запроса
- Текст запроса
- Тело ответа
- Области авторизации
- GenerateContentRequest
Обновляет пакет запросов GenerateContent для пакетной обработки.
Конечная точка
патчhttps: / /generativelanguage.googleapis.com /v1beta /{generateContentBatch.name=batches /*}:updateGenerateContentBatchPATCH https://generativelanguage.googleapis.com/v1beta/{generateContentBatch.name=batches/*}:updateGenerateContentBatch Параметры пути
generateContentBatch.namestringТолько вывод. Идентификатор. Имя ресурса пакета.
Формат: batches/{batchId} . Он имеет вид batches/{batches} .
Параметры запроса
string ( FieldMask format) updateMaskНеобязательно. Список полей для обновления.
Это список полных имён полей, разделённых запятыми. Пример: "user.displayName,photo" .
Текст запроса
Тело запроса содержит экземпляр GenerateContentBatch .
string model Обязательно. Имя Model , используемой для создания дополнения.
Формат: models/{model} .
string displayNameОбязательно. Имя этого пакета, заданное пользователем.
object ( InputConfig ) inputConfigОбязательно. Введите конфигурацию экземпляров, на которых выполняется пакетная обработка.
string ( int64 format) priorityНеобязательно. Приоритет пакета. Пакеты с более высоким приоритетом будут обработаны раньше пакетов с более низким приоритетом. Допускаются отрицательные значения. Значение по умолчанию — 0.
Тело ответа
В случае успеха тело ответа содержит экземпляр GenerateContentBatch .
GenerateContentRequest
Запрос на генерацию дополнения из модели.
string model Обязательно. Имя Model , используемой для создания дополнения.
Формат: models/{model} .
tools[]object ( Tool ) Необязательно. Список Tools Model может использовать для генерации следующего ответа.
Tool — это фрагмент кода, позволяющий системе взаимодействовать с внешними системами для выполнения действия или набора действий, выходящих за рамки знаний и области действия Model . Поддерживаемые Tool : Function и codeExecution . Подробнее см. в руководствах по вызову функций и выполнению кода .
toolConfigobject ( ToolConfig ) Необязательно. Конфигурация инструмента для любого Tool , указанного в запросе. Пример использования см. в руководстве по вызову функций .
safetySettings[]object ( SafetySetting ) Необязательно. Список уникальных экземпляров SafetySetting для блокировки небезопасного контента.
Это будет применяться к GenerateContentRequest.contents и GenerateContentResponse.candidates . Для каждого типа SafetyCategory не должно быть более одной настройки. API будет блокировать любой контент и ответы, не соответствующие пороговым значениям, установленным этими настройками. Этот список переопределяет настройки по умолчанию для каждой SafetyCategory , указанной в safetySettings. Если в списке нет SafetySetting для заданной SafetyCategory , API будет использовать настройку безопасности по умолчанию для этой категории. Поддерживаются категории вреда HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY. Подробную информацию о доступных настройках безопасности см. в руководстве . Также см. руководство по безопасности , чтобы узнать, как учитывать вопросы безопасности в ваших приложениях ИИ.
object ( Content ) systemInstructionНеобязательно. Системные инструкции, заданные разработчиком. В настоящее время доступен только текст.
object ( GenerationConfig ) generationConfigНеобязательно. Параметры конфигурации для создания модели и вывода данных.
string cachedContent Необязательно. Имя кэшированного контента, который будет использоваться в качестве контекста для прогнозирования. Формат: cachedContents/{cachedContent}
| JSON-представление |
|---|
{ "model": string, "contents": [ { object ( |
BatchState
Состояние партии.
| Перечисления | |
|---|---|
BATCH_STATE_UNSPECIFIED | Состояние партии не указано. |
BATCH_STATE_PENDING | Служба готовится к запуску пакета. |
BATCH_STATE_RUNNING | Партия находится в процессе изготовления. |
BATCH_STATE_SUCCEEDED | Партия завершена успешно. |
BATCH_STATE_FAILED | Партия не удалась. |
BATCH_STATE_CANCELLED | Партия была отменена. |
BATCH_STATE_EXPIRED | Срок годности партии истек. |
Ресурс REST: партии
Ресурс: Операция
Этот ресурс представляет собой длительную операцию, являющуюся результатом вызова сетевого API.
string name Имя, назначенное сервером, уникально только в пределах той же службы, которая его изначально возвращает. Если вы используете HTTP-сопоставление по умолчанию, name должно быть именем ресурса, заканчивающимся на operations/{unique_id} .
object metadataМетаданные, специфичные для сервиса, связанные с операцией. Обычно они содержат информацию о ходе выполнения и общие метаданные, такие как время создания. Некоторые сервисы могут не предоставлять такие метаданные. Любой метод, возвращающий длительную операцию, должен документировать тип метаданных, если таковой имеется.
Объект, содержащий поля произвольного типа. Дополнительное поле "@type" содержит URI, идентифицирующий тип. Пример: { "id": 1234, "@type": "types.example.com/standard/id" } .
doneboolean Если значение равно false , это означает, что операция всё ещё выполняется. Если true , операция завершена и доступен либо error , либо response .
resultUnion typeerror , так и допустимым response . Если done == false , ни error , ни response не устанавливаются. Если done == true , может быть установлен только один из вариантов: error или response . Некоторые службы могут не предоставлять результат. result может быть только одним из следующих:object ( Status ) errorОшибочный результат операции в случае сбоя или отмены.
object response Обычный, успешный ответ операции. Если исходный метод не возвращает данных об успешном выполнении, например, Delete , ответом будет google.protobuf.Empty . Если исходный метод — стандартный Get / Create / Update , ответом должен быть ресурс. Для других методов ответ должен иметь тип XxxResponse , где Xxx — имя исходного метода. Например, если имя исходного метода — TakeSnapshot() , выводимый тип ответа — TakeSnapshotResponse .
Объект, содержащий поля произвольного типа. Дополнительное поле "@type" содержит URI, идентифицирующий тип. Пример: { "id": 1234, "@type": "types.example.com/standard/id" } .
| JSON-представление |
|---|
{
"name": string,
"metadata": {
"@type": string,
field1: ...,
...
},
"done": boolean,
// result
"error": {
object ( |