Azure reference k rozhraní REST API OpenAI, zvuku a videa (Verze 1 Preview)

Tento článek dokumentuje operace rozhraní REST API pro odvozování obrazu, zvuku (řeči) a roviny videa pro Azure OpenAI ve verzi v1 Preview. Informace o dokončení chatu, vkládání, hodnoceních, souborech, jemném ladění, odpovědích, vektorových úložištích a všech ostatních operacích najdete v oficiálním Azure referenčních informacích k rozhraní REST API OpenAI.

Odvození roviny dat

Zbytek tohoto článku se věnuje operacím s obrázky, zvukem a videem v nové verzi rozhraní API verze Preview verze Azure specifikace odvozování roviny dat OpenAI. Další informace najdete v průvodci životním cyklem rozhraní API.

Úplné rozhraní API roviny dat v1 verze 1 najdete v oficiálním Azure referenčních informací k rozhraní REST API OpenAI.

Vytvořte řeč

POST {endpoint}/openai/v1/audio/speech?api-version=preview

Generuje zvuk z textu na řeč ze vstupního textu.

Parametry identifikátoru URI

Název V Povinné Typ Description
koncový bod cesta Ano řetězec
Adresu url
Podporované Azure koncových bodů OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze rozhraní API dotaz No Explicitní verze rozhraní API Microsoft Foundry Models, která se má použít pro tento požadavek.
v1 pokud není zadán jinak.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název Povinné Typ Description
Authorization Pravdivé řetězec Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsah: https://ai.azure.com/.default
API klíč Pravdivé řetězec Tady zadejte Azure klíč rozhraní API OpenAI.

Tělo žádosti

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

Název Typ Description Povinné Výchozí
vstup řetězec Text, pro který chcete vygenerovat zvuk. Maximální délka je 4096 znaků. Ano
pokyny řetězec Pomocí dalších pokynů můžete ovládat hlas vygenerovaného zvuku. Nefunguje s tts-1 nebo tts-1-hd. No
model řetězec Model, který se má použít pro tento požadavek na převod textu na řeč. Ano
formát_odpovědi objekt Podporované formáty zvukového výstupu pro převod textu na řeč. No
Rychlost number Rychlost řeči pro vygenerovaný zvuk. Hodnoty jsou platné v rozsahu od 0,25 do 4.0, přičemž výchozí a vyšší hodnoty 1,0 odpovídají rychlejší řeči. No 1
stream_format výčet Formát pro streamování zvuku. Podporované formáty jsou sse a audio. sse není podporován pro tts-1 nebo tts-1-hd.
Možné hodnoty: sse, audio
No
voice objekt Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu Type Description
application/octet-stream řetězec

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu Type Description
application/json AzureErrorResponse

Příklady

Příklad

Syntetizuje zvuk z poskytnutého textu.

POST {endpoint}/openai/v1/audio/speech?api-version=preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3",
 "model": "tts-1"
}

Odpovědi: Stavový kód: 200

{
  "body": "101010101"
}

Vytvoření přepisu

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

Přepisuje zvuk do vstupního jazyka.

Parametry identifikátoru URI

Název V Povinné Typ Description
koncový bod cesta Ano řetězec
Adresu url
Podporované Azure koncových bodů OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze rozhraní API dotaz No Explicitní verze rozhraní API Foundry Models, která se má použít pro tento požadavek.
v1 pokud není zadán jinak.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název Povinné Typ Description
Authorization Pravdivé řetězec Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsah: https://ai.azure.com/.default
API klíč Pravdivé řetězec Tady zadejte Azure klíč rozhraní API OpenAI.

Tělo žádosti

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

