A API Gemini permite fazer upload de arquivos de mídia separadamente da entrada de comando, o que permite reutilizar sua mídia em várias solicitações e comandos. Para mais detalhes, consulte o guia Comandos com mídia.
Recurso REST: files
Recurso: File
Um arquivo enviado para a API. Próximo ID: 15
name
string
Imutável. Identificador. O nome do recurso File. O ID (nome sem o prefixo "files/") pode conter até 40 caracteres alfanuméricos minúsculos ou traços (-). Ele não pode começar nem terminar com um traço. Se o nome estiver vazio na criação, um nome exclusivo será gerado. Exemplo: files/123-456
displayName
string
Opcional. O nome de exibição legível para o File. O nome de exibição não pode ter mais de 512 caracteres, incluindo espaços. Exemplo: "Imagem de boas-vindas"
mimeType
string
Apenas saída. Tipo MIME do arquivo.
sizeBytes
string (int64 format)
Apenas saída. Tamanho do arquivo em bytes.
createTime
string (Timestamp format)
Apenas saída. O carimbo de data/hora de quando o File foi criado.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime
string (Timestamp format)
Apenas saída. O carimbo de data/hora da última atualização do File.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
expirationTime
string (Timestamp format)
Apenas saída. O carimbo de data/hora de quando o File será excluído. Só é definido se a File estiver programada para expirar.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
sha256Hash
string (bytes format)
Apenas saída. Hash SHA-256 dos bytes enviados.
Uma string codificada em base64.
uri
string
Apenas saída. O URI do File.
downloadUri
string
Apenas saída. O URI de download do File.
state
enum (State)
Apenas saída. Estado de processamento do arquivo.
source
enum (Source)
Origem do arquivo.
error
object (google.rpc.Status)
Apenas saída. Status de erro se o processamento do arquivo falhar.
metadata
Union type
metadata pode ser apenas de um dos tipos a seguir:videoMetadata
object (VideoFileMetadata)
Apenas saída. Metadados de um vídeo.
| Representação JSON |
|---|
{ "name": string, "displayName": string, "mimeType": string, "sizeBytes": string, "createTime": string, "updateTime": string, "expirationTime": string, "sha256Hash": string, "uri": string, "downloadUri": string, "state": enum ( |
VideoFileMetadata
Metadados de um vídeo File.
videoDuration
string (Duration format)
Duração do vídeo.
Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
| Representação JSON |
|---|
{ "videoDuration": string } |
Estado
Estados do ciclo de vida de um arquivo.
| Tipos enumerados | |
|---|---|
STATE_UNSPECIFIED |
O valor padrão. Esse valor é usado se o estado for omitido. |
PROCESSING |
O arquivo está sendo processado e ainda não pode ser usado para inferência. |
ACTIVE |
O arquivo é processado e fica disponível para inferência. |
FAILED |
Falha ao processar o arquivo. |
Origem
| Tipos enumerados | |
|---|---|
SOURCE_UNSPECIFIED |
Usado se a origem não for especificada. |
UPLOADED |
Indica que o arquivo foi enviado pelo usuário. |
GENERATED |
Indica que o arquivo foi gerado pelo Google. |
REGISTERED |
Indica que o arquivo é registrado, ou seja, um arquivo do Google Cloud Storage. |
Método: files.get
- Endpoint
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Exemplo de solicitação
Recebe os metadados do File especificado.
Endpoint
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=files /*}
Parâmetros de caminho
name
string
Obrigatório. O nome do File a ser recebido. Exemplo: files/abc-123. Ele assume a forma files/{file}.
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Exemplo de solicitação
Python
Node.js
Go
Shell
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de File.
Método: files.list
- Endpoint
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Exemplo de solicitação
Lista os metadados dos Files pertencentes ao projeto solicitante.
Endpoint
gethttps: / /generativelanguage.googleapis.com /v1beta /files
Parâmetros de consulta
pageSize
integer
Opcional. Número máximo de Files a serem retornados por página. Se não for especificado, o padrão será 10. O valor máximo de pageSize é 100.
pageToken
string
Opcional. Um token de página de uma chamada files.list anterior.
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Exemplo de solicitação
Python
Node.js
Go
Shell
Corpo da resposta
Resposta para files.list.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
files[]
object (File)
A lista de Files.
nextPageToken
string
Um token que pode ser enviado como um pageToken em uma chamada files.list subsequente.
| Representação JSON |
|---|
{
"files": [
{
object ( |
Método: files.delete
- Endpoint
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Exemplo de solicitação
Exclui o File.
Endpoint
deletehttps: / /generativelanguage.googleapis.com /v1beta /{name=files /*}
Parâmetros de caminho
name
string
Obrigatório. O nome do File a ser excluído. Exemplo: files/abc-123. Ele assume a forma files/{file}.
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Exemplo de solicitação
Python
Node.js
Go
Shell
Corpo da resposta
Se não houver nenhum problema, o corpo da resposta será um objeto JSON vazio.
Método: files.register
Registra arquivos do Google Cloud Storage com o FileService. O usuário precisa fornecer URIs do Google Cloud Storage e vai receber um recurso "File" para cada URI em troca. Observação: os arquivos não são copiados, apenas registrados com a API File. Se um arquivo não for registrado, toda a solicitação vai falhar.
Endpoint
posthttps: / /generativelanguage.googleapis.com /v1beta /files:register
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
uris[]
string
Obrigatório. Os URIs do Google Cloud Storage a serem registrados. Exemplo: gs://bucket/object.
Método: media.upload
Cria uma File.
Endpoint
- URI de upload, para solicitações de upload de mídia:
https: / /generativelanguage.googleapis.com /upload /v1beta /files
- URI de metadados, para solicitações somente de metadados:
https: / /generativelanguage.googleapis.com /v1beta /files
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
file
object (File)
Opcional. Metadados do arquivo a ser criado.
Exemplo de solicitação
Imagem
Python
Node.js
Go
Shell
Áudio
Python
Node.js
Go
Shell
Texto
Python
Node.js
Go
Shell
Vídeo
Python
Node.js
Go
Shell
Python
Go
Status
O status da interação.
| Tipos enumerados | |
|---|---|
UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
IN_PROGRESS |
A interação está em andamento. |
REQUIRES_ACTION |
A interação exige ação/entrada do usuário. |
COMPLETED |
A interação é concluída. |
FAILED |
A interação falhou. |
CANCELLED |
A interação foi cancelada. |
INCOMPLETE |
A interação foi concluída, mas contém resultados incompletos (por exemplo, atingiu maxTokens). |
BUDGET_EXCEEDED |
A interação foi interrompida porque o orçamento de tokens foi excedido. |