Batch Mode

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

Candidato

Es un candidato de respuesta generado a partir del modelo.

Campos
content object (Content)

Solo salida. Es el contenido generado que devolvió el modelo.

finishReason enum (FinishReason)

Opcional. Solo salida. El motivo por el que el modelo dejó de generar tokens.

Si está vacío, el modelo no dejó de generar tokens.

safetyRatings[] object (SafetyRating)

Es una lista de calificaciones sobre la seguridad de un candidato de respuesta.

Hay, como máximo, una clasificación por categoría.

citationMetadata object (CitationMetadata)

Solo salida. Es la información de la cita del candidato generado por el modelo.

Es posible que este campo se complete con información de recitación para cualquier texto incluido en content. Son pasajes que se "recitan" a partir de material protegido por derechos de autor en los datos de entrenamiento del LLM fundamental.

tokenCount integer

Solo salida. Es el recuento de tokens para este candidato.

groundingAttributions[] object (GroundingAttribution)

Solo salida. Es la información de atribución de las fuentes que contribuyeron a una respuesta fundamentada.

Este campo se propaga para las llamadas a GenerateAnswer.

groundingMetadata object (GroundingMetadata)

Solo salida. Son los metadatos de fundamentación del candidato.

Este campo se propaga para las llamadas a GenerateContent.

avgLogprobs number

Solo salida. Es la puntuación promedio de probabilidad logarítmica del candidato.

logprobsResult object (LogprobsResult)

Solo salida. Puntuaciones de verosimilitud del registro para los tokens de respuesta y los tokens principales

urlContextMetadata object (UrlContextMetadata)

Solo salida. Son los metadatos relacionados con la herramienta de recuperación del contexto de la URL.

index integer

Solo salida. Índice del candidato en la lista de candidatos de respuesta.

Representación JSON 
{
  "content": {
    object (Content)
  },
  "finishReason": enum (FinishReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  },
  "tokenCount": integer,
  "groundingAttributions": [
    {
      object (GroundingAttribution)
    }
  ],
  "groundingMetadata": {
    object (GroundingMetadata)
  },
  "avgLogprobs": number,
  "logprobsResult": {
    object (LogprobsResult)
  },
  "urlContextMetadata": {
    object (UrlContextMetadata)
  },
  "index": integer
}

FinishReason

Define el motivo por el que el modelo dejó de generar tokens.

Enumeraciones
FINISH_REASON_UNSPECIFIED Valor predeterminado Este valor no se usa.
STOP Punto de detención natural del modelo o secuencia de detención proporcionada.
MAX_TOKENS Se alcanzó la cantidad máxima de tokens especificada en la solicitud.
SAFETY El contenido del candidato de respuesta se marcó por motivos de seguridad.
RECITATION El contenido de la respuesta candidata se marcó por motivos de recitación.
LANGUAGE Se marcó el contenido de la respuesta candidata por usar un idioma no admitido.
OTHER Motivo desconocido.
BLOCKLIST La generación de tokens se detuvo porque el contenido incluye términos prohibidos.
PROHIBITED_CONTENT Se detuvo la generación de tokens porque es posible que contenga contenido prohibido.
SPII Se detuvo la generación de tokens porque es posible que el contenido incluya información de identificación personal sensible (IIPS).
MALFORMED_FUNCTION_CALL La llamada a la función que generó el modelo no es válida.
IMAGE_SAFETY Se detuvo la generación de tokens porque las imágenes generadas contienen incumplimientos de seguridad.
UNEXPECTED_TOOL_CALL El modelo generó una llamada a la herramienta, pero no se habilitó ninguna herramienta en la solicitud.

GroundingAttribution

Es la atribución de una fuente que contribuyó a una respuesta.

Campos
sourceId object (AttributionSourceId)

Solo salida. Es el identificador de la fuente que contribuye a esta atribución.

content object (Content)

Es el contenido de la fuente de fundamentación que compone esta atribución.

Representación JSON 
{
  "sourceId": {
    object (AttributionSourceId)
  },
  "content": {
    object (Content)
  }
}

AttributionSourceId

Es el identificador de la fuente que contribuye a esta atribución.

Campos
source Union type
source puede ser una de las siguientes opciones:
groundingPassage object (GroundingPassageId)

Es el identificador de un pasaje intercalado.

semanticRetrieverChunk object (SemanticRetrieverChunk)

