Azure referenční informace k rozhraní REST API OpenAI a obrázku OpenAI (2024-10-21)

Tento článek dokumentuje operace rozhraní REST API pro generování a odvozování roviny zvuku (speech) v rovině obrázků pro Azure OpenAI ve 2024-10-21 verzi GA. Informace o dokončení chatu, vkládání, dokončování a všech ostatních operacích najdete v oficiálním Azure referenčních informacích k rozhraní OPENAI REST API.

Specifikace rozhraní API

Správa a interakce s modely a zdroji Azure OpenAI je rozdělena do tří hlavních API povrchů:

• Úroveň řízení
• Datová rovina – authoring
• Datová rovina – inference

Každá API-plocha/specifikace zahrnuje jinou sadu schopností Azure OpenAI. Každé API má svou vlastní jedinečnou sadu preview a stable/generally dostupných (GA) API verzí. Předběžná vydání v současnosti obvykle následují měsíční rytmus.

Autentizace

Azure OpenAI poskytuje dvě metody autentizace. Můžete použít buď API Keys, nebo Microsoft Entra ID.

• Autentizace API klíče: Pro tento typ autentizace musí všechny API požadavky obsahovat API klíč v HTTP hlavičce api-key . Quickstart poskytuje návod, jak s tímto typem autentizace hovorit.

• Microsoft Entra ID autentizace: API volání můžete autentizovat pomocí Microsoft Entra tokenu. Autentizační tokeny jsou zahrnuty v požadavku jako hlavička Authorization . Poskytnutý token musí být předcházen Bearer, například Bearer YOUR_AUTH_TOKEN. Můžete si přečíst náš návod na autentizaci pomocí Microsoft Entra ID.

Verze REST API

API služeb jsou verzována pomocí parametru api-version dotazu. Všechny verze se řídí datovou strukturou YYYY-MM-DD. Příklad:

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

Inference v datové rovině

Zbytek tohoto článku se zabývá operacemi obrázků a zvuku ve verzi GA Azure specifikace odvozování roviny dat OpenAI, 2024-10-21.

Informace o operacích náhledu imagí a zvuku najdete v referenčních informacích k rozhraní REST API pro náhled imagí a zvuku.

Přepisy - Vytvořit

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

Přepisuje zvuk do vstupního jazyka.

Parametry identifikátoru URI

Hlavička požadavku

Tělo žádosti

Typ obsahu: vícedílné/formulářové data

Responses

Kód stavu: 200

Popis: OK

Příklady

Příklad

Získává přepsán text a související metadata z poskytnutých mluvených zvukových dat.

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

Odpovědi: Stavový kód: 200

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

Příklad

Získává přepsán text a související metadata z poskytnutých mluvených zvukových dat.

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

Odpovědi: Stavový kód: 200

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

Překlady - Vytvořit

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

Přepisuje a překládá vstupní audio do anglického textu.

Parametry identifikátoru URI

Hlavička požadavku

Tělo žádosti

Typ obsahu: vícedílné/formulářové data

Responses

Kód stavu: 200

Popis: OK

Příklady

Příklad

Získává anglicky přepisovaný text a související metadata z poskytnutých mluvených zvukových dat.

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

Odpovědi: Stavový kód: 200

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

Příklad

Získává anglicky přepisovaný text a související metadata z poskytnutých mluvených zvukových dat.

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

Odpovědi: Stavový kód: 200

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

Generování obrázků

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

Generuje dávku obrázků z textového popisku na daném nasazení modelu dall-e

Parametry identifikátoru URI

Hlavička požadavku

Tělo žádosti

Typ obsahu: application/json

Responses

Kód stavu: 200

Popis: Ok

Stavový kód: výchozí

Popis: Došlo k chybě.

Příklady

Příklad

Vytváří obrázky na základě zadání.

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

Odpovědi: Stavový kód: 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

Definice schématu používané chatem, dokončováním, vkládáním a dalšími textovými operacemi najdete v referenčních informacích k rozhraní REST API Azure OpenAI. Následující schémata podporují operace obrázků a zvuku na této stránce.

innerErrorCode

Chybové kódy pro vnitřní objekt chyby.

Popis: Chybové kódy pro vnitřní chybový objekt.

Typ: řetězec

Výchozí hodnota:

Název enum: InnerErrorCode

Hodnoty výčtu:

dalleErrorResponse

dalleError

dalleInnerError

Vnitřní chyba s dalšími detaily.

výsledek závažnosti obsahu filtru

Výsledek detekce filtru obsahu

dalleFilterResults

Informace o kategorii filtrování obsahu (nenávist, sexuální, násilí self_harm), zda byla zjištěna, stejně jako o závažnosti (very_low, nízká, střední, vysoká škála, která určuje intenzitu a riziko škodlivého obsahu) a zda byl obsah filtrován či nikoliv. Informace o obsahu jailbreaku a vulgarismu, zda byly detekovány a zda byly filtrovány či nikoliv. A informace o zákaznickém blokovacím seznamu, pokud byl filtrován a jeho ID.

zvuková odpověď

Překlad nebo přepisová odpověď, když response_format byl json

audioVerboseResponse

Překlad nebo přepis, když response_format byl verbose_json

formát zvukové odpovědi

Definuje formát výstupu.

Popis: Definuje formát výstupu.

Typ: řetězec

Výchozí hodnota:

Hodnoty výčtu:

• json
• poslat SMS
• srt
• verbose_json
• vttt

kvalita obrázku

Kvalita obrázku, který bude generován.

Popis: Kvalita obrázku, který bude generován.

Typ: řetězec

Výchozí: standardní

Název enum: Quality

Hodnoty výčtu:

imagesResponseFormat

Formát, ve kterém jsou generované obrázky vráceny.

Popis: Formát, ve kterém jsou generované obrázky vráceny.

Typ: řetězec

Výchozí: adresa URL

Název enum: ImagesResponseFormat

Hodnoty výčtu:

imageSize

Velikost generovaných obrázků.

Popis: Velikost generovaných obrázků.

Typ: řetězec

Výchozí: 1024x1024

Název enum: Velikost

Hodnoty výčtu:

imageStyle

Styl generovaných obrázků.

Popis: Styl generovaných obrázků.

Typ: řetězec

Výchozí: živé

Název enum: Styl

Hodnoty výčtu:

generateImagesResponse

Další kroky

Seznamte se s modely a vyladěním pomocí rozhraní REST API. Přečtěte si další informace o podobách modelů, které power Azure OpenAI.