Notitie
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen u aan te melden of de directory te wijzigen.
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen de mappen te wijzigen.
In dit artikel worden de rest API-bewerkingen voor het genereren van afbeeldingen en audio (spraak) voor Azure OpenAI in de 2025-04-01-preview release beschreven. Zie de officiële Azure OpenAI REST API-verwijzing voor insluitingen, assistenten, antwoorden, vectorarchieven en alle andere bewerkingen.
API-specificaties
Het beheren en interageren met Azure OpenAI-modellen en -middelen is verdeeld over drie primaire API-oppervlakken:
- beheerlaag
- Datavlak - authoring
- Datavlak - inferentie
Elke API-oppervlakte/specificatie bevat een andere set Azure OpenAI-mogelijkheden. Elke API heeft zijn eigen unieke set preview- en stabiele/algemeen beschikbare (GA) API-releases. Preview-releases volgen momenteel meestal een maandelijkse cadens.
Important
Er is nu een nieuwe preview inferensie-API. Lees meer in onze gids voor de API-levenscyclus.
| API | Laatste preview-release | Laatste GA-release | Specifications | Description |
|---|---|---|---|---|
| Besturingsvlak | 2025-07-01-preview |
2025-06-01 |
Specificatiebestanden | De control plane API wordt gebruikt voor operaties zoals het aanmaken van resources, modelimplementatie en andere taken op hoger niveau resource management. Het controlevlak bepaalt ook wat mogelijk is met mogelijkheden zoals Azure Resource Manager, Bicep, Terraform en Azure CLI. |
| Gegevensvlak | v1 preview |
v1 |
Specificatiebestanden | De data plane API beheert inferentie- en auteursoperaties. |
Authenticatie
Azure OpenAI biedt twee methoden voor authenticatie. Je kunt API Keys of Microsoft Entra ID gebruiken.
API-sleutelauthenticatie: Voor dit type authenticatie moeten alle API-verzoeken de API-sleutel in de
api-keyHTTP-header bevatten. De Quickstart geeft instructies over hoe je met dit type authenticatie oproepen kunt voeren.Microsoft Entra ID authenticatie: Je kunt een API-aanroep authenticeren met een Microsoft Entra-token. Authenticatietokens worden opgenomen in een verzoek als header
Authorization. Het gegeven token moet voorafgegaan worden doorBearer, bijvoorbeeldBearer YOUR_AUTH_TOKEN. Je kunt onze handleiding lezen over authenticatie met Microsoft Entra ID.
REST API-versiebeheer
De service-API's zijn versiegevaagd met behulp van de api-version queryparameter. Alle versies volgen de YYYY-MM-DD datumstructuur. Voorbeeld:
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01
Datavlak-inferentie
De rest van dit artikel bevat informatie over de afbeeldings- en audiobewerkingen in de 2025-04-01-preview preview-versie van de specificatie van deductie van het Azure OpenAI-gegevensvlak.
Zie de GA-afbeeldings- en audio-REST API-verwijzing voor de GA-installatiekopieën en audiobewerkingen.
Transcripties - Maak
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview
Transcribeert audio naar de invoertaal.
URI-parameters
| Naam | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Ja | tekenreeks-URL | Ondersteund Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang "aoairesource" door de naam van je Azure OpenAI-resource). https://{your-resource-name}.openai.azure.com |
| uitrol-id | path | Ja | tekenreeks | |
| api-versie | zoekopdracht | Ja | tekenreeks |
Koptekst van aanvraag
Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.
| Naam | Required | Type | Description |
|---|---|---|---|
| Autorisatie | True | tekenreeks |
Voorbeeld:Authorization: Bearer {Azure_OpenAI_Auth_Token}Om een authenticatietoken te genereren met Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeScope: https://ai.azure.com/.default |
| API-sleutel | True | tekenreeks | Geef hier de Azure OpenAI API-sleutel |
Aanvraaglichaam
Inhoudstype: multipart/form-data
| Naam | Type | Description | Required | Default |
|---|---|---|---|---|
| model | tekenreeks | ID van het model dat ik moet gebruiken. De opties zijn , , , , gpt-4o-transcribeen gpt-4o-mini-transcribe. gpt-4o-mini-transcribe-2025-12-15whisper-1gpt-4o-transcribe-diarize |
Ja | |
| bestand | tekenreeks | Het audiobestand object dat getranscribeerd moet worden. | Ja | |
| language | tekenreeks | De taal van de invoeraudio. Het leveren van de invoertaal in ISO-639-1-formaat verbetert de nauwkeurigheid en latentie. | No | |
| prompt | tekenreeks | Een optionele tekst om de stijl van het model te sturen of een eerder audiosegment voort te zetten. De prompt moet overeenkomen met de audiotaal. | No | |
| responsformaat | audioResponseFormat | Definieert het formaat van de uitvoer. | No | |
| Temperatuur | number | De bemonsteringstemperatuur, tussen 0 en 1. Hogere waarden zoals 0,8 maken de output willekeuriger, terwijl lagere waarden zoals 0,2 het meer gefocust en deterministisch maken. Als het op 0 staat, gebruikt het model logaritmische waarschijnlijkheid om de temperatuur automatisch te verhogen totdat bepaalde drempels zijn bereikt. | No | 0 |
| timestamp_granularities[] | gegevensreeks | De tijdstempelgranulariteiten die voor deze transcriptie worden ingevuld.
response_format moet worden ingesteld verbose_json om tijdstempelgranulariteiten te gebruiken. Beide opties worden ondersteund: word, of segment. Opmerking: Er is geen extra latentie voor segmenttijdstempels, maar het genereren van woordtijdstempels veroorzaakt extra latentie. |
No | ['segment'] |
Responses
Statuscode: 200
Beschrijving: OK
| Inhoudstype | Typ | Description |
|---|---|---|
| application/json | Object | |
| text/plain | tekenreeks | Getranscribeerde tekst in het uitvoerformaat (wanneer response_format een van textwas, vtt of srt). |
Voorbeelden
Voorbeeld
Krijgt getranscribeerde tekst en bijbehorende metadata van de geleverde gesproken audiogegevens.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview
Reacties: Statuscode: 200
{
"body": {
"text": "A structured object when requesting json or verbose_json"
}
}
Voorbeeld
Krijgt getranscribeerde tekst en bijbehorende metadata van de geleverde gesproken audiogegevens.
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--"
Reacties: Statuscode: 200
{
"type": "string",
"example": "plain text when requesting text, srt, or vtt"
}
Vertalingen - Creatie
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview
Transcribeert en vertaalt invoeraudio naar Engelse tekst.
URI-parameters
| Naam | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Ja | tekenreeks-URL | Ondersteund Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang "aoairesource" door de naam van je Azure OpenAI-resource). https://{your-resource-name}.openai.azure.com |
| uitrol-id | path | Ja | tekenreeks | |
| api-versie | zoekopdracht | Ja | tekenreeks |
Koptekst van aanvraag
Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.
| Naam | Required | Type | Description |
|---|---|---|---|
| Autorisatie | True | tekenreeks |
Voorbeeld:Authorization: Bearer {Azure_OpenAI_Auth_Token}Om een authenticatietoken te genereren met Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeScope: https://ai.azure.com/.default |
| API-sleutel | True | tekenreeks | Geef hier de Azure OpenAI API-sleutel |
Aanvraaglichaam
Inhoudstype: multipart/form-data
| Naam | Type | Description | Required | Default |
|---|---|---|---|---|
| bestand | tekenreeks | Het audiobestand om te vertalen. | Ja | |
| prompt | tekenreeks | Een optionele tekst om de stijl van het model te sturen of een eerder audiosegment voort te zetten. De prompt moet in het Engels zijn. | No | |
| responsformaat | audioResponseFormat | Definieert het formaat van de uitvoer. | No | |
| Temperatuur | number | De bemonsteringstemperatuur, tussen 0 en 1. Hogere waarden zoals 0,8 maken de output willekeuriger, terwijl lagere waarden zoals 0,2 het meer gefocust en deterministisch maken. Als het op 0 staat, gebruikt het model logaritmische waarschijnlijkheid om de temperatuur automatisch te verhogen totdat bepaalde drempels zijn bereikt. | No | 0 |
Responses
Statuscode: 200
Beschrijving: OK
| Inhoudstype | Typ | Description |
|---|---|---|
| application/json | Object | |
| text/plain | tekenreeks | Getranscribeerde tekst in het uitvoerformaat (wanneer response_format een tekst, vtt of srt was). |
Voorbeelden
Voorbeeld
Krijgt Engelstalige getranscribeerde tekst en bijbehorende metadata van de aangeleverde gesproken audiogegevens.
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--"
Reacties: Statuscode: 200
{
"body": {
"text": "A structured object when requesting json or verbose_json"
}
}
Voorbeeld
Krijgt Engelstalige getranscribeerde tekst en bijbehorende metadata van de aangeleverde gesproken audiogegevens.
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--"
Reacties: Statuscode: 200
{
"type": "string",
"example": "plain text when requesting text, srt, or vtt"
}
Spraak - Creëren
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview
Genereert audio uit de ingevoerde tekst.
URI-parameters
| Naam | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Ja | tekenreeks-URL | Ondersteund Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang "aoairesource" door de naam van je Azure OpenAI-resource). https://{your-resource-name}.openai.azure.com |
| uitrol-id | path | Ja | tekenreeks | |
| api-versie | zoekopdracht | Ja | tekenreeks |
Koptekst van aanvraag
Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.
| Naam | Required | Type | Description |
|---|---|---|---|
| Autorisatie | True | tekenreeks |
Voorbeeld:Authorization: Bearer {Azure_OpenAI_Auth_Token}Om een authenticatietoken te genereren met Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeScope: https://ai.azure.com/.default |
| API-sleutel | True | tekenreeks | Geef hier de Azure OpenAI API-sleutel |
Aanvraaglichaam
Inhoudstype: multipart/form-data
| Naam | Type | Description | Required | Default |
|---|---|---|---|---|
| Invoer | tekenreeks | De tekst om audio voor te synthetiseren. De maximale lengte is 4.096 tekens. | Ja | |
| responsformaat | enum | Het formaat om de audio in te synthetiseren. Mogelijke waarden: mp3, opus, aac, flac, wav, pcm |
No | |
| speed | number | De snelheid van de gesynthetiseerde audio. Selecteer een waarde van 0.25 tot 4.0.
1.0 is de standaard. |
No | 1.0 |
| voice | enum | De stem om te gebruiken voor spraaksynthese. Mogelijke waarden: alloy, echo, fable, onyx, nova, shimmer |
Ja |
Responses
Statuscode: 200
Beschrijving: OK
| Inhoudstype | Typ | Description |
|---|---|---|
| application/octet-stream | tekenreeks |
Voorbeelden
Voorbeeld
Synthese audio uit de verstrekte tekst.
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"
}
Reacties: Statuscode: 200
{
"body": "101010101"
}
Beeldgeneraties - Aanmaken
POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview
Genereert een batch afbeeldingen uit een tekstonderschrift bij een bepaalde beeldgeneratiemodel-implementatie
URI-parameters
| Naam | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Ja | tekenreeks-URL | Ondersteund Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang "aoairesource" door de naam van je Azure OpenAI-resource). https://{your-resource-name}.openai.azure.com |
| uitrol-id | path | Ja | tekenreeks | |
| api-versie | zoekopdracht | Ja | tekenreeks |
Koptekst van aanvraag
Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.
| Naam | Required | Type | Description |
|---|---|---|---|
| Autorisatie | True | tekenreeks |
Voorbeeld:Authorization: Bearer {Azure_OpenAI_Auth_Token}Om een authenticatietoken te genereren met Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeScope: https://ai.azure.com/.default |
| API-sleutel | True | tekenreeks | Geef hier de Azure OpenAI API-sleutel |
Aanvraaglichaam
Inhoudstype: toepassing/json
| Naam | Type | Description | Required | Default |
|---|---|---|---|---|
| achtergrond | imageBackground | Maakt het mogelijk om transparantie in te stellen voor de achtergrond van de gegenereerde afbeeldingen. Deze parameter wordt alleen ondersteund voor GPT-image-1 serie modellen. | No | auto |
| n | integer | Het aantal te genereren afbeeldingen. Voor dall-e-3 wordt alleen n=1 ondersteund. | No | 1 |
| uitvoercompressie | integer | Het compressieniveau (0-100%) voor de gegenereerde afbeeldingen. Deze parameter wordt alleen ondersteund voor gpt-image-1 serie modellen met het jpeg-uitvoerformaat. | No | 100 |
| uitvoerformaat | imagesOutputFormat | Het bestandsformaat waarin de gegenereerde afbeeldingen worden teruggestuurd. Alleen ondersteund voor GPT-image-1 serie modellen. | No | PNG |
| prompt | tekenreeks | Een tekstbeschrijving van de gewenste afbeelding(en). De maximale lengte is 32000 tekens voor de GPT-image-1 serie en 4000 tekens voor dall-e-3 | Ja | |
| gedeeltelijke_afbeeldingen | integer | Het aantal gedeeltelijke beelden dat gegenereerd moet worden. Deze parameter wordt gebruikt voor streaming responses die gedeeltelijke beelden teruggeven. De waarde moet tussen 0 en 3 liggen. Wanneer ingesteld op 0, zal de respons een enkele afbeelding zijn die in één streaming-event wordt verzonden. Let op dat de uiteindelijke afbeelding mogelijk wordt verzonden voordat het volledige aantal gedeeltelijke beelden is gegenereerd, als de volledige afbeelding sneller wordt gemaakt. | 0 | |
| stream | boolean | Bewerk de afbeelding in streamingmodus. | nee | false |
| kwaliteit | imageQuality | De kwaliteit van de afbeelding die wordt gegenereerd. | No | auto |
| responsformaat | imagesResponseFormat | Het formaat waarin de gegenereerde afbeeldingen worden teruggegeven. Deze parameter wordt niet ondersteund voor gpt-image-1-series modellen die altijd base64-gecodeerde images teruggeven.Mogelijke waarden: url, b64_json. |
No | URL |
| size | imageSize | De grootte van de gegenereerde afbeeldingen. | No | auto |
| Stijl | imageStyle | De stijl van de gegenereerde afbeeldingen. Alleen ondersteund voor DALL-e-3. | No | Levendige |
| user | tekenreeks | Een unieke identificatie die je eindgebruiker vertegenwoordigt, die kan helpen bij het monitoren en detecteren van misbruik. | No |
Responses
Statuscode: 200
Beschrijving: OK
| Inhoudstype | Typ | Description |
|---|---|---|
| application/json | generateImagesResponse |
Statuscode: standaard
Beschrijving: Er is een fout opgetreden.
| Inhoudstype | Typ | Description |
|---|---|---|
| application/json | dalleErrorResponse |
Voorbeelden
Voorbeeld
Maakt afbeeldingen aan die een prompt krijgen.
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"
}
Reacties: 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
}
}
}
]
}
}
Beeldgeneraties - Bewerken
POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview
Bewerkt een afbeelding van een tekstonderschrift op een gegeven gpt-image-1 modelimplementatie
URI-parameters
| Naam | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Ja | tekenreeks-URL | Ondersteund Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang "aoairesource" door de naam van je Azure OpenAI-resource). https://{your-resource-name}.openai.azure.com |
| uitrol-id | path | Ja | tekenreeks | |
| api-versie | zoekopdracht | Ja | tekenreeks |
Koptekst van aanvraag
Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.
| Naam | Required | Type | Description |
|---|---|---|---|
| Autorisatie | True | tekenreeks |
Voorbeeld:Authorization: Bearer {Azure_OpenAI_Auth_Token}Om een authenticatietoken te genereren met Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeScope: https://ai.azure.com/.default |
| API-sleutel | True | tekenreeks | Geef hier de Azure OpenAI API-sleutel |
Aanvraaglichaam
Inhoudstype: multipart/form-data
| Naam | Type | Description | Required | Default |
|---|---|---|---|---|
| afbeelding | string of array | De afbeelding(en) om te bewerken. Het moet een ondersteund afbeeldingsbestand zijn of een array van afbeeldingen. Elke afbeelding moet een png- of jpg-bestand zijn van minder dan 50MB. | Ja | |
| invoergetrouwheid | tekenreeks | Bepaal hoeveel moeite het model zal leveren om de stijl en kenmerken, vooral gelaatstrekken, van invoerbeelden te matchen. Deze parameter wordt alleen ondersteund voor GPT-image-1 serie modellen. Supports high en low. |
nee |
low. |
| mask | tekenreeks | Een extra afbeelding waarvan de volledig transparante gebieden (bijv. waar alfa nul is) aangeven waar de afbeelding bewerkt moet worden. Als er meerdere afbeeldingen worden geleverd, wordt het masker op de eerste afbeelding toegepast. Het moet een geldig PNG-bestand zijn, minder dan 4MB, en dezelfde afmetingen hebben als de afbeelding. | No | |
| n | integer | Het aantal te genereren afbeeldingen. Het moet tussen 1 en 10 zijn. | No | 1 |
| prompt | tekenreeks | Een tekstbeschrijving van de gewenste afbeelding(en). De maximale lengte is 32.000 tekens. | Ja | |
| kwaliteit | imageQuality | De kwaliteit van de afbeelding die wordt gegenereerd. | No | auto |
| gedeeltelijke_afbeeldingen | Het aantal gedeeltelijke beelden dat gegenereerd moet worden. Deze parameter wordt gebruikt voor streaming responses die gedeeltelijke beelden teruggeven. De waarde moet tussen 0 en 3 liggen. Wanneer ingesteld op 0, zal de respons een enkele afbeelding zijn die in één streaming-event wordt verzonden. Let op dat de uiteindelijke afbeelding mogelijk wordt verzonden voordat het volledige aantal gedeeltelijke beelden is gegenereerd, als de volledige afbeelding sneller wordt gemaakt. | |||
| stream | boolean | Bewerk de afbeelding in streamingmodus. | nee | false |
| responsformaat | imagesResponseFormat | Het formaat waarin de gegenereerde afbeeldingen worden teruggegeven. | No | URL |
| size | imageSize | De grootte van de gegenereerde afbeeldingen. | No | auto |
| user | tekenreeks | Een unieke identificatie die je eindgebruiker vertegenwoordigt, die kan helpen bij het monitoren en detecteren van misbruik. | No |
Responses
Statuscode: 200
Beschrijving: OK
| Inhoudstype | Typ | Description |
|---|---|---|
| application/json | generateImagesResponse |
Statuscode: standaard
Beschrijving: Er is een fout opgetreden.
| Inhoudstype | Typ | Description |
|---|---|---|
| application/json | dalleErrorResponse |
Components
Zie de naslaginformatie over de Azure OpenAI REST API voor de schemadefinities die worden gebruikt door chatten, voltooiingen, insluitingen, antwoorden en andere tekstbewerkingen. De volgende schema's ondersteunen de afbeeldings- en audiobewerkingen op deze pagina.
innerErrorCode
Foutcodes voor het binnenste foutobject.
| Property | Value |
|---|---|
| Description | Foutcodes voor het binnenste foutobject. |
| Typ | tekenreeks |
| waarden | ResponsibleAIPolicyViolation |
dalleErrorResponse
| Naam | Type | Description | Required | Default |
|---|---|---|---|---|
| error | dalleError | No |
dalleError
| Naam | Type | Description | Required | Default |
|---|---|---|---|---|
| inner_error | dalleInnerError | Interne fout met extra details. | No | |
| param | tekenreeks | No | ||
| type | tekenreeks | No |
dalleInnerError
Interne fout met extra details.
| Naam | Type | Description | Required | Default |
|---|---|---|---|---|
| code | innerErrorCode | Foutcodes voor het binnenste foutobject. | No | |
| content_filter_results | dalleFilterResults | Informatie over de categorie content filtering (haat, seksueel, geweld, self_harm), of deze is gedetecteerd, evenals het ernstniveau (very_low, laag, middelgroot, op grote schaal die de intensiteit en het risiconiveau van schadelijke inhoud bepaalt) en of deze gefilterd is of niet. Informatie over jailbreak-inhoud en vloeken, of het is gedetecteerd en of het gefilterd is of niet. En informatie over de klantbloklijst, als die gefilterd is en het identiteitsbewijs. | No | |
| gewijzigde_opdracht | tekenreeks | De prompt die werd gebruikt om de afbeelding te genereren, als er een revisie van de prompt was. | No |
resultaat van ernst van inhoudsfiltering
| Naam | Type | Description | Required | Default |
|---|---|---|---|---|
| filtered | boolean | Ja | ||
| severity | tekenreeks | No |
Resultaat van gedetecteerde inhoudsfilter
| Naam | Type | Description | Required | Default |
|---|---|---|---|---|
| detected | boolean | No | ||
| filtered | boolean | Ja |
contentFilterDetailedResults
Contentfiltering resulteert met een detail van contentfilter-id's voor de gefilterde segmenten.
| Naam | Type | Description | Required | Default |
|---|---|---|---|---|
| details | gegevensreeks | No | ||
| filtered | boolean | Ja |
dalleFilterResults
Informatie over de categorie content filtering (haat, seksueel, geweld, self_harm), of deze is gedetecteerd, evenals het ernstniveau (very_low, laag, middelgroot, op grote schaal die de intensiteit en het risiconiveau van schadelijke inhoud bepaalt) en of deze gefilterd is of niet. Informatie over jailbreak-inhoud en vloeken, of het is gedetecteerd en of het gefilterd is of niet. En informatie over de klantbloklijst, als die gefilterd is en het identiteitsbewijs.
| Naam | Type | Description | Required | Default |
|---|---|---|---|---|
| custom_blocklists | contentFilterDetailedResults | Contentfiltering resulteert met een detail van contentfilter-id's voor de gefilterde segmenten. | No | |
| hate | inhoudfilterernstresultaat | No | ||
| jailbreak | resultaat van gedetecteerde inhoudsfilter | No | ||
| profanity | resultaat van gedetecteerde inhoudsfilter | No | ||
| self_harm | inhoudfilterernstresultaat | No | ||
| sexual | inhoudfilterernstresultaat | No | ||
| violence | inhoudfilterernstresultaat | No |
audioResponseFormat
Definieert het formaat van de uitvoer.
| Property | Value |
|---|---|
| Description | Definieert het formaat van de uitvoer. |
| Typ | tekenreeks |
| waarden | jsontextsrtverbose_jsonvtt |
imageQuality
De kwaliteit van de afbeelding die wordt gegenereerd.
| Property | Value |
|---|---|
| Description | De kwaliteit van de afbeelding die wordt gegenereerd. |
| Typ | tekenreeks |
| standaard | auto |
| waarden | autohighmediumlowhdstandard |
imagesResponseFormat
Het formaat waarin de gegenereerde afbeeldingen worden teruggegeven.
| Property | Value |
|---|---|
| Description | Het formaat waarin de gegenereerde afbeeldingen worden teruggegeven. |
| Typ | tekenreeks |
| standaard | URL |
| waarden | urlb64_json |
imagesOutputFormat
Het bestandsformaat waarin de gegenereerde afbeeldingen worden teruggestuurd. Alleen ondersteund voor seriemodellen.
| Property | Value |
|---|---|
| Description | Het bestandsformaat waarin de gegenereerde afbeeldingen worden teruggestuurd. Alleen ondersteund voor GPT-image-1 serie modellen. |
| Typ | tekenreeks |
| standaard | PNG |
| waarden | pngjpeg |
imageSize
De grootte van de gegenereerde afbeeldingen.
| Property | Value |
|---|---|
| Description | De grootte van de gegenereerde afbeeldingen. |
| Typ | tekenreeks |
| standaard | auto |
| waarden | auto1792x10241024x17921024x10241024x15361536x1024 |
imageStyle
De stijl van de gegenereerde afbeeldingen. Alleen ondersteund voor DALL-e-3.
| Property | Value |
|---|---|
| Description | De stijl van de gegenereerde afbeeldingen. Alleen ondersteund voor DALL-e-3. |
| Typ | tekenreeks |
| standaard | Levendige |
| waarden | vividnatural |
imageBackground
Maakt het mogelijk om transparantie in te stellen voor de achtergrond van de gegenereerde afbeelding(en). Deze parameter wordt alleen ondersteund voor GPT-image-1 serie modellen.
| Property | Value |
|---|---|
| Description | Maakt het mogelijk om transparantie in te stellen voor de achtergrond van de gegenereerde afbeelding(en). Deze parameter wordt alleen ondersteund voor GPT-image-1 serie modellen. |
| Typ | tekenreeks |
| standaard | auto |
| waarden | transparentopaqueauto |
generateImagesResponse
| Naam | Type | Description | Required | Default |
|---|---|---|---|---|
| created | integer | De unix-tijdstempel toen de operatie werd gemaakt. | Ja | |
| Gegevens | gegevensreeks | De resultaatgegevens van de operatie, indien succesvol | Ja | |
| gebruik | imageGenerationsUsage | Geeft tokengebruiksdetails voor afbeeldingsgeneratieverzoeken weer. Alleen voor GPT-image-1 serie modellen. | No |
imageGenerationsUsage
Geeft tokengebruiksdetails voor afbeeldingsgeneratieverzoeken weer. Alleen voor GPT-image-1 serie modellen.
| Naam | Type | Description | Required | Default |
|---|---|---|---|---|
| input_tokens | integer | Het aantal invoertokens. | No | |
| input_tokens_details | Object | Een gedetailleerde uitsplitsing van de invoertokens. | No | |
| └image_tokens | integer | Het aantal afbeeldingstokens. | No | |
| └text_tokens | integer | Het aantal teksttokens. | No | |
| output_tokens | integer | Het aantal outputtokens. | No | |
| total_tokens | integer | Het totale aantal gebruikte tokens. | No |
Volgende stappen
Meer informatie over modellen en afstemming met de REST API. Meer informatie over de onderliggende modellen die gebruikmaken van Azure OpenAI.