Název Typ Description Povinné Výchozí
chunking_strategy objekt No
└- prefix_padding_ms integer Množství zvuku, které se má zahrnout před detekovanou řečí VAD (v milisekundách). No 300
└─ trvání_ticha_ms integer Doba ticha pro detekci zastavení řeči (v milisekundách). S kratšími hodnotami bude model reagovat rychleji, ale může přejít na krátké pauzy od uživatele. No 200
└- prahová hodnota number Prahová hodnota citlivosti (0,0 až 1,0) pro detekci hlasové aktivity Vyšší prahová hodnota bude vyžadovat hlasitější zvuk k aktivaci modelu, a proto může fungovat lépe v hlučných prostředích. No 0,5
└- typ výčet Je nutné nastavit, aby server_vad se ruční blokování dat povolilo pomocí vad na straně serveru.
Možné hodnoty: server_vad
No
soubor řetězec Ano
filename řetězec Volitelný název souboru nebo popisný identifikátor, který chcete přidružit k zvukovým datům. No
include[] pole Další informace, které se mají zahrnout do odpovědi na přepis logprobs vrátí pravděpodobnosti protokolu tokenů v odpovědi, abyste porozuměli spolehlivosti modelu v přepisu. logprobs funguje pouze s response_format nastavena json pouze na modely gpt-4o-transcribe, gpt-4o-transcribe-diarize, , gpt-4o-mini-transcribea gpt-4o-mini-transcribe-2025-12-15. No
jazyk řetězec Jazyk vstupního zvuku. Poskytnutí jazyka zadávání vstupu ve formátu ISO-639-1 (např. en) zlepší přesnost a latenci. No
model řetězec Model, který se má použít pro tuto žádost o přepis. No
požádat řetězec Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla odpovídat jazyku zvuku. No
formát_odpovědi objekt No
datový proud boolean Pokud je nastavená hodnota true, data odpovědi modelu se streamují do klienta, protože se generují pomocí událostí odeslaných serverem. Poznámka: Streamování není pro whisper-1 model podporováno a bude ignorováno. No Nepravda
Teplota number Teplota vzorkování mezi 0 a 1. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Pokud je nastavená hodnota 0, model použije pravděpodobnost protokolu k automatickému zvýšení teploty do dosažení určitých prahových hodnot. No 0
timestamp_granularities[] pole Členitosti časového razítka, které se mají pro tento přepis naplnit. response_format musí být nastavená verbose_json tak, aby používala členitosti časového razítka. Podporují se obě tyto možnosti: wordnebo segment. Poznámka: Pro časová razítka segmentů neexistuje žádná další latence, ale generování časových razítek slov způsobuje další latenci. No ['segment']

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu Type Description
application/json AzureAudioTranscriptionResponse
prostý text řetězec

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu Type Description
application/json AzureErrorResponse

Příklady

Příklad

Získá přepisovaný text a přidružená metadata z poskytnutých mluvených zvukových dat.

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Odpovědi: Stavový kód: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Vytvoření překladu

POST {endpoint}/openai/v1/audio/translations?api-version=preview

Získá anglický jazyk přepisovaný text a přidružená metadata z poskytnutých mluvených zvukových dat.

Parametry identifikátoru URI

Název V Povinné Typ Description
koncový bod cesta Ano řetězec
Adresu url
Podporované Azure koncových bodů OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze rozhraní API dotaz No Explicitní verze rozhraní API Foundry Models, která se má použít pro tento požadavek.
v1 pokud není zadán jinak.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název Povinné Typ Description
Authorization Pravdivé řetězec Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsah: https://ai.azure.com/.default
API klíč Pravdivé řetězec Tady zadejte Azure klíč rozhraní API OpenAI.

Tělo žádosti

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

Název Typ Description Povinné Výchozí
soubor řetězec Ano
filename řetězec Volitelný název souboru nebo popisný identifikátor, který chcete přidružit k zvukovým datům No
model řetězec Model, který se má použít pro tuto žádost o překlad. No
požádat řetězec Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla být v angličtině. No
formát_odpovědi objekt No
Teplota number Teplota vzorkování mezi 0 a 1. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Pokud je nastavená hodnota 0, model použije pravděpodobnost protokolu k automatickému zvýšení teploty do dosažení určitých prahových hodnot. No 0

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu Type Description
application/json AzureAudioTranslationResponse
prostý text řetězec

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu Type Description
application/json AzureErrorResponse

