Batch API

La API de Gemini admite APIs por lotes, que te permiten procesar varias solicitudes en una sola llamada. Para obtener más detalles, consulta la guía de la API por lotes.

Método: models.batchGenerateContent

Pone en cola un lote de solicitudes de models.generateContent para el procesamiento por lotes.

Extremo

post https://generativelanguage.googleapis.com/v1beta/{batch.model=models/*}:batchGenerateContent

Parámetros de ruta

batch.model string

Obligatorio. Es el nombre del Model que se usará para generar la finalización.

Formato: models/{model}. Toma la forma models/{model}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Campos
batch.name string

Solo salida. Es el identificador. Es el nombre del recurso del lote.

Formato: batches/{batchId}.

batch.displayName string

Obligatorio. Es el nombre definido por el usuario de este lote.

batch.inputConfig object (InputConfig)

Obligatorio. Es la configuración de entrada de las instancias en las que se realiza el procesamiento por lotes.

batch.output object (GenerateContentBatchOutput)

Solo salida. Es el resultado de la solicitud por lotes.

batch.createTime string (Timestamp format)

Solo salida. Es la fecha y hora en que se creó el lote.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.endTime string (Timestamp format)

Solo salida. Es la fecha y hora en que se completó el procesamiento por lotes.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.updateTime string (Timestamp format)

Solo salida. Fecha y hora en la que se actualizó el lote por última vez.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.batchStats object (BatchStats)

Solo salida. Son las estadísticas sobre el lote.

batch.state enum (BatchState)

Solo salida. Es el estado del lote.

batch.priority string (int64 format)

Opcional. Es la prioridad del lote. Los lotes con un valor de prioridad más alto se procesarán antes que los lotes con un valor de prioridad más bajo. Se permiten valores negativos. El valor predeterminado es 0.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

GenerateContentRequest

Es una solicitud para generar una finalización a partir del modelo.

Campos
model string

Obligatorio. Es el nombre del Model que se usará para generar la finalización.

Formato: models/{model}.

contents[] object (Content)

Obligatorio. El contenido de la conversación actual con el modelo.

Para consultas de un solo turno, esta es una instancia única. Para las consultas de varios turnos, como chat, este es un campo repetido que contiene el historial de conversaciones y la solicitud más reciente.

tools[] object (Tool)

Opcional. Es una lista de Tools que el Model puede usar para generar la siguiente respuesta.

Una Tool es un fragmento de código que permite que el sistema interactúe con sistemas externos para realizar una acción, o un conjunto de acciones, fuera del conocimiento y del alcance del Model. Los Tool admitidos son Function y codeExecution. Consulta las guías de Llamada a función y Ejecución de código para obtener más información.

toolConfig object (ToolConfig)

Opcional. Es la configuración de la herramienta para cualquier Tool especificado en la solicitud. Consulta la guía de llamadas a funciones para ver un ejemplo de uso.

safetySettings[] object (SafetySetting)

Opcional. Es una lista de instancias SafetySetting únicas para bloquear contenido no seguro.

Esto se aplicará en GenerateContentRequest.contents y GenerateContentResponse.candidates. No debe haber más de un parámetro de configuración para cada tipo de SafetyCategory. La API bloqueará todo el contenido y las respuestas que no cumplan con los umbrales establecidos por estos parámetros de configuración. Esta lista anula la configuración predeterminada de cada SafetyCategory especificado en safetySettings. Si no hay un SafetySetting para un SafetyCategory determinado proporcionado en la lista, la API usará el parámetro de configuración de seguridad predeterminado para esa categoría. Se admiten las categorías de daño HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT y HARM_CATEGORY_CIVIC_INTEGRITY. Consulta la guía para obtener información detallada sobre los parámetros de configuración de seguridad disponibles. También consulta la Guía de seguridad para obtener información sobre cómo incorporar consideraciones de seguridad en tus aplicaciones de IA.

systemInstruction object (Content)

Opcional. El desarrollador establece instrucciones del sistema. Actualmente, solo texto.

generationConfig object (GenerationConfig)

Opcional. Son las opciones de configuración para la generación y los resultados del modelo.

cachedContent string

Opcional. Nombre del contenido almacenado en caché que se usará como contexto para entregar la predicción. Formato: cachedContents/{cachedContent}

