Azure Rest API-verwijzing voor OpenAI-installatiekopieën en audio (2024-10-21)

In dit artikel worden de rest API-bewerkingen voor het genereren van afbeeldingen en audio(spraak)-gegevensvlakken voor Azure OpenAI in de 2024-10-21 GA-release beschreven. Zie de officiële naslaginformatie over de Azure OpenAI REST API voor voltooiingen, insluitingen, voltooiingen 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-key HTTP-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 door Bearer, bijvoorbeeld Bearer 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 GA-release van de Azure OpenAI-gegevensvlakdeductiespecificatie, 2024-10-21.

Zie de naslaginformatie over de preview-afbeelding en audio-REST API voor de preview-afbeelding en audiobewerkingen.

Transcripties - Maak

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

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 Deployment ID van het spraak-naar-tekstmodel.

Voor informatie over ondersteunde modellen, zie [/azure/ai-foundry/openai/concepts/models#audio-models].
api-versie zoekopdracht Ja tekenreeks API-versie

Koptekst van aanvraag

Naam Required Type Description
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 object dat getranscribeerd moet worden. Ja
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 wordt gezet, gebruikt het model logaritmische waarschijnlijkheid om de temperatuur automatisch te verhogen totdat bepaalde drempels zijn bereikt. No 0
language tekenreeks De taal van de invoeraudio. Het leveren van de invoertaal in ISO-639-1-formaat zal de nauwkeurigheid en latentie verbeteren. No

Responses

Statuscode: 200

Beschrijving: OK

Inhoudstype Typ Description
application/json audioResponse of audioVerboseResponse
text/plain tekenreeks Getranscribeerde tekst in het uitvoerformaat (wanneer response_format een tekstformaat was, 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=2024-10-21

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=2024-10-21

"---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=2024-10-21

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 Implementatie-id van het transcriptiemodel dat is geïmplementeerd.

Voor informatie over ondersteunde modellen, zie [/azure/ai-foundry/openai/concepts/models#audio-models].
api-versie zoekopdracht Ja tekenreeks API-versie

Koptekst van aanvraag

Naam Required Type Description
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 wordt gezet, 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 audioResponse of audioVerboseResponse
text/plain tekenreeks Getranscribeerde tekst in het uitvoerformaat (wanneer response_format een tekstformaat was, vtt of srt).

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=2024-10-21

"---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=2024-10-21

"---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"
}

Afbeeldingen genereren

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

Genereert een batch afbeeldingen uit een tekstbijschrift bij een gegeven dall-e 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 Deployment ID van het dall-e model dat werd uitgerold.
api-versie zoekopdracht Ja tekenreeks API-versie

Koptekst van aanvraag

Naam Required Type Description
API-sleutel True tekenreeks Geef hier de Azure OpenAI API-sleutel

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam Type Description Required Default
prompt tekenreeks Een tekstbeschrijving van de gewenste afbeelding(en). De maximale lengte is 4.000 tekens. Ja
n integer Het aantal te genereren afbeeldingen. No 1
size imageSize De grootte van de gegenereerde afbeeldingen. No 1024x1024
responsformaat imagesResponseFormat Het formaat waarin de gegenereerde afbeeldingen worden teruggegeven. No URL
user tekenreeks Een unieke identificatie die je eindgebruiker vertegenwoordigt, die kan helpen bij het monitoren en detecteren van misbruik. No
kwaliteit imageQuality De kwaliteit van de afbeelding die wordt gegenereerd. No standaard
Stijl imageStyle De stijl van de gegenereerde afbeeldingen. No Levendige

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=2024-10-21

{
 "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
          }
        },
        "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
          }
        }
      }
    ]
  }
}

Components

Zie de naslaginformatie over de Azure OpenAI REST API voor de schemadefinities die worden gebruikt door chatten, voltooiingen, insluitingen en andere tekstbewerkingen. De volgende schema's ondersteunen de afbeeldings- en audiobewerkingen op deze pagina.

innerErrorCode