Příklady

Příklad

Získá anglický jazyk přepisovaný text a přidružená metadata z poskytnutých mluvených zvukových dat.

POST {endpoint}/openai/v1/audio/translations?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Odpovědi: Stavový kód: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Vytvoření úpravy obrázku

POST {endpoint}/openai/v1/images/edits?api-version=preview

Parametry identifikátoru URI

Název V Povinné Typ Description
koncový bod cesta Ano řetězec
Adresu url
Podporované Azure koncových bodů OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze rozhraní API dotaz No Explicitní verze rozhraní API Foundry Models, která se má použít pro tento požadavek.
v1 pokud není zadán jinak.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název Povinné Typ Description
Authorization Pravdivé řetězec Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsah: https://ai.azure.com/.default
API klíč Pravdivé řetězec Tady zadejte Azure klíč rozhraní API OpenAI.

Tělo žádosti

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

Název Typ Description Povinné Výchozí
na pozadí výčet Umožňuje nastavit průhlednost pozadí vygenerovaných obrázků.
Tento parametr je podporován pouze pro gpt-image-1 modely. Musí to být jedna z transparenthodnot nebo opaqueauto (výchozí hodnota). Při auto použití model automaticky určí nejlepší pozadí obrázku.

Pokud transparentformát výstupu musí podporovat průhlednost, takže by měl být nastaven na png (výchozí hodnota) nebo webp.
Možné hodnoty: transparent, opaque, auto
No
bitová kopie řetězec nebo pole Ano
maska řetězec No
model řetězec Nasazení modelu, které se má použít pro operaci úprav image. Ano
n integer Počet obrázků, které se mají vygenerovat. Musí být mezi 1 a 10. No 1
komprese_výstupu integer Úroveň komprese (0–100%) pro vygenerované obrázky. Tento parametr je podporován pouze u gpt-image-1modelů -series s výstupními webp formáty a jpeg výchozí hodnota je 100. No 100
formát_výstupu výčet Formát, ve kterém se vrátí vygenerované obrázky. Tento parametr je podporován pouze pro gpt-image-1modely -series. Musí být jedním z png, jpegnebo webp.
Výchozí hodnota je png.
Možné hodnoty: png, jpeg, webp
No
požádat řetězec Textový popispožadovaných Maximální délka je 1000 znaků pro dall-e-2modely -series a 32000 znaků gpt-image-1. Ano
kvalita výčet Kvalita image, která se vygeneruje. high medium a low jsou podporovány pouze pro gpt-image-1modely -series. dall-e-2 podporuje standard pouze kvalitu. Výchozí hodnota autoje .
Možné hodnoty: standard, low, medium, high, auto
No
formát_odpovědi výčet Formát, ve kterém se vrátí vygenerované obrázky. Musí to být jedna z url nebo b64_json. Adresy URL jsou platné pouze 60 minut po vygenerování image. Tento parametr je podporován pouze pro dall-e-2, protože gpt-image-1modely -series vždy vrátí obrázky s kódováním base64.
Možné hodnoty: url, b64_json
No
size výčet Velikost vygenerovaných obrázků. Musí být jedna z 1024x1024hodnot , 1536x1024 (na šířku), 1024x1536 (na výšku) nebo auto (výchozí hodnota) pro gpt-image-1modely -series a jedna z 256x256, 512x512nebo 1024x1024 pro dall-e-2.
Možné hodnoty: 256x256, 512x512, 1024x1024, 1536x1024, 1024x1536auto
No
uživatel řetězec Jedinečný identifikátor představující koncového uživatele, který může pomoct OpenAI monitorovat a zjišťovat zneužití. No

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu Type Description
application/json AzureImagesResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu Type Description
application/json AzureErrorResponse

Vytvoření imagege

POST {endpoint}/openai/v1/images/generations?api-version=preview

Parametry identifikátoru URI

Název V Povinné Typ Description
koncový bod cesta Ano řetězec
Adresu url
Podporované Azure koncových bodů OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze rozhraní API dotaz No Explicitní verze rozhraní API Foundry Models, která se má použít pro tento požadavek.
v1 pokud není zadán jinak.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název Povinné Typ Description
Authorization Pravdivé řetězec Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsah: https://ai.azure.com/.default
API klíč Pravdivé řetězec Tady zadejte Azure klíč rozhraní API OpenAI.

Tělo žádosti

Typ obsahu: application/json

Název Typ Description Povinné Výchozí
na pozadí výčet Umožňuje nastavit průhlednost pozadí vygenerovaných obrázků.
Tento parametr je podporován pouze pro gpt-image-1 modely. Musí to být jedna z transparenthodnot nebo opaqueauto (výchozí hodnota). Při auto použití model automaticky určí nejlepší pozadí obrázku.

Pokud transparentformát výstupu musí podporovat průhlednost, takže by měl být nastaven na png (výchozí hodnota) nebo webp.
Možné hodnoty: transparent, opaque, auto
No
model řetězec Nasazení modelu, které se má použít pro generování image. Ano
Moderování výčet Umožňuje řídit úroveň moderování obsahu pro obrázky generované gpt-image-1modely -series. Musí být buď low pro méně omezující filtrování, nebo auto (výchozí hodnota).
Možné hodnoty: low, auto
No
n integer Počet obrázků, které se mají vygenerovat. Musí být mezi 1 a 10. Pouze pro dall-e-3, n=1 je podporováno. No 1
komprese_výstupu integer Úroveň komprese (0–100%) pro vygenerované obrázky. Tento parametr je podporován pouze u gpt-image-1modelů -series s výstupními webp formáty a jpeg výchozí hodnota je 100. No 100
formát_výstupu výčet Formát, ve kterém se vrátí vygenerované obrázky. Tento parametr je podporován pouze pro gpt-image-1modely -series. Musí být jedním z png, jpegnebo webp.
Možné hodnoty: png, jpeg, webp
No
požádat řetězec Textový popispožadovaných Maximální délka je 32000 znaků pro gpt-image-1modely -series, 1 000 znaků pro dall-e-2 a 4000 znaků pro dall-e-3. Ano
kvalita výčet Kvalita image, která se vygeneruje.

- auto (výchozí hodnota) automaticky vybere nejlepší kvalitu daného modelu.
- high medium a low jsou podporovány pro gpt-image-1modely -series.
- hd a standard jsou podporovány pro dall-e-3.
- standard je jedinou možností pro dall-e-2.
Možné hodnoty: standard, hd, low, medium, highauto
No
formát_odpovědi výčet Formát, ve kterém se vygenerovaly obrázky a dall-e-2dall-e-3 jsou vráceny. Musí to být jedna z url nebo b64_json. Adresy URL jsou platné pouze 60 minut po vygenerování image. Tento parametr není podporován pro gpt-image-1modely -series, které vždy vrátí obrázky s kódováním Base64.
Možné hodnoty: url, b64_json
No
size výčet Velikost vygenerovaných obrázků. Musí být jedna z 1024x1024hodnot , 1536x1024 (na šířku), 1024x1536 (na výšku) nebo auto (výchozí hodnota) pro gpt-image-1modely -series, jeden z 256x256, 512x512nebo 1024x1024 pro dall-e-2, a jeden z 1024x1024, 1792x1024nebo 1024x1792 pro dall-e-3.
Možné hodnoty: auto, 1024x1024, , 1536x10241024x1536, 256x256512x512, 1792x10241024x1792
No
styl výčet Styl vygenerovaných obrázků Tento parametr je podporován pouze pro dall-e-3. Musí to být jedna z vivid nebo natural. Živé příčiny, že se model přikloní ke generování hyper-reálných a dramatických obrázků. Přirozeně způsobí, že model vytvoří přirozenější, méně hyper-reálné obrázky.
Možné hodnoty: vivid, natural
No
uživatel řetězec Jedinečný identifikátor představující koncového uživatele, který může pomoct OpenAI monitorovat a zjišťovat zneužití. No

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu Type Description
application/json AzureImagesResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu Type Description
application/json AzureErrorResponse

