La API de Gemini admite la carga de archivos multimedia por separado de la entrada de instrucciones, lo que permite que tu contenido multimedia se vuelva a usar en varias solicitudes y varias instrucciones. Para obtener más detalles, consulta la guía Cómo usar instrucciones con contenido multimedia.
Método: media.upload
Crea un File
.
Extremo
- URI de carga para las solicitudes de carga de medios:
https://generativelanguage.googleapis.com/upload/v1beta/files
- URI de metadatos para las solicitudes de metadatos únicamente:
https://generativelanguage.googleapis.com/v1beta/files
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
file
object (File
)
Opcional. Son los metadatos del archivo que se creará.
Método: files.get
Obtiene los metadatos del File
determinado.
Extremo
gethttps://generativelanguage.googleapis.com/v1beta/{name=files/*}
Parámetros de ruta
name
string
Obligatorio. El nombre de la File
que se debe obtener. Ejemplo: files/abc-123
Tiene el formato files/{file}
.
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 File
.
Método: files.list
Muestra una lista de los metadatos de los File
que pertenecen al proyecto solicitante.
Extremo
gethttps://generativelanguage.googleapis.com/v1beta/files
Parámetros de consulta
pageSize
integer
Opcional. Es la cantidad máxima de File
que se mostrarán por página. Si no se especifica, el valor predeterminado es 10. El valor máximo de pageSize
es 100.
pageToken
string
Opcional. Un token de página de una llamada files.list
anterior.
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
La respuesta para files.list
.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
files[]
object (File
)
La lista de File
.
nextPageToken
string
Es un token que se puede enviar como pageToken
en una llamada files.list
posterior.
Representación JSON |
---|
{
"files": [
{
object ( |
Método: files.delete
Borra el File
.
Extremo
deletehttps://generativelanguage.googleapis.com/v1beta/{name=files/*}
Parámetros de ruta
name
string
Obligatorio. El nombre de la File
que se borrará. Ejemplo: files/abc-123
Tiene el formato files/{file}
.
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.
Recurso de REST: files
Recurso: Archivo
Un archivo subido a la API. ID siguiente: 15
name
string
Inmutable. Identificador. Nombre del recurso de File
. El ID (nombre sin el prefijo "files/") puede contener hasta 40 caracteres alfanuméricos en minúscula o guiones (-). El ID no puede comenzar ni terminar con un guion. Si el nombre está vacío cuando se crea, se generará uno único. Ejemplo: files/123-456
displayName
string
Opcional. Es el nombre visible legible por humanos del File
. El nombre visible no debe tener más de 512 caracteres, incluidos los espacios. Ejemplo: "Imagen de bienvenida"
mimeType
string
Solo salida. Es el tipo MIME del archivo.
sizeBytes
string (int64 format)
Solo salida. Es el tamaño del archivo en bytes.
createTime
string (Timestamp
format)
Solo salida. Es la marca de tiempo de cuándo se creó el File
.
Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "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. Es la marca de tiempo de la última actualización de File
.
Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
o "2014-10-02T15:01:23+05:30"
.
expirationTime
string (Timestamp
format)
Solo salida. Es la marca de tiempo del momento en que se borrará el File
. Solo se establece si se programó que venza File
.
Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
o "2014-10-02T15:01:23+05:30"
.
sha256Hash
string (bytes format)
Solo salida. Hash SHA-256 de los bytes subidos.
String codificada en base64.
uri
string
Solo salida. Es el URI de File
.
downloadUri
string
Solo salida. Es el URI de descarga del File
.
state
enum (State
)
Solo salida. Es el estado de procesamiento del archivo.
source
enum (Source
)
Es la fuente del archivo.
error
object (Status
)
Solo salida. Es el estado de error si el procesamiento del archivo falló.
metadata
Union type
metadata
puede ser una de las siguientes opciones:videoMetadata
object (VideoMetadata
)
Solo salida. Son los metadatos de un video.
Representación JSON |
---|
{ "name": string, "displayName": string, "mimeType": string, "sizeBytes": string, "createTime": string, "updateTime": string, "expirationTime": string, "sha256Hash": string, "uri": string, "downloadUri": string, "state": enum ( |
VideoMetadata
Metadatos de un video File
.
videoDuration
string (Duration
format)
Es la duración del video.
Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s
”. Ejemplo: "3.5s"
.
Representación JSON |
---|
{ "videoDuration": string } |
Estado
Estados del ciclo de vida de un archivo.
Enumeraciones | |
---|---|
STATE_UNSPECIFIED |
Es el valor predeterminado. Este valor se usa si se omite el estado. |
PROCESSING |
El archivo se está procesando y aún no se puede usar para la inferencia. |
ACTIVE |
El archivo se procesa y está disponible para la inferencia. |
FAILED |
No se pudo procesar el archivo. |
Fuente
Enumeraciones | |
---|---|
SOURCE_UNSPECIFIED |
Se usa si no se especifica la fuente. |
UPLOADED |
Indica que el usuario subió el archivo. |
GENERATED |
Indica que Google genera el archivo. |
Estado
El tipo de Status
define un modelo de error lógico que es adecuado para entornos de programación diferentes, incluidas las API de REST y las API de RPC. Lo usa gRPC. Cada mensaje Status
contiene tres datos: código de error, mensaje de error y detalles del error.
Puedes obtener más información sobre este modelo de error y cómo trabajar con él en la guía de diseño de API.
code
integer
El código de estado, que debe ser un valor enum de google.rpc.Code
.
message
string
Un mensaje de error dirigido al desarrollador, que debe estar en inglés. Cualquier mensaje de error dirigido al usuario debe localizarse y enviarse al campo google.rpc.Status.details
; o el cliente debe localizarlo.
details[]
object
Una lista de mensajes que contienen los detalles del error. Hay un conjunto común de tipos de mensajes para que usen las API.
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 |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |