Azure REST API-referens för OpenAI-avbildning och ljud (2024-10-21)

Den här artikeln dokumenterar rest-API-åtgärder för bildgenerering och ljud (tal) för Azure OpenAI i 2024-10-21 GA-versionen. Information om chattavslut, inbäddningar, slutföranden och alla andra åtgärder finns i den officiella Azure REST API-referensen för OpenAI.

API-specifikationer

Hantering och interaktion med Azure OpenAI-modeller och resurser är uppdelad över tre huvudsakliga API-ytor:

• Kontrollplan
• Dataplan – författarskap
• Dataplan – inferens

Varje API-yta/specifikation kapslar in en annan uppsättning Azure OpenAI-funktioner. Varje API har sin egen unika uppsättning förhandsvisningar och stabila/allmänt tillgängliga (GA) API-releaser. Förhandsvisningar följer för närvarande en månatlig rytm.

Authentication

Azure OpenAI erbjuder två metoder för autentisering. Du kan använda antingen API-nycklar eller Microsoft Entra ID.

• API-nyckelautentisering: För denna typ av autentisering måste alla API-förfrågningar inkludera API-nyckeln i api-key HTTP-headern. Quickstart ger vägledning för hur man gör samtal med denna typ av autentisering.

• Microsoft Entra ID autentisering: Du kan autentisera ett API-anrop med en Microsoft Entra-token. Autentiseringstoken ingår i en förfrågan som Authorization header. Den givna token måste föregås av Bearer, till exempel Bearer YOUR_AUTH_TOKEN. Du kan läsa vår guide om autentisera med Microsoft Entra ID.

REST API-versionshantering

Tjänste-API:erna versioneras med hjälp av frågeparametern api-version . Alla versioner följer YYYY-MM-DD datumstrukturen. Ett exempel:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

Dataplansinferens

Resten av den här artikeln beskriver bild- och ljudåtgärderna i GA-versionen av Azure OpenAI-dataplanets slutsatsdragningsspecifikation, 2024-10-21.

Information om förhandsgranskningen av bild- och ljudåtgärder finns i rest API-referensen för förhandsgranskningsbild och ljud.

Transkriptioner - Skapa

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

Transkriberar ljudet till inmatningsspråket.

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: flera delar/formulärdata

Responses

Statuskod: 200

Beskrivning: OK

Exempel

Example

Får transkriberad text och tillhörande metadata från tillhandahållen talad ljuddata.

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

Svar: Statuskod: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

Får transkriberad text och tillhörande metadata från tillhandahållen talad ljuddata.

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

Svar: Statuskod: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Översättningar - Skapa

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

Transkriberar och översätter inmatat ljud till engelsk text.

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: flera delar/formulärdata

Responses

Statuskod: 200

Beskrivning: OK

Exempel

Example

Hämtar engelskspråkig transkriberad text och tillhörande metadata från tillhandahållen talad ljuddata.

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

Svar: Statuskod: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

Hämtar engelskspråkig transkriberad text och tillhörande metadata från tillhandahållen talad ljuddata.

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

Svar: Statuskod: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Bildgenerering

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

Genererar en batch bilder från en texttext på en given dall-e-modelldistribution

URI parametrar

Begärandehuvud

Begärandekropp

Innehållstyp: program/json

Responses

Statuskod: 200

Beskrivning: Ok

Statuskod: standard

Beskrivning: Ett fel uppstod.

Exempel

Example

Skapar bilder med en prompt.

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

Svar: Statuskod: 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

Schemadefinitioner som används av chatt, slutföranden, inbäddningar och andra textåtgärder finns i referensen för Azure OpenAI REST API. Följande scheman stöder bild- och ljudåtgärderna på den här sidan.

innerErrorCode

Felkoder för det inre felobjektet.

Beskrivning: Felkoder för det inre felobjektet.

Typ: sträng

Standard:

Enumnamn: InnerErrorCode

Uppräkningsvärden:

dalleErrorResponse

dalleError

dalleInnerError

Inre fel med ytterligare detaljer.

innehållsfilterallvarlighetsresultat

Resultat för innehållsfilter upptäckt

dalleFilterResults

Information om innehållsfiltreringskategorin (hat, sexuell, våld, self_harm), om den har upptäckts, samt allvarlighetsgraden (very_low, låg, medel, hög skala som avgör intensiteten och risknivån för skadligt innehåll) och om den har filtrerats eller inte. Information om jailbreak-innehåll och svordomar, om det har upptäckts och om det har filtrerats eller inte. Och information om kundblocklistan, om den har filtrerats och dess ID.

ljudsvar

Översättnings- eller transkriptionssvar när response_format var json

audioVerboseResponse

Översättnings- eller transkriptionssvar när response_format var verbose_json

audioResponseFormat

Definierar formatet på utdatan.

Beskrivning: Definierar formatet på utdatan.

Typ: sträng

Standard:

Uppräkningsvärden:

• json
• text
• srt
• verbose_json
• vtt

bildkvalitet

Bildkvaliteten som kommer att genereras.

Beskrivning: Kvaliteten på bilden som kommer att genereras.

Typ: sträng

Standard: standard

Enum-namn: Kvalitet

Uppräkningsvärden:

imagesResponseFormat

Formatet i vilket de genererade bilderna returneras.

Beskrivning: Formatet i vilket de genererade bilderna returneras.

Typ: sträng

Standard: url

Enum-namn: ImagesResponseFormat

Uppräkningsvärden:

imageSize

Storleken på de genererade bilderna.

Beskrivning: Storleken på de genererade bilderna.

Typ: sträng

Standard: 1024x1024

Enum-namn: Storlek

Uppräkningsvärden:

imageStyle

Stilen på de genererade bilderna.

Beskrivning: Stilen på de genererade bilderna.

Typ: sträng

Standard: levande

Enum-namn: Stil

Uppräkningsvärden:

skapaBildsvar

Nästa steg

Lär dig mer om modeller och finjustering med REST-API:et. Läs mer om underlying modeller som driver Azure OpenAI.