Representación JSON 
{
  "model": string,
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  },
  "cachedContent": string
}

Método: models.asyncBatchEmbedContent

Pone en cola un lote de solicitudes de models.embedContent para el procesamiento por lotes. Tenemos un controlador models.batchEmbedContents en GenerativeService, pero se sincronizó. Por lo tanto, le asignamos el nombre Async para evitar confusiones.

Extremo

post https://generativelanguage.googleapis.com/v1beta/{batch.model=models/*}:asyncBatchEmbedContent

Parámetros de ruta

batch.model string

Obligatorio. Es el nombre del Model que se usará para generar la finalización.

Formato: models/{model}. Toma la forma models/{model}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Campos
batch.name string

Solo salida. Es el identificador. Es el nombre del recurso del lote.

Formato: batches/{batchId}.

batch.displayName string

Obligatorio. Es el nombre definido por el usuario de este lote.

batch.inputConfig object (InputEmbedContentConfig)

Obligatorio. Es la configuración de entrada de las instancias en las que se realiza el procesamiento por lotes.

batch.output object (EmbedContentBatchOutput)

Solo salida. Es el resultado de la solicitud por lotes.

batch.createTime string (Timestamp format)

Solo salida. Es la fecha y hora en que se creó el lote.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.endTime string (Timestamp format)

Solo salida. Es la fecha y hora en que se completó el procesamiento por lotes.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.updateTime string (Timestamp format)

Solo salida. Fecha y hora en la que se actualizó el lote por última vez.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.batchStats object (EmbedContentBatchStats)

Solo salida. Son las estadísticas sobre el lote.

batch.state enum (BatchState)

Solo salida. Es el estado del lote.

batch.priority string (int64 format)

Opcional. Es la prioridad del lote. Los lotes con un valor de prioridad más alto se procesarán antes que los lotes con un valor de prioridad más bajo. Se permiten valores negativos. El valor predeterminado es 0.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

EmbedContentRequest

Solicitud que contiene el Content para que el modelo lo incorpore.

Campos
model string

Obligatorio. Es el nombre del recurso del modelo. Este valor sirve como ID para que lo use el modelo.

Este nombre debe coincidir con un nombre de modelo que muestre el método models.list.

Formato: models/{model}

content object (Content)

Obligatorio. Es el contenido que se incorporará. Solo se contarán los campos parts.text.

taskType enum (TaskType)

Opcional. Es el tipo de tarea opcional para el que se usarán los embeddings. No es compatible con modelos anteriores (models/embedding-001).

title string

Opcional. Es un título opcional para el texto. Solo se aplica cuando TaskType es RETRIEVAL_DOCUMENT.

Nota: Especificar un title para RETRIEVAL_DOCUMENT proporciona incorporaciones de mejor calidad para la recuperación.

outputDimensionality integer

Opcional. Dimensión reducida opcional para el embedding de salida. Si se establece, los valores excesivos en el embedding de salida se truncan desde el final. Solo es compatible con los modelos más recientes desde 2024. No puedes establecer este valor si usas el modelo anterior (models/embedding-001).

Representación JSON 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}

Método: batches.get

Obtiene el último estado de una operación de larga duración. Los clientes pueden usar este método para sondear el resultado de la operación por intervalos según la recomendación del servicio de la API.

Extremo

get https://generativelanguage.googleapis.com/v1beta/{name=batches/*}

Parámetros de ruta

name string

El nombre del recurso de operación. Toma la forma batches/{batches}.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Método: batches.list

Enumera las operaciones que coinciden con el filtro especificado en la solicitud. Si el servidor no admite este método, muestra UNIMPLEMENTED.

Extremo

get https://generativelanguage.googleapis.com/v1beta/{name=batches}

Parámetros de ruta

name string

El nombre del recurso principal de la operación. Toma la forma batches.

Parámetros de consulta

filter string

El filtro de lista estándar.

pageSize integer

El tamaño de página de lista estándar.

pageToken string

El token de página de lista estándar.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de ListOperationsResponse.

Método: batches.cancel