Foutcodes voor het binnenste foutobject.

Beschrijving: Foutcodes voor het binnenste foutobject.

Type: tekenreeks

Standaard:

Naam: InnerErrorCode

Enum-waarden:

Value Description
Overtreding van Responsible AI-beleid De prompt overtrad een van meer contentfilterregels.

dalleErrorResponse

Naam Type Description Required Default
error dalleError No

dalleError

Naam Type Description Required Default
param tekenreeks No
type tekenreeks No
inner_error dalleInnerError Interne fout met extra details. 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, of die gefilterd is en de identificatie ervan. 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
filtered boolean Ja
detected boolean No

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, of die gefilterd is en de identificatie ervan.

Naam Type Description Required Default
sexual inhoudfilterernstresultaat No
violence inhoudfilterernstresultaat No
hate inhoudfilterernstresultaat No
self_harm inhoudfilterernstresultaat No
profanity resultaat van gedetecteerde inhoudsfilter No
jailbreak resultaat van gedetecteerde inhoudsfilter No

audioantwoord

Vertaling of transcriptierespons wanneer response_format JSON was

Naam Type Description Required Default
tekst tekenreeks Vertaalde of getranscribeerde tekst. Ja

audioVerboseResponse

Vertaling of transcriptierespons wanneer response_format verbose_json

Naam Type Description Required Default
tekst tekenreeks Vertaalde of getranscribeerde tekst. Ja
taak tekenreeks Soort audiotaak. No
language tekenreeks Language. No
duration number Duur. No
segments gegevensreeks No

audioResponseFormat

Definieert het formaat van de uitvoer.

Beschrijving: Definieert het formaat van de uitvoer.

Type: tekenreeks

Standaard:

Enum-waarden:

  • json
  • tekst
  • srt
  • verbose_json
  • vtt

imageQuality

De kwaliteit van de afbeelding die wordt gegenereerd.

Beschrijving: De kwaliteit van de afbeelding die wordt gegenereerd.

Type: tekenreeks

Standaard: standaard

Enum Naam: Kwaliteit

Enum-waarden:

Value Description
standaard Standaardkwaliteit levert beelden met standaardkwaliteit op.
Hd HD-kwaliteit zorgt voor beelden met fijnere details en grotere consistentie over het hele beeld.

imagesResponseFormat

Het formaat waarin de gegenereerde afbeeldingen worden teruggegeven.

Beschrijving: Het formaat waarin de gegenereerde afbeeldingen worden teruggestuurd.

Type: tekenreeks

Standaard: URL

Naam: ImagesResponseFormat

Enum-waarden:

Value Description
URL De URL die tijdelijke toegang biedt om de gegenereerde afbeeldingen te downloaden.
b64_json De gegenereerde afbeeldingen worden teruggegeven als base64-gecodeerde string.

imageSize

De grootte van de gegenereerde afbeeldingen.

Beschrijving: De grootte van de gegenereerde afbeeldingen.

Type: tekenreeks

Standaard: 1024x1024

Enum Naam: Grootte

Enum-waarden:

Value Description
1792x1024 De gewenste grootte van de gegenereerde afbeelding is 1792x1024 pixels.
1024x1792 De gewenste grootte van de gegenereerde afbeelding is 1024x1792 pixels.
1024x1024 De gewenste grootte van de gegenereerde afbeelding is 1024x1024 pixels.

imageStyle

De stijl van de gegenereerde afbeeldingen.

Beschrijving: De stijl van de gegenereerde afbeeldingen.

Type: tekenreeks

Standaard: levendig

Enum Naam: Stijl

Enum-waarden:

Value Description
Levendige Vivid creëert beelden die hyperrealistisch en dramatisch zijn.
Natuurlijke Natuurlijk creëert beelden die natuurlijker en minder hyperrealistisch zijn.

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

Volgende stappen 

Meer informatie over modellen en afstemming met de REST API. Meer informatie over de onderliggende modellen die gebruikmaken van Azure OpenAI.

  • Last updated on