Es el identificador de un Chunk recuperado a través de Semantic Retriever.

Representación JSON 
{

  // source
  "groundingPassage": {
    object (GroundingPassageId)
  },
  "semanticRetrieverChunk": {
    object (SemanticRetrieverChunk)
  }
  // Union type
}

GroundingPassageId

Es el identificador de una parte dentro de un GroundingPassage.

Campos
passageId string

Solo salida. Es el ID del pasaje que coincide con el GroundingPassage.id del GenerateAnswerRequest.

partIndex integer

Solo salida. Índice de la parte dentro del GroundingPassage.content de GenerateAnswerRequest.

Representación JSON 
{
  "passageId": string,
  "partIndex": integer
}

SemanticRetrieverChunk

Es el identificador de un Chunk recuperado a través de Semantic Retriever especificado en GenerateAnswerRequest con SemanticRetrieverConfig.

Campos
source string

Solo salida. Nombre de la fuente que coincide con el SemanticRetrieverConfig.source de la solicitud. Ejemplo: corpora/123 o corpora/123/documents/abc

chunk string

Solo salida. Nombre del Chunk que contiene el texto atribuido. Ejemplo: corpora/123/documents/abc/chunks/xyz

Representación JSON 
{
  "source": string,
  "chunk": string
}

GroundingMetadata

Son los metadatos que se devuelven al cliente cuando se habilita la fundamentación.

Campos
groundingChunks[] object (GroundingChunk)

Lista de referencias de respaldo recuperadas de la fuente de fundamentación especificada.

groundingSupports[] object (GroundingSupport)

Lista de compatibilidad con la fundamentación.

webSearchQueries[] string

Son las búsquedas web para la búsqueda web de seguimiento.

searchEntryPoint object (SearchEntryPoint)

Opcional. Entrada de la Búsqueda de Google para las búsquedas web de seguimiento.

retrievalMetadata object (RetrievalMetadata)

Son metadatos relacionados con la recuperación en el flujo de fundamentación.

