Table des matières
- 1. Aperçu de l’API
- 2. Autorisations d’accès à l’API
- 3. Guide d’intégration
- 4. Gestion des erreurs
- 5. Quotas et limites d’utilisation
- 6. Support client
1. Aperçu de l’API
L’API de Description Vidéo permet aux utilisateurs de soumettre une URL de vidéo et de générer une description détaillée de son contenu. Cette API est particulièrement utile pour :
- Le catalogage et l’indexation de contenu
- Les fonctionnalités d’accessibilité pour les malvoyants
- La modération de contenu vidéo
- L’analyse de contenu éducatif
2. Autorisations d’accès à l’API
Avant d’utiliser l’API de Description Vidéo, vous devez obtenir un App ID valide.
2.1 Processus de demande d’App ID
Dans le tableau de bord de l’API, fournissez simplement un courriel et un nom de produit pour générer un App ID.
3. Guide d’intégration
3.1 Format de requête
Les requêtes doivent être envoyées au format JSON et doivent inclure les champs suivants :
| Champ | Type | Requis | Description |
|---|---|---|---|
| appId | String | Oui | Votre identifiant d’application du tableau de bord API |
| fileUrl | String | Oui | L’URL du fichier vidéo à décrire |
| mimeType | String | Oui | Le type MIME de la vidéo |
| prompt | Array | Non | Tableau optionnel de prompts pour guider la description |
Formats vidéo pris en charge
L’API prend en charge les formats vidéo suivants :
- video/mov
- video/mp4
- video/mpg
- video/mpeg
- video/avi
- video/wmv
- video/mpegps
- video/flv
3.2 URL de requête
L’URL de base pour les requêtes de l’API de Description Vidéo :
https://us-central1-describepicture.cloudfunctions.net/describe_file_api
3.3 Exemple de requête
Voici un exemple complet en Python utilisant la bibliothèque requests :
import requests
def describe_video(base_url, app_id, video_url, mime_type, prompt=None):
# Valider le format vidéo
supported_types = [
'video/mov', 'video/mp4', 'video/mpg', 'video/mpeg',
'video/avi', 'video/wmv', 'video/mpegps', 'video/flv'
]
if mime_type not in supported_types:
raise ValueError(f"Format vidéo non pris en charge. Formats pris en charge : {', '.join(supported_types)}")
# Préparer les données de la requête
url = f"{base_url}/describe_file_api"
data = {
'appId': app_id,
'fileUrl': video_url,
'mimeType': mime_type
}
# Ajouter le prompt optionnel
if prompt:
data['prompt'] = [{'role': 'user', 'text': prompt}]
# Envoyer la requête
response = requests.post(url, json=data)
response.raise_for_status()
return response.json()
# Exemple d'utilisation
base_url = "https://us-central1-describepicture.cloudfunctions.net"
app_id = "votre-app-id"
video_url = "https://example.com/video.mp4"
mime_type = "video/mp4"
prompt = "Décrivez ce qui se passe dans cette vidéo"
result = describe_video(base_url, app_id, video_url, mime_type, prompt)
print(result)
3.4 Format de réponse
La réponse de l’API est retournée au format JSON avec les champs suivants :
| Champ | Type | Description |
|---|---|---|
| description | String | La description générée du contenu vidéo |
| remainingDuration | Number | Durée disponible restante (en secondes) pour votre compte |
3.5 Exemple de réponse
{
"description": "La vidéo montre une démonstration de cuisine où un chef prépare un plat de pâtes. Il commence par faire bouillir de l'eau, puis ajoute les pâtes tout en préparant une sauce tomate avec de l'ail et des herbes. Le plat final est garni de basilic frais et de parmesan.",
"remainingDuration": 3600
}
4. Gestion des erreurs
L’API utilise les codes d’état HTTP standard et fournit des messages d’erreur détaillés :
- 400 : Mauvaise requête - Paramètres invalides ou format vidéo non pris en charge
- 401 : Non autorisé - App ID invalide ou manquant
- 403 : Interdit - Quota dépassé ou restrictions de compte
- 404 : Non trouvé - URL de la vidéo inaccessible
- 500 : Erreur interne du serveur - Erreur de traitement côté serveur
Les réponses d’erreur incluent un message descriptif :
{
"error": "Format vidéo non pris en charge. Formats pris en charge : video/mp4, video/mov, ..."
}
5. Quotas et limites d’utilisation
L’utilisation est mesurée en secondes de durée vidéo. Votre compte dispose d’un quota qui détermine combien de secondes de vidéo vous pouvez traiter. Vous pouvez consulter votre durée restante dans le tableau de bord de l’API.
Limites de débit
- Taille maximale de la vidéo : 20GB
- Durée maximale de la vidéo : 30 minutes
- Nombre maximal de requêtes simultanées : 5 par compte
6. Support client
Pour le support technique ou les questions concernant l’API, veuillez nous contacter à aidescribepicture@gmail.com. Incluez votre App ID et tout message d’erreur pertinent dans votre demande de support.