L'API Gemini permet d'importer des fichiers multimédias séparément de l'entrée de la requête, ce qui permet de les réutiliser dans plusieurs requêtes et requêtes. Pour en savoir plus, consultez le guide Créer des invites avec le contenu multimédia.
Méthode: media.upload
- Point de terminaison
- Corps de la requête
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Corps de la réponse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Exemple de requête <ph type="x-smartling-placeholder">
Crée un objet File
.
Point de terminaison
- URI d'importation pour les demandes d'importation de fichiers multimédias:
https://generativelanguage.googleapis.com/upload/v1beta/files
.
- .
- URI de métadonnées, pour les requêtes ne contenant que des métadonnées:
https://generativelanguage.googleapis.com/v1beta/files
.
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
<ph type="x-smartling-placeholder">file
object (File
)
Facultatif. Métadonnées du fichier à créer.
Exemple de requête
Image
Python
Node.js
Go
Coquille Rose
Audio
Python
Node.js
Go
Coquille Rose
Texte
Python
Node.js
Go
Coquille Rose
Vidéo
Python
Node.js
Go
Coquille Rose
Python
Méthode: files.get
- Point de terminaison
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Exemple de requête
<ph type="x-smartling-placeholder">
- </ph>
- Basic
Récupère les métadonnées pour le File
donné.
Point de terminaison
<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> obtenir
https://generativelanguage.googleapis.com/v1beta/{name=files/*}
.
Paramètres de chemin d'accès
name
string
Obligatoire. Nom du File
à obtenir. Exemple: files/abc-123
. Il se présente sous la forme files/{file}
.
Corps de la requête
Le corps de la requête doit être vide.
Exemple de requête
Python
Node.js
Go
Coquille Rose
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une instance de File
.
Méthode: files.list
- Point de terminaison
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Exemple de requête
<ph type="x-smartling-placeholder">
- </ph>
- Basic
Répertorie les métadonnées des File
appartenant au projet demandeur.
Point de terminaison
<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> obtenir
https://generativelanguage.googleapis.com/v1beta/files
.
Paramètres de requête
pageSize
integer
Facultatif. Nombre maximal de File
s à renvoyer par page. Si aucune valeur n'est spécifiée, la valeur par défaut est 10. La valeur maximale de pageSize
est de 100.
pageToken
string
Facultatif. Jeton de page d'un appel files.list
précédent.
Corps de la requête
Le corps de la requête doit être vide.
Exemple de requête
Python
Node.js
Go
Coquille Rose
Corps de la réponse
Réponse pour files.list
.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
files[]
object (File
)
Liste des objets File
.
nextPageToken
string
Jeton pouvant être envoyé en tant que pageToken
dans un appel files.list
ultérieur.
Représentation JSON |
---|
{
"files": [
{
object ( |
Méthode: files.delete
- Point de terminaison
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Exemple de requête
<ph type="x-smartling-placeholder">
- </ph>
- Basic
Supprime File
.
Point de terminaison
<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> supprimer
https://generativelanguage.googleapis.com/v1beta/{name=files/*}
.
Paramètres de chemin d'accès
name
string
Obligatoire. Nom du File
à supprimer. Exemple: files/abc-123
. Il se présente sous la forme files/{file}
.
Corps de la requête
Le corps de la requête doit être vide.
Exemple de requête
Python
Node.js
Go
Coquille Rose
Corps de la réponse
Si la requête aboutit, le corps de la réponse est vide.
Ressource REST : fichiers
- Ressource: Fichier
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- VideoMetadata
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- État
- État
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Méthodes
Ressource: Fichier
Fichier importé dans l'API.
name
string
Immuable. Identifiant. Nom de ressource File
. L'ID (nom sans le préfixe "files/") peut contenir jusqu'à 40 caractères alphanumériques minuscules ou tirets (-). L'ID ne peut pas commencer ni se terminer par un tiret. Si le nom est vide lors de la création, un nom unique est généré. Exemple : files/123-456
displayName
string
Facultatif. Nom lisible à afficher pour File
. Le nom à afficher ne doit pas dépasser 512 caractères, espaces compris. Exemple : "Image de bienvenue"
mimeType
string
Uniquement en sortie. Type MIME du fichier.
sizeBytes
string (int64 format)
Uniquement en sortie. Taille du fichier en octets.
createTime
string (Timestamp
format)
Uniquement en sortie. Horodatage de la création de l'élément File
.
Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z"
et "2014-10-02T15:01:23.045123456Z"
.
updateTime
string (Timestamp
format)
Uniquement en sortie. Horodatage de la dernière mise à jour de l'élément File
.
Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z"
et "2014-10-02T15:01:23.045123456Z"
.
expirationTime
string (Timestamp
format)
Uniquement en sortie. Horodatage de la suppression de l'élément File
. Défini uniquement si l'élément File
doit expirer.
Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z"
et "2014-10-02T15:01:23.045123456Z"
.
sha256Hash
string (bytes format)
Uniquement en sortie. Hachage SHA-256 des octets importés.
Chaîne encodée en base64.
uri
string
Uniquement en sortie. URI de File
.
state
enum (State
)
Uniquement en sortie. État de traitement du fichier.
error
object (Status
)
Uniquement en sortie. État de l'erreur en cas d'échec du traitement du fichier.
metadata
. Métadonnées du fichier. metadata
ne peut être qu'un des éléments suivants :
videoMetadata
object (VideoMetadata
)
Uniquement en sortie. Métadonnées d'une vidéo.
Représentation JSON |
---|
{ "name": string, "displayName": string, "mimeType": string, "sizeBytes": string, "createTime": string, "updateTime": string, "expirationTime": string, "sha256Hash": string, "uri": string, "state": enum ( |
VideoMetadata
Métadonnées pour une vidéo File
.
videoDuration
string (Duration
format)
Durée de la vidéo.
Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s
". Exemple : "3.5s"
Représentation JSON |
---|
{ "videoDuration": string } |
État
États pour le cycle de vie d'un fichier
Enums | |
---|---|
STATE_UNSPECIFIED |
Valeur par défaut. Cette valeur est utilisée si l'État est omis. |
PROCESSING |
Le fichier est en cours de traitement et ne peut pas encore être utilisé pour l'inférence. |
ACTIVE |
Le fichier est traité et disponible pour l'inférence. |
FAILED |
Échec du traitement du fichier. |
État
Le type Status
définit un modèle d'erreur logique adapté aux différents environnements de programmation, y compris les API REST et RPC. Il est utilisé par le protocole gRPC. Chaque message Status
contient trois éléments de données : un code d'erreur, un message d'erreur et les détails de l'erreur.
Pour en savoir plus sur ce modèle d'erreur et sur son utilisation, consultez le Guide de conception d'API.
code
integer
Code d'état, qui doit être une valeur d'énumération de google.rpc.Code
.
message
string
Message d'erreur destiné au développeur, qui doit être en anglais. Tout message d'erreur destiné aux utilisateurs doit être localisé et envoyé dans le champ google.rpc.Status.details
, ou localisé par le client.
details[]
object
Liste de messages comportant les détails de l'erreur. Il existe un ensemble commun de types de message utilisable par les API.
Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type"
contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }
.
Représentation JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |