Batch API

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.inputConfig object ( InputConfig )

Обязательно. Введите конфигурацию экземпляров, на которых выполняется пакетная обработка.

объект batch.output object ( GenerateContentBatchOutput )

Только вывод. Вывод пакетного запроса.

строка batch.createTime string ( 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.endTime string ( 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.updateTime string ( 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 ( BatchStats )

Только вывод. Статистика по партии.

batch.state enum ( BatchState )

Только вывод. Состояние партии.

string ( int64 format) batch.priority (формат int64)

Необязательно. Приоритет пакета. Пакеты с более высоким приоритетом будут обработаны раньше пакетов с более низким приоритетом. Допускаются отрицательные значения. Значение по умолчанию — 0.

Тело ответа

В случае успеха тело ответа содержит экземпляр Operation .

GenerateContentRequest

Запрос на генерацию дополнения из модели.

Поля
string model

Обязательно. Имя Model , используемой для создания дополнения.

Формат: models/{model} .

contents[] object ( Content )

Обязательно. Содержание текущего разговора с моделью.

Для одноэтапных запросов это один экземпляр. Для многоэтапных запросов, таких как chat , это повторяющееся поле, содержащее историю разговоров и последний запрос.

tools[] object ( Tool )

Необязательно. Список Tools Model может использовать для генерации следующего ответа.

Tool — это фрагмент кода, позволяющий системе взаимодействовать с внешними системами для выполнения действия или набора действий, выходящих за рамки знаний и области действия Model . Поддерживаемые Tool : Function и codeExecution . Подробнее см. в руководствах по вызову функций и выполнению кода .

объект toolConfig object ( 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 (GenerationConfig)

Необязательно. Параметры конфигурации для создания модели и вывода данных.

string cachedContent

Необязательно. Имя кэшированного контента, который будет использоваться в качестве контекста для прогнозирования. Формат: cachedContents/{cachedContent}

JSON-представление 
{
  "model": string,
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  },
  "cachedContent": string
}

Метод: 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.inputConfig object ( InputEmbedContentConfig )

Обязательно. Введите конфигурацию экземпляров, на которых выполняется пакетная обработка.

object ( EmbedContentBatchOutput ) batch.output ( EmbedContentBatchOutput )

Только вывод. Вывод пакетного запроса.

строка batch.createTime string ( 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.endTime string ( 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.updateTime string ( 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 ( EmbedContentBatchStats )

Только вывод. Статистика по партии.

batch.state enum ( BatchState )

Только вывод. Состояние партии.

string ( int64 format) batch.priority (формат int64)

Необязательно. Приоритет пакета. Пакеты с более высоким приоритетом будут обработаны раньше пакетов с более низким приоритетом. Допускаются отрицательные значения. Значение по умолчанию — 0.

Тело ответа

В случае успеха тело ответа содержит экземпляр Operation .

EmbedContentRequest

Запрос, содержащий Content для модели для встраивания.

Поля
string model

Обязательно. Имя ресурса модели. Служит идентификатором, который будет использовать модель.

Это имя должно совпадать с именем модели, возвращаемым методом models.list .

Формат: models/{model}

объект content object ( Content )

Обязательно. Содержимое для встраивания. Учитываются только поля parts.text .

taskType enum ( TaskType )

Необязательно. Необязательный тип задачи, для которой будут использоваться вложения. Не поддерживается в более ранних моделях ( models/embedding-001 ).

string title

Необязательно. Необязательное название текста. Применимо только если TaskType — RETRIEVAL_DOCUMENT .

Примечание: указание title для RETRIEVAL_DOCUMENT обеспечивает более высокое качество встраивания при поиске.

outputDimensionality integer

Необязательно. Необязательное уменьшенное измерение для выходного эмбеддинга. Если установлено, избыточные значения в выходном эмбеддинге отсекаются с конца. Поддерживается только новыми моделями с 2024 года. Вы не можете установить это значение при использовании более ранней модели ( models/embedding-001 ).

JSON-представление 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}

Метод: 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

Стандартный фильтр списка.

pageSize integer

Стандартный размер страницы списка.

string pageToken

Стандартный токен страницы списка.

Текст запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит экземпляр 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

Ресурс, представляющий пакет запросов GenerateContent .

Поля
string model

Обязательно. Имя Model , используемой для создания дополнения.

Формат: models/{model} .

string name

Только вывод. Идентификатор. Имя ресурса пакета.

Формат: batches/{batchId} .

string displayName

Обязательно. Имя этого пакета, заданное пользователем.

object ( InputConfig ) inputConfig ( InputConfig )

Обязательно. Введите конфигурацию экземпляров, на которых выполняется пакетная обработка.

output object ( GenerateContentBatchOutput )

Только вывод. Вывод пакетного запроса.

createTime string ( 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" .

строка endTime string ( 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" .

строка updateTime string ( 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 (BatchStats)

Только вывод. Статистика по партии.

перечисление state enum ( BatchState )

Только вывод. Состояние партии.

string ( int64 format) priority (формат int64)

Необязательно. Приоритет пакета. Пакеты с более высоким приоритетом будут обработаны раньше пакетов с более низким приоритетом. Допускаются отрицательные значения. Значение по умолчанию — 0.

JSON-представление 
{
  "model": string,
  "name": string,
  "displayName": string,
  "inputConfig": {
    object (InputConfig)
  },
  "output": {
    object (GenerateContentBatchOutput)
  },
  "createTime": string,
  "endTime": string,
  "updateTime": string,
  "batchStats": {
    object (BatchStats)
  },
  "state": enum (BatchState),
  "priority": string
}

InputConfig

Настраивает входные данные для пакетного запроса.

Поля
Union type source союза
Обязательно. Источник входных данных. source может быть только одним из следующих:
string fileName

Имя File , содержащего входные запросы.

object ( InlinedRequests ) requests ( InlinedRequests )

Запросы, подлежащие обработке в пакете.

JSON-представление 
{

  // source
  "fileName": string,
  "requests": {
    object (InlinedRequests)
  }
  // Union type
}

InlinedRequests

Запросы, которые должны быть обработаны в пакете, если они предоставлены как часть запроса на создание пакета.

Поля
объект requests[] object ( InlinedRequest )

Обязательно. Запросы, подлежащие пакетной обработке.

JSON-представление 
{
  "requests": [
    {
      object (InlinedRequest)
    }
  ]
}

InlinedRequest

Запрос подлежит пакетной обработке.

Поля
объект request object ( GenerateContentRequest )

Обязательно. Запрос должен быть обработан в пакетном режиме.

объект metadata object ( Struct format)

Необязательно. Метаданные, которые будут связаны с запросом.

JSON-представление 
{
  "request": {
    object (GenerateContentRequest)
  },
  "metadata": {
    object
  }
}

GenerateContentBatchOutput

Вывод пакетного запроса. Возвращается в поле BatchGenerateContentResponse или GenerateContentBatch.output .

Поля
output Union type
Вывод пакетного запроса. output может быть только одним из следующих:
responsesFile string

Только вывод. Идентификатор файла, содержащего ответы. Файл будет представлять собой JSONL-файл с одним ответом в каждой строке. Ответы будут представлять собой сообщения GenerateContentResponse отформатированные как JSON. Ответы будут записаны в том же порядке, что и запросы на входные данные.

объект inlinedResponses object ( InlinedResponses )

Только выходные данные. Ответы на запросы в пакете. Возвращается, если пакет был сформирован с использованием встроенных запросов. Ответы будут располагаться в том же порядке, что и входящие запросы.

JSON-представление 
{

  // output
  "responsesFile": string,
  "inlinedResponses": {
    object (InlinedResponses)
  }
  // Union type
}

Встроенные ответы

Ответы на запросы в пакете.

Поля
объект inlinedResponses[] object ( InlinedResponse )

Только вывод. Ответы на запросы в пакете.

JSON-представление 
{
  "inlinedResponses": [
    {
      object (InlinedResponse)
    }
  ]
}

Встроенный ответ

Ответ на один запрос в пакете.

Поля
объект metadata object ( Struct format)

Только вывод. Метаданные, связанные с запросом.

output Union type
Вывод запроса. output может быть только одним из следующих:
object ( Status ) error (статус)

Только вывод. Ошибка, возникшая при обработке запроса.

объект response object ( GenerateContentResponse )

Только вывод. Ответ на запрос.

JSON-представление 
{
  "metadata": {
    object
  },

  // output
  "error": {
    object (Status)
  },
  "response": {
    object (GenerateContentResponse)
  }
  // Union type
}

BatchStats

Статистика по партии.

Поля
string ( int64 format) requestCount (формат int64)

Только вывод. Количество запросов в пакете.

string ( int64 format) successfulRequestCount (формат int64)

Только вывод. Количество успешно обработанных запросов.

string ( int64 format) failedRequestCount (формат int64)

Только вывод. Количество запросов, которые не удалось обработать.

string ( int64 format) pendingRequestCount (формат int64)

Только вывод. Количество запросов, ожидающих обработки.

JSON-представление 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

EmbedContentBatch

Ресурс, представляющий пакет запросов EmbedContent .

Поля
string model

Обязательно. Имя Model , используемой для создания дополнения.

Формат: models/{model} .

string name

Только вывод. Идентификатор. Имя ресурса пакета.

Формат: batches/{batchId} .

string displayName

Обязательно. Имя этого пакета, заданное пользователем.

object ( InputEmbedContentConfig ) inputConfig (InputEmbedContentConfig)

Обязательно. Введите конфигурацию экземпляров, на которых выполняется пакетная обработка.

output object ( EmbedContentBatchOutput )

Только вывод. Вывод пакетного запроса.

createTime string ( 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" .

строка endTime string ( 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" .

строка updateTime string ( 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 ) batchStats ( EmbedContentBatchStats )

Только вывод. Статистика по партии.

перечисление state enum ( BatchState )

Только вывод. Состояние партии.

string ( int64 format) priority (формат int64)

Необязательно. Приоритет пакета. Пакеты с более высоким приоритетом будут обработаны раньше пакетов с более низким приоритетом. Допускаются отрицательные значения. Значение по умолчанию — 0.

JSON-представление 
{
  "model": string,
  "name": string,
  "displayName": string,
  "inputConfig": {
    object (InputEmbedContentConfig)
  },
  "output": {
    object (EmbedContentBatchOutput)
  },
  "createTime": string,
  "endTime": string,
  "updateTime": string,
  "batchStats": {
    object (EmbedContentBatchStats)
  },
  "state": enum (BatchState),
  "priority": string
}

InputEmbedContentConfig

Настраивает входные данные для пакетного запроса.

Поля
Union type source союза
Обязательно. Источник входных данных. source может быть только одним из следующих:
string fileName

Имя File , содержащего входные запросы.

object ( InlinedEmbedContentRequests ) requests ( InlinedEmbedContentRequests )

Запросы, подлежащие обработке в пакете.

JSON-представление 
{

  // source
  "fileName": string,
  "requests": {
    object (InlinedEmbedContentRequests)
  }
  // Union type
}

InlinedEmbedContentRequests

Запросы, которые должны быть обработаны в пакете, если они предоставлены как часть запроса на создание пакета.

Поля
объект requests[] object ( InlinedEmbedContentRequest )

Обязательно. Запросы, подлежащие пакетной обработке.

JSON-представление 
{
  "requests": [
    {
      object (InlinedEmbedContentRequest)
    }
  ]
}

InlinedEmbedContentRequest

Запрос подлежит пакетной обработке.

Поля
объект request object ( EmbedContentRequest )

Обязательно. Запрос должен быть обработан в пакетном режиме.

объект metadata object ( Struct format)

Необязательно. Метаданные, которые будут связаны с запросом.

JSON-представление 
{
  "request": {
    object (EmbedContentRequest)
  },
  "metadata": {
    object
  }
}

EmbedContentBatchOutput

Вывод пакетного запроса. Возвращается в AsyncBatchEmbedContentResponse или в поле EmbedContentBatch.output .

Поля
output Union type
Вывод пакетного запроса. output может быть только одним из следующих:
responsesFile string

Только вывод. Идентификатор файла, содержащего ответы. Файл будет представлять собой JSONL-файл с одним ответом в каждой строке. Ответы будут представлять собой сообщения EmbedContentResponse отформатированные как JSON. Ответы будут записаны в том же порядке, что и запросы на входные данные.

объект inlinedResponses object ( InlinedEmbedContentResponses )

Только выходные данные. Ответы на запросы в пакете. Возвращается, если пакет был сформирован с использованием встроенных запросов. Ответы будут располагаться в том же порядке, что и входящие запросы.

JSON-представление 
{

  // output
  "responsesFile": string,
  "inlinedResponses": {
    object (InlinedEmbedContentResponses)
  }
  // Union type
}

InlinedEmbedContentResponses

Ответы на запросы в пакете.

Поля
объект inlinedResponses[] object ( InlinedEmbedContentResponse )

Только вывод. Ответы на запросы в пакете.

JSON-представление 
{
  "inlinedResponses": [
    {
      object (InlinedEmbedContentResponse)
    }
  ]
}

InlinedEmbedContentResponse

Ответ на один запрос в пакете.

Поля
объект metadata object ( Struct format)

Только вывод. Метаданные, связанные с запросом.

output Union type
Вывод запроса. output может быть только одним из следующих:
object ( Status ) error (статус)

Только вывод. Ошибка, возникшая при обработке запроса.

объект response object ( EmbedContentResponse )

Только вывод. Ответ на запрос.

JSON-представление 
{
  "metadata": {
    object
  },

  // output
  "error": {
    object (Status)
  },
  "response": {
    object (EmbedContentResponse)
  }
  // Union type
}

EmbedContentBatchStats

Статистика по партии.

Поля
string ( int64 format) requestCount (формат int64)

Только вывод. Количество запросов в пакете.

string ( int64 format) successfulRequestCount (формат int64)

Только вывод. Количество успешно обработанных запросов.

string ( int64 format) failedRequestCount (формат int64)

Только вывод. Количество запросов, которые не удалось обработать.

string ( int64 format) pendingRequestCount (формат int64)

Только вывод. Количество запросов, ожидающих обработки.

JSON-представление 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

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" } .

done boolean

Если значение равно false , это означает, что операция всё ещё выполняется. Если true , операция завершена и доступен либо error , либо response .

result Union type
Результат операции, который может быть как error , так и допустимым 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 (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}