Inicia la cancelación asincrónica en una operación de larga duración. El servidor realiza su mejor esfuerzo para cancelar la operación, pero no se garantiza el éxito. Si el servidor no es compatible con este método, muestra google.rpc.Code.UNIMPLEMENTED. Los clientes pueden usar Operations.GetOperation o los otros métodos para comprobar si la cancelación se realizó de forma correcta o si la operación se completó a pesar de la cancelación. Si la cancelación se realiza de forma correcta, la operación no se borra. En lugar de ello, se convierte en una operación que tiene un valor Operation.error con un google.rpc.Status.code de 1, que corresponde a Code.CANCELLED.

Extremo

post https://generativelanguage.googleapis.com/v1beta/{name=batches/*}:cancel

Parámetros de ruta

name string

El nombre del recurso de la operación que se cancelará. Toma la forma batches/{batches}.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta es un objeto JSON vacío.

Método: batches.delete

Borra una operación de larga duración. Este método indica que el cliente ya no está interesado en el resultado de la operación. No cancela la operación. Si el servidor no es compatible con este método, muestra google.rpc.Code.UNIMPLEMENTED.

Extremo

delete https://generativelanguage.googleapis.com/v1beta/{name=batches/*}

Parámetros de ruta

name string

El nombre del recurso de la operación que se borrará. Toma la forma batches/{batches}.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta es un objeto JSON vacío.

GenerateContentBatch

Es un recurso que representa un lote de solicitudes de GenerateContent.

Campos
model string

Obligatorio. Es el nombre del Model que se usará para generar la finalización.

Formato: models/{model}.

name string

Solo salida. Es el identificador. Es el nombre del recurso del lote.

Formato: batches/{batchId}.

displayName string

Obligatorio. Es el nombre definido por el usuario de este lote.

inputConfig object (InputConfig)

Obligatorio. Es la configuración de entrada de las instancias en las que se realiza el procesamiento por lotes.

output object (GenerateContentBatchOutput)

Solo salida. Es el resultado de la solicitud por lotes.

createTime string (Timestamp format)

Solo salida. Es la fecha y hora en que se creó el lote.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

endTime string (Timestamp format)

Solo salida. Es la fecha y hora en que se completó el procesamiento por lotes.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Solo salida. Fecha y hora en la que se actualizó el lote por última vez.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batchStats object (BatchStats)

Solo salida. Son las estadísticas sobre el lote.

state enum (BatchState)

Solo salida. Es el estado del lote.

priority string (int64 format)

Opcional. Es la prioridad del lote. Los lotes con un valor de prioridad más alto se procesarán antes que los lotes con un valor de prioridad más bajo. Se permiten valores negativos. El valor predeterminado es 0.

Representación 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

Configura la entrada de la solicitud por lotes.

Campos
source Union type
Obligatorio. Es la fuente de la entrada. source puede ser una de las siguientes opciones:
fileName string

Nombre del File que contiene las solicitudes de entrada.

requests object (InlinedRequests)

Son las solicitudes que se procesarán en el lote.