Příklady

Příklad

Vytvoří obrázky s výzvou.

POST {endpoint}/openai/v1/images/generations?api-version=preview

{
 "model": "dall-e-3",
 "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
          },
          "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
          }
        }
      }
    ]
  }
}

Úlohy generování videa – Vytvoření

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Vytvoří novou úlohu generování videa.

Parametry identifikátoru URI

Název V Povinné Typ Description
koncový bod cesta Ano řetězec
Adresu url
Podporované Azure koncových bodů OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze rozhraní API dotaz No Explicitní verze rozhraní API Foundry Models, která se má použít pro tento požadavek.
v1 pokud není zadán jinak.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název Povinné Typ Description
Authorization Pravdivé řetězec Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsah: https://ai.azure.com/.default
API klíč Pravdivé řetězec Tady zadejte Azure klíč rozhraní API OpenAI.

Tělo žádosti

Typ obsahu: application/json

Název Typ Description Povinné Výchozí
height integer Výška videa. Podporují se následující rozměry: 480x480, 854x480, 720x720, 1280x720, 1080x1080 a 1920x1080 v orientaci na šířku i na výšku. Ano
model řetězec Název nasazení, které se má pro tento požadavek použít. Ano
n_seconds integer Doba trvání úlohy generování videa. Musí být v rozmezí 1 až 20 sekund. No 5
n_variants integer Počet videí, která se mají pro tuto úlohu vytvořit jako varianty. Musí být mezi 1 a 5. Menší rozměry umožňují více variant. No 1
požádat řetězec Výzva k této úloze generování videa. Ano
width integer Šířka videa. Podporují se následující rozměry: 480x480, 854x480, 720x720, 1280x720, 1080x1080 a 1920x1080 v orientaci na šířku i na výšku. Ano

Tělo žádosti

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

Název Typ Description Povinné Výchozí
Soubory pole Ano
height integer Výška videa. Podporují se následující rozměry: 480x480, 854x480, 720x720, 1280x720, 1080x1080 a 1920x1080 v orientaci na šířku i na výšku. Ano
inpaint_items pole Volitelné nepovinné položky pro tuto úlohu generování videa. No
model řetězec Název nasazení, které se má pro tento požadavek použít. Ano
n_seconds integer Doba trvání úlohy generování videa. Musí být v rozmezí 1 až 20 sekund. No 5
n_variants integer Počet videí, která se mají pro tuto úlohu vytvořit jako varianty. Musí být mezi 1 a 5. Menší rozměry umožňují více variant. No 1
požádat řetězec Výzva k této úloze generování videa. Ano
width integer Šířka videa. Podporují se následující rozměry: 480x480, 854x480, 720x720, 1280x720, 1080x1080 a 1920x1080 v orientaci na šířku i na výšku. Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu Type Description
application/json VideoGenerationJob

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Příklady

Ukázkový soubor nebyl nalezen: ./examples/create_video_generation_job_simple.json

Úlohy generování videí – Seznam

GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Zobrazí seznam úloh generování videa.

Parametry identifikátoru URI

Název V Povinné Typ Description
koncový bod cesta Ano řetězec
Adresu url
Podporované Azure koncových bodů OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze rozhraní API dotaz No Explicitní verze rozhraní API Foundry Models, která se má použít pro tento požadavek.
v1 pokud není zadán jinak.
před dotaz No řetězec
Po dotaz No řetězec
limit dotaz Ano integer
statuses dotaz No pole

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název Povinné Typ Description
Authorization Pravdivé řetězec Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsah: https://ai.azure.com/.default
API klíč Pravdivé řetězec Tady zadejte Azure klíč rozhraní API OpenAI.

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu Type Description
application/json VideoGenerationJobList

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Příklady

