Nota
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare ad accedere o modificare le directory.
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare a modificare le directory.
Questo articolo illustra le operazioni dell'API REST di inferenza dell'immagine, dell'audio (voce) e del piano dati di generazione video per Azure OpenAI nella versione di anteprima v1. Per i completamenti delle chat, incorporamenti, vals, file, ottimizzazione, risposte, archivi vettoriali e tutte le altre operazioni, vedere le informazioni di riferimento ufficiali sull'API REST OpenAI Azure.
Inferenza del piano dati
Il resto di questo articolo illustra le operazioni di immagine, audio e video nella nuova versione api di anteprima v1 della specifica di inferenza del piano dati OpenAI Azure. Per altre informazioni, vedere la guida al ciclo di vita dell'API.
Per l'API del piano dati versione 1 disponibile a livello generale completo, vedere le informazioni di riferimento ufficiali sull'API REST OpenAI Azure.
Creare il riconoscimento vocale
POST {endpoint}/openai/v1/audio/speech?api-version=preview
Genera l'audio sintesi vocale dal testo di input.
Parametri dell'URI
| Name | In | Obbligatorio | Tipo | Description |
|---|---|---|---|---|
| endpoint | path | Sì | corda Url |
Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com |
| api-version | quesito | No | Versione esplicita dell'API foundry models Microsoft da usare per questa richiesta.v1 se non specificato diversamente. |
Intestazione della richiesta
Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.
| Name | Obbligatorio | Tipo | Description |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeAmbito: https://ai.azure.com/.default |
| api-key | Vero | corda | Specificare Azure chiave API OpenAI qui |
Corpo della richiesta
Tipo di contenuto: multipart/form-data
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| input | corda | Testo per cui generare l'audio. La lunghezza massima è di 4096 caratteri. | Sì | |
| instructions | corda | Controllare la voce dell'audio generato con istruzioni aggiuntive. Non funziona con tts-1 o tts-1-hd. |
No | |
| model | corda | Modello da usare per questa richiesta di sintesi vocale. | Sì | |
| formato_risposta | object | Formati di output audio supportati per la sintesi vocale. | No | |
| speed | number | Velocità del parlato per l'audio generato. I valori sono validi nell'intervallo compreso tra 0,25 e 4.0, con 1.0 i valori predefiniti e superiori corrispondenti alla voce più veloce. | No | 1 |
| stream_format | enum | Formato in cui trasmettere l'audio. I formati supportati sono sse e audio.
sse non è supportato per tts-1 o tts-1-hd.Valori possibili: sse, audio |
No | |
| Voce | object | Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/octet-stream | corda |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureErrorResponse |
Esempi
Example
Sintetizza l'audio dal testo fornito.
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"
}
Risposte: Codice di stato: 200
{
"body": "101010101"
}
Creare la trascrizione
POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview
Trascrive l'audio nella lingua di input.
Parametri dell'URI
| Name | In | Obbligatorio | Tipo | Description |
|---|---|---|---|---|
| endpoint | path | Sì | corda Url |
Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com |
| api-version | quesito | No | Versione esplicita dell'API Foundry Models da usare per questa richiesta.v1 se non specificato diversamente. |
Intestazione della richiesta
Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.
| Name | Obbligatorio | Tipo | Description |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeAmbito: https://ai.azure.com/.default |
| api-key | Vero | corda | Specificare Azure chiave API OpenAI qui |
Corpo della richiesta
Tipo di contenuto: multipart/form-data
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| chunking_strategy | object | No | ||
| └prefix_padding_ms | Intero | Quantità di audio da includere prima del riconoscimento vocale rilevato da VAD (in millisecondi). | No | 300 |
| └durata_silenzio_ms | Intero | Durata del silenzio per rilevare l'arresto vocale (in millisecondi). Con valori più brevi il modello risponderà più rapidamente, ma può passare a brevi pause dall'utente. | No | 200 |
| └* soglia | number | Soglia di riservatezza (da 0,0 a 1,0) per il rilevamento delle attività vocali. Una soglia più elevata richiederà un audio più forte per attivare il modello e quindi potrebbe offrire prestazioni migliori in ambienti rumorosi. | No | 0,5 |
| └─ Tipo | enum | Deve essere impostato su server_vad per abilitare la suddivisione in blocchi manuale tramite VAD sul lato server.Valori possibili: server_vad |
No | |
| file | corda | Sì | ||
| filename | corda | Nome file facoltativo o identificatore descrittivo da associare ai dati audio. | No | |
| include[] | array | Informazioni aggiuntive da includere nella risposta di trascrizione.
logprobs restituirà le probabilità di log dei token nella risposta per comprendere la fiducia del modello nella trascrizione.
logprobs funziona solo con response_format impostato su json e solo con i modelli gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribee gpt-4o-mini-transcribe-2025-12-15. |
No | |
| Lingua | corda | Lingua dell'audio di input. Specificare il linguaggio di input nel formato ISO-639-1 (ad esempio en) migliorerà l'accuratezza e la latenza. |
No | |
| model | corda | Modello da usare per questa richiesta di trascrizione. | No | |
| prompt | corda | Testo facoltativo per guidare lo stile del modello o continuare un segmento audio precedente. Il prompt deve corrispondere alla lingua audio. | No | |
| formato_risposta | object | No | ||
| stream | Boolean | Se impostato su true, i dati di risposta del modello verranno trasmessi al client durante la generazione tramite eventi inviati dal server. Nota: lo streaming non è supportato per il whisper-1 modello e verrà ignorato. |
No | Falso |
| Temperatura | number | Temperatura di campionamento, compresa tra 0 e 1. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico. Se impostato su 0, il modello userà la probabilità di log per aumentare automaticamente la temperatura fino a raggiungere determinate soglie. | No | 0 |
| timestamp_granularities[] | array | Granularità del timestamp da popolare per questa trascrizione.
response_format deve essere impostato verbose_json per usare le granularità del timestamp. Sono supportate entrambe o entrambe le opzioni seguenti: wordo segment. Nota: non esiste una latenza aggiuntiva per i timestamp dei segmenti, ma la generazione di timestamp delle parole comporta una latenza aggiuntiva. |
No | ['segment'] |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureAudioTranscriptionResponse | |
| testo/puro | corda |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureErrorResponse |
Esempi
Example
Ottiene il testo trascritto e i metadati associati dai dati audio parlato forniti.
POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview
{
"file": "<binary audio data>",
"model": "whisper-1",
"response_format": "text"
}
Risposte: Codice di stato: 200
{
"body": "plain text when requesting text, srt, or vtt"
}
Creare la traduzione
POST {endpoint}/openai/v1/audio/translations?api-version=preview
Ottiene il testo trascritto in lingua inglese e i metadati associati dai dati audio parlato forniti.
Parametri dell'URI
| Name | In | Obbligatorio | Tipo | Description |
|---|---|---|---|---|
| endpoint | path | Sì | corda Url |
Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com |
| api-version | quesito | No | Versione esplicita dell'API Foundry Models da usare per questa richiesta.v1 se non specificato diversamente. |
Intestazione della richiesta
Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.
| Name | Obbligatorio | Tipo | Description |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeAmbito: https://ai.azure.com/.default |
| api-key | Vero | corda | Specificare Azure chiave API OpenAI qui |
Corpo della richiesta
Tipo di contenuto: multipart/form-data
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| file | corda | Sì | ||
| filename | corda | Nome file facoltativo o identificatore descrittivo da associare ai dati audio | No | |
| model | corda | Modello da utilizzare per questa richiesta di traduzione. | No | |
| prompt | corda | Testo facoltativo per guidare lo stile del modello o continuare un segmento audio precedente. Il prompt deve essere in inglese. | No | |
| formato_risposta | object | No | ||
| Temperatura | number | Temperatura di campionamento, compresa tra 0 e 1. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico. Se impostato su 0, il modello userà la probabilità di log per aumentare automaticamente la temperatura fino a raggiungere determinate soglie. | No | 0 |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureAudioTranslationResponse | |
| testo/puro | corda |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureErrorResponse |
Esempi
Example
Ottiene il testo trascritto in lingua inglese e i metadati associati dai dati audio parlato forniti.
POST {endpoint}/openai/v1/audio/translations?api-version=preview
{
"file": "<binary audio data>",
"model": "whisper-1",
"response_format": "text"
}
Risposte: Codice di stato: 200
{
"body": "plain text when requesting text, srt, or vtt"
}
Creare la modifica dell'immagine
POST {endpoint}/openai/v1/images/edits?api-version=preview
Parametri dell'URI
| Name | In | Obbligatorio | Tipo | Description |
|---|---|---|---|---|
| endpoint | path | Sì | corda Url |
Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com |
| api-version | quesito | No | Versione esplicita dell'API Foundry Models da usare per questa richiesta.v1 se non specificato diversamente. |
Intestazione della richiesta
Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.
| Name | Obbligatorio | Tipo | Description |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeAmbito: https://ai.azure.com/.default |
| api-key | Vero | corda | Specificare Azure chiave API OpenAI qui |
Corpo della richiesta
Tipo di contenuto: multipart/form-data
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| sfondo | enum | Consente di impostare la trasparenza per lo sfondo delle immagini generate. Questo parametro è supportato solo per gpt-image-1 i modelli. Deve essere uno di transparento opaqueauto (valore predefinito). Quando auto viene usato, il modello determinerà automaticamente lo sfondo migliore per l'immagine.Se transparent, il formato di output deve supportare la trasparenza, quindi deve essere impostato su png (valore predefinito) o webp.Valori possibili: transparent, opaque, auto |
No | |
| immagine | stringa o matrice | Sì | ||
| mask | corda | No | ||
| model | corda | Distribuzione del modello da usare per l'operazione di modifica dell'immagine. | Sì | |
| n | Intero | Numero di immagini da generare. Deve essere compreso tra 1 e 10. | No | 1 |
| Compressione dell'output | Intero | Livello di compressione (0-100%) per le immagini generate. Questo parametro è supportato solo per gpt-image-1i modelli -series con i webp formati di output o jpeg e il valore predefinito è 100. |
No | 100 |
| formato_di_output | enum | Formato in cui vengono restituite le immagini generate. Questo parametro è supportato solo per gpt-image-1i modelli -series. Deve essere uno di png, jpego webp.Il valore predefinito è png.Valori possibili: png, jpeg, webp |
No | |
| prompt | corda | Descrizione testuale delle immagini desiderate. La lunghezza massima è di 1000 caratteri per dall-e-2i modelli di serie e 32000 caratteri gpt-image-1. |
Sì | |
| qualità | enum | Qualità dell'immagine che verrà generata.
highe mediumlow sono supportati solo per gpt-image-1i modelli -series.
dall-e-2 supporta standard solo la qualità. Il valore predefinito è auto.Valori possibili: standard, lowmedium, , high,auto |
No | |
| formato_risposta | enum | Formato in cui vengono restituite le immagini generate. Deve essere uno di url o b64_json. Gli URL sono validi solo per 60 minuti dopo la generazione dell'immagine. Questo parametro è supportato solo per dall-e-2, perché gpt-image-1i modelli -series restituiscono sempre immagini con codifica Base64.Valori possibili: url, b64_json |
No | |
| size | enum | Dimensioni delle immagini generate. Deve essere uno di 1024x1024, 1536x1024 (orizzontale), 1024x1536 (verticale) o auto (valore predefinito) per gpt-image-1i modelli -series e uno di 256x256, 512x512o 1024x1024 per dall-e-2.Valori possibili: 256x256, 512x5121024x1024, 1536x1024, , 1024x1536auto |
No | |
| user | corda | Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. | No |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureImagesResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureErrorResponse |
Creare un'immagine
POST {endpoint}/openai/v1/images/generations?api-version=preview
Parametri dell'URI
| Name | In | Obbligatorio | Tipo | Description |
|---|---|---|---|---|
| endpoint | path | Sì | corda Url |
Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com |
| api-version | quesito | No | Versione esplicita dell'API Foundry Models da usare per questa richiesta.v1 se non specificato diversamente. |
Intestazione della richiesta
Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.
| Name | Obbligatorio | Tipo | Description |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeAmbito: https://ai.azure.com/.default |
| api-key | Vero | corda | Specificare Azure chiave API OpenAI qui |
Corpo della richiesta
Content-Type: application/json
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| sfondo | enum | Consente di impostare la trasparenza per lo sfondo delle immagini generate. Questo parametro è supportato solo per gpt-image-1 i modelli. Deve essere uno di transparento opaqueauto (valore predefinito). Quando auto viene usato, il modello determinerà automaticamente lo sfondo migliore per l'immagine.Se transparent, il formato di output deve supportare la trasparenza, quindi deve essere impostato su png (valore predefinito) o webp.Valori possibili: transparent, opaque, auto |
No | |
| model | corda | Distribuzione del modello da usare per la generazione di immagini. | Sì | |
| Moderazione | enum | Controllare il livello di moderazione del contenuto per le immagini generate dai gpt-image-1modelli di serie. Deve essere per un low filtro meno restrittivo o auto (valore predefinito).Valori possibili: low, auto |
No | |
| n | Intero | Numero di immagini da generare. Deve essere compreso tra 1 e 10. Solo per dall-e-3, n=1 è supportato. |
No | 1 |
| Compressione dell'output | Intero | Livello di compressione (0-100%) per le immagini generate. Questo parametro è supportato solo per gpt-image-1i modelli -series con i webp formati di output o jpeg e il valore predefinito è 100. |
No | 100 |
| formato_di_output | enum | Formato in cui vengono restituite le immagini generate. Questo parametro è supportato solo per gpt-image-1i modelli -series. Deve essere uno di png, jpego webp.Valori possibili: png, jpeg, webp |
No | |
| prompt | corda | Descrizione testuale delle immagini desiderate. La lunghezza massima è di 32000 caratteri per gpt-image-1i modelli di serie, 1000 caratteri per dall-e-2 e 4000 caratteri per dall-e-3. |
Sì | |
| qualità | enum | Qualità dell'immagine che verrà generata. - auto (valore predefinito) selezionerà automaticamente la migliore qualità per il modello specificato.- highe mediumlow sono supportati per gpt-image-1i modelli -series.- hd e standard sono supportati per dall-e-3.- standard è l'unica opzione per dall-e-2.Valori possibili: standard, hdlow, medium, , highauto |
No | |
| formato_risposta | enum | Formato in cui vengono restituite le immagini generate con dall-e-2 e dall-e-3 . Deve essere uno di url o b64_json. Gli URL sono validi solo per 60 minuti dopo la generazione dell'immagine. Questo parametro non è supportato per gpt-image-1i modelli di serie che restituiranno sempre immagini con codifica Base64.Valori possibili: url, b64_json |
No | |
| size | enum | Dimensioni delle immagini generate. Deve essere uno di 1024x1024, 1536x1024 (orizzontale), (verticale) 1024x1536 o auto (valore predefinito) per gpt-image-1i modelli -series, uno di 256x256, 512x512o 1024x1024 per dall-e-2e uno di 1024x1024, 1792x1024o 1024x1792 per dall-e-3.Valori possibili: auto, 1024x1024, 1536x10241024x1536, 256x256, 512x512, , 1792x10241024x1792 |
No | |
| Stile | enum | Stile delle immagini generate. Questo parametro è supportato solo per dall-e-3. Deve essere uno di vivid o natural. Vivid fa sì che il modello si appoggi verso la generazione di immagini iper-reali e drammatiche. Naturale fa sì che il modello producano immagini più naturali e meno iper-reali.Valori possibili: vivid, natural |
No | |
| user | corda | Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. | No |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureImagesResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureErrorResponse |
Esempi
Example
Crea immagini in base a un prompt.
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"
}
Risposte: Codice di stato: 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
}
}
}
]
}
}
Processi di generazione di video - Creare
POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview
Crea un nuovo processo di generazione di video.
Parametri dell'URI
| Name | In | Obbligatorio | Tipo | Description |
|---|---|---|---|---|
| endpoint | path | Sì | corda Url |
Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com |
| api-version | quesito | No | Versione esplicita dell'API Foundry Models da usare per questa richiesta.v1 se non specificato diversamente. |
Intestazione della richiesta
Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.
| Name | Obbligatorio | Tipo | Description |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeAmbito: https://ai.azure.com/.default |
| api-key | Vero | corda | Specificare Azure chiave API OpenAI qui |
Corpo della richiesta
Content-Type: application/json
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| height | Intero | Altezza del video. Sono supportate le dimensioni seguenti: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 sia in orientamento orizzontale che verticale. | Sì | |
| model | corda | Nome della distribuzione da usare per questa richiesta. | Sì | |
| n_seconds | Intero | Durata del processo di generazione video. Deve essere compreso tra 1 e 20 secondi. | No | 5 |
| n_variants | Intero | Numero di video da creare come varianti per questo processo. Deve essere compreso tra 1 e 5. Le dimensioni più piccole consentono più varianti. | No | 1 |
| prompt | corda | Richiesta di questo processo di generazione video. | Sì | |
| width | Intero | Larghezza del video. Sono supportate le dimensioni seguenti: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 sia in orientamento orizzontale che verticale. | Sì |
Corpo della richiesta
Tipo di contenuto: multipart/form-data
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| File | array | Sì | ||
| height | Intero | Altezza del video. Sono supportate le dimensioni seguenti: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 sia in orientamento orizzontale che verticale. | Sì | |
| inpaint_items | array | Elementi facoltativi per questo processo di generazione di video. | No | |
| model | corda | Nome della distribuzione da usare per questa richiesta. | Sì | |
| n_seconds | Intero | Durata del processo di generazione video. Deve essere compreso tra 1 e 20 secondi. | No | 5 |
| n_variants | Intero | Numero di video da creare come varianti per questo processo. Deve essere compreso tra 1 e 5. Le dimensioni più piccole consentono più varianti. | No | 1 |
| prompt | corda | Richiesta di questo processo di generazione video. | Sì | |
| width | Intero | Larghezza del video. Sono supportate le dimensioni seguenti: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 sia in orientamento orizzontale che verticale. | Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | VideoGenerationJob |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Esempi
File di esempio non trovato: ./examples/create_video_generation_job_simple.json
Processi di generazione di video - Elenco
GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview
Elenca i processi di generazione di video.
Parametri dell'URI
| Name | In | Obbligatorio | Tipo | Description |
|---|---|---|---|---|
| endpoint | path | Sì | corda Url |
Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com |
| api-version | quesito | No | Versione esplicita dell'API Foundry Models da usare per questa richiesta.v1 se non specificato diversamente. |
|
| before | quesito | No | corda | |
| dopo | quesito | No | corda | |
| limit | quesito | Sì | Intero | |
| statuses | quesito | No | array |
Intestazione della richiesta
Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.
| Name | Obbligatorio | Tipo | Description |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeAmbito: https://ai.azure.com/.default |
| api-key | Vero | corda | Specificare Azure chiave API OpenAI qui |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | VideoGenerationJobList |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Esempi
File di esempio non trovato: ./examples/get_video_generation_job_list.json
Processi di generazione di video - Ottenere
GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview
Recupera le proprietà di un processo di generazione di video.
Parametri dell'URI
| Name | In | Obbligatorio | Tipo | Description |
|---|---|---|---|---|
| endpoint | path | Sì | corda Url |
Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com |
| api-version | quesito | No | Versione esplicita dell'API Foundry Models da usare per questa richiesta.v1 se non specificato diversamente. |
|
| job-id | path | Sì | corda | ID del processo di generazione video da usare per la richiesta OpenAI Azure. |
Intestazione della richiesta
Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.
| Name | Obbligatorio | Tipo | Description |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeAmbito: https://ai.azure.com/.default |
| api-key | Vero | corda | Specificare Azure chiave API OpenAI qui |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | VideoGenerationJob |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Esempi
File di esempio non trovato: ./examples/get_video_generation_job.json
Processi di generazione di video - Elimina
DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview
Elimina un processo di generazione di video.
Parametri dell'URI
| Name | In | Obbligatorio | Tipo | Description |
|---|---|---|---|---|
| endpoint | path | Sì | corda Url |
Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com |
| api-version | quesito | No | Versione esplicita dell'API Foundry Models da usare per questa richiesta.v1 se non specificato diversamente. |
|
| job-id | path | Sì | corda | ID del processo di generazione video da usare per la richiesta OpenAI Azure. |
Intestazione della richiesta
Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.
| Name | Obbligatorio | Tipo | Description |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeAmbito: https://ai.azure.com/.default |
| api-key | Vero | corda | Specificare Azure chiave API OpenAI qui |
Responses
Codice di stato: 204
Descrizione: nessun contenuto da inviare per questa richiesta, ma le intestazioni potrebbero essere utili.
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Generazioni di video - Ottenere
GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview
Recupera una generazione di video in base all'ID.
Parametri dell'URI
| Name | In | Obbligatorio | Tipo | Description |
|---|---|---|---|---|
| endpoint | path | Sì | corda Url |
Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com |
| api-version | quesito | No | Versione esplicita dell'API Foundry Models da usare per questa richiesta.v1 se non specificato diversamente. |
|
| generation-id | path | Sì | corda | ID della generazione di video da usare per la richiesta OpenAI Azure. |
Intestazione della richiesta
Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.
| Name | Obbligatorio | Tipo | Description |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeAmbito: https://ai.azure.com/.default |
| api-key | Vero | corda | Specificare Azure chiave API OpenAI qui |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | VideoGeneration |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Esempi
File di esempio non trovato: ./examples/get_video_generation.json
Generazioni di video - Recuperare l'anteprima
GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview
Recupera un'anteprima del contenuto video generato.
Parametri dell'URI
| Name | In | Obbligatorio | Tipo | Description |
|---|---|---|---|---|
| endpoint | path | Sì | corda Url |
Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com |
| api-version | quesito | No | Versione esplicita dell'API Foundry Models da usare per questa richiesta.v1 se non specificato diversamente. |
|
| generation-id | path | Sì | corda | ID della generazione di video da usare per la richiesta OpenAI Azure. |
Intestazione della richiesta
Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.
| Name | Obbligatorio | Tipo | Description |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeAmbito: https://ai.azure.com/.default |
| api-key | Vero | corda | Specificare Azure chiave API OpenAI qui |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| image/jpg | corda |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Generazioni di video - Recuperare il contenuto video
GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview
Recupera il contenuto video generato.
Parametri dell'URI
| Name | In | Obbligatorio | Tipo | Description |
|---|---|---|---|---|
| endpoint | path | Sì | corda Url |
Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com |
| api-version | quesito | No | Versione esplicita dell'API Foundry Models da usare per questa richiesta.v1 se non specificato diversamente. |
|
| generation-id | path | Sì | corda | ID della generazione di video da usare per la richiesta OpenAI Azure. |
| qualità | quesito | No |
Intestazione della richiesta
Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.
| Name | Obbligatorio | Tipo | Description |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeAmbito: https://ai.azure.com/.default |
| api-key | Vero | corda | Specificare Azure chiave API OpenAI qui |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| video/mp4 | corda |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Generazioni di video - Recuperare solo le intestazioni videocontent
HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview
Recupera le intestazioni per il contenuto video generato.
Parametri dell'URI
| Name | In | Obbligatorio | Tipo | Description |
|---|---|---|---|---|
| endpoint | path | Sì | corda Url |
Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com |
| api-version | quesito | No | Versione esplicita dell'API Foundry Models da usare per questa richiesta.v1 se non specificato diversamente. |
|
| generation-id | path | Sì | corda | ID della generazione di video da usare per la richiesta OpenAI Azure. |
| qualità | quesito | No |
Intestazione della richiesta
Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.
| Name | Obbligatorio | Tipo | Description |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeAmbito: https://ai.azure.com/.default |
| api-key | Vero | corda | Specificare Azure chiave API OpenAI qui |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Type | Descrizione |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Components
Per le definizioni di schema usate da chat, completamenti, incorporamenti, risposte e altre operazioni di testo, vedere le informazioni di riferimento sull'API REST OpenAI Azure. Gli schemi seguenti supportano le operazioni di immagine, audio e video in questa pagina.
AzureAudioTranscriptionResponse
Informazioni sui risultati per un'operazione che trascrive l'audio parlato in testo scritto.
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| duration | number | Durata totale dell'audio elaborato per produrre informazioni di trascrizione a corredo. | No | |
| Lingua | corda | Lingua parlata rilevata nei dati audio trascritti. Questo valore viene espresso come codice di lingua ISO-639-1 di due lettere, ad esempio 'en' o 'fr'. |
No | |
| Segmenti | array | Raccolta di informazioni sulla tempistica, le probabilità e altri dettagli di ogni segmento audio elaborato. | No | |
| compito | object | Definisce i descrittori possibili per le risposte alle operazioni audio disponibili. | No | |
| text | corda | Testo trascritto per i dati audio forniti. | Sì | |
| words | array | Raccolta di informazioni sulla tempistica di ogni parola elaborata. | No |
AzureAudioTranslationResponse
Informazioni sui risultati per un'operazione che ha tradotto l'audio parlato in testo scritto.
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| duration | number | Durata totale dell'audio elaborato per produrre informazioni di traduzione accompagnate. | No | |
| Lingua | corda | Lingua parlata rilevata nei dati audio tradotti. Questo valore viene espresso come codice di lingua ISO-639-1 di due lettere, ad esempio 'en' o 'fr'. |
No | |
| Segmenti | array | Raccolta di informazioni sulla tempistica, le probabilità e altri dettagli di ogni segmento audio elaborato. | No | |
| compito | object | Definisce i descrittori possibili per le risposte alle operazioni audio disponibili. | No | |
| text | corda | Testo tradotto per i dati audio forniti. | Sì |
AzureErrorResponse
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| Errore | object | Dettagli dell'errore. | No | |
| └─ codice | corda | Identificatore distinto generato dal computer per l'errore. | No | |
| └─ errore_interno | No | |||
| └* messaggio | corda | Messaggio leggibile associato all'errore. | No | |
| └* param | corda | Se applicabile, il parametro di input della richiesta associato all'errore | No | |
| └─ Tipo | enum | Tipo di oggetto, sempre 'error'. Valori possibili: error |
No |
AzureImagesResponse
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| sfondo | enum | Solo GPT-image-1: parametro di sfondo usato per la generazione dell'immagine.
transparentO opaque .Valori possibili: transparent, opaque |
No | |
| creato | Intero | Timestamp Unix (in secondi) di quando è stata creata l'immagine. | Sì | |
| Dati | array | No | ||
| formato_di_output | enum | Formato di output della generazione dell'immagine. , pngwebpo jpeg.Valori possibili: png, webp, jpeg |
No | |
| qualità | enum | Qualità dell'immagine generata. , lowmediumo high.Valori possibili: low, medium, high |
No | |
| size | enum | Dimensioni dell'immagine generata. , 1024x10241024x1536o 1536x1024.Valori possibili: 1024x1024, 1024x1536, 1536x1024 |
No | |
| uso | object | Solo per gpt-image-1i modelli -series, le informazioni sull'utilizzo del token per la generazione dell'immagine. |
No | |
| └ input_tokens | Intero | Numero di token (immagini e testo) nel prompt di input. | No | |
| └input_tokens_details | object | I token di input contengono informazioni dettagliate per la generazione di immagini. | No | |
| └ image_tokens | Intero | Numero di token di immagine nel prompt di input. | No | |
| └ text_tokens | Intero | Numero di token di testo nel prompt di input. | No | |
| └output_tokens | Intero | Numero di token di immagine nell'immagine di output. | No | |
| └total_tokens | Intero | Numero totale di token (immagini e testo) usati per la generazione di immagini. | No |
AzureOpenAIVideoGenerationErrorResponse
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| codice | corda | Identificatore distinto generato dal computer per l'errore. | No | |
| inner_error | object | Se applicabile, un errore upstream che ha generato questo errore. | No | |
| └─ codice | enum | Codice associato all'errore interno. Valori possibili: ResponsibleAIPolicyViolation |
No | |
| └─ dettagli_errore | Dettagli del risultato del filtro contenuto associati all'errore interno. | No | ||
| └ revised_prompt | corda | Se applicabile, il prompt modificato usato per la generazione. | No | |
| message | corda | Messaggio leggibile associato all'errore. | No | |
| param | corda | Se applicabile, il parametro di input della richiesta associato all'errore | No | |
| type | corda | Se applicabile, il numero di riga di input associato all'errore. | No |
VideoGeneration
Risultato della generazione di video.
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| creato_il | Intero | Ora in cui è stata creata la generazione di video. | Sì | |
| height | Intero | Altezza del video. | Sì | |
| id | corda | ID della generazione di video. | Sì | |
| job_id | corda | ID del processo di generazione video per questo video. | Sì | |
| n_seconds | Intero | Durata della generazione di video. | Sì | |
| object | enum | Valori possibili: video.generation |
Sì | |
| prompt | corda | Richiesta di generazione di video. | Sì | |
| width | Intero | Larghezza del video. | Sì |
VideoGenerationJob
Un processo di generazione di video.
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| creato_il | Intero | Ora di creazione del processo. | Sì | |
| scade_il | Intero | Ora in cui il processo viene eliminato automaticamente dal servizio. Il contenuto video e i metadati del processo devono essere archiviati prima di questa data per evitare la perdita di dati. | No | |
| failure_reason | string (vedere modelli validi di seguito) | No | ||
| terminato_il | Intero | L'ora in cui il lavoro è terminato con tutte le generazioni di video. | No | |
| Generazioni | array | Video generati per questo processo. Il numero dipende dal n_variants specificato e dal successo della creazione delle generazioni. | No | |
| height | Intero | Altezza del video. | Sì | |
| id | corda | ID del processo. | Sì | |
| inpaint_items | array | Elementi facoltativi per questo processo di generazione di video. | No | |
| model | corda | Nome della distribuzione da usare per questo processo di generazione video. | Sì | |
| n_seconds | Intero | Durata del processo di generazione video. | Sì | |
| n_variants | Intero | Numero di video da creare come varianti per questo processo di generazione di video. | Sì | |
| object | enum | Valori possibili: video.generation.job |
Sì | |
| prompt | corda | Richiesta di questo processo di generazione video. | Sì | |
| stato | object | Stato di un processo di generazione di video. | Sì | |
| width | Intero | Altezza del video. | Sì |
VideoGenerationJobList
Elenco dei processi di generazione di video.
| Name | Tipo | Description | Obbligatorio | Predefinito |
|---|---|---|---|---|
| Dati | array | Elenco dei processi di generazione di video. | Sì | |
| first_id | corda | ID del primo processo nella pagina corrente, se disponibile. | No | |
| ha_di_piu | Boolean | Flag che indica se sono disponibili più processi dopo l'elenco. | Sì | |
| last_id | corda | ID dell'ultimo processo nella pagina corrente, se disponibile. | No | |
| object | enum | Valori possibili: list |
Sì |
Passaggi successivi
Informazioni sui modelli e sull'ottimizzazione con l'API REST. Altre informazioni sui modelli informazioni che alimentano Azure OpenAI.