Representación JSON 
{

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

InlinedRequests

Son las solicitudes que se procesarán en el lote si se proporcionan como parte de la solicitud de creación del lote.

Campos
requests[] object (InlinedRequest)

Obligatorio. Son las solicitudes que se procesarán en el lote.

Representación JSON 
{
  "requests": [
    {
      object (InlinedRequest)
    }
  ]
}

InlinedRequest

Es la solicitud que se procesará en el lote.

Campos
request object (GenerateContentRequest)

Obligatorio. Es la solicitud que se procesará en el lote.

metadata object (Struct format)

Opcional. Son los metadatos que se asociarán con la solicitud.

Representación JSON 
{
  "request": {
    object (GenerateContentRequest)
  },
  "metadata": {
    object
  }
}

GenerateContentBatchOutput

Es el resultado de una solicitud por lotes. Se devuelve en el campo BatchGenerateContentResponse o GenerateContentBatch.output.

Campos
output Union type
Es el resultado de la solicitud por lotes. output puede ser una de las siguientes opciones:
responsesFile string

Solo salida. Es el ID del archivo que contiene las respuestas. El archivo será un archivo JSONL con una sola respuesta por línea. Las respuestas serán mensajes GenerateContentResponse con formato JSON. Las respuestas se escribirán en el mismo orden que las solicitudes de entrada.

inlinedResponses object (InlinedResponses)

Solo salida. Son las respuestas a las solicitudes del lote. Se devuelve cuando el lote se compiló con solicitudes intercaladas. Las respuestas estarán en el mismo orden que las solicitudes de entrada.

Representación JSON 
{

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

InlinedResponses

Son las respuestas a las solicitudes del lote.

Campos
inlinedResponses[] object (InlinedResponse)

Solo salida. Son las respuestas a las solicitudes del lote.

Representación JSON 
{
  "inlinedResponses": [
    {
      object (InlinedResponse)
    }
  ]
}

InlinedResponse

Es la respuesta a una sola solicitud del lote.

Campos
metadata object (Struct format)

Solo salida. Son los metadatos asociados a la solicitud.

output Union type
Es el resultado de la solicitud. output puede ser una de las siguientes opciones:
error object (Status)

Solo salida. Es el error que se produjo mientras se procesaba la solicitud.

response object (GenerateContentResponse)

Solo salida. Es la respuesta a la solicitud.

Representación JSON 
{
  "metadata": {
    object
  },

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

BatchStats

Son las estadísticas sobre el lote.

Campos
requestCount string (int64 format)

Solo salida. Es la cantidad de solicitudes en el lote.

successfulRequestCount string (int64 format)

Solo salida. Es la cantidad de solicitudes que se procesaron correctamente.

failedRequestCount string (int64 format)

Solo salida. Es la cantidad de solicitudes que no se pudieron procesar.

pendingRequestCount string (int64 format)

Solo salida. Es la cantidad de solicitudes que aún están pendientes de procesamiento.

Representación JSON 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

EmbedContentBatch

Es un recurso que representa un lote de solicitudes de EmbedContent.

Campos
model string

Obligatorio. Es el nombre del Model que se usará para generar la finalización.

Formato: models/{model}.

name string

Solo salida. Es el identificador. Es el nombre del recurso del lote.

Formato: batches/{batchId}.

displayName string

Obligatorio. Es el nombre definido por el usuario de este lote.

inputConfig object (InputEmbedContentConfig)

Obligatorio. Es la configuración de entrada de las instancias en las que se realiza el procesamiento por lotes.

output object (EmbedContentBatchOutput)

Solo salida. Es el resultado de la solicitud por lotes.

createTime string (Timestamp format)

Solo salida. Es la fecha y hora en que se creó el lote.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

endTime string (Timestamp format)

Solo salida. Es la fecha y hora en que se completó el procesamiento por lotes.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Solo salida. Fecha y hora en la que se actualizó el lote por última vez.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batchStats object (EmbedContentBatchStats)

Solo salida. Son las estadísticas sobre el lote.

state enum (BatchState)

Solo salida. Es el estado del lote.

priority string (int64 format)

Opcional. Es la prioridad del lote. Los lotes con un valor de prioridad más alto se procesarán antes que los lotes con un valor de prioridad más bajo. Se permiten valores negativos. El valor predeterminado es 0.

Representación 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

Configura la entrada de la solicitud por lotes.

Campos
source Union type
Obligatorio. Es la fuente de la entrada. source puede ser una de las siguientes opciones:
fileName string

Nombre del File que contiene las solicitudes de entrada.

requests object (InlinedEmbedContentRequests)

Son las solicitudes que se procesarán en el lote.

Representación JSON 
{

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

InlinedEmbedContentRequests

Son las solicitudes que se procesarán en el lote si se proporcionan como parte de la solicitud de creación del lote.

Campos
requests[] object (InlinedEmbedContentRequest)

Obligatorio. Son las solicitudes que se procesarán en el lote.

Representación JSON 
{
  "requests": [
    {
      object (InlinedEmbedContentRequest)
    }
  ]
}

InlinedEmbedContentRequest

Es la solicitud que se procesará en el lote.

Campos
request object (EmbedContentRequest)

Obligatorio. Es la solicitud que se procesará en el lote.

metadata object (Struct format)

Opcional. Son los metadatos que se asociarán con la solicitud.

Representación JSON 
{
  "request": {
    object (EmbedContentRequest)
  },
  "metadata": {
    object
  }
}

EmbedContentBatchOutput

Es el resultado de una solicitud por lotes. Se devuelve en el campo AsyncBatchEmbedContentResponse o EmbedContentBatch.output.

Campos
output Union type
Es el resultado de la solicitud por lotes. output puede ser una de las siguientes opciones:
responsesFile string

Solo salida. Es el ID del archivo que contiene las respuestas. El archivo será un archivo JSONL con una sola respuesta por línea. Las respuestas serán mensajes EmbedContentResponse con formato JSON. Las respuestas se escribirán en el mismo orden que las solicitudes de entrada.

inlinedResponses object (InlinedEmbedContentResponses)

Solo salida. Son las respuestas a las solicitudes del lote. Se devuelve cuando el lote se compiló con solicitudes intercaladas. Las respuestas estarán en el mismo orden que las solicitudes de entrada.

Representación JSON 
{

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

InlinedEmbedContentResponses

Son las respuestas a las solicitudes del lote.

Campos
inlinedResponses[] object (InlinedEmbedContentResponse)

Solo salida. Son las respuestas a las solicitudes del lote.

Representación JSON 
{
  "inlinedResponses": [
    {
      object (InlinedEmbedContentResponse)
    }
  ]
}

InlinedEmbedContentResponse

Es la respuesta a una sola solicitud del lote.

Campos
metadata object (Struct format)

Solo salida. Son los metadatos asociados a la solicitud.

output Union type
Es el resultado de la solicitud. output puede ser una de las siguientes opciones:
error object (Status)

Solo salida. Es el error que se produjo mientras se procesaba la solicitud.

response object (EmbedContentResponse)

Solo salida. Es la respuesta a la solicitud.

Representación JSON 
{
  "metadata": {
    object
  },

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

EmbedContentBatchStats

Son las estadísticas sobre el lote.

Campos
requestCount string (int64 format)

Solo salida. Es la cantidad de solicitudes en el lote.

successfulRequestCount string (int64 format)

Solo salida. Es la cantidad de solicitudes que se procesaron correctamente.

failedRequestCount string (int64 format)

Solo salida. Es la cantidad de solicitudes que no se pudieron procesar.

pendingRequestCount string (int64 format)

Solo salida. Es la cantidad de solicitudes que aún están pendientes de procesamiento.

Representación JSON 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

BatchState

Es el estado del lote.

Enumeraciones
BATCH_STATE_UNSPECIFIED El estado del lote no está especificado.
BATCH_STATE_PENDING El servicio se está preparando para ejecutar el lote.
BATCH_STATE_RUNNING El lote está en curso.
BATCH_STATE_SUCCEEDED El lote se completó correctamente.
BATCH_STATE_FAILED El lote falló.
BATCH_STATE_CANCELLED Se canceló el lote.
BATCH_STATE_EXPIRED El lote venció.

Recurso de REST: batches

Recurso: Operation

Este recurso representa una operación de larga duración que es el resultado de una llamada a la API de la red.

Campos
name string

El nombre asignado por el servidor, que solo es único dentro del mismo servicio que originalmente lo muestra. Si usas la asignación HTTP predeterminada, el name debe ser un nombre de recurso que termine con operations/{unique_id}.

metadata object

Metadatos específicos del servicio asociados con la operación. Por lo general, contiene información de progreso y metadatos comunes, como la fecha de creación. Puede que algunos servicios no proporcionen estos metadatos. Cualquier método que muestra una operación de larga duración debe documentar el tipo de metadatos, si corresponde.

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Si el valor es false, significa que la operación aún está en progreso. Si es true, la operación está completa, y error o response están disponibles.

result Union type
El resultado de la operación, que puede ser un error o una response válida. Si done == false, no se establecen error ni response. Si done == true, se puede establecer error o response. Es posible que algunos servicios no proporcionen el resultado. result puede ser solo una de las siguientes opciones:
error object (Status)

El resultado de error de la operación en caso de falla o cancelación.

response object

La respuesta normal y correcta de la operación. Si el método original no muestra datos en caso de éxito, como Delete, la respuesta es google.protobuf.Empty. Si el método original es Get, Create o Update estándar, la respuesta debe ser el recurso. Para otros métodos, la respuesta debe tener el tipo XxxResponse, en la que Xxx es el nombre del método original. Por ejemplo, si el nombre del método original es TakeSnapshot(), el tipo de respuesta inferido es TakeSnapshotResponse.

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

Representación JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}