Ukázkový soubor nebyl nalezen: ./examples/get_video_generation_job_list.json

Úlohy generování videa – Získání

GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Načte vlastnosti úlohy generování videa.

Parametry identifikátoru URI

Název V Povinné Typ Description
koncový bod cesta Ano řetězec
Adresu url
Podporované Azure koncových bodů OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze rozhraní API dotaz No Explicitní verze rozhraní API Foundry Models, která se má použít pro tento požadavek.
v1 pokud není zadán jinak.
job-id cesta Ano řetězec ID úlohy generování videa, které se má použít pro požadavek Azure OpenAI.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název Povinné Typ Description
Authorization Pravdivé řetězec Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsah: https://ai.azure.com/.default
API klíč Pravdivé řetězec Tady zadejte Azure klíč rozhraní API OpenAI.

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu Type Description
application/json VideoGenerationJob

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Příklady

Ukázkový soubor nebyl nalezen: ./examples/get_video_generation_job.json

Úlohy generování videa – Odstranění

DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Odstraní úlohu generování videa.

Parametry identifikátoru URI

Název V Povinné Typ Description
koncový bod cesta Ano řetězec
Adresu url
Podporované Azure koncových bodů OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze rozhraní API dotaz No Explicitní verze rozhraní API Foundry Models, která se má použít pro tento požadavek.
v1 pokud není zadán jinak.
job-id cesta Ano řetězec ID úlohy generování videa, které se má použít pro požadavek Azure OpenAI.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název Povinné Typ Description
Authorization Pravdivé řetězec Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsah: https://ai.azure.com/.default
API klíč Pravdivé řetězec Tady zadejte Azure klíč rozhraní API OpenAI.

Responses

Stavový kód: 204

Popis: Pro tento požadavek se nedá odeslat žádný obsah, ale hlavičky můžou být užitečné.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Generace videí – Získat

GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview

Načte generování videa podle ID.

Parametry identifikátoru URI

Název V Povinné Typ Description
koncový bod cesta Ano řetězec
Adresu url
Podporované Azure koncových bodů OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze rozhraní API dotaz No Explicitní verze rozhraní API Foundry Models, která se má použít pro tento požadavek.
v1 pokud není zadán jinak.
generation-id cesta Ano řetězec ID generování videa, které se má použít pro požadavek Azure OpenAI.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název Povinné Typ Description
Authorization Pravdivé řetězec Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsah: https://ai.azure.com/.default
API klíč Pravdivé řetězec Tady zadejte Azure klíč rozhraní API OpenAI.

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu Type Description
application/json VideoGeneration

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Příklady

Ukázkový soubor nebyl nalezen: ./examples/get_video_generation.json

Generace videa – Načtení miniatury

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview

Načte miniaturu generovaného obsahu videa.

Parametry identifikátoru URI

Název V Povinné Typ Description
koncový bod cesta Ano řetězec
Adresu url
Podporované Azure koncových bodů OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze rozhraní API dotaz No Explicitní verze rozhraní API Foundry Models, která se má použít pro tento požadavek.
v1 pokud není zadán jinak.
generation-id cesta Ano řetězec ID generování videa, které se má použít pro požadavek Azure OpenAI.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název Povinné Typ Description
Authorization Pravdivé řetězec Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsah: https://ai.azure.com/.default
API klíč Pravdivé řetězec Tady zadejte Azure klíč rozhraní API OpenAI.

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu Type Description
image/jpg řetězec

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Generace videí – Načtení obsahu videa

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Načte vygenerovaný obsah videa.

Parametry identifikátoru URI

Název V Povinné Typ Description
koncový bod cesta Ano řetězec
Adresu url
Podporované Azure koncových bodů OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze rozhraní API dotaz No Explicitní verze rozhraní API Foundry Models, která se má použít pro tento požadavek.
v1 pokud není zadán jinak.
generation-id cesta Ano řetězec ID generování videa, které se má použít pro požadavek Azure OpenAI.
kvalita dotaz No

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název Povinné Typ Description
Authorization Pravdivé řetězec Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsah: https://ai.azure.com/.default
API klíč Pravdivé řetězec Tady zadejte Azure klíč rozhraní API OpenAI.

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu Type Description
video/mp4 řetězec

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Generace videa – Načtení pouze záhlaví videokontentů

HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Načte záhlaví pro vygenerovaný obsah videa.

Parametry identifikátoru URI

Název V Povinné Typ Description
koncový bod cesta Ano řetězec
Adresu url
Podporované Azure koncových bodů OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze rozhraní API dotaz No Explicitní verze rozhraní API Foundry Models, která se má použít pro tento požadavek.
v1 pokud není zadán jinak.
generation-id cesta Ano řetězec ID generování videa, které se má použít pro požadavek Azure OpenAI.
kvalita dotaz No

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název Povinné Typ Description
Authorization Pravdivé řetězec Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsah: https://ai.azure.com/.default
API klíč Pravdivé řetězec Tady zadejte Azure klíč rozhraní API OpenAI.

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Components

Definice schématu používané chatem, dokončováním, vkládáním, odpověďmi 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 s obrázky, zvukem a videem na této stránce.

AzureAudioTranscriptionResponse

Informace o výsledku operace, která přepisovala mluvený zvuk do psaného textu.

Název Typ Description Povinné Výchozí
duration number Celková doba trvání zvuku zpracovaného za účelem vytvoření doprovodných informací přepisu. No
jazyk řetězec Mluvený jazyk, který byl zjištěn v přepisovaných zvukových datech.
Tento kód se vyjadřuje jako dvoumísmenný kód jazyka ISO-639-1, jako je "en" nebo "fr".
No
Segmenty pole Kolekce informací o načasování, pravděpodobnostech a dalších podrobnostech jednotlivých zpracovaných zvukových segmentů. No
úkol objekt Definuje možné popisovače pro dostupné odpovědi na zvukové operace. No
poslat SMS řetězec Přepisovaný text pro poskytnutá zvuková data. Ano
Slova pole Kolekce informací o načasování každého zpracovaného slova. No

AzureAudioTranslationResponse

Informace o výsledku operace, která přeložila mluvený zvuk do psaného textu.

Název Typ Description Povinné Výchozí
duration number Celková doba trvání zvuku zpracovávaného za účelem vytvoření doprovodných informací o překladu. No
jazyk řetězec Mluvený jazyk, který byl zjištěn v přeložených zvukových datech.
Tento kód se vyjadřuje jako dvoumísmenný kód jazyka ISO-639-1, jako je "en" nebo "fr".
No
Segmenty pole Kolekce informací o načasování, pravděpodobnostech a dalších podrobnostech jednotlivých zpracovaných zvukových segmentů. No
úkol objekt Definuje možné popisovače pro dostupné odpovědi na zvukové operace. No
poslat SMS řetězec Přeložený text pro poskytnutá zvuková data Ano

AzureErrorResponse

Název Typ Description Povinné Výchozí
chyba objekt Podrobnosti o chybě. No
└ kód řetězec Jedinečný strojově vygenerovaný identifikátor chyby. No
└inner_error No
└- zpráva řetězec Zpráva čitelná člověkem spojená s chybou. No
└- param řetězec Pokud je to možné, vstupní parametr požadavku přidružený k chybě No
└- typ výčet Typ objektu, vždy error.
Možné hodnoty: error
No

AzureImagesResponse

