Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Cet article documente les opérations d’api REST d’inférence d’image, audio (reconnaissance vocale) et de plan de données de génération vidéo pour Azure OpenAI dans la préversion v1. Pour les achèvements de conversation, les incorporations, les valeurs, les fichiers, le réglage précis, les réponses, les magasins vectoriels et toutes les autres opérations, consultez la référence officielle de l’API REST OpenAI Azure.
Inférence du plan de données
Le reste de cet article traite des opérations d’image, audio et vidéo dans la nouvelle version préliminaire de l’API v1 de la spécification d’inférence du plan de données OpenAI Azure. Pour plus d’informations, consultez le guide de cycle de vie des API.
Pour obtenir l’API complète de plan de données en disponibilité générale v1, consultez la référence officielle de l’API REST OpenAI Azure.
Créer un discours
POST {endpoint}/openai/v1/audio/speech?api-version=preview
Génère l’audio de synthèse vocale à partir du texte d’entrée.
Paramètres d’URI
| Nom | Dans | Obligatoire | Catégorie | Description |
|---|---|---|---|---|
| endpoint | path | Oui | string url |
Prise en charge Azure points de terminaison OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par votre Azure nom de ressource OpenAI). https://{your-resource-name}.openai.azure.com |
| version de l'API | Requête | Non | Version explicite de Microsoft’API Foundry Models à utiliser pour cette requête.v1 s’il n’est pas spécifié. |
En-tête de requête
Utilisez l’authentification basée sur les jetons ou la clé API. L’authentification avec l’authentification basée sur des jetons est recommandée et plus sécurisée.
| Nom | Obligatoire | Catégorie | Description |
|---|---|---|---|
| Authorization | True | string |
Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token}Pour générer un jeton d’authentification à l’aide de Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.comType : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorizePortée: https://ai.azure.com/.default |
| clé API | True | string | Fournissez Azure clé API OpenAI ici |
Corps de la requête
Content-Type : multipart/form-data
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| entrée | string | Texte pour lequel générer l’audio. La longueur maximale est de 4 096 caractères. | Oui | |
| consignes | string | Contrôlez la voix de votre audio généré avec des instructions supplémentaires. Ne fonctionne pas avec tts-1 ou tts-1-hd. |
Non | |
| model | string | Modèle à utiliser pour cette demande de synthèse vocale. | Oui | |
| format_de_réponse | Objet | Formats de sortie audio pris en charge pour la synthèse vocale. | Non | |
| Vitesse | number | Vitesse de la parole pour l’audio généré. Les valeurs sont valides dans la plage comprise entre 0,25 et 4.0, avec 1,0 les valeurs par défaut et supérieures correspondant à la reconnaissance vocale plus rapide. | Non | 1 |
| stream_format | enum | Format dans lequel diffuser l’audio. Les formats pris en charge sont sse et audio.
sse n’est pas pris en charge pour tts-1 ou tts-1-hd.Valeurs possibles : sse, audio |
Non | |
| Voix | Objet | Oui |
Responses
Code d’état : 200
Description : la demande a réussi.
| Type de contenu | Type | Description |
|---|---|---|
| application/octet-stream | string |
Code d’état : par défaut
Description : réponse d’erreur inattendue.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureErrorResponse |
Exemples
Example
Synthétise l’audio à partir du texte fourni.
POST {endpoint}/openai/v1/audio/speech?api-version=preview
{
"input": "Hi! What are you going to make?",
"voice": "fable",
"response_format": "mp3",
"model": "tts-1"
}
Réponses : Code d’état : 200
{
"body": "101010101"
}
Créer une transcription
POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview
Transcrit l’audio dans la langue d’entrée.
Paramètres d’URI
| Nom | Dans | Obligatoire | Catégorie | Description |
|---|---|---|---|---|
| endpoint | path | Oui | string url |
Prise en charge Azure points de terminaison OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par votre Azure nom de ressource OpenAI). https://{your-resource-name}.openai.azure.com |
| version de l'API | Requête | Non | Version explicite de l’API Foundry Models à utiliser pour cette requête.v1 s’il n’est pas spécifié. |
En-tête de requête
Utilisez l’authentification basée sur les jetons ou la clé API. L’authentification avec l’authentification basée sur des jetons est recommandée et plus sécurisée.
| Nom | Obligatoire | Catégorie | Description |
|---|---|---|---|
| Authorization | True | string |
Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token}Pour générer un jeton d’authentification à l’aide de Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.comType : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorizePortée: https://ai.azure.com/.default |
| clé API | True | string | Fournissez Azure clé API OpenAI ici |
Corps de la requête
Content-Type : multipart/form-data
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| chunking_strategy | Objet | Non | ||
| prefix_padding_ms | entier | Quantité d’audio à inclure avant la détection de la voix vaD (en millisecondes). | Non | 300 |
| └durée_du_silence_ms | entier | Durée du silence pour détecter l’arrêt de la parole (en millisecondes). Avec des valeurs plus courtes, le modèle répond plus rapidement, mais peut passer à des pauses courtes de l’utilisateur. | Non | 200 |
| └─ seuil | number | Seuil de sensibilité (0,0 à 1,0) pour la détection d’activité vocale. Un seuil plus élevé nécessite un son plus fort pour activer le modèle, et peut donc s’améliorer dans les environnements bruyants. | Non | 0,5 |
| └─ Type | enum | Doit être défini pour activer la segmentation manuelle à server_vad l’aide du VAD côté serveur.Valeurs possibles : server_vad |
Non | |
| fichier | string | Oui | ||
| filename | string | Nom de fichier facultatif ou identificateur descriptif à associer aux données audio. | Non | |
| include[] | tableau | Informations supplémentaires à inclure dans la réponse de transcription.
logprobs retourne les probabilités de journal des jetons dans la réponse pour comprendre la confiance du modèle dans la transcription.
logprobs fonctionne uniquement avec response_format défini sur json et uniquement avec les modèles gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribeet gpt-4o-mini-transcribe-2025-12-15. |
Non | |
| language | string | Langue de l’audio d’entrée. L’approvisionnement du langage d’entrée au format ISO-639-1 (par exemple en) améliore la précision et la latence. |
Non | |
| model | string | Modèle à utiliser pour cette demande de transcription. | Non | |
| prompt | string | Texte facultatif pour guider le style du modèle ou continuer un segment audio précédent. L’invite doit correspondre à la langue audio. | Non | |
| format_de_réponse | Objet | Non | ||
| stream | booléen | Si la valeur est true, les données de réponse du modèle sont transmises au client au fur et à mesure qu’elles sont générées à l’aide d’événements envoyés par le serveur. Remarque : La diffusion en continu n’est pas prise en charge pour le whisper-1 modèle et sera ignorée. |
Non | Faux |
| Température | number | Température d’échantillonnage comprise entre 0 et 1. Les valeurs plus élevées telles que 0,8 rendent la sortie plus aléatoire, tandis que les valeurs inférieures comme 0,2 le rendent plus prioritaire et déterministe. Si la valeur est 0, le modèle utilise la probabilité de journal pour augmenter automatiquement la température jusqu’à ce que certains seuils soient atteints. | Non | 0 |
| timestamp_granularities[] | tableau | Granularités d’horodatage à remplir pour cette transcription.
response_format doit être défini verbose_json pour utiliser des granularités d’horodatage. L’une ou l’autre de ces options sont prises en charge : wordou segment. Remarque : Il n’existe aucune latence supplémentaire pour les horodatages de segment, mais la génération d’horodatages de mots entraîne une latence supplémentaire. |
Non | ['segment'] |
Responses
Code d’état : 200
Description : la demande a réussi.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureAudioTranscriptionResponse | |
| texte brut | string |
Code d’état : par défaut
Description : réponse d’erreur inattendue.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureErrorResponse |
Exemples
Example
Obtient le texte transcrit et les métadonnées associées à partir de données audio parlées fournies.
POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview
{
"file": "<binary audio data>",
"model": "whisper-1",
"response_format": "text"
}
Réponses : Code d’état : 200
{
"body": "plain text when requesting text, srt, or vtt"
}
Créer une traduction
POST {endpoint}/openai/v1/audio/translations?api-version=preview
Obtient le texte transcrit en langue anglaise et les métadonnées associées à partir de données audio parlées fournies.
Paramètres d’URI
| Nom | Dans | Obligatoire | Catégorie | Description |
|---|---|---|---|---|
| endpoint | path | Oui | string url |
Prise en charge Azure points de terminaison OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par votre Azure nom de ressource OpenAI). https://{your-resource-name}.openai.azure.com |
| version de l'API | Requête | Non | Version explicite de l’API Foundry Models à utiliser pour cette requête.v1 s’il n’est pas spécifié. |
En-tête de requête
Utilisez l’authentification basée sur les jetons ou la clé API. L’authentification avec l’authentification basée sur des jetons est recommandée et plus sécurisée.
| Nom | Obligatoire | Catégorie | Description |
|---|---|---|---|
| Authorization | True | string |
Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token}Pour générer un jeton d’authentification à l’aide de Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.comType : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorizePortée: https://ai.azure.com/.default |
| clé API | True | string | Fournissez Azure clé API OpenAI ici |
Corps de la requête
Content-Type : multipart/form-data
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| fichier | string | Oui | ||
| filename | string | Nom de fichier facultatif ou identificateur descriptif à associer aux données audio | Non | |
| model | string | Modèle à utiliser pour cette demande de traduction. | Non | |
| prompt | string | Texte facultatif pour guider le style du modèle ou continuer un segment audio précédent. L’invite doit être en anglais. | Non | |
| format_de_réponse | Objet | Non | ||
| Température | number | Température d’échantillonnage comprise entre 0 et 1. Les valeurs plus élevées telles que 0,8 rendent la sortie plus aléatoire, tandis que les valeurs inférieures comme 0,2 le rendent plus prioritaire et déterministe. Si la valeur est 0, le modèle utilise la probabilité de journal pour augmenter automatiquement la température jusqu’à ce que certains seuils soient atteints. | Non | 0 |
Responses
Code d’état : 200
Description : la demande a réussi.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureAudioTranslationResponse | |
| texte brut | string |
Code d’état : par défaut
Description : réponse d’erreur inattendue.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureErrorResponse |
Exemples
Example
Obtient le texte transcrit en langue anglaise et les métadonnées associées à partir de données audio parlées fournies.
POST {endpoint}/openai/v1/audio/translations?api-version=preview
{
"file": "<binary audio data>",
"model": "whisper-1",
"response_format": "text"
}
Réponses : Code d’état : 200
{
"body": "plain text when requesting text, srt, or vtt"
}
Créer une modification d’image
POST {endpoint}/openai/v1/images/edits?api-version=preview
Paramètres d’URI
| Nom | Dans | Obligatoire | Catégorie | Description |
|---|---|---|---|---|
| endpoint | path | Oui | string url |
Prise en charge Azure points de terminaison OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par votre Azure nom de ressource OpenAI). https://{your-resource-name}.openai.azure.com |
| version de l'API | Requête | Non | Version explicite de l’API Foundry Models à utiliser pour cette requête.v1 s’il n’est pas spécifié. |
En-tête de requête
Utilisez l’authentification basée sur les jetons ou la clé API. L’authentification avec l’authentification basée sur des jetons est recommandée et plus sécurisée.
| Nom | Obligatoire | Catégorie | Description |
|---|---|---|---|
| Authorization | True | string |
Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token}Pour générer un jeton d’authentification à l’aide de Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.comType : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorizePortée: https://ai.azure.com/.default |
| clé API | True | string | Fournissez Azure clé API OpenAI ici |
Corps de la requête
Content-Type : multipart/form-data
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| Arrière-plan | enum | Permet de définir la transparence pour l’arrière-plan de la ou des images générées. Ce paramètre est pris en charge uniquement pour les gpt-image-1 modèles. Doit être l’une des transparentvaleurs opaque par défaut ou auto (valeur par défaut). Lorsqu’il auto est utilisé, le modèle détermine automatiquement le meilleur arrière-plan pour l’image.Si transparent, le format de sortie doit prendre en charge la transparence, il doit donc être défini sur png (valeur par défaut) ou webp.Valeurs possibles : transparent, , opaqueauto |
Non | |
| image | chaîne ou tableau | Oui | ||
| Masque | string | Non | ||
| model | string | Déploiement de modèle à utiliser pour l’opération de modification d’image. | Oui | |
| n | entier | Nombre d’images à générer. Doit être compris entre 1 et 10. | Non | 1 |
| compression_de_sortie | entier | Niveau de compression (0-100%) pour les images générées. Ce paramètre est uniquement pris en charge pour gpt-image-1les modèles -series avec les webp formats ou jpeg les formats de sortie, et la valeur par défaut est 100. |
Non | 100 |
| format de sortie | enum | Format dans lequel les images générées sont retournées. Ce paramètre est uniquement pris en charge pour gpt-image-1les modèles -series. Doit être l’un des png, jpegou webp.La valeur par défaut est png.Valeurs possibles : png, , jpegwebp |
Non | |
| prompt | string | Description textuelle de la ou des images souhaitées. La longueur maximale est de 1 000 caractères et dall-e-2de 32 000 caractères pour gpt-image-1les modèles -series. |
Oui | |
| Qualité | enum | Qualité de l’image qui sera générée.
high, medium et low sont uniquement pris en charge pour gpt-image-1les modèles -series.
dall-e-2 prend uniquement en charge standard la qualité. La valeur par défaut est auto.Valeurs possibles : standard, , lowmedium, high,auto |
Non | |
| format_de_réponse | enum | Format dans lequel les images générées sont retournées. Doit être l’un des url ou b64_json. Les URL ne sont valides que pendant 60 minutes après la génération de l’image. Ce paramètre est pris en charge uniquement pour dall-e-2les gpt-image-1modèles -series qui retournent toujours des images encodées en base64.Valeurs possibles : url, b64_json |
Non | |
| size | enum | Taille des images générées. Doit être l’un des 1024x1024éléments suivants : 1536x1024 (paysage), 1024x1536 (portrait) ou auto (valeur par défaut) pour gpt-image-1les modèles -series, et l’un des 256x256modèles , 512x512ou 1024x1024 pour dall-e-2.Valeurs possibles : 256x256, , 512x5121024x1024, 1536x1024, 1024x1536auto |
Non | |
| utilisateur | string | Identificateur unique représentant votre utilisateur final, qui peut aider OpenAI à surveiller et détecter les abus. | Non |
Responses
Code d’état : 200
Description : la demande a réussi.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureImagesResponse |
Code d’état : par défaut
Description : réponse d’erreur inattendue.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureErrorResponse |
Createimage
POST {endpoint}/openai/v1/images/generations?api-version=preview
Paramètres d’URI
| Nom | Dans | Obligatoire | Catégorie | Description |
|---|---|---|---|---|
| endpoint | path | Oui | string url |
Prise en charge Azure points de terminaison OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par votre Azure nom de ressource OpenAI). https://{your-resource-name}.openai.azure.com |
| version de l'API | Requête | Non | Version explicite de l’API Foundry Models à utiliser pour cette requête.v1 s’il n’est pas spécifié. |
En-tête de requête
Utilisez l’authentification basée sur les jetons ou la clé API. L’authentification avec l’authentification basée sur des jetons est recommandée et plus sécurisée.
| Nom | Obligatoire | Catégorie | Description |
|---|---|---|---|
| Authorization | True | string |
Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token}Pour générer un jeton d’authentification à l’aide de Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.comType : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorizePortée: https://ai.azure.com/.default |
| clé API | True | string | Fournissez Azure clé API OpenAI ici |
Corps de la requête
Content-Type : application/json
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| Arrière-plan | enum | Permet de définir la transparence pour l’arrière-plan de la ou des images générées. Ce paramètre est pris en charge uniquement pour les gpt-image-1 modèles. Doit être l’une des transparentvaleurs opaque par défaut ou auto (valeur par défaut). Lorsqu’il auto est utilisé, le modèle détermine automatiquement le meilleur arrière-plan pour l’image.Si transparent, le format de sortie doit prendre en charge la transparence, il doit donc être défini sur png (valeur par défaut) ou webp.Valeurs possibles : transparent, , opaqueauto |
Non | |
| model | string | Déploiement de modèle à utiliser pour la génération d’image. | Oui | |
| Modération | enum | Contrôlez le niveau de modération du contenu pour les images générées par gpt-image-1les modèles de série. Doit être soit low pour un filtrage moins restrictif ou auto (valeur par défaut).Valeurs possibles : low, auto |
Non | |
| n | entier | Nombre d’images à générer. Doit être compris entre 1 et 10. Pour dall-e-3, uniquement n=1 est pris en charge. |
Non | 1 |
| compression_de_sortie | entier | Niveau de compression (0-100%) pour les images générées. Ce paramètre est uniquement pris en charge pour gpt-image-1les modèles -series avec les webp formats ou jpeg les formats de sortie, et la valeur par défaut est 100. |
Non | 100 |
| format de sortie | enum | Format dans lequel les images générées sont retournées. Ce paramètre est uniquement pris en charge pour gpt-image-1les modèles -series. Doit être l’un des png, jpegou webp.Valeurs possibles : png, , jpegwebp |
Non | |
| prompt | string | Description textuelle de la ou des images souhaitées. La longueur maximale est de 32 000 caractères pour gpt-image-1les modèles -series, 1 000 caractères et dall-e-2 4 000 caractères pour dall-e-3. |
Oui | |
| Qualité | enum | Qualité de l’image qui sera générée. - auto (valeur par défaut) sélectionne automatiquement la meilleure qualité pour le modèle donné.- high, medium et low sont pris en charge pour gpt-image-1les modèles -series.- hd et standard sont pris en charge pour dall-e-3.- standard est la seule option pour dall-e-2.Valeurs possibles : standard, , hdlow, medium, highauto |
Non | |
| format_de_réponse | enum | Format dans lequel les images générées et dall-e-2dall-e-3 sont retournées. Doit être l’un des url ou b64_json. Les URL ne sont valides que pendant 60 minutes après la génération de l’image. Ce paramètre n’est pas pris en charge pour gpt-image-1les modèles -series qui retournent toujours des images codées en base64.Valeurs possibles : url, b64_json |
Non | |
| size | enum | Taille des images générées. Doit être l’un des 1024x1024, 1536x1024 (paysage), 1024x1536 (portrait) ou auto (valeur par défaut) pour gpt-image-1les modèles -series, l’un des 256x256modèles , 512x512ou pour , ou 1024x1024 pour dall-e-2, et l’un des 1024x1024, 1792x1024ou 1024x1792 pour dall-e-3.Valeurs possibles : auto, , 1024x1024, 1536x10241024x1536256x256512x512, , 1792x10241024x1792 |
Non | |
| style | enum | Style des images générées. Ce paramètre n’est pris en charge que pour dall-e-3. Doit être l’un des vivid ou natural. Le modèle se penche sur la génération d’images hyper-réelles et dramatiques. Naturel provoque la production d’images plus naturelles, moins hyper-réelles.Valeurs possibles : vivid, natural |
Non | |
| utilisateur | string | Identificateur unique représentant votre utilisateur final, qui peut aider OpenAI à surveiller et détecter les abus. | Non |
Responses
Code d’état : 200
Description : la demande a réussi.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureImagesResponse |
Code d’état : par défaut
Description : réponse d’erreur inattendue.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureErrorResponse |
Exemples
Example
Crée des images à l’invite.
POST {endpoint}/openai/v1/images/generations?api-version=preview
{
"model": "dall-e-3",
"prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
"n": 1,
"style": "natural",
"quality": "standard"
}
Réponses : Code d’état : 200
{
"body": {
"created": 1698342300,
"data": [
{
"revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
"prompt_filter_results": {
"sexual": {
"severity": "safe",
"filtered": false
},
"violence": {
"severity": "safe",
"filtered": false
},
"hate": {
"severity": "safe",
"filtered": false
},
"self_harm": {
"severity": "safe",
"filtered": false
},
"profanity": {
"detected": false,
"filtered": false
},
"custom_blocklists": {
"filtered": false,
"details": []
}
},
"url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
"content_filter_results": {
"sexual": {
"severity": "safe",
"filtered": false
},
"violence": {
"severity": "safe",
"filtered": false
},
"hate": {
"severity": "safe",
"filtered": false
},
"self_harm": {
"severity": "safe",
"filtered": false
}
}
}
]
}
}
Travaux de génération de vidéos - Créer
POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview
Crée un travail de génération de vidéos.
Paramètres d’URI
| Nom | Dans | Obligatoire | Catégorie | Description |
|---|---|---|---|---|
| endpoint | path | Oui | string url |
Prise en charge Azure points de terminaison OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par votre Azure nom de ressource OpenAI). https://{your-resource-name}.openai.azure.com |
| version de l'API | Requête | Non | Version explicite de l’API Foundry Models à utiliser pour cette requête.v1 s’il n’est pas spécifié. |
En-tête de requête
Utilisez l’authentification basée sur les jetons ou la clé API. L’authentification avec l’authentification basée sur des jetons est recommandée et plus sécurisée.
| Nom | Obligatoire | Catégorie | Description |
|---|---|---|---|
| Authorization | True | string |
Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token}Pour générer un jeton d’authentification à l’aide de Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.comType : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorizePortée: https://ai.azure.com/.default |
| clé API | True | string | Fournissez Azure clé API OpenAI ici |
Corps de la requête
Content-Type : application/json
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| height | entier | Hauteur de la vidéo. Les dimensions suivantes sont prises en charge : 480x480, 854x480, 720x720, 1280x720, 1080x1080 et 1920x1080 dans les orientations paysage et portrait. | Oui | |
| model | string | Nom du déploiement à utiliser pour cette demande. | Oui | |
| n_seconds | entier | Durée du travail de génération de vidéos. Doit être compris entre 1 et 20 secondes. | Non | 5 |
| n_variants | entier | Nombre de vidéos à créer en tant que variantes pour ce travail. Doit être compris entre 1 et 5. Les dimensions plus petites permettent davantage de variantes. | Non | 1 |
| prompt | string | Invite de ce travail de génération de vidéos. | Oui | |
| width | entier | Largeur de la vidéo. Les dimensions suivantes sont prises en charge : 480x480, 854x480, 720x720, 1280x720, 1080x1080 et 1920x1080 dans les orientations paysage et portrait. | Oui |
Corps de la requête
Content-Type : multipart/form-data
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| fichiers | tableau | Oui | ||
| height | entier | Hauteur de la vidéo. Les dimensions suivantes sont prises en charge : 480x480, 854x480, 720x720, 1280x720, 1080x1080 et 1920x1080 dans les orientations paysage et portrait. | Oui | |
| inpaint_items | tableau | Éléments d’inpainting facultatifs pour ce travail de génération de vidéos. | Non | |
| model | string | Nom du déploiement à utiliser pour cette demande. | Oui | |
| n_seconds | entier | Durée du travail de génération de vidéos. Doit être compris entre 1 et 20 secondes. | Non | 5 |
| n_variants | entier | Nombre de vidéos à créer en tant que variantes pour ce travail. Doit être compris entre 1 et 5. Les dimensions plus petites permettent davantage de variantes. | Non | 1 |
| prompt | string | Invite de ce travail de génération de vidéos. | Oui | |
| width | entier | Largeur de la vidéo. Les dimensions suivantes sont prises en charge : 480x480, 854x480, 720x720, 1280x720, 1080x1080 et 1920x1080 dans les orientations paysage et portrait. | Oui |
Responses
Code d’état : 200
Description : la demande a réussi.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | VideoGenerationJob |
Code d’état : par défaut
Description : réponse d’erreur inattendue.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Exemples
Exemple de fichier introuvable : ./examples/create_video_generation_job_simple.json
Travaux de génération de vidéos - Liste
GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview
Répertorie les travaux de génération de vidéos.
Paramètres d’URI
| Nom | Dans | Obligatoire | Catégorie | Description |
|---|---|---|---|---|
| endpoint | path | Oui | string url |
Prise en charge Azure points de terminaison OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par votre Azure nom de ressource OpenAI). https://{your-resource-name}.openai.azure.com |
| version de l'API | Requête | Non | Version explicite de l’API Foundry Models à utiliser pour cette requête.v1 s’il n’est pas spécifié. |
|
| before | Requête | Non | string | |
| Après | Requête | Non | string | |
| limit | Requête | Oui | entier | |
| statuses | Requête | Non | tableau |
En-tête de requête
Utilisez l’authentification basée sur les jetons ou la clé API. L’authentification avec l’authentification basée sur des jetons est recommandée et plus sécurisée.
| Nom | Obligatoire | Catégorie | Description |
|---|---|---|---|
| Authorization | True | string |
Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token}Pour générer un jeton d’authentification à l’aide de Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.comType : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorizePortée: https://ai.azure.com/.default |
| clé API | True | string | Fournissez Azure clé API OpenAI ici |
Responses
Code d’état : 200
Description : la demande a réussi.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | VideoGenerationJobList |
Code d’état : par défaut
Description : réponse d’erreur inattendue.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Exemples
Exemple de fichier introuvable : ./examples/get_video_generation_job_list.json
Travaux de génération de vidéos - Obtenir
GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview
Récupère les propriétés d’un travail de génération de vidéos.
Paramètres d’URI
| Nom | Dans | Obligatoire | Catégorie | Description |
|---|---|---|---|---|
| endpoint | path | Oui | string url |
Prise en charge Azure points de terminaison OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par votre Azure nom de ressource OpenAI). https://{your-resource-name}.openai.azure.com |
| version de l'API | Requête | Non | Version explicite de l’API Foundry Models à utiliser pour cette requête.v1 s’il n’est pas spécifié. |
|
| job-id | path | Oui | string | ID du travail de génération de vidéos à utiliser pour la requête OpenAI Azure. |
En-tête de requête
Utilisez l’authentification basée sur les jetons ou la clé API. L’authentification avec l’authentification basée sur des jetons est recommandée et plus sécurisée.
| Nom | Obligatoire | Catégorie | Description |
|---|---|---|---|
| Authorization | True | string |
Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token}Pour générer un jeton d’authentification à l’aide de Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.comType : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorizePortée: https://ai.azure.com/.default |
| clé API | True | string | Fournissez Azure clé API OpenAI ici |
Responses
Code d’état : 200
Description : la demande a réussi.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | VideoGenerationJob |
Code d’état : par défaut
Description : réponse d’erreur inattendue.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Exemples
Exemple de fichier introuvable : ./examples/get_video_generation_job.json
Travaux de génération de vidéos - Supprimer
DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview
Supprime un travail de génération de vidéos.
Paramètres d’URI
| Nom | Dans | Obligatoire | Catégorie | Description |
|---|---|---|---|---|
| endpoint | path | Oui | string url |
Prise en charge Azure points de terminaison OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par votre Azure nom de ressource OpenAI). https://{your-resource-name}.openai.azure.com |
| version de l'API | Requête | Non | Version explicite de l’API Foundry Models à utiliser pour cette requête.v1 s’il n’est pas spécifié. |
|
| job-id | path | Oui | string | ID du travail de génération de vidéos à utiliser pour la requête OpenAI Azure. |
En-tête de requête
Utilisez l’authentification basée sur les jetons ou la clé API. L’authentification avec l’authentification basée sur des jetons est recommandée et plus sécurisée.
| Nom | Obligatoire | Catégorie | Description |
|---|---|---|---|
| Authorization | True | string |
Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token}Pour générer un jeton d’authentification à l’aide de Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.comType : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorizePortée: https://ai.azure.com/.default |
| clé API | True | string | Fournissez Azure clé API OpenAI ici |
Responses
Code d’état : 204
Description : il n’existe aucun contenu à envoyer pour cette demande, mais les en-têtes peuvent être utiles.
Code d’état : par défaut
Description : réponse d’erreur inattendue.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Générations de vidéos - Obtenir
GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview
Récupère une génération de vidéo par ID.
Paramètres d’URI
| Nom | Dans | Obligatoire | Catégorie | Description |
|---|---|---|---|---|
| endpoint | path | Oui | string url |
Prise en charge Azure points de terminaison OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par votre Azure nom de ressource OpenAI). https://{your-resource-name}.openai.azure.com |
| version de l'API | Requête | Non | Version explicite de l’API Foundry Models à utiliser pour cette requête.v1 s’il n’est pas spécifié. |
|
| generation-id | path | Oui | string | ID de la génération de vidéos à utiliser pour la requête OpenAI Azure. |
En-tête de requête
Utilisez l’authentification basée sur les jetons ou la clé API. L’authentification avec l’authentification basée sur des jetons est recommandée et plus sécurisée.
| Nom | Obligatoire | Catégorie | Description |
|---|---|---|---|
| Authorization | True | string |
Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token}Pour générer un jeton d’authentification à l’aide de Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.comType : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorizePortée: https://ai.azure.com/.default |
| clé API | True | string | Fournissez Azure clé API OpenAI ici |
Responses
Code d’état : 200
Description : la demande a réussi.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | VideoGeneration |
Code d’état : par défaut
Description : réponse d’erreur inattendue.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Exemples
Exemple de fichier introuvable : ./examples/get_video_generation.json
Générations de vidéos - Récupérer une miniature
GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview
Récupère une miniature du contenu vidéo généré.
Paramètres d’URI
| Nom | Dans | Obligatoire | Catégorie | Description |
|---|---|---|---|---|
| endpoint | path | Oui | string url |
Prise en charge Azure points de terminaison OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par votre Azure nom de ressource OpenAI). https://{your-resource-name}.openai.azure.com |
| version de l'API | Requête | Non | Version explicite de l’API Foundry Models à utiliser pour cette requête.v1 s’il n’est pas spécifié. |
|
| generation-id | path | Oui | string | ID de la génération de vidéos à utiliser pour la requête OpenAI Azure. |
En-tête de requête
Utilisez l’authentification basée sur les jetons ou la clé API. L’authentification avec l’authentification basée sur des jetons est recommandée et plus sécurisée.
| Nom | Obligatoire | Catégorie | Description |
|---|---|---|---|
| Authorization | True | string |
Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token}Pour générer un jeton d’authentification à l’aide de Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.comType : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorizePortée: https://ai.azure.com/.default |
| clé API | True | string | Fournissez Azure clé API OpenAI ici |
Responses
Code d’état : 200
Description : la demande a réussi.
| Type de contenu | Type | Description |
|---|---|---|
| image/jpg | string |
Code d’état : par défaut
Description : réponse d’erreur inattendue.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Générations de vidéos - Récupérer du contenu vidéo
GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview
Récupère le contenu vidéo généré.
Paramètres d’URI
| Nom | Dans | Obligatoire | Catégorie | Description |
|---|---|---|---|---|
| endpoint | path | Oui | string url |
Prise en charge Azure points de terminaison OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par votre Azure nom de ressource OpenAI). https://{your-resource-name}.openai.azure.com |
| version de l'API | Requête | Non | Version explicite de l’API Foundry Models à utiliser pour cette requête.v1 s’il n’est pas spécifié. |
|
| generation-id | path | Oui | string | ID de la génération de vidéos à utiliser pour la requête OpenAI Azure. |
| Qualité | Requête | Non |
En-tête de requête
Utilisez l’authentification basée sur les jetons ou la clé API. L’authentification avec l’authentification basée sur des jetons est recommandée et plus sécurisée.
| Nom | Obligatoire | Catégorie | Description |
|---|---|---|---|
| Authorization | True | string |
Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token}Pour générer un jeton d’authentification à l’aide de Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.comType : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorizePortée: https://ai.azure.com/.default |
| clé API | True | string | Fournissez Azure clé API OpenAI ici |
Responses
Code d’état : 200
Description : la demande a réussi.
| Type de contenu | Type | Description |
|---|---|---|
| vidéo/mp4 | string |
Code d’état : par défaut
Description : réponse d’erreur inattendue.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Générations de vidéos - Récupérer uniquement les en-têtes videocontent
HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview
Récupère les en-têtes pour le contenu vidéo généré.
Paramètres d’URI
| Nom | Dans | Obligatoire | Catégorie | Description |
|---|---|---|---|---|
| endpoint | path | Oui | string url |
Prise en charge Azure points de terminaison OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par votre Azure nom de ressource OpenAI). https://{your-resource-name}.openai.azure.com |
| version de l'API | Requête | Non | Version explicite de l’API Foundry Models à utiliser pour cette requête.v1 s’il n’est pas spécifié. |
|
| generation-id | path | Oui | string | ID de la génération de vidéos à utiliser pour la requête OpenAI Azure. |
| Qualité | Requête | Non |
En-tête de requête
Utilisez l’authentification basée sur les jetons ou la clé API. L’authentification avec l’authentification basée sur des jetons est recommandée et plus sécurisée.
| Nom | Obligatoire | Catégorie | Description |
|---|---|---|---|
| Authorization | True | string |
Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token}Pour générer un jeton d’authentification à l’aide de Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.comType : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorizePortée: https://ai.azure.com/.default |
| clé API | True | string | Fournissez Azure clé API OpenAI ici |
Responses
Code d’état : 200
Description : la demande a réussi.
Code d’état : par défaut
Description : réponse d’erreur inattendue.
| Type de contenu | Type | Description |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Composants
Pour connaître les définitions de schéma utilisées par la conversation, les saisies semi-automatiques, les incorporations, les réponses et d’autres opérations de texte, consultez la référence de l’API REST OpenAI Azure. Les schémas suivants prennent en charge les opérations image, audio et vidéo sur cette page.
AzureAudioTranscriptionResponse
Informations de résultat pour une opération qui a transcrit l’audio parlé en texte écrit.
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| durée | number | Durée totale de l’audio traité pour produire des informations de transcription associées. | Non | |
| language | string | Langue parlée détectée dans les données audio transcrites. Cela est exprimé sous la forme d’un code de langue ISO-639-1 à deux lettres comme « en » ou « fr ». |
Non | |
| segments | tableau | Collection d’informations sur le minutage, les probabilités et les autres détails de chaque segment audio traité. | Non | |
| tâche | Objet | Définit les descripteurs possibles pour les réponses d’opération audio disponibles. | Non | |
| texte | string | Texte transcrit pour les données audio fournies. | Oui | |
| words | tableau | Collection d’informations sur le minutage de chaque mot traité. | Non |
AzureAudioTranslationResponse
Informations de résultat pour une opération qui a traduit l’audio parlé en texte écrit.
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| durée | number | Durée totale de l’audio traité pour produire des informations de traduction associées. | Non | |
| language | string | Langue parlée détectée dans les données audio traduites. Cela est exprimé sous la forme d’un code de langue ISO-639-1 à deux lettres comme « en » ou « fr ». |
Non | |
| segments | tableau | Collection d’informations sur le minutage, les probabilités et les autres détails de chaque segment audio traité. | Non | |
| tâche | Objet | Définit les descripteurs possibles pour les réponses d’opération audio disponibles. | Non | |
| texte | string | Texte traduit pour les données audio fournies. | Oui |
AzureErrorResponse
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| erreur | Objet | Détails de l’erreur. | Non | |
| └─ Code | string | Identificateur distinct généré par l’ordinateur pour l’erreur. | Non | |
| └─ erreur_interne | Non | |||
| └─ Message | string | Message lisible par l’homme associé à l’erreur. | Non | |
| └> param | string | Le cas échéant, le paramètre d’entrée de requête associé à l’erreur | Non | |
| └─ Type | enum | Type d’objet, toujours « error ». Valeurs possibles : error |
Non |
AzureImagesResponse
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| Arrière-plan | enum | GPT-image-1 uniquement : paramètre d’arrière-plan utilisé pour la génération d’image.
transparentOu opaque .Valeurs possibles : transparent, opaque |
Non | |
| créé | entier | Horodatage Unix (en secondes) de la création de l’image. | Oui | |
| Données | tableau | Non | ||
| format de sortie | enum | Format de sortie de la génération d’image. Soit png, webpou jpeg.Valeurs possibles : png, , webpjpeg |
Non | |
| Qualité | enum | Qualité de l’image générée. Soit low, mediumou high.Valeurs possibles : low, , mediumhigh |
Non | |
| size | enum | Taille de l’image générée. Soit 1024x1024, 1024x1536ou 1536x1024.Valeurs possibles : 1024x1024, , 1024x15361536x1024 |
Non | |
| utilisation | Objet | Pour gpt-image-1les modèles de série uniquement, les informations d’utilisation des jetons pour la génération d’image. |
Non | |
| └input_tokens | entier | Nombre de jetons (images et texte) dans l’invite d’entrée. | Non | |
| └ détails_des_jets_d'entrée | Objet | Les jetons d’entrée indiquent des informations détaillées pour la génération d’images. | Non | |
| └image_tokens | entier | Nombre de jetons d’image dans l’invite d’entrée. | Non | |
| └ text_tokens | entier | Nombre de jetons de texte dans l’invite d’entrée. | Non | |
| └output_tokens | entier | Nombre de jetons d’image dans l’image de sortie. | Non | |
| └total_tokens | entier | Nombre total de jetons (images et texte) utilisés pour la génération d’images. | Non |
AzureOpenAIVideoGenerationErrorResponse
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| code | string | Identificateur distinct généré par l’ordinateur pour l’erreur. | Non | |
| inner_error | Objet | Le cas échéant, une erreur en amont qui provient de cette erreur. | Non | |
| └─ Code | enum | Code associé à l’erreur interne. Valeurs possibles : ResponsibleAIPolicyViolation |
Non | |
| └─ détails_erreur | Détails du résultat du filtre de contenu associés à l’erreur interne. | Non | ||
| └revised_prompt | string | Le cas échéant, l’invite modifiée utilisée pour la génération. | Non | |
| message | string | Message lisible par l’homme associé à l’erreur. | Non | |
| param | string | Le cas échéant, le paramètre d’entrée de requête associé à l’erreur | Non | |
| type | string | Le cas échéant, le numéro de ligne d’entrée associé à l’erreur. | Non |
VideoGeneration
Résultat de la génération de vidéos.
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| date_de_création | entier | Heure de création de la génération de vidéos. | Oui | |
| height | entier | Hauteur de la vidéo. | Oui | |
| ID | string | ID de la génération de vidéo. | Oui | |
| job_id | string | ID du travail de génération de vidéo pour cette vidéo. | Oui | |
| n_seconds | entier | Durée de la génération de vidéos. | Oui | |
| Objet | enum | Valeurs possibles : video.generation |
Oui | |
| prompt | string | Invite de cette génération vidéo. | Oui | |
| width | entier | Largeur de la vidéo. | Oui |
VideoGenerationJob
Un travail de génération de vidéos.
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| date_de_création | entier | Heure de création du travail. | Oui | |
| expires_at | entier | Heure à laquelle le travail est automatiquement supprimé du service. Le contenu vidéo et les métadonnées du travail doivent être stockés avant cette date pour éviter toute perte de données. | Non | |
| failure_reason | chaîne (voir les modèles valides ci-dessous) | Non | ||
| finished_at | entier | Heure à laquelle le travail s’est terminé avec toutes les générations vidéo. | Non | |
| Générations | tableau | Vidéos générées pour ce travail. Le nombre dépend de la n_variants donnée et de la réussite de la création des générations. | Non | |
| height | entier | Hauteur de la vidéo. | Oui | |
| ID | string | ID du travail. | Oui | |
| inpaint_items | tableau | Éléments d’inpainting facultatifs pour ce travail de génération de vidéos. | Non | |
| model | string | Nom du déploiement à utiliser pour ce travail de génération de vidéos. | Oui | |
| n_seconds | entier | Durée du travail de génération de vidéos. | Oui | |
| n_variants | entier | Nombre de vidéos à créer en tant que variantes pour ce travail de génération de vidéos. | Oui | |
| Objet | enum | Valeurs possibles : video.generation.job |
Oui | |
| prompt | string | Invite de ce travail de génération de vidéos. | Oui | |
| statut | Objet | État d’un travail de génération de vidéos. | Oui | |
| width | entier | Hauteur de la vidéo. | Oui |
VideoGenerationJobList
Liste des travaux de génération vidéo.
| Nom | Catégorie | Description | Obligatoire | Par défaut |
|---|---|---|---|---|
| Données | tableau | Liste des travaux de génération vidéo. | Oui | |
| premier_identifiant | string | ID du premier travail de la page active, le cas échéant. | Non | |
| has_more | booléen | Indicateur indiquant s’il existe davantage de travaux disponibles après la liste. | Oui | |
| last_id | string | ID du dernier travail de la page active, le cas échéant. | Non | |
| Objet | enum | Valeurs possibles : list |
Oui |
Étapes suivantes
Découvrez les modèles et le réglage précis avec l’API REST. En savoir plus sur les modèles underlying qui alimentent Azure OpenAI.