Representación JSON 
{
  "groundingChunks": [
    {
      object (GroundingChunk)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "webSearchQueries": [
    string
  ],
  "searchEntryPoint": {
    object (SearchEntryPoint)
  },
  "retrievalMetadata": {
    object (RetrievalMetadata)
  }
}

SearchEntryPoint

Es el punto de entrada de la Búsqueda de Google.

Campos
renderedContent string

Opcional. Es un fragmento de contenido web que se puede incorporar en una página web o en un WebView de una app.

sdkBlob string (bytes format)

Opcional. Es un JSON codificado en Base64 que representa un array de tuplas <término de búsqueda, URL de búsqueda>.

String codificada en base64.

Representación JSON 
{
  "renderedContent": string,
  "sdkBlob": string
}

GroundingChunk

Fragmento de fundamentación.

Campos
chunk_type Union type
Tipo de fragmento. chunk_type puede ser una de las siguientes opciones:
web object (Web)

Es un fragmento fundamentado de la Web.

Representación JSON 
{

  // chunk_type
  "web": {
    object (Web)
  }
  // Union type
}

Web

Fragmento de la Web.

Campos
uri string

Es la referencia de URI del fragmento.

title string

Es el título del fragmento.

Representación JSON 
{
  "uri": string,
  "title": string
}

GroundingSupport

Compatibilidad con la fundamentación.

Campos
groundingChunkIndices[] integer

Es una lista de índices (en "grounding_chunk") que especifican las citas asociadas con la afirmación. Por ejemplo, [1,3,4] significa que grounding_chunk[1], grounding_chunk[3] y grounding_chunk[4] son el contenido recuperado que se atribuye a la afirmación.

confidenceScores[] number

Es la puntuación de confianza de las referencias de asistencia. El rango varía de 0 a 1. El 1 indica la mayor confianza. Esta lista debe tener el mismo tamaño que groundingChunkIndices.

segment object (Segment)

Es el segmento del contenido al que pertenece esta asistencia.

Representación JSON 
{
  "groundingChunkIndices": [
    integer
  ],
  "confidenceScores": [
    number
  ],
  "segment": {
    object (Segment)
  }
}

Segmentar

Es el segmento del contenido.

Campos
partIndex integer

Solo salida. Índice de un objeto Part dentro de su objeto Content principal.

startIndex integer

Solo salida. Índice de inicio en la parte determinada, medido en bytes. Es el desplazamiento desde el inicio de la parte, incluido, a partir de cero.

endIndex integer

Solo salida. Índice final de la parte determinada, medido en bytes. Es el desplazamiento desde el inicio de la parte, exclusivo, a partir de cero.

text string

Solo salida. Es el texto correspondiente al segmento de la respuesta.

Representación JSON 
{
  "partIndex": integer,
  "startIndex": integer,
  "endIndex": integer,
  "text": string
}

RetrievalMetadata

Son metadatos relacionados con la recuperación en el flujo de fundamentación.

Campos
googleSearchDynamicRetrievalScore number

Opcional. Es una puntuación que indica la probabilidad de que la información de la Búsqueda de Google pueda ayudar a responder la instrucción. La puntuación se encuentra en el rango [0, 1], donde 0 es la probabilidad más baja y 1 es la probabilidad más alta. Esta puntuación solo se completa cuando se habilitan la fundamentación de la Búsqueda de Google y la recuperación dinámica. Se comparará con el umbral para determinar si se debe activar la Búsqueda de Google.

Representación JSON 
{
  "googleSearchDynamicRetrievalScore": number
}

LogprobsResult

Resultado de Logprobs

Campos
topCandidates[] object (TopCandidates)

La longitud es igual a la cantidad total de pasos de decodificación.

chosenCandidates[] object (Candidate)

La longitud es igual a la cantidad total de pasos de decodificación. Los candidatos elegidos pueden estar o no en topCandidates.

Representación JSON 
{
  "topCandidates": [
    {
      object (TopCandidates)
    }
  ],
  "chosenCandidates": [
    {
      object (Candidate)
    }
  ]
}

TopCandidates

Son los candidatos con las probabilidades de registro más altas en cada paso de decodificación.

Campos
candidates[] object (Candidate)

Se ordena por probabilidad logarítmica en orden descendente.

Representación JSON 
{
  "candidates": [
    {
      object (Candidate)
    }
  ]
}

Candidato

Es el candidato para el token y la puntuación de logprobs.

Campos
token string

Es el valor de cadena del token del candidato.

tokenId integer

Es el valor del ID del token del candidato.

logProbability number

Es la probabilidad de registro del candidato.

Representación JSON 
{
  "token": string,
  "tokenId": integer,
  "logProbability": number
}

UrlContextMetadata

Son los metadatos relacionados con la herramienta de recuperación del contexto de la URL.

Campos
urlMetadata[] object (UrlMetadata)

Es la lista del contexto de URL.

Representación JSON 
{
  "urlMetadata": [
    {
      object (UrlMetadata)
    }
  ]
}

UrlMetadata

Es el contexto de la recuperación de una sola URL.

Campos
retrievedUrl string

Es la URL recuperada por la herramienta.

urlRetrievalStatus enum (UrlRetrievalStatus)

Es el estado de la recuperación de la URL.

Representación JSON 
{
  "retrievedUrl": string,
  "urlRetrievalStatus": enum (UrlRetrievalStatus)
}

UrlRetrievalStatus

Es el estado de la recuperación de la URL.

Enumeraciones
URL_RETRIEVAL_STATUS_UNSPECIFIED Valor predeterminado Este valor no se usa.
URL_RETRIEVAL_STATUS_SUCCESS Se recuperó la URL correctamente.
URL_RETRIEVAL_STATUS_ERROR No se pudo recuperar la URL debido a un error.

CitationMetadata

Es una colección de atribuciones de fuentes para un fragmento de contenido.

Campos
citationSources[] object (CitationSource)

Son las citas de las fuentes para una respuesta específica.

Representación JSON 
{
  "citationSources": [
    {
      object (CitationSource)
    }
  ]
}

CitationSource

Es una cita de una fuente para una parte de una respuesta específica.

Campos
startIndex integer

Opcional. Es el inicio del segmento de la respuesta que se atribuye a esta fuente.

El índice indica el inicio del segmento, medido en bytes.

endIndex integer

Opcional. Es el final del segmento atribuido, exclusivo.

uri string

Opcional. Es el URI que se atribuye como fuente de una parte del texto.

license string

Opcional. Es la licencia del proyecto de GitHub que se atribuye como fuente del segmento.

Se requiere información de la licencia para las citas de código.

Representación JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "license": string
}

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 solo puede ser uno de los siguientes:
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
}

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.