Název Typ Description Povinné Výchozí
na pozadí výčet Pouze GPT-image-1: parametr pozadí použitý pro generování image. Buď transparent nebo opaque.
Možné hodnoty: transparent, opaque
No
Vytvořen integer Časové razítko unixu (v sekundách) doby vytvoření image. Ano
data pole No
formát_výstupu výčet Výstupní formát generování image. Buď png, webpnebo jpeg.
Možné hodnoty: png, webp, jpeg
No
kvalita výčet Kvalita vygenerované image Buď low, mediumnebo high.
Možné hodnoty: low, medium, high
No
size výčet Velikost vygenerovaného obrázku Buď 1024x1024, 1024x1536nebo 1536x1024.
Možné hodnoty: 1024x1024, 1024x1536, 1536x1024
No
využití objekt Pouze pro gpt-image-1modely -series informace o využití tokenů pro generování image. No
└input_tokens integer Počet tokenů (obrázků a textu) ve vstupní výzvě No
└- input_tokens_details objekt Vstupní tokeny podrobné informace pro generování image. No
└image_tokens integer Počet tokenů obrázků ve vstupní výzvě No
└text_tokens integer Počet textových tokenů ve vstupní výzvě No
└output_tokens integer Počet tokenů image ve výstupní imagi. No
└─ celkem_tokeny integer Celkový počet tokenů (obrázků a textu) použitých pro generování image. No

AzureOpenAIVideoGenerationErrorResponse

Název Typ Description Povinné Výchozí
kód řetězec Jedinečný strojově vygenerovaný identifikátor chyby. No
inner_error objekt Pokud je to možné, nadřazená chyba, která pochází z této chyby. No
└ kód výčet Kód přidružený k vnitřní chybě.
Možné hodnoty: ResponsibleAIPolicyViolation
No
└─ podrobnosti_o_chybě Podrobnosti o výsledku filtru obsahu spojené s vnitřní chybou. No
└─ revidovaný_podnět řetězec Pokud je to možné, upravená výzva použitá pro generování. No
zpráva řetězec Zpráva čitelná člověkem spojená s chybou. No
param řetězec Pokud je to možné, vstupní parametr požadavku přidružený k chybě No
typ řetězec Pokud je to možné, vstupní číslo řádku přidružené k chybě. No

VideoGeneration

Výsledek generování videa.

Název Typ Description Povinné Výchozí
datum_vytvoření integer Čas vytvoření generování videa Ano
height integer Výška videa. Ano
id řetězec ID generování videa. Ano
job_id řetězec ID úlohy generování videa pro toto video. Ano
n_seconds integer Doba trvání generování videa. Ano
objekt výčet
Možné hodnoty: video.generation
Ano
požádat řetězec Výzva k této generaci videa. Ano
width integer Šířka videa. Ano

VideoGenerationJob

Úloha generování videa.

Název Typ Description Povinné Výchozí
datum_vytvoření integer Čas vytvoření úlohy Ano
datum vypršení integer Čas, kdy se úloha automaticky odstraní ze služby. Obsah videa a metadata úlohy by se měly uložit před tímto datem, aby nedošlo ke ztrátě dat. No
failure_reason řetězec (viz následující platné modely) No
dokončeno v integer Čas dokončení úlohy se všemi generacemi videa. No
Generace pole Generovaná videa pro tuto úlohu. Číslo závisí na daném n_variants a úspěchu vytváření generací. No
height integer Výška videa. Ano
id řetězec ID úlohy. Ano
inpaint_items pole Volitelné nepovinné položky pro tuto úlohu generování videa. No
model řetězec Název nasazení, které se má použít pro tuto úlohu generování videa. Ano
n_seconds integer Doba trvání úlohy generování videa. Ano
n_variants integer Počet videí, která se mají vytvořit jako varianty pro tuto úlohu generování videa. Ano
objekt výčet
Možné hodnoty: video.generation.job
Ano
požádat řetězec Výzva k této úloze generování videa. Ano
stav objekt Stav úlohy generování videa Ano
width integer Výška videa. Ano

VideoGenerationJobList

Seznam úloh generování videa

Název Typ Description Povinné Výchozí
data pole Seznam úloh generování videa Ano
first_id řetězec ID první úlohy na aktuální stránce, pokud je k dispozici. No
má více boolean Příznak označující, jestli jsou po seznamu k dispozici další úlohy. Ano
last_id řetězec ID poslední úlohy na aktuální stránce, pokud je k dispozici. No
objekt výčet
Možné hodnoty: list
Ano

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.