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 Datenebenen für die Bildgenerierung und die Audiodatenebenen-Ableitungs-REST-API-Vorgänge für Azure OpenAI in der 2025-04-01-preview Version dokumentiert. Informationen zu Chatabschlussen, Einbettungen, Assistenten, Antworten, Vektorspeichern und allen anderen Vorgängen finden Sie in der offiziellen Azure OpenAI REST-API-Referenz.
API-Spezifikationen
Die Verwaltung und Interaktion mit Azure OpenAI-Modellen und -Ressourcen ist auf drei Haupt-API-Oberflächen verteilt:
- Steuerebene
- Datenebene – Autoring
- Datenebene – Schlussfolgerung
Jede API-Oberfläche/Spezifikation kapselt einen anderen Satz von Azure OpenAI-Funktionen. Jede API hat ihren eigenen einzigartigen Satz von Vorschau- und stabilen/allgemein verfügbaren (GA) API-Releases. Preview-Veröffentlichungen folgen derzeit meist einem monatlichen Rhythmus.
Important
Es gibt jetzt eine neue Vorschau-Inferenz-API. Erfahren Sie mehr in unserem API-Lebenszyklus-Leitfaden.
| API | Neueste Vorschau-Veröffentlichung | Neueste GA-Veröffentlichung | Specifications | Beschreibung |
|---|---|---|---|---|
| Steuerungsebene | 2025-07-01-preview |
2025-06-01 |
Spezifikationsdateien | Die Control Plane API wird für Operationen wie Ressourcenerstellung, Modellbereitstellung und andere Aufgaben des höheren Ressourcenmanagements verwendet. Die Kontrollebene regelt außerdem, was mit Funktionen wie Azure Resource Manager, Bicep, Terraform und Azure CLI möglich ist. |
| Datenebene | v1 preview |
v1 |
Spezifikationsdateien | Die Data Plane API steuert Inferenz- und Autorenoperationen. |
Authentifizierung
Azure OpenAI bietet zwei Methoden zur Authentifizierung an. Du kannst entweder API-Schlüssel oder Microsoft Entra ID verwenden.
API-Schlüssel-Authentifizierung: Für diese Art der Authentifizierung müssen alle API-Anfragen den API-Schlüssel im
api-keyHTTP-Header enthalten. Der Quickstart bietet Anleitungen, wie man mit dieser Art der Authentifizierung Anrufe tätigt.Microsoft Entra ID Authentifizierung: Sie können einen API-Aufruf mit einem Microsoft Entra-Token authentifizieren. Authentifizierungstoken sind in einer Anfrage als Header
Authorizationenthalten. Der bereitgestellte Token muss zum Beispiel vonBearervorangestellt werden, zum BeispielBearer YOUR_AUTH_TOKEN. Sie können unseren Anleitungsleitfaden zum Thema Authentifizierung mit Microsoft Entra ID lesen.
REST-API-Versionierung
Die Service-APIs werden mit dem Abfrageparameter api-version versioniert. Alle Versionen folgen der YYYY-MM-DD Datumsstruktur. Beispiel:
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01
Inferenz der Datenebene
Der Rest dieses Artikels behandelt die Bild- und Audiovorgänge in der 2025-04-01-preview Vorschauversion der Azure OpenAI-Datenebenen-Ableitungsspezifikation.
Informationen zu den GA-Bild- und Audiovorgängen finden Sie in der REFERENZ zur GA-Bild- und Audio-REST-API.
Transkriptionen – Erstellen
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview
Transkribiert Audio in die Eingabesprache.
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | Zeichenketten-URL | Unterstützt Azure OpenAI-Endpunkte (Protokoll und Hostname, zum Beispiel: https://aoairesource.openai.azure.com. Ersetze "aoairesource" durch deinen Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| Bereitstellungs-ID | path | Ja | string | |
| API-Version | Anfrage | Ja | string |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Eine Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und ist sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Um ein Authentifizierungstoken mit Azure CLI zu generieren: 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 | Stellen Sie hier den Azure OpenAI API-Schlüssel bereit |
Anforderungstext
Content-Typ: mehrteilige Formulardaten (multipart/form-data)
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| Modell | string | ID des zu verwendenden Modells. Die Optionen sind gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, , whisper-1und gpt-4o-transcribe-diarize. |
Ja | |
| Datei | string | Das Audiodatei-Objekt, das transkribiert werden soll. | Ja | |
| language | string | Die Sprache des eingegebenen Audios. Die Bereitstellung der Eingabesprache im ISO-639-1-Format verbessert die Genauigkeit und Latenz. | No | |
| Eingabeaufforderung | string | Ein optionaler Text, um den Stil des Modells zu steuern oder ein vorheriges Audiosegment fortzusetzen. Der Prompt sollte mit der Audiosprache übereinstimmen. | No | |
| Antwortformat | audioResponseFormat | Definiert das Format der Ausgabe. | No | |
| Temperatur | number | Die Probentemperatur liegt 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 deterministischer machen. Wenn auf 0 gesetzt, verwendet das Modell die logaritarische Wahrscheinlichkeit, um die Temperatur automatisch zu erhöhen, bis bestimmte Schwellenwerte erreicht sind. | No | 0 |
| timestamp_granularities[] | array | Die Zeitstempel-Granularitäten, die für diese Transkription gefüllt werden sollen.
response_format muss so eingestellt verbose_json werden, dass Zeitstempel-Granularitäten verwendet werden. Entweder oder beide dieser Optionen werden unterstützt: word, oder segment. Hinweis: Es gibt keine zusätzliche Latenz für Segmentzeitstempel, aber das Erstellen von Wortzeitstempeln verursacht zusätzliche Latenz. |
No | ['segment'] |
Antworten
Statuscode: 200
Beschreibung: OK
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | Objekt | |
| Textdatei/Klartext | string | Transkribierter Text im Ausgabeformat (wenn response_format einer von war text, vtt oder srt). |
Beispiele
Example
Erhält transkribierten Text und zugehörige Metadaten aus bereitgestellten gesprochenen Audiodaten.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview
Antworten: Statuscode: 200
{
"body": {
"text": "A structured object when requesting json or verbose_json"
}
}
Example
Erhält transkribierten Text und zugehörige Metadaten aus bereitgestellten gesprochenen Audiodaten.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview
"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
Antworten: Statuscode: 200
{
"type": "string",
"example": "plain text when requesting text, srt, or vtt"
}
Übersetzungen – Erstellen
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview
Transkribiert und übersetzt Eingabeaudio in englischen Text.
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | Zeichenketten-URL | Unterstützt Azure OpenAI-Endpunkte (Protokoll und Hostname, zum Beispiel: https://aoairesource.openai.azure.com. Ersetze "aoairesource" durch deinen Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| Bereitstellungs-ID | path | Ja | string | |
| API-Version | Anfrage | Ja | string |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Eine Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und ist sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Um ein Authentifizierungstoken mit Azure CLI zu generieren: 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 | Stellen Sie hier den Azure OpenAI API-Schlüssel bereit |
Anforderungstext
Content-Typ: mehrteilige Formulardaten (multipart/form-data)
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| Datei | string | Die Audiodatei zum Übersetzen. | Ja | |
| Eingabeaufforderung | string | Ein optionaler Text, um den Stil des Modells zu steuern oder ein vorheriges Audiosegment fortzusetzen. Der Prompt sollte auf Englisch sein. | No | |
| Antwortformat | audioResponseFormat | Definiert das Format der Ausgabe. | No | |
| Temperatur | number | Die Probentemperatur liegt 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 deterministischer machen. Wenn auf 0 gesetzt, verwendet das Modell die logaritarische Wahrscheinlichkeit, um die Temperatur automatisch zu erhöhen, bis bestimmte Schwellenwerte erreicht sind. | No | 0 |
Antworten
Statuscode: 200
Beschreibung: OK
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | Objekt | |
| Textdatei/Klartext | string | Transkribierter Text im Ausgabeformat (wenn response_format eines von Text, VTT oder SRT war). |
Beispiele
Example
Erhält englischsprachigen transkribierten Text und zugehörige Metadaten aus bereitgestellten gesprochenen Audiodaten.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview
"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
Antworten: Statuscode: 200
{
"body": {
"text": "A structured object when requesting json or verbose_json"
}
}
Example
Erhält englischsprachigen transkribierten Text und zugehörige Metadaten aus bereitgestellten gesprochenen Audiodaten.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview
"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
Antworten: Statuscode: 200
{
"type": "string",
"example": "plain text when requesting text, srt, or vtt"
}
Rede – Erstellen
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview
Erzeugt Audio aus dem Eingabetext.
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | Zeichenketten-URL | Unterstützt Azure OpenAI-Endpunkte (Protokoll und Hostname, zum Beispiel: https://aoairesource.openai.azure.com. Ersetze "aoairesource" durch deinen Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| Bereitstellungs-ID | path | Ja | string | |
| API-Version | Anfrage | Ja | string |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Eine Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und ist sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Um ein Authentifizierungstoken mit Azure CLI zu generieren: 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 | Stellen Sie hier den Azure OpenAI API-Schlüssel bereit |
Anforderungstext
Content-Typ: mehrteilige Formulardaten (multipart/form-data)
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| input | string | Der Text, um Audio zu synthetisieren. Die maximale Länge beträgt 4.096 Zeichen. | Ja | |
| Antwortformat | enum | Das Format, um das Audio zu synthetisieren. Mögliche Werte: mp3, opus, , aacflac, wav,pcm |
No | |
| Geschwindigkeit | number | Die Geschwindigkeit des synthetisierten Audios. Wählen Sie einen Wert von bis 0.254.0aus.
1.0 ist der Standard. |
No | 1.0 |
| Stimme | enum | Die Stimme für Sprachsynthese. Mögliche Werte: alloy, echo, , fableonyx, nova,shimmer |
Ja |
Antworten
Statuscode: 200
Beschreibung: OK
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/octet-stream | string |
Beispiele
Example
Synthetisiert Audio aus dem bereitgestellten Text.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview
{
"input": "Hi! What are you going to make?",
"voice": "fable",
"response_format": "mp3"
}
Antworten: Statuscode: 200
{
"body": "101010101"
}
Bildgenerierungen – Erstellen
POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview
Erzeugt einen Batch von Bildern aus einer Textunterschrift bei der Bereitstellung eines gegebenen Bildgenerierungsmodells
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | Zeichenketten-URL | Unterstützt Azure OpenAI-Endpunkte (Protokoll und Hostname, zum Beispiel: https://aoairesource.openai.azure.com. Ersetze "aoairesource" durch deinen Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| Bereitstellungs-ID | path | Ja | string | |
| API-Version | Anfrage | Ja | string |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Eine Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und ist sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Um ein Authentifizierungstoken mit Azure CLI zu generieren: 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 | Stellen Sie hier den Azure OpenAI API-Schlüssel bereit |
Anforderungstext
Content-Type: application/json
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| Hintergrund | imageBackground | Ermöglicht es, Transparenz für den Hintergrund der generierten Bilder einzustellen. Dieser Parameter wird nur für GPT-Image-1-Serienmodelle unterstützt. | No | auto |
| n | Ganzzahl | Die Anzahl der zu erzeugenden Bilder. Für dall-e-3 wird nur n=1 unterstützt. | No | 1 |
| Ausgabekomprimierung | Ganzzahl | Der Kompressionswert (0–100%) für die erzeugten Bilder. Dieser Parameter wird nur für GPT-Image-1-Serienmodelle mit dem JPEG-Ausgabeformat unterstützt. | No | 100 |
| Ausgabeformat | imagesOutputFormat | Das Dateiformat, in dem die generierten Bilder zurückgegeben werden. Wird nur für GPT-Image-1-Modelle unterstützt. | No | png |
| Eingabeaufforderung | string | Eine Textbeschreibung des gewünschten Bildes. Die maximale Länge beträgt 32.000 Zeichen für die GPT-Image-1-Serie und 4.000 Zeichen für Dall-e-3 | Ja | |
| unvollständige Bilder | Ganzzahl | Die Anzahl der zu generierenden Teilbilder. Dieser Parameter wird für Streaming-Antworten verwendet, die teilweise Bilder zurückgeben. Der Wert muss zwischen 0 und 3 liegen. Wenn auf 0 gesetzt, ist die Antwort ein einzelnes Bild, das in einem Streaming-Event gesendet wird. Beachten Sie, dass das endgültige Bild möglicherweise gesendet wird, bevor die volle Anzahl der Teilbilder erzeugt wurde, wenn das vollständige Bild schneller erzeugt wird. | 0 | |
| stream | Boolescher Wert | Bearbeite das Bild im Streaming-Modus. | nein | false |
| Qualität | imageQuality | Die Qualität des erzeugten Bildes. | No | auto |
| Antwortformat | imagesResponseFormat | Das Format, in dem die generierten Bilder zurückgegeben werden. Dieser Parameter wird für gpt-image-1-Serien-Modelle nicht unterstützt, die immer base64-codierte Bilder zurückgeben.Mögliche Werte: url, b64_json. |
No | url |
| size | imageSize | Die Größe der generierten Bilder. | No | auto |
| Stil | imageStyle | Der Stil der generierten Bilder. Nur für DALL-e-3 unterstützt. | No | vivid |
| user | string | Eine eindeutige Kennung, die Ihren Endnutzer repräsentiert und dabei helfen kann, Missbrauch zu überwachen und zu erkennen. | No |
Antworten
Statuscode: 200
Beschreibung: Ok
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | generateImagesResponse |
Statuscode: Standard
Beschreibung: Ein Fehler ist aufgetreten.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | dalleErrorResponse |
Beispiele
Example
Erstellt Bilder mit einem Prompt.
POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview
{
"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
}
}
}
]
}
}
Bilderzeugungen – Bearbeiten
POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview
Bearbeitet ein Bild aus einer Textunterschrift auf einer gegebenen GPT-Image-1-Modellbereitstellung
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
| endpoint | path | Ja | Zeichenketten-URL | Unterstützt Azure OpenAI-Endpunkte (Protokoll und Hostname, zum Beispiel: https://aoairesource.openai.azure.com. Ersetze "aoairesource" durch deinen Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com |
| Bereitstellungs-ID | path | Ja | string | |
| API-Version | Anfrage | Ja | string |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Eine Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und ist sicherer.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Autorisierung | Richtig | string |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}Um ein Authentifizierungstoken mit Azure CLI zu generieren: 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 | Stellen Sie hier den Azure OpenAI API-Schlüssel bereit |
Anforderungstext
Content-Typ: mehrteilige Formulardaten (multipart/form-data)
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| Bild | Saite oder Array | Die Bild(e) zum Bearbeiten. Muss eine unterstützte Bilddatei oder ein Array von Bildern sein. Jedes Bild sollte eine PNG- oder jpg-Datei mit weniger als 50 MB sein. | Ja | |
| input_fidelity | string | Kontrollieren Sie, wie viel Aufwand das Modell aufwenden wird, um den Stil und die Merkmale, insbesondere Gesichtszüge, der Eingabebilder anzupassen. Dieser Parameter wird nur für GPT-Image-1-Serienmodelle unterstützt. Supports high und low. |
nein |
low. |
| mask | string | Ein zusätzliches Bild, dessen vollständig transparente Flächen (z. B. bei null Alpha) anzeigen, wo das Bild bearbeitet werden soll. Wenn mehrere Bilder bereitgestellt werden, wird die Maske auf das erste Bild angewendet. Es muss eine gültige PNG-Datei sein, weniger als 4 MB, und die gleichen Abmessungen wie das Bild haben. | No | |
| n | Ganzzahl | Die Anzahl der zu erzeugenden Bilder. Muss zwischen 1 und 10 liegen. | No | 1 |
| Eingabeaufforderung | string | Eine Textbeschreibung des gewünschten Bildes. Die maximale Länge beträgt 32.000 Zeichen. | Ja | |
| Qualität | imageQuality | Die Qualität des erzeugten Bildes. | No | auto |
| unvollständige Bilder | Die Anzahl der zu generierenden Teilbilder. Dieser Parameter wird für Streaming-Antworten verwendet, die teilweise Bilder zurückgeben. Der Wert muss zwischen 0 und 3 liegen. Wenn auf 0 gesetzt, ist die Antwort ein einzelnes Bild, das in einem Streaming-Event gesendet wird. Beachten Sie, dass das endgültige Bild möglicherweise gesendet wird, bevor die volle Anzahl der Teilbilder erzeugt wurde, wenn das vollständige Bild schneller erzeugt wird. | |||
| stream | Boolescher Wert | Bearbeite das Bild im Streaming-Modus. | nein | false |
| Antwortformat | imagesResponseFormat | Das Format, in dem die generierten Bilder zurückgegeben werden. | No | url |
| size | imageSize | Die Größe der generierten Bilder. | No | auto |
| user | string | Eine eindeutige Kennung, die Ihren Endnutzer repräsentiert und dabei helfen kann, Missbrauch zu überwachen und zu erkennen. | No |
Antworten
Statuscode: 200
Beschreibung: Ok
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | generateImagesResponse |
Statuscode: Standard
Beschreibung: Ein Fehler ist aufgetreten.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/json | dalleErrorResponse |
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- und Audiovorgänge auf dieser Seite.
innerErrorCode
Fehlercodes für das innere Fehlerobjekt.
| Eigentum | Wert |
|---|---|
| Beschreibung | Fehlercodes für das innere Fehlerobjekt. |
| Typ | string |
| Werte | ResponsibleAIPolicyViolation |
dalleErrorResponse
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| Fehler | dalleError | No |
dalleError
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| innerer Fehler | dalleInnerError | Innerer Fehler mit zusätzlichen Details. | No | |
| param | string | No | ||
| type | string | No |
dalleInnerError
Innerer Fehler mit zusätzlichen Details.
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| code | innerErrorCode | Fehlercodes für das innere Fehlerobjekt. | No | |
| Content-Filtern-Egebnisse | dalleFilterResults | Informationen über die Kategorie der Inhaltsfilterung (Hass, sexuell, Gewalt, self_harm), ob sie erkannt wurde, sowie das Schweregrad (very_low, niedrig, mittel, hoch im Maßstab, das die Intensität und das Risikoniveau schädlicher Inhalte bestimmt) und ob sie gefiltert wurden oder nicht. Informationen zu Jailbreak-Inhalten und Schimpfwörtern, ob sie erkannt wurden und ob sie gefiltert wurden oder nicht. Und Informationen zur Kundensperrliste, falls sie gefiltert wurde und deren ID es ist. | No | |
| überarbeitete_Aufforderung | string | Der Prompt, mit dem das Bild generiert wurde, falls es eine Überarbeitung des Prompts gab. | No |
contentFilterSeverityResult
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| gefiltert | Boolescher Wert | Ja | ||
| severity | string | No |
Ergebnis der Inhaltserkennungsfilterung
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| erkannt | Boolescher Wert | No | ||
| gefiltert | Boolescher Wert | Ja |
contentFilterDetailedResults
Das Filtern von Inhalten liefert eine detaillierte Anzahl der Inhaltsfilter-IDs für die gefilterten Segmente.
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| Details | array | No | ||
| gefiltert | Boolescher Wert | Ja |
dalleFilterResults
Informationen über die Kategorie der Inhaltsfilterung (Hass, sexuell, Gewalt, self_harm), ob sie erkannt wurde, sowie das Schweregrad (very_low, niedrig, mittel, hoch im Maßstab, das die Intensität und das Risikoniveau schädlicher Inhalte bestimmt) und ob sie gefiltert wurden oder nicht. Informationen zu Jailbreak-Inhalten und Schimpfwörtern, ob sie erkannt wurden und ob sie gefiltert wurden oder nicht. Und Informationen zur Kundensperrliste, falls sie gefiltert wurde und deren ID es ist.
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| custom_blocklists | contentFilterDetailedResults | Das Filtern von Inhalten liefert eine detaillierte Anzahl der Inhaltsfilter-IDs für die gefilterten Segmente. | No | |
| hate | Inhaltsfilter-Schweregrad-Ergebnis | No | ||
| Jailbreak | Ergebnis des Inhaltsfilters erkannt | No | ||
| Profanität | Ergebnis des Inhaltsfilters erkannt | No | ||
| Selbstverletzung | Inhaltsfilter-Schweregrad-Ergebnis | No | ||
| Sexuelle | Inhaltsfilter-Schweregrad-Ergebnis | No | ||
| Gewalt | Inhaltsfilter-Schweregrad-Ergebnis | No |
audioResponseFormat
Definiert das Format der Ausgabe.
| Eigentum | Wert |
|---|---|
| Beschreibung | Definiert das Format der Ausgabe. |
| Typ | string |
| Werte | jsontextsrtverbose_jsonvtt |
imageQuality
Die Qualität des erzeugten Bildes.
| Eigentum | Wert |
|---|---|
| Beschreibung | Die Qualität des erzeugten Bildes. |
| Typ | string |
| Vorgabe | auto |
| Werte | autohighmediumlowhdstandard |
imagesResponseFormat
Das Format, in dem die generierten Bilder zurückgegeben werden.
| Eigentum | Wert |
|---|---|
| Beschreibung | Das Format, in dem die generierten Bilder zurückgegeben werden. |
| Typ | string |
| Vorgabe | url |
| Werte | urlb64_json |
imagesOutputFormat
Das Dateiformat, in dem die generierten Bilder zurückgegeben werden. Nur für Serienmodelle unterstützt.
| Eigentum | Wert |
|---|---|
| Beschreibung | Das Dateiformat, in dem die generierten Bilder zurückgegeben werden. Wird nur für GPT-Image-1-Modelle unterstützt. |
| Typ | string |
| Vorgabe | png |
| Werte | pngjpeg |
imageSize
Die Größe der generierten Bilder.
| Eigentum | Wert |
|---|---|
| Beschreibung | Die Größe der generierten Bilder. |
| Typ | string |
| Vorgabe | auto |
| Werte | auto1792x10241024x17921024x10241024x15361536x1024 |
imageStyle
Der Stil der generierten Bilder. Nur für DALL-e-3 unterstützt.
| Eigentum | Wert |
|---|---|
| Beschreibung | Der Stil der generierten Bilder. Nur für DALL-e-3 unterstützt. |
| Typ | string |
| Vorgabe | vivid |
| Werte | vividnatural |
imageBackground
Ermöglicht es, Transparenz für den Hintergrund der generierten Bilder einzustellen. Dieser Parameter wird nur für GPT-Image-1-Serienmodelle unterstützt.
| Eigentum | Wert |
|---|---|
| Beschreibung | Ermöglicht es, Transparenz für den Hintergrund der generierten Bilder einzustellen. Dieser Parameter wird nur für GPT-Image-1-Serienmodelle unterstützt. |
| Typ | string |
| Vorgabe | auto |
| Werte | transparentopaqueauto |
generateImagesResponse
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| erstellt | Ganzzahl | Der Unix-Zeitstempel, als die Operation erstellt wurde. | Ja | |
| data | array | Die Ergebnisdaten der Operation, falls erfolgreich | Ja | |
| Nutzung | imageGenerationsUsage | Repräsentiert Details zur Tokennutzung für Bildgenerierungsanfragen. Nur für Modelle der GPT-Image-1-Serie. | No |
imageGenerationsUsage
Repräsentiert Details zur Tokennutzung für Bildgenerierungsanfragen. Nur für Modelle der GPT-Image-1-Serie.
| Name | Typ | Beschreibung | Erforderlich | Vorgabe |
|---|---|---|---|---|
| input_tokens | Ganzzahl | Die Anzahl der Eingabetoken. | No | |
| input_tokens_details | Objekt | Eine detaillierte Aufschlüsselung der Eingabetoken. | No | |
| └– image_tokens | Ganzzahl | Die Anzahl der Bildtokens. | No | |
| └- text_tokens | Ganzzahl | Die Anzahl der Texttokens. | No | |
| output_tokens | Ganzzahl | Die Anzahl der Ausgabetoken. | No | |
| Gesamtanzahl Tokens | Ganzzahl | Die Gesamtzahl der verwendeten Token. | No |
Nächste Schritte
Erfahren Sie mehr über Modelle und Feinabstimmungen mit der REST-API. Erfahren Sie mehr über die zugrundeliegenden Modelle, die Azure OpenAI antreiben.