Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
In diesem Artikel werden die Datenebenenvorgänge der Bild-, Audio- (Sprache) und Der Datenebenen-Ableitung von REST-API-Vorgängen für Azure OpenAI in der v1-Vorschauversion dokumentiert. Informationen zu Chatabschlussen, Einbettungen, Evals, Dateien, Feinabstimmungen, Antworten, Vektorspeichern und allen anderen Vorgängen finden Sie in der offiziellen Azure OpenAI REST-API-Referenz.
Datenebenen-Ableitung
Der Rest dieses Artikels behandelt die Bild-, Audio- und Videovorgänge in der neuen Version der v1-Vorschau-API-Version der Azure OpenAI-Datenebenen-Ableitungsspezifikation. Weitere Informationen finden Sie im API-Lebenszyklushandbuch.
Die vollständige v1 GA-Datenebenen-API finden Sie in der offiziellen Azure OpenAI REST-API-Referenz.
Sprache erstellen
POST {endpoint}/openai/v1/audio/speech?api-version=preview
Generiert Text-zu-Sprache-Audio aus dem Eingabetext.
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | string url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| API-Version | Anfrage | No | Die explizite Microsoft Foundry Models API-Version, die für diese Anforderung verwendet werden soll.v1 wenn nicht anders angegeben. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeUmfang: https://ai.azure.com/.default |
| API-Schlüssel | Richtig | string | Bereitstellen Azure OpenAI-API-Schlüssels hier |
Anforderungstext
Content-Typ: mehrteilige Formulardaten (multipart/form-data)
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| input | string | Der Text, für den Audio generiert werden soll. Die maximale Länge beträgt 4096 Zeichen. | Ja | |
| Anweisungen | string | Steuern Sie die Stimme Ihrer generierten Audiodaten mit zusätzlichen Anweisungen. Funktioniert nicht mit tts-1 oder tts-1-hd. |
No | |
| Modell | string | Das Modell, das für diese Text-zu-Sprache-Anforderung verwendet werden soll. | Ja | |
| Antwortformat | Objekt | Die unterstützten Audioausgabeformate für Text-zu-Sprache. | No | |
| Geschwindigkeit | number | Die Geschwindigkeit der Spracherkennung für generierte Audiodaten. Werte sind im Bereich von 0,25 bis 4,0 gültig, wobei 1,0 die Standardwerte und höhere Werte, die schnelleren Spracherkennungen entsprechen. | No | 1 |
| stream_format | enum | Das Format, in das die Audiodaten gestreamt werden sollen. Unterstützte Formate sind sse und audio.
sse wird für tts-1 oder tts-1-hd.Mögliche Werte: sse, audio |
No | |
| Stimme | Objekt | Ja |
Antworten
Statuscode: 200
Beschreibung: Die Anforderung ist erfolgreich.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/octet-stream | string |
Statuscode: Standard
Beschreibung: Eine unerwartete Fehlerantwort.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureErrorResponse |
Beispiele
Example
Synthetisiert Audio aus dem bereitgestellten Text.
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"
}
Antworten: Statuscode: 200
{
"body": "101010101"
}
Transkription erstellen
POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview
Transkribiert Audio in die Eingabesprache.
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | string url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| API-Version | Anfrage | No | Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll.v1 wenn nicht anders angegeben. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeUmfang: https://ai.azure.com/.default |
| API-Schlüssel | Richtig | string | Bereitstellen Azure OpenAI-API-Schlüssels hier |
Anforderungstext
Content-Typ: mehrteilige Formulardaten (multipart/form-data)
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| chunking_strategy | Objekt | No | ||
| └– prefix_padding_ms | Ganzzahl | Die Menge der Audiodaten, die vor der erkannten VAD-Sprache (in Millisekunden) enthalten sein sollen. | No | 300 |
| └– Dauer_der_Stille_in_ms | Ganzzahl | Dauer der Stille zum Erkennen des Sprachstopps (in Millisekunden). Mit kürzeren Werten reagiert das Modell schneller, kann aber an kurzen Pausen vom Benutzer teilnehmen. | No | 200 |
| └– Schwellenwert | number | Vertraulichkeitsschwellenwert (0,0 bis 1,0) für die Sprachaktivitätserkennung. Eine höhere Schwelle erfordert lauteres Audio, um das Modell zu aktivieren, und kann daher in lauten Umgebungen besser funktionieren. | No | 0,5 |
| └– Typ | enum | Muss so festgelegt sein, dass server_vad manuelle Blöcke mithilfe der serverseitigen VAD aktiviert werden.Mögliche Werte: server_vad |
No | |
| Datei | string | Ja | ||
| filename | string | Der optionale Dateiname oder der beschreibende Bezeichner, der den Audiodaten zugeordnet werden soll. | No | |
| include[] | array | Zusätzliche Informationen, die in die Transkriptionsantwort aufgenommen werden sollen.
logprobs gibt die Protokollwahrscheinlichkeiten der Token in der Antwort zurück, um das Vertrauen des Modells in die Transkription zu verstehen.
logprobs funktioniert nur mit response_format auf json und nur mit den Modellen gpt-4o-transcribe, gpt-4o-transcribe-diarize, , gpt-4o-mini-transcribeund gpt-4o-mini-transcribe-2025-12-15. |
No | |
| language | string | Die Sprache des Eingabeaudios. Durch die Bereitstellung der Eingabesprache in ISO-639-1 (z. B. en) wird die Genauigkeit und Latenz verbessert. |
No | |
| Modell | string | Das Modell, das für diese Transkriptionsanforderung verwendet werden soll. | No | |
| Eingabeaufforderung | string | Optionaler Text zum Leiten der Formatvorlage des Modells oder Fortsetzen eines vorherigen Audiosegments. Die Eingabeaufforderung sollte mit der Audiosprache übereinstimmen. | No | |
| Antwortformat | Objekt | No | ||
| stream | Boolescher Wert | Wenn dieser Wert auf "true" festgelegt ist, werden die Modellantwortdaten an den Client gestreamt, da sie mithilfe von Server gesendeten Ereignissen generiert wird. Hinweis: Streaming wird für das whisper-1 Modell nicht unterstützt und wird ignoriert. |
No | Falsch |
| Temperatur | number | Die Probenahmetemperatur zwischen 0 und 1. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Bei Festlegung auf 0 verwendet das Modell die Protokollwahrscheinlichkeit , um die Temperatur automatisch zu erhöhen, bis bestimmte Schwellenwerte erreicht werden. | No | 0 |
| timestamp_granularities[] | array | Die Zeitstempel-Granularitäten, die für diese Transkription aufgefüllt werden sollen.
response_format muss für die Verwendung von Timestamp-Granularitäten festgelegt verbose_json werden. Entweder oder beide dieser Optionen werden unterstützt: wordoder segment. Hinweis: Es gibt keine zusätzliche Latenz für Segmentzeitstempel, aber das Generieren von Wortzeitstempeln verursacht zusätzliche Latenz. |
No | ['segment'] |
Antworten
Statuscode: 200
Beschreibung: Die Anforderung ist erfolgreich.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureAudioTranscriptionResponse | |
| Textdatei/Klartext | string |
Statuscode: Standard
Beschreibung: Eine unerwartete Fehlerantwort.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureErrorResponse |
Beispiele
Example
Ruft transkribierten Text und zugeordnete Metadaten aus bereitgestellten gesprochenen Audiodaten ab.
POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview
{
"file": "<binary audio data>",
"model": "whisper-1",
"response_format": "text"
}
Antworten: Statuscode: 200
{
"body": "plain text when requesting text, srt, or vtt"
}
Übersetzung erstellen
POST {endpoint}/openai/v1/audio/translations?api-version=preview
Ruft englischsprachigen transkribierten Text und zugeordnete Metadaten aus bereitgestellten gesprochenen Audiodaten ab.
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | string url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| API-Version | Anfrage | No | Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll.v1 wenn nicht anders angegeben. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeUmfang: https://ai.azure.com/.default |
| API-Schlüssel | Richtig | string | Bereitstellen Azure OpenAI-API-Schlüssels hier |
Anforderungstext
Content-Typ: mehrteilige Formulardaten (multipart/form-data)
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| Datei | string | Ja | ||
| filename | string | Optionaler Dateiname oder beschreibender Bezeichner, der den Audiodaten zugeordnet werden soll | No | |
| Modell | string | Das Modell, das für diese Übersetzungsanforderung verwendet werden soll. | No | |
| Eingabeaufforderung | string | Optionaler Text zum Leiten der Formatvorlage des Modells oder Fortsetzen eines vorherigen Audiosegments. Die Eingabeaufforderung sollte in Englisch sein. | No | |
| Antwortformat | Objekt | No | ||
| Temperatur | number | Die Probenahmetemperatur zwischen 0 und 1. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Bei Festlegung auf 0 verwendet das Modell die Protokollwahrscheinlichkeit , um die Temperatur automatisch zu erhöhen, bis bestimmte Schwellenwerte erreicht werden. | No | 0 |
Antworten
Statuscode: 200
Beschreibung: Die Anforderung ist erfolgreich.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureAudioTranslationResponse | |
| Textdatei/Klartext | string |
Statuscode: Standard
Beschreibung: Eine unerwartete Fehlerantwort.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureErrorResponse |
Beispiele
Example
Ruft englischsprachigen transkribierten Text und zugeordnete Metadaten aus bereitgestellten gesprochenen Audiodaten ab.
POST {endpoint}/openai/v1/audio/translations?api-version=preview
{
"file": "<binary audio data>",
"model": "whisper-1",
"response_format": "text"
}
Antworten: Statuscode: 200
{
"body": "plain text when requesting text, srt, or vtt"
}
Erstellen einer Bildbearbeitung
POST {endpoint}/openai/v1/images/edits?api-version=preview
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | string url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| API-Version | Anfrage | No | Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll.v1 wenn nicht anders angegeben. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeUmfang: https://ai.azure.com/.default |
| API-Schlüssel | Richtig | string | Bereitstellen Azure OpenAI-API-Schlüssels hier |
Anforderungstext
Content-Typ: mehrteilige Formulardaten (multipart/form-data)
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| Hintergrund | enum | Ermöglicht das Festlegen der Transparenz für den Hintergrund der generierten Bilder. Dieser Parameter wird nur für gpt-image-1 Modelle unterstützt. Muss einer von transparentoder opaqueauto (Standardwert) sein. Wenn auto das Modell verwendet wird, bestimmt das Modell automatisch den besten Hintergrund für das Bild.Wenn transparentdas Ausgabeformat Transparenz unterstützen muss, sollte es entweder auf png (Standardwert) oder webpfestgelegt werden.Mögliche Werte: transparent, , opaqueauto |
No | |
| Bild | Zeichenfolge oder Matrix | Ja | ||
| mask | string | No | ||
| Modell | string | Die Modellbereitstellung, die für den Bildbearbeitungsvorgang verwendet werden soll. | Ja | |
| n | Ganzzahl | Die Anzahl der zu generierenden Bilder. Muss zwischen 1 und 10 sein. | No | 1 |
| Ausgabekomprimierung | Ganzzahl | Die Komprimierungsebene (0-100%) für die generierten Bilder. Dieser Parameter wird nur für gpt-image-1-Serienmodelle mit den webp Formaten oder jpeg Ausgabeformaten unterstützt und ist standardmäßig auf 100 festgelegt. |
No | 100 |
| Ausgabeformat | enum | Das Format, in dem die generierten Bilder zurückgegeben werden. Dieser Parameter wird nur für Modelle der gpt-image-1Serie unterstützt. Muss eine von png, jpeg, oder webp.Der Standardwert ist png.Mögliche Werte: png, , jpegwebp |
No | |
| Eingabeaufforderung | string | Eine Textbeschreibung der gewünschten Bilder. Die maximale Länge beträgt 1000 Zeichen für dall-e-2und 32000 Zeichen für gpt-image-1-Serienmodelle. |
Ja | |
| Qualität | enum | Die Qualität des Bilds, das generiert wird.
high, medium und low werden nur für Modelle der gpt-image-1Serie unterstützt.
dall-e-2 unterstützt standard nur Qualität. Standardwert ist .autoMögliche Werte: standard, , lowmedium, , highauto |
No | |
| Antwortformat | enum | Das Format, in dem die generierten Bilder zurückgegeben werden. Muss eine von url oder b64_json. URLs sind nur 60 Minuten lang gültig, nachdem das Bild generiert wurde. Dieser Parameter wird nur für dall-e-2"-series"-Modelle unterstützt, da gpt-image-1base64-codierte Bilder immer zurückgegeben werden.Mögliche Werte: url, b64_json |
No | |
| size | enum | Die Größe der generierten Bilder. Muss eines von 1024x1024, 1536x1024 (Querformat), 1024x1536 (Hochformat) oder auto (Standardwert) für gpt-image-1-Serienmodelle und eines von 256x256, 512x512oder 1024x1024 für dall-e-2.Mögliche Werte: 256x256, , 512x512, 1024x10241536x1024, , , 1024x1536auto |
No | |
| user | string | Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen. | No |
Antworten
Statuscode: 200
Beschreibung: Die Anforderung ist erfolgreich.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureImagesResponse |
Statuscode: Standard
Beschreibung: Eine unerwartete Fehlerantwort.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureErrorResponse |
Createimage
POST {endpoint}/openai/v1/images/generations?api-version=preview
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | string url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| API-Version | Anfrage | No | Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll.v1 wenn nicht anders angegeben. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeUmfang: https://ai.azure.com/.default |
| API-Schlüssel | Richtig | string | Bereitstellen Azure OpenAI-API-Schlüssels hier |
Anforderungstext
Content-Type: application/json
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| Hintergrund | enum | Ermöglicht das Festlegen der Transparenz für den Hintergrund der generierten Bilder. Dieser Parameter wird nur für gpt-image-1 Modelle unterstützt. Muss einer von transparentoder opaqueauto (Standardwert) sein. Wenn auto das Modell verwendet wird, bestimmt das Modell automatisch den besten Hintergrund für das Bild.Wenn transparentdas Ausgabeformat Transparenz unterstützen muss, sollte es entweder auf png (Standardwert) oder webpfestgelegt werden.Mögliche Werte: transparent, , opaqueauto |
No | |
| Modell | string | Die Modellbereitstellung, die für die Imagegenerierung verwendet werden soll. | Ja | |
| Moderation | enum | Steuern Sie die Inhaltsmoderationsebene für Bilder, die von gpt-image-1-Serienmodellen generiert werden. Muss entweder low für weniger restriktive Filterung oder auto (Standardwert) sein.Mögliche Werte: low, auto |
No | |
| n | Ganzzahl | Die Anzahl der zu generierenden Bilder. Muss zwischen 1 und 10 sein. Nur für dall-e-3, n=1 wird unterstützt. |
No | 1 |
| Ausgabekomprimierung | Ganzzahl | Die Komprimierungsebene (0-100%) für die generierten Bilder. Dieser Parameter wird nur für gpt-image-1-Serienmodelle mit den webp Formaten oder jpeg Ausgabeformaten unterstützt und ist standardmäßig auf 100 festgelegt. |
No | 100 |
| Ausgabeformat | enum | Das Format, in dem die generierten Bilder zurückgegeben werden. Dieser Parameter wird nur für Modelle der gpt-image-1Serie unterstützt. Muss eine von png, jpeg, oder webp.Mögliche Werte: png, , jpegwebp |
No | |
| Eingabeaufforderung | string | Eine Textbeschreibung der gewünschten Bilder. Die maximale Länge beträgt 32000 Zeichen für gpt-image-1-Serienmodelle, 1000 Zeichen für dall-e-2 und 4000 Zeichen für dall-e-3. |
Ja | |
| Qualität | enum | Die Qualität des Bilds, das generiert wird. - auto (Standardwert) wählt automatisch die beste Qualität für das angegebene Modell aus.- high, medium und low werden für Modelle der gpt-image-1Serie unterstützt.- hd und standard werden für dall-e-3.- standard ist die einzige Option für dall-e-2.Mögliche Werte: standard, , hd, lowmedium, , , highauto |
No | |
| Antwortformat | enum | Das Format, in dem generierte Bilder mit dall-e-2 und dall-e-3 zurückgegeben werden. Muss eine von url oder b64_json. URLs sind nur 60 Minuten lang gültig, nachdem das Bild generiert wurde. Dieser Parameter wird für gpt-image-1Modelle der Serie nicht unterstützt, die immer base64-codierte Bilder zurückgeben.Mögliche Werte: url, b64_json |
No | |
| size | enum | Die Größe der generierten Bilder. Muss eine von 1024x1024, (Querformat), 1536x1024 (Hochformat) oder 1024x1536 (Standardwert) für auto-Serienmodelle, eines von gpt-image-1, 256x256, oder 512x512 für 1024x1024, und eine von dall-e-2, 1024x1024oder 1792x1024 für 1024x1792dall-e-3 .Mögliche Werte: auto, , 1024x1024, 1536x10241024x1536, 256x256, , 512x512, 1792x10241024x1792 |
No | |
| Stil | enum | Die Formatvorlage der generierten Bilder. Dieser Parameter wird nur für dall-e-3. Muss eine von vivid oder natural. Lebendig bewirkt, dass sich das Modell auf die Erzeugung hyper realer und dramatischer Bilder stützt. Natürlich erzeugt das Modell natürlichere, weniger hyper reale Bilder.Mögliche Werte: vivid, natural |
No | |
| user | string | Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen. | No |
Antworten
Statuscode: 200
Beschreibung: Die Anforderung ist erfolgreich.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureImagesResponse |
Statuscode: Standard
Beschreibung: Eine unerwartete Fehlerantwort.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureErrorResponse |
Beispiele
Example
Erstellt Bilder mit einer Eingabeaufforderung.
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"
}
Antworten: Statuscode: 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
}
}
}
]
}
}
Videogenerierungsaufträge – Erstellen
POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview
Erstellt einen neuen Auftrag zur Videogenerierung.
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | string url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| API-Version | Anfrage | No | Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll.v1 wenn nicht anders angegeben. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeUmfang: https://ai.azure.com/.default |
| API-Schlüssel | Richtig | string | Bereitstellen Azure OpenAI-API-Schlüssels hier |
Anforderungstext
Content-Type: application/json
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| height | Ganzzahl | Die Höhe des Videos. Die folgenden Dimensionen werden unterstützt: 480x480, 854x480, 720x720, 1280x720, 1080x1080 und 1920x1080 sowohl im Quer- als auch im Hochformat. | Ja | |
| Modell | string | Der Name der Bereitstellung, die für diese Anforderung verwendet werden soll. | Ja | |
| n_seconds | Ganzzahl | Die Dauer des Auftrags zur Videogenerierung. Muss zwischen 1 und 20 Sekunden betragen. | No | 5 |
| n_variants | Ganzzahl | Die Anzahl der Videos, die als Varianten für diesen Auftrag erstellt werden sollen. Muss zwischen 1 und 5 sein. Kleinere Abmessungen ermöglichen mehr Varianten. | No | 1 |
| Eingabeaufforderung | string | Die Aufforderung für diesen Auftrag zur Videogenerierung. | Ja | |
| width | Ganzzahl | Die Breite des Videos. Die folgenden Dimensionen werden unterstützt: 480x480, 854x480, 720x720, 1280x720, 1080x1080 und 1920x1080 sowohl im Quer- als auch im Hochformat. | Ja |
Anforderungstext
Content-Typ: mehrteilige Formulardaten (multipart/form-data)
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| files | array | Ja | ||
| height | Ganzzahl | Die Höhe des Videos. Die folgenden Dimensionen werden unterstützt: 480x480, 854x480, 720x720, 1280x720, 1080x1080 und 1920x1080 sowohl im Quer- als auch im Hochformat. | Ja | |
| inpaint_items | array | Optionale Inpaintingelemente für diesen Videogenerierungsauftrag. | No | |
| Modell | string | Der Name der Bereitstellung, die für diese Anforderung verwendet werden soll. | Ja | |
| n_seconds | Ganzzahl | Die Dauer des Auftrags zur Videogenerierung. Muss zwischen 1 und 20 Sekunden betragen. | No | 5 |
| n_variants | Ganzzahl | Die Anzahl der Videos, die als Varianten für diesen Auftrag erstellt werden sollen. Muss zwischen 1 und 5 sein. Kleinere Abmessungen ermöglichen mehr Varianten. | No | 1 |
| Eingabeaufforderung | string | Die Aufforderung für diesen Auftrag zur Videogenerierung. | Ja | |
| width | Ganzzahl | Die Breite des Videos. Die folgenden Dimensionen werden unterstützt: 480x480, 854x480, 720x720, 1280x720, 1080x1080 und 1920x1080 sowohl im Quer- als auch im Hochformat. | Ja |
Antworten
Statuscode: 200
Beschreibung: Die Anforderung ist erfolgreich.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | VideoGenerationJob |
Statuscode: Standard
Beschreibung: Eine unerwartete Fehlerantwort.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Beispiele
Beispieldatei nicht gefunden: ./examples/create_video_generation_job_simple.json
Videogenerierungsaufträge – Liste
GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview
Listet Videogenerierungsaufträge auf.
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | string url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| API-Version | Anfrage | No | Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll.v1 wenn nicht anders angegeben. |
|
| before | Anfrage | No | string | |
| Nach | Anfrage | No | string | |
| Begrenzung | Anfrage | Ja | Ganzzahl | |
| statuses | Anfrage | No | array |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeUmfang: https://ai.azure.com/.default |
| API-Schlüssel | Richtig | string | Bereitstellen Azure OpenAI-API-Schlüssels hier |
Antworten
Statuscode: 200
Beschreibung: Die Anforderung ist erfolgreich.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | VideoGenerationJobList |
Statuscode: Standard
Beschreibung: Eine unerwartete Fehlerantwort.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Beispiele
Beispieldatei nicht gefunden: ./examples/get_video_generation_job_list.json
Videogenerierungsaufträge – Abrufen
GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview
Ruft die Eigenschaften eines Auftrags zur Videogenerierung ab.
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | string url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| API-Version | Anfrage | No | Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll.v1 wenn nicht anders angegeben. |
|
| job-id | path | Ja | string | Die ID des Videogenerierungsauftrags, der für die Azure OpenAI-Anforderung verwendet werden soll. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeUmfang: https://ai.azure.com/.default |
| API-Schlüssel | Richtig | string | Bereitstellen Azure OpenAI-API-Schlüssels hier |
Antworten
Statuscode: 200
Beschreibung: Die Anforderung ist erfolgreich.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | VideoGenerationJob |
Statuscode: Standard
Beschreibung: Eine unerwartete Fehlerantwort.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Beispiele
Beispieldatei nicht gefunden: ./examples/get_video_generation_job.json
Aufträge zur Videogenerierung – Löschen
DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview
Löscht einen Auftrag zur Videogenerierung.
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | string url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| API-Version | Anfrage | No | Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll.v1 wenn nicht anders angegeben. |
|
| job-id | path | Ja | string | Die ID des Videogenerierungsauftrags, der für die Azure OpenAI-Anforderung verwendet werden soll. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeUmfang: https://ai.azure.com/.default |
| API-Schlüssel | Richtig | string | Bereitstellen Azure OpenAI-API-Schlüssels hier |
Antworten
Statuscode: 204
Beschreibung: Es gibt keinen Inhalt, der für diese Anforderung gesendet werden soll, aber die Kopfzeilen können nützlich sein.
Statuscode: Standard
Beschreibung: Eine unerwartete Fehlerantwort.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Videogenerationen – Abrufen
GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview
Ruft eine Videogenerierung nach ID ab.
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | string url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| API-Version | Anfrage | No | Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll.v1 wenn nicht anders angegeben. |
|
| generation-id | path | Ja | string | Die ID der Videogenerierung, die für die Azure OpenAI-Anforderung verwendet werden soll. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeUmfang: https://ai.azure.com/.default |
| API-Schlüssel | Richtig | string | Bereitstellen Azure OpenAI-API-Schlüssels hier |
Antworten
Statuscode: 200
Beschreibung: Die Anforderung ist erfolgreich.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | VideoGeneration |
Statuscode: Standard
Beschreibung: Eine unerwartete Fehlerantwort.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Beispiele
Beispieldatei nicht gefunden: ./examples/get_video_generation.json
Videogenerationen – Miniaturansicht abrufen
GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview
Ruft eine Miniaturansicht des generierten Videoinhalts ab.
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | string url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| API-Version | Anfrage | No | Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll.v1 wenn nicht anders angegeben. |
|
| generation-id | path | Ja | string | Die ID der Videogenerierung, die für die Azure OpenAI-Anforderung verwendet werden soll. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeUmfang: https://ai.azure.com/.default |
| API-Schlüssel | Richtig | string | Bereitstellen Azure OpenAI-API-Schlüssels hier |
Antworten
Statuscode: 200
Beschreibung: Die Anforderung ist erfolgreich.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Bild/jpg | string |
Statuscode: Standard
Beschreibung: Eine unerwartete Fehlerantwort.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Videogenerationen – Abrufen von Videoinhalten
GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview
Ruft den generierten Videoinhalt ab.
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | string url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| API-Version | Anfrage | No | Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll.v1 wenn nicht anders angegeben. |
|
| generation-id | path | Ja | string | Die ID der Videogenerierung, die für die Azure OpenAI-Anforderung verwendet werden soll. |
| Qualität | Anfrage | No |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeUmfang: https://ai.azure.com/.default |
| API-Schlüssel | Richtig | string | Bereitstellen Azure OpenAI-API-Schlüssels hier |
Antworten
Statuscode: 200
Beschreibung: Die Anforderung ist erfolgreich.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Video/mp4 | string |
Statuscode: Standard
Beschreibung: Eine unerwartete Fehlerantwort.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Videogenerationen – Nur Videoinhaltsheader abrufen
HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview
Ruft Kopfzeilen für den generierten Videoinhalt ab.
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | string url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| API-Version | Anfrage | No | Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll.v1 wenn nicht anders angegeben. |
|
| generation-id | path | Ja | string | Die ID der Videogenerierung, die für die Azure OpenAI-Anforderung verwendet werden soll. |
| Qualität | Anfrage | No |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeUmfang: https://ai.azure.com/.default |
| API-Schlüssel | Richtig | string | Bereitstellen Azure OpenAI-API-Schlüssels hier |
Antworten
Statuscode: 200
Beschreibung: Die Anforderung ist erfolgreich.
Statuscode: Standard
Beschreibung: Eine unerwartete Fehlerantwort.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Komponenten
Informationen zu den Schemadefinitionen, die von Chats, Vervollständigungen, Einbettungen, Antworten und anderen Textvorgängen verwendet werden, finden Sie in der Azure OpenAI REST-API-Referenz. Die folgenden Schemas unterstützen die Bild-, Audio- und Videovorgänge auf dieser Seite.
AzureAudioTranscriptionResponse
Ergebnisinformationen für einen Vorgang, der gesprochene Audio in geschriebenen Text transkribiert hat.
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| Dauer | number | Die Gesamtdauer der verarbeiteten Audiodaten, um begleitende Transkriptionsinformationen zu erzeugen. | No | |
| language | string | Die gesprochene Sprache, die in den transkribierten Audiodaten erkannt wurde. Dies wird als zweiseitiger ISO-639-1-Sprachcode wie "en" oder "fr" ausgedrückt. |
No | |
| Segmente | array | Eine Sammlung von Informationen über das Timing, die Wahrscheinlichkeit und andere Details der einzelnen verarbeiteten Audiosegmente. | No | |
| Aufgabe | Objekt | Definiert die möglichen Deskriptoren für verfügbare Audiovorgangsantworten. | No | |
| Text | string | Der transkribierte Text für die bereitgestellten Audiodaten. | Ja | |
| words | array | Eine Sammlung von Informationen über die Anzeigedauer jedes verarbeiteten Worts. | No |
AzureAudioTranslationResponse
Ergebnisinformationen für einen Vorgang, der gesprochene Audio in geschriebenen Text übersetzt hat.
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| Dauer | number | Die Gesamtdauer der verarbeiteten Audiodaten, um begleitende Übersetzungsinformationen zu erzeugen. | No | |
| language | string | Die gesprochene Sprache, die in den übersetzten Audiodaten erkannt wurde. Dies wird als zweiseitiger ISO-639-1-Sprachcode wie "en" oder "fr" ausgedrückt. |
No | |
| Segmente | array | Eine Sammlung von Informationen über das Timing, die Wahrscheinlichkeit und andere Details der einzelnen verarbeiteten Audiosegmente. | No | |
| Aufgabe | Objekt | Definiert die möglichen Deskriptoren für verfügbare Audiovorgangsantworten. | No | |
| Text | string | Der übersetzte Text für die bereitgestellten Audiodaten. | Ja |
AzureErrorResponse
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| Fehler | Objekt | Die Fehlerdetails. | No | |
| └– Code | string | Der eindeutige, vom Computer generierte Bezeichner für den Fehler. | No | |
| └─ innerer_Fehler | No | |||
| └– Nachricht | string | Eine lesbare Nachricht, die dem Fehler zugeordnet ist. | No | |
| └- param | string | Falls zutreffend, der dem Fehler zugeordnete Anforderungseingabeparameter | No | |
| └– Typ | enum | Der Objekttyp, immer 'error'. Mögliche Werte: error |
No |
AzureImagesResponse
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| Hintergrund | enum | NUR GPT-image-1: Der Hintergrundparameter, der für die Bildgenerierung verwendet wird. Entweder transparent oder opaque.Mögliche Werte: transparent, opaque |
No | |
| erstellt | Ganzzahl | Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung des Bilds. | Ja | |
| data | array | No | ||
| Ausgabeformat | enum | Das Ausgabeformat der Bildgenerierung. Entweder png, , webpoder jpeg.Mögliche Werte: png, , webpjpeg |
No | |
| Qualität | enum | Die Qualität des generierten Bilds. Entweder low, , mediumoder high.Mögliche Werte: low, , mediumhigh |
No | |
| size | enum | Die Größe des generierten Bilds. Entweder 1024x1024, , 1024x1536oder 1536x1024.Mögliche Werte: 1024x1024, , 1024x15361536x1024 |
No | |
| Nutzung | Objekt | Nur bei gpt-image-1Modellen der Serie werden die Tokenverwendungsinformationen für die Bildgenerierung angegeben. |
No | |
| └─ Eingabe-Tokens | Ganzzahl | Die Anzahl der Token (Bilder und Text) in der Eingabeaufforderung. | No | |
| └– input_tokens_details | Objekt | Die Eingabetoken enthalten detaillierte Informationen für die Bildgenerierung. | No | |
| └– image_tokens | Ganzzahl | Die Anzahl der Bildtoken in der Eingabeaufforderung. | No | |
| └- text_tokens | Ganzzahl | Die Anzahl der Texttoken in der Eingabeaufforderung. | No | |
| └– Ausgabe-Tokens | Ganzzahl | Die Anzahl der Bildtoken im Ausgabebild. | No | |
| └– total_tokens | Ganzzahl | Die Gesamtzahl der Token (Bilder und Text), die für die Bildgenerierung verwendet werden. | No |
AzureOpenAIVideoGenerationErrorResponse
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| code | string | Der eindeutige, vom Computer generierte Bezeichner für den Fehler. | No | |
| innerer Fehler | Objekt | Falls zutreffend, ein Upstreamfehler, der diesen Fehler verursacht hat. | No | |
| └– Code | enum | Der code, der dem inneren Fehler zugeordnet ist. Mögliche Werte: ResponsibleAIPolicyViolation |
No | |
| └─ Fehlerdetails | Die Ergebnisdetails des Inhaltsfilters, die dem inneren Fehler zugeordnet sind. | No | ||
| └- revised_prompt | string | Falls zutreffend, wird die geänderte Aufforderung zur Generierung verwendet. | No | |
| Nachricht | string | Eine lesbare Nachricht, die dem Fehler zugeordnet ist. | No | |
| param | string | Falls zutreffend, der dem Fehler zugeordnete Anforderungseingabeparameter | No | |
| type | string | Falls zutreffend, wird die dem Fehler zugeordnete Eingabezeilennummer zugeordnet. | No |
VideoGeneration
Ergebnis der Videogenerierung.
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| erstellt_am | Ganzzahl | Die Zeit, zu der die Videogenerierung erstellt wurde. | Ja | |
| height | Ganzzahl | Die Höhe des Videos. | Ja | |
| id | string | Die ID der Videogenerierung. | Ja | |
| job_id | string | Die ID des Videogenerierungsauftrags für dieses Video. | Ja | |
| n_seconds | Ganzzahl | Die Dauer der Videogenerierung. | Ja | |
| Objekt | enum | Mögliche Werte: video.generation |
Ja | |
| Eingabeaufforderung | string | Die Aufforderung für diese Videogenerierung. | Ja | |
| width | Ganzzahl | Die Breite des Videos. | Ja |
VideoGenerationJob
Ein Auftrag zur Videogenerierung.
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| erstellt_am | Ganzzahl | Der Zeitpunkt, zu dem der Auftrag erstellt wurde. | Ja | |
| läuft_ab_am | Ganzzahl | Der Zeitpunkt, zu dem der Auftrag automatisch aus dem Dienst gelöscht wird. Der Videoinhalt und die Metadaten des Auftrags sollten vor diesem Datum gespeichert werden, um Datenverluste zu vermeiden. | No | |
| failure_reason | Zeichenfolge (siehe gültige Modelle unten) | No | ||
| finished_at | Ganzzahl | Die Zeit, zu der der Auftrag mit allen Videogenerationen abgeschlossen wurde. | No | |
| Generationen | array | Die generierten Videos für diesen Auftrag. Die Zahl hängt von der angegebenen n_variants und dem Erfolg der Generationen ab. | No | |
| height | Ganzzahl | Die Höhe des Videos. | Ja | |
| id | string | Die ID des Auftrags. | Ja | |
| inpaint_items | array | Optionale Inpaintingelemente für diesen Videogenerierungsauftrag. | No | |
| Modell | string | Der Name der Bereitstellung, die für diesen Auftrag zur Videogenerierung verwendet werden soll. | Ja | |
| n_seconds | Ganzzahl | Die Dauer des Auftrags zur Videogenerierung. | Ja | |
| n_variants | Ganzzahl | Die Anzahl der Videos, die als Varianten für diesen Auftrag zur Videogenerierung erstellt werden sollen. | Ja | |
| Objekt | enum | Mögliche Werte: video.generation.job |
Ja | |
| Eingabeaufforderung | string | Die Aufforderung für diesen Auftrag zur Videogenerierung. | Ja | |
| Status | Objekt | Der Status eines Auftrags zur Videogenerierung. | Ja | |
| width | Ganzzahl | Die Höhe des Videos. | Ja |
VideoGenerationJobList
Eine Liste der Aufträge zur Videogenerierung.
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| data | array | Die Liste der Aufträge zur Videogenerierung. | Ja | |
| first_id | string | Die ID des ersten Auftrags auf der aktuellen Seite, falls verfügbar. | No | |
| has_more | Boolescher Wert | Ein Kennzeichen, das angibt, ob nach der Liste weitere Aufträge verfügbar sind. | Ja | |
| last_id | string | Die ID des letzten Auftrags auf der aktuellen Seite, falls verfügbar. | No | |
| Objekt | enum | Mögliche Werte: list |
Ja |
Nächste Schritte
Erfahren Sie mehr über Modelle und Feinabstimmungen mit der REST-API. Erfahren Sie mehr über die modelle underlying that power Azure OpenAI.