Referenční dokumentace k rozhraní REST API pro modely Azure OpenAI v Azure AI Foundry

Tento článek obsahuje podrobnosti o koncových bodech rozhraní REST API pro odvozování pro Azure OpenAI.

Specifikace rozhraní API

Správa modelů a prostředků Azure OpenAI a interakce s nimi je rozdělená mezi tři primární plochy rozhraní API:

• Řídicí rovina
• Rovina dat – vytváření
• Rovina dat – odvozování

Každá povrch/specifikace rozhraní API zapouzdřuje jinou sadu funkcí Azure OpenAI. Každé rozhraní API má svou vlastní jedinečnou sadu verzí Preview a stabilní/obecně dostupné (GA) API. Verze Preview se v současné době obvykle řídí měsíčním tempem.

Důležité

Teď je k dispozici nové náhledové rozhraní API pro odvozování. Další informace najdete v průvodci životním cyklem rozhraní API.

rozhraní API	Nejnovější verze Preview	Nejnovější verze GA	Specifikace	Popis
Řídicí rovina	2024-06-01-preview	2024-10-01	Soubory specifikace	Azure OpenAI sdílí společnou řídicí rovinu se všemi ostatními službami. Rozhraní API roviny řízení se používá například pro vytváření prostředků Azure OpenAI, nasazení modelu a dalších úloh správy prostředků vyšší úrovně. Řídicí rovina také řídí možnosti, jako je Azure Resource Manager, Bicep, Terraform a Azure CLI.
Rovina dat – vytváření	2025-04-01-preview	2024-10-21	Soubory specifikace	Rozhraní API pro vytváření roviny dat řídí jemné ladění, nahrávání souborů, úlohy příjmu dat, dávky a určité dotazy na úrovni modelu.
Rovina dat – odvozování	2025-04-01-preview	2024-10-21	Soubory specifikace	Rozhraní API pro odvozování roviny dat poskytuje možnosti odvozování a koncové body pro funkce, jako jsou dokončování, dokončování chatu, vkládání, zvuk, data, Dall-e, asistenti atd.

Ověřování

Azure OpenAI poskytuje dvě metody ověřování. Můžete použít klíče rozhraní API nebo ID Microsoft Entra.

• Ověřování pomocí klíče rozhraní API: Pro tento typ ověřování musí všechny požadavky rozhraní API obsahovat klíč rozhraní API v api-key hlavičce HTTP. Rychlý start obsahuje pokyny k volání s tímto typem ověřování.

• Ověřování ID Microsoft Entra: Volání rozhraní API můžete ověřit pomocí tokenu Microsoft Entra. Ověřovací tokeny jsou součástí požadavku jako hlavičky Authorization . Zadaný token musí předcházet Bearernapříklad Bearer YOUR_AUTH_TOKEN. Můžete si přečíst náš návod k ověřování pomocí Microsoft Entra ID.

Správa verzí rozhraní REST API

Rozhraní API služby se označují verzí pomocí parametru dotazu api-version. Všechny verze mají datovou strukturu RRRR-MM-DD. Příklad:

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

Odvození roviny dat

Zbytek článku se věnuje nejnovější verzi GA specifikace odvozování roviny dat Azure OpenAI. 2024-10-21

Pokud hledáte dokumentaci k nejnovější verzi rozhraní API verze Preview, projděte si nejnovější rozhraní API pro odvozování roviny dat ve verzi Preview.

Dokončení

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

Vytvoří dokončení pro zadaný příkazový řádek, parametry a vybraný model.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure 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
ID nasazení	cesta	Ano	řetězec	ID nasazení modelu, který byl nasazen.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

Název	Požaduje se	Typ	Popis
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
pobídnout	řetězec nebo pole	Výzvy k vygenerování dokončení pro, zakódované jako řetězec, pole řetězců, pole tokenů nebo pole polí tokenů. Všimněte si, že <|endoftext|> je oddělovač dokumentu, který model uvidí během trénování, takže pokud není zadána výzva, model se vygeneruje, jako by byl na začátku nového dokumentu.	Ano
nejlepší z	celočíselný	Vygeneruje best_of dokončení na straně serveru a vrátí "nejlepší" (ten s nejvyšší pravděpodobností protokolu na token). Výsledky se nedají streamovat. Pokud se používá s n, best_of řídí počet dokončení kandidáta a n určuje, kolik se má vrátit â € best_of " musí být větší než n. Poznámka: Protože tento parametr generuje mnoho dokončení, může rychle spotřebovat kvótu tokenu. Pečlivě používejte a ujistěte se, že máte přiměřené nastavení a max_tokensstop.	Ne	0
ozvěna	Boolean	Ozvěte výzvu kromě dokončení.	Ne	Nepravda
trest za frekvenci	Číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.	Ne	0
logit_bias	objekt	Upravte pravděpodobnost výskytu zadaných tokenů v dokončení. Přijímá objekt JSON, který mapuje tokeny (určené jejich ID tokenu v tokenizátoru GPT) na přidruženou hodnotu předsudku od -100 do 100. Matematicky se před vzorkováním přidá do logitů vygenerovaných modelem. Přesný účinek se bude lišit podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu. Můžete například předat {"50256": -100} , abyste zabránili generování tokenu <|endoftext|> .	Ne	Nic
protokoly	celočíselný	Zahrňte pravděpodobnosti protokolu u nejpravděpodobnějších logprobs výstupních tokenů a vybraných tokenů. Pokud je například logprobs 5, rozhraní API vrátí seznam pěti nejpravděpodobnějších tokenů. Rozhraní API vždy vrátí logprob vzorkovaný token, takže v odpovědi může být až logprobs+1 elementy. Maximální hodnota je logprobs 5.	Ne	Nic
maximální počet tokenů	celočíselný	Maximální počet tokenů, které lze vygenerovat v dokončení. Počet tokenů výzvy plus max_tokens nesmí překročit délku kontextu modelu.	Ne	16
n	celočíselný	Kolik dokončení se má vygenerovat pro každou výzvu. Poznámka: Protože tento parametr generuje mnoho dokončení, může rychle spotřebovat kvótu tokenu. Pečlivě používejte a ujistěte se, že máte přiměřené nastavení a max_tokensstop.	Ne	0
penalizace přítomnosti	Číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.	Ne	0
semeno	celočíselný	Pokud je zadáno, náš systém se bude snažit vzorkovat deterministicky, aby opakované požadavky se stejnými seed parametry měly vrátit stejný výsledek. Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.	Ne
Zastavit	řetězec nebo pole	Až čtyři sekvence, ve kterých rozhraní API přestane generovat další tokeny. Vrácený text nebude obsahovat sekvenci zastavení.	Ne
datový proud	Boolean	Zda se má streamovat zpět částečný průběh. Pokud jsou nastavené, tokeny se posílají jako události odesílané jen	Ne	Nepravda
přípona	řetězec	Přípona, která následuje po dokončení vloženého textu. Tento parametr je podporován pouze pro gpt-3.5-turbo-instruct.	Ne	Nic
Teplota	Číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. 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. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne	0
top_p	Číslo	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne	0
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	Ne

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	createCompletionResponse	Představuje odpověď na dokončení z rozhraní API. Poznámka: Streamované i nestreamované objekty odpovědi sdílejí stejný obrazec (na rozdíl od koncového bodu chatu).

Stavový kód: výchozí

Popis: Služba není k dispozici

Typ obsahu	Typ	Popis
application/json	errorResponse

Příklady

Příklad

Vytvoří dokončení pro zadaný příkazový řádek, parametry a vybraný model.

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

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Vkládání

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

Získejte vektorové znázornění daného vstupu, které lze snadno využívat modely a algoritmy strojového učení.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure 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
ID nasazení	cesta	Ano	řetězec
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

Název	Požaduje se	Typ	Popis
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
vstup	řetězec nebo pole	Vstupní text pro vložení, kódovaný jako řetězec nebo pole tokenů. Pokud chcete vložit více vstupů do jednoho požadavku, předejte pole řetězců nebo pole polí tokenů. Vstup nesmí překročit maximální počet vstupních tokenů modelu (8 192 tokenů pro text-embedding-ada-002), nesmí být prázdný řetězec a jakékoli pole musí mít maximálně 2 048 dimenzí nebo méně.	Ano
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct s monitorováním a zjišťováním zneužití.	Ne
typ_vstupu	řetězec	vstupní typ vkládání hledání, které se má použít	Ne
formát kódování	řetězec	Formát pro vrácení vložených objektů. Může to být buď float nebo base64. Výchozí hodnota floatje .	Ne
rozměry	celočíselný	Početdimenzích Podporováno pouze v text-embedding-3 novějších modelech.	Ne

Odpovědi

Název	Typ	Popis	Požaduje se	Výchozí
objekt	řetězec		Ano
model	řetězec		Ano
údaje	pole		Ano
využití	objekt		Ano

Vlastnosti pro použití

tokeny výzvy

Název	Typ	Popis	Výchozí
tokeny výzvy	celočíselný

celkový počet tokenů

Název	Typ	Popis	Výchozí
celkový počet tokenů	celočíselný

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	objekt

Příklady

Příklad

Vrátí vložené položky pro danou výzvu.

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

{
 "input": [
  "this is a test"
 ]
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Dokončení chatu

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

Vytvoří dokončení zprávy chatu.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure 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
ID nasazení	cesta	Ano	řetězec	ID nasazení modelu, který byl nasazen.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

Název	Požaduje se	Typ	Popis
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
Teplota	Číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. 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. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne	0
top_p	Číslo	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne	0
datový proud	Boolean	Pokud je tato možnost nastavená, budou odeslány částečné rozdíly zpráv, například v ChatGPT. Tokeny se posílají jako události odesílané jen	Ne	Nepravda
Zastavit	řetězec nebo pole	Až čtyři sekvence, ve kterých rozhraní API přestane generovat další tokeny.	Ne
maximální počet tokenů	celočíselný	Maximální počet tokenů, které lze vygenerovat v dokončení chatu. Celková délka vstupních tokenů a vygenerovaných tokenů je omezená délkou kontextu modelu.	Ne
maximální_počet_tokenů_dokončení	celočíselný	Horní mez počtu tokenů, které lze vygenerovat pro dokončení, včetně viditelných výstupních tokenů a zdůvodnění tokenů.	Ne
penalizace přítomnosti	Číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.	Ne	0
trest za frekvenci	Číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.	Ne	0
logit_bias	objekt	Upravte pravděpodobnost výskytu zadaných tokenů v dokončení. Přijímá objekt JSON, který mapuje tokeny (určené jejich ID tokenu v tokenizátoru) na přidruženou hodnotu předsudku od -100 do 100. Matematicky se před vzorkováním přidá do logitů vygenerovaných modelem. Přesný účinek se bude lišit podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu.	Ne	Nic
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	Ne
zprávy	pole	Seznam zpráv, které tvoří dosud konverzaci.	Ano
zdroje_dat	pole	Položky konfigurace pro rozšíření chatu Azure OpenAI, které je používají. Tato další specifikace je kompatibilní pouze s Azure OpenAI.	Ne
protokoly	Boolean	Zda se mají vrátit pravděpodobnosti protokolu výstupních tokenů, nebo ne. Pokud je pravda, vrátí pravděpodobnosti protokolu každého výstupního tokenu vráceného v hodnotě contentmessage.	Ne	Nepravda
top_logprobs	celočíselný	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu. logprobs parametr musí být nastaven na true hodnotu, pokud je použit tento parametr.	Ne
n	celočíselný	Kolik možností dokončení chatu se má vygenerovat pro každou vstupní zprávu. Mějte na paměti, že se vám bude účtovat na základě počtu vygenerovaných tokenů napříč všemi možnostmi. Udržujte n si přehled o 1 minimalizaci nákladů.	Ne	0
paralelní volání nástrojů	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	Ne	Pravdivé
formát_odpovědi	ResponseFormatText nebo ResponseFormatJsonObject nebo ResponseFormatJsonSchema	Objekt určující formát, který musí model vypíše. Kompatibilní s GPT-4o Nastavení pro { "type": "json_schema", "json_schema": {...} } povolení strukturovaných výstupů, které zaručuje, že model bude odpovídat zadanému schématu JSON. Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON. Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.	Ne
semeno	celočíselný	Tato funkce je v beta verzi. Pokud je zadáno, náš systém se bude snažit vzorkovat deterministicky, aby opakované požadavky se stejnými seed parametry měly vrátit stejný výsledek. Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.	Ne
nářadí	pole	Seznam nástrojů, které model může volat. V současné době se jako nástroj podporují jenom funkce. Pomocí tohoto příkazu můžete poskytnout seznam funkcí, pro které může model generovat vstupy JSON. Podporuje se maximálně 128 funkcí.	Ne
výběr nástroje	chatCompletionToolChoiceOption	Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádný nástroj a místo toho vygeneruje zprávu. auto znamená, že model si může vybrat mezi generováním zprávy nebo voláním jednoho nebo více nástrojů. required znamená, že model musí volat jeden nebo více nástrojů. Zadáním konkrétního nástroje vynutíte {"type": "function", "function": {"name": "my_function"}} model, aby tento nástroj volal. none je výchozí, pokud nejsou k dispozici žádné nástroje. auto je výchozí, pokud jsou k dispozici nástroje.	Ne
volání funkce	string nebo chatCompletionFunctionCallOption	Zastaralá ve prospěch tool_choice. Určuje, která funkce (pokud existuje) volána modelem. none znamená, že model nebude volat funkci a místo toho vygeneruje zprávu. auto znamená, že model může vybrat mezi generováním zprávy nebo voláním funkce. Zadáním konkrétní funkce vynutíte {"name": "my_function"} , aby model volal danou funkci. none je výchozí, pokud nejsou k dispozici žádné funkce. auto je výchozí, pokud jsou k dispozici funkce.	Ne
– funkce	pole	Zastaralá ve prospěch tools. Seznam funkcí, pro které model může generovat vstupy JSON.	Ne

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	createChatCompletionResponse nebo createChatCompletionStreamResponse

Stavový kód: výchozí

Popis: Služba není k dispozici

Typ obsahu	Typ	Popis
application/json	errorResponse

Příklady

Příklad

Vytvoří dokončení pro zadaný příkazový řádek, parametry a vybraný model.

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

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Příklad

Vytvoří dokončení na základě dat služby Azure Search a spravované identity přiřazené systémem.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Příklad

Vytvoří dokončení na základě vektorových dat služby Azure Search, předchozí zprávy asistenta a spravované identity přiřazené uživatelem.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Příklad

Vytvoří dokončení pro zadanou službu Azure Cosmos DB.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Přepisy – vytvoření

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

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure 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
ID nasazení	cesta	Ano	řetězec	ID nasazení modelu pro převod řeči na text Informace o podporovaných modelech najdete v tématu [/azure/ai-services/openai/concepts/models#audio-models].
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

Název	Požaduje se	Typ	Popis
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: multipart/form-data

Název	Typ	Popis	Požaduje se	Výchozí
soubor	řetězec	Objekt zvukového souboru, který se má přepisovat.	Ano
pobídnout	ř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.	Ne
formát_odpovědi	audioResponseFormat	Definuje formát výstupu.	Ne
Teplota	Číslo	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.	Ne	0
jazyk	řetězec	Jazyk vstupního zvuku. Poskytnutí jazyka zadávání vstupu ve formátu ISO-639-1 zlepší přesnost a latenci.	Ne

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	audioResponse nebo audioVerboseResponse
text/obyčejný	řetězec	Přepis textu ve výstupním formátu (když response_format byl jedním z textů, vtt nebo srt).

Příklady

Příklad

Získá přepisovaný text a přidružená 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á přepisovaný text a přidružená 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ření

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

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

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure 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
ID nasazení	cesta	Ano	řetězec	ID nasazení šeptaného modelu, který byl nasazen. Informace o podporovaných modelech najdete v tématu [/azure/ai-services/openai/concepts/models#audio-models].
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

Název	Požaduje se	Typ	Popis
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: multipart/form-data

Název	Typ	Popis	Požaduje se	Výchozí
soubor	řetězec	Zvukový soubor, který chcete přeložit.	Ano
pobídnout	ř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ě.	Ne
formát_odpovědi	audioResponseFormat	Definuje formát výstupu.	Ne
Teplota	Číslo	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.	Ne	0

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	audioResponse nebo audioVerboseResponse
text/obyčejný	řetězec	Přepis textu ve výstupním formátu (když response_format byl jedním z textů, vtt nebo srt).

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 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á anglický jazyk přepisovaný text a přidružená 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

Vygeneruje dávku obrázků z textového titulku v daném nasazení modelu dall-e.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure 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
ID nasazení	cesta	Ano	řetězec	ID nasazení modelu dall-e, který byl nasazen.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

Název	Požaduje se	Typ	Popis
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
pobídnout	řetězec	Textový popispožadovaných Maximální délka je 4 000 znaků.	Ano
n	celočíselný	Počet obrázků, které se mají vygenerovat.	Ne	0
velikost	imageSize	Velikost vygenerovaných obrázků.	Ne	1024 × 1024
formát_odpovědi	imagesResponseFormat	Formát, ve kterém se vrátí vygenerované obrázky.	Ne	adresa URL
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	Ne
kvalita	imageQuality	Kvalita image, která se vygeneruje.	Ne	standard
– styl	imageStyle	Styl vygenerovaných obrázků	Ne	živý

Odpovědi

Stavový kód: 200

Popis: Ok

Typ obsahu	Typ	Popis
application/json	generateImagesResponse

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	dalleErrorResponse

Příklady

Příklad

Vytvoří obrázky s výzvou.

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

Komponenty

chybováOdezva

Název	Typ	Popis	Požaduje se	Výchozí
chyba	chyba		Ne

errorBase

Název	Typ	Popis	Požaduje se	Výchozí
kód	řetězec		Ne
zpráva	řetězec		Ne

chyba

Název	Typ	Popis	Požaduje se	Výchozí
Param	řetězec		Ne
druh	řetězec		Ne
vnitřní_chyba	innerError	Vnitřní chyba s dalšími podrobnostmi	Ne

vnitřní chyba

Vnitřní chyba s dalšími podrobnostmi

Název	Typ	Popis	Požaduje se	Výchozí
kód	innerErrorCode	Kódy chyb pro vnitřní objekt chyby.	Ne
výsledky filtru obsahu	contentFilterPromptResults	Informace o kategorii filtrování obsahu (nenávist, sexuální, násilí, self_harm), pokud byla zjištěna, a také úroveň závažnosti (very_low, nízká, střední, vysoká, která určuje intenzitu a úroveň rizika škodlivého obsahu) a jestli byla filtrována nebo ne. Informace o obsahu jailbreaku a vulgárních výrazech, pokud byly zjištěny, a pokud byly filtrovány nebo ne. A informace o seznamu blokovaných zákazníků, pokud byl filtrován a jeho ID.	Ne

vnitřní chybový kód

Kódy chyb pro vnitřní objekt chyby.

Popis: Kódy chyb pro vnitřní objekt chyby.

Typ: řetězec

Výchozí:

Název výčtu: InnerErrorCode

Hodnoty výčtu:

Hodnota	Popis
Překročení zásad odpovědného AI	Výzva porušila jedno z více pravidel filtru obsahu.

dalleErrorResponse

Název	Typ	Popis	Požaduje se	Výchozí
chyba	dalleError		Ne

dalleError

Název	Typ	Popis	Požaduje se	Výchozí
Param	řetězec		Ne
druh	řetězec		Ne
vnitřní_chyba	dalleInnerError	Vnitřní chyba s dalšími podrobnostmi	Ne

dalleInnerError

Vnitřní chyba s dalšími podrobnostmi

Název	Typ	Popis	Požaduje se	Výchozí
kód	innerErrorCode	Kódy chyb pro vnitřní objekt chyby.	Ne
výsledky filtru obsahu	dalleFilterResults	Informace o kategorii filtrování obsahu (nenávist, sexuální, násilí, self_harm), pokud byla zjištěna, a také úroveň závažnosti (very_low, nízká, střední, vysoká, která určuje intenzitu a úroveň rizika škodlivého obsahu) a jestli byla filtrována nebo ne. Informace o obsahu jailbreaku a vulgárních výrazech, pokud byly zjištěny, a pokud byly filtrovány nebo ne. A informace o seznamu blokovaných zákazníků, pokud byl filtrován a jeho ID.	Ne
revidovaný_příkaz	řetězec	Výzva, která byla použita k vygenerování obrázku, pokud došlo k nějaké revizi výzvy.	Ne

základVýsledkůFiltruObsahu

Název	Typ	Popis	Požaduje se	Výchozí
filtrovaný	Boolean		Ano

výsledek závažnosti obsahu filtru

Název	Typ	Popis	Požaduje se	Výchozí
filtrovaný	Boolean		Ano
závažnost	řetězec		Ne

Výsledek detekce filtru obsahu

Název	Typ	Popis	Požaduje se	Výchozí
filtrovaný	Boolean		Ano
zjištěný	Boolean		Ne

Detekován filtr obsahu s výsledkem citace

Název	Typ	Popis	Požaduje se	Výchozí
citace	objekt		Ne

Vlastnosti citace

Adresa URL

Název	Typ	Popis	Výchozí
Adresa URL	řetězec

licence

Název	Typ	Popis	Výchozí
licence	řetězec

základ výsledků filtru obsahu

Informace o výsledcích filtrování obsahu

Název	Typ	Popis	Požaduje se	Výchozí
sexuální	výsledek závažnosti filtrování obsahu		Ne
násilí	výsledek závažnosti filtrování obsahu		Ne
nenávist	výsledek závažnosti filtrování obsahu		Ne
sebepoškozování	výsledek závažnosti filtrování obsahu		Ne
rouhání	výsledek detekovaného filtru obsahu		Ne
chyba	errorBase		Ne

výsledky výzvy filtru obsahu

Informace o kategorii filtrování obsahu (nenávist, sexuální, násilí, self_harm), pokud byla zjištěna, a také úroveň závažnosti (very_low, nízká, střední, vysoká, která určuje intenzitu a úroveň rizika škodlivého obsahu) a jestli byla filtrována nebo ne. Informace o obsahu jailbreaku a vulgárních výrazech, pokud byly zjištěny, a pokud byly filtrovány nebo ne. A informace o seznamu blokovaných zákazníků, pokud byl filtrován a jeho ID.

Název	Typ	Popis	Požaduje se	Výchozí
sexuální	výsledek závažnosti filtrování obsahu		Ne
násilí	výsledek závažnosti filtrování obsahu		Ne
nenávist	výsledek závažnosti filtrování obsahu		Ne
sebepoškozování	výsledek závažnosti filtrování obsahu		Ne
rouhání	výsledek detekovaného filtru obsahu		Ne
chyba	errorBase		Ne
útěk z vězení	výsledek detekovaného filtru obsahu		Ne

výsledky výběru filtru obsahu

Informace o kategorii filtrování obsahu (nenávist, sexuální, násilí, self_harm), pokud byla zjištěna, a také úroveň závažnosti (very_low, nízká, střední, vysoká, která určuje intenzitu a úroveň rizika škodlivého obsahu) a jestli byla filtrována nebo ne. Informace o textu a vulgárních výrazech třetích stran, pokud byly zjištěny, a pokud byly filtrovány nebo ne. A informace o seznamu blokovaných zákazníků, pokud byl filtrován a jeho ID.

Název	Typ	Popis	Požaduje se	Výchozí
sexuální	výsledek závažnosti filtrování obsahu		Ne
násilí	výsledek závažnosti filtrování obsahu		Ne
nenávist	výsledek závažnosti filtrování obsahu		Ne
sebepoškozování	výsledek závažnosti filtrování obsahu		Ne
rouhání	výsledek detekovaného filtru obsahu		Ne
chyba	errorBase		Ne
chráněný_materiál_text	výsledek detekovaného filtru obsahu		Ne
kód chráněného materiálu	detekován filtr obsahu s výsledkem citace		Ne

výsledek filtrování promptu

Výsledky filtrování obsahu pro jednu výzvu v požadavku

Název	Typ	Popis	Požaduje se	Výchozí
index výzev	celočíselný		Ne
výsledky filtru obsahu	contentFilterPromptResults	Informace o kategorii filtrování obsahu (nenávist, sexuální, násilí, self_harm), pokud byla zjištěna, a také úroveň závažnosti (very_low, nízká, střední, vysoká, která určuje intenzitu a úroveň rizika škodlivého obsahu) a jestli byla filtrována nebo ne. Informace o obsahu jailbreaku a vulgárních výrazech, pokud byly zjištěny, a pokud byly filtrovány nebo ne. A informace o seznamu blokovaných zákazníků, pokud byl filtrován a jeho ID.	Ne

vyzvat k filtrování výsledků

Výsledky filtrování obsahu pro nulové nebo více výzev v požadavku V žádosti o streamování můžou výsledky různých výzev dorazit v různých časech nebo v různých objednávkách.

Pro tuto komponentu nejsou definovány žádné vlastnosti.

výsledky filtrování obsahu Dallego

Informace o výsledcích filtrování obsahu

Název	Typ	Popis	Požaduje se	Výchozí
sexuální	výsledek závažnosti filtrování obsahu		Ne
násilí	výsledek závažnosti filtrování obsahu		Ne
nenávist	výsledek závažnosti filtrování obsahu		Ne
sebepoškozování	výsledek závažnosti filtrování obsahu		Ne

Výsledky Filtrování Dalle

Informace o kategorii filtrování obsahu (nenávist, sexuální, násilí, self_harm), pokud byla zjištěna, a také úroveň závažnosti (very_low, nízká, střední, vysoká, která určuje intenzitu a úroveň rizika škodlivého obsahu) a jestli byla filtrována nebo ne. Informace o obsahu jailbreaku a vulgárních výrazech, pokud byly zjištěny, a pokud byly filtrovány nebo ne. A informace o seznamu blokovaných zákazníků, pokud byl filtrován a jeho ID.

Název	Typ	Popis	Požaduje se	Výchozí
sexuální	výsledek závažnosti filtrování obsahu		Ne
násilí	výsledek závažnosti filtrování obsahu		Ne
nenávist	výsledek závažnosti filtrování obsahu		Ne
sebepoškozování	výsledek závažnosti filtrování obsahu		Ne
rouhání	výsledek detekovaného filtru obsahu		Ne
útěk z vězení	výsledek detekovaného filtru obsahu		Ne

společnáŽádostODokončeníChatu

Název	Typ	Popis	Požaduje se	Výchozí
Teplota	Číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. 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. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne	0
top_p	Číslo	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne	0
datový proud	Boolean	Pokud je tato možnost nastavená, budou odeslány částečné rozdíly zpráv, například v ChatGPT. Tokeny se posílají jako události odesílané jen pro data, jakmile budou k dispozici, a datový proud je ukončen zprávou data: [DONE] .	Ne	Nepravda
Zastavit	řetězec nebo pole	Až čtyři sekvence, ve kterých rozhraní API přestane generovat další tokeny.	Ne
maximální počet tokenů	celočíselný	Maximální počet tokenů povolených pro vygenerovanou odpověď. Ve výchozím nastavení bude počet tokenů, které model může vrátit, (4096 – tokeny výzvy). Tato hodnota je nyní zastaralá ve prospěch max_completion_tokensa není kompatibilní s modely řad o1.	Ne	4096
maximální_počet_tokenů_dokončení	celočíselný	Horní mez počtu tokenů, které lze vygenerovat pro dokončení, včetně viditelných výstupních tokenů a zdůvodnění tokenů.	Ne
penalizace přítomnosti	Číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.	Ne	0
trest za frekvenci	Číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.	Ne	0
logit_bias	objekt	Upravte pravděpodobnost výskytu zadaných tokenů v dokončení. Přijímá objekt JSON, který mapuje tokeny (určené jejich ID tokenu v tokenizátoru) na přidruženou hodnotu předsudku od -100 do 100. Matematicky se před vzorkováním přidá do logitů vygenerovaných modelem. Přesný účinek se bude lišit podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu.	Ne
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může azure OpenAI pomoct monitorovat a zjišťovat zneužití.	Ne

vytvořitPožadavekNaDokončení

Název	Typ	Popis	Požaduje se	Výchozí
pobídnout	řetězec nebo pole	Výzvy k vygenerování dokončení pro, zakódované jako řetězec, pole řetězců, pole tokenů nebo pole polí tokenů. Všimněte si, že <|endoftext|> je oddělovač dokumentu, který model uvidí během trénování, takže pokud není zadána výzva, model se vygeneruje, jako by byl na začátku nového dokumentu.	Ano
nejlepší z	celočíselný	Vygeneruje best_of dokončení na straně serveru a vrátí "nejlepší" (ten s nejvyšší pravděpodobností protokolu na token). Výsledky se nedají streamovat. Pokud se používá s n, best_of řídí počet dokončení kandidáta a n určuje, kolik se má vrátit â € best_of " musí být větší než n. Poznámka: Protože tento parametr generuje mnoho dokončení, může rychle spotřebovat kvótu tokenu. Pečlivě používejte a ujistěte se, že máte přiměřené nastavení a max_tokensstop.	Ne	0
ozvěna	Boolean	Ozvěte výzvu kromě dokončení.	Ne	Nepravda
trest za frekvenci	Číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.	Ne	0
logit_bias	objekt	Upravte pravděpodobnost výskytu zadaných tokenů v dokončení. Přijímá objekt JSON, který mapuje tokeny (určené jejich ID tokenu v tokenizátoru GPT) na přidruženou hodnotu předsudku od -100 do 100. Matematicky se před vzorkováním přidá do logitů vygenerovaných modelem. Přesný účinek se bude lišit podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu. Můžete například předat {"50256": -100} , abyste zabránili generování tokenu <|endoftext|> .	Ne	Nic
protokoly	celočíselný	Zahrňte pravděpodobnosti protokolu u nejpravděpodobnějších logprobs výstupních tokenů a vybraných tokenů. Pokud je například logprobs 5, rozhraní API vrátí seznam pěti nejpravděpodobnějších tokenů. Rozhraní API vždy vrátí logprob vzorkovaný token, takže v odpovědi může být až logprobs+1 elementy. Maximální hodnota je logprobs 5.	Ne	Nic
maximální počet tokenů	celočíselný	Maximální počet tokenů, které lze vygenerovat v dokončení. Počet tokenů výzvy plus max_tokens nesmí překročit délku kontextu modelu.	Ne	16
n	celočíselný	Kolik dokončení se má vygenerovat pro každou výzvu. Poznámka: Protože tento parametr generuje mnoho dokončení, může rychle spotřebovat kvótu tokenu. Pečlivě používejte a ujistěte se, že máte přiměřené nastavení a max_tokensstop.	Ne	0
penalizace přítomnosti	Číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.	Ne	0
semeno	celočíselný	Pokud je zadáno, náš systém se bude snažit vzorkovat deterministicky, aby opakované požadavky se stejnými seed parametry měly vrátit stejný výsledek. Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.	Ne
Zastavit	řetězec nebo pole	Až čtyři sekvence, ve kterých rozhraní API přestane generovat další tokeny. Vrácený text nebude obsahovat sekvenci zastavení.	Ne
datový proud	Boolean	Zda se má streamovat zpět částečný průběh. Pokud jsou nastavené, tokeny se posílají jako události odesílané jen	Ne	Nepravda
přípona	řetězec	Přípona, která následuje po dokončení vloženého textu. Tento parametr je podporován pouze pro gpt-3.5-turbo-instruct.	Ne	Nic
Teplota	Číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. 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. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne	0
top_p	Číslo	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne	0
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	Ne

GenerovatOdezvuNaDokončení

Představuje odpověď na dokončení z rozhraní API. Poznámka: Streamované i nestreamované objekty odpovědi sdílejí stejný obrazec (na rozdíl od koncového bodu chatu).

Název	Typ	Popis	Požaduje se	Výchozí
ID	řetězec	Jedinečný identifikátor dokončení.	Ano
volby	pole	Seznam voleb dokončení, které model vygeneroval pro vstupní výzvu.	Ano
vytvořené	celočíselný	Časové razítko unixu (v sekundách) doby vytvoření dokončení.	Ano
model	řetězec	Model použitý k dokončení.	Ano
výzva_filtr_výsledků	promptFilterResults	Výsledky filtrování obsahu pro nulové nebo více výzev v požadavku V žádosti o streamování můžou výsledky různých výzev dorazit v různých časech nebo v různých objednávkách.	Ne
systémový otisk prstu	řetězec	Tento otisk prstu představuje konfiguraci back-endu, se kterou model běží. Lze použít společně s parametrem seed požadavku, abyste pochopili, kdy byly provedeny změny back-endu, které by mohly ovlivnit determinismus.	Ne
objekt	výčet	Typ objektu, který je vždy "text_completion" Možné hodnoty: text_completion	Ano
využití	completionUsage	Statistiky využití žádosti o dokončení	Ne

Vytvořit požadavek na dokončení chatu (createChatCompletionRequest)

Název	Typ	Popis	Požaduje se	Výchozí
Teplota	Číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. 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. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne	0
top_p	Číslo	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne	0
datový proud	Boolean	Pokud je tato možnost nastavená, budou odeslány částečné rozdíly zpráv, například v ChatGPT. Tokeny se posílají jako události odesílané jen	Ne	Nepravda
Zastavit	řetězec nebo pole	Až čtyři sekvence, ve kterých rozhraní API přestane generovat další tokeny.	Ne
maximální počet tokenů	celočíselný	Maximální počet tokenů, které lze vygenerovat v dokončení chatu. Celková délka vstupních tokenů a vygenerovaných tokenů je omezená délkou kontextu modelu.	Ne
maximální_počet_tokenů_dokončení	celočíselný	Horní mez počtu tokenů, které lze vygenerovat pro dokončení, včetně viditelných výstupních tokenů a zdůvodnění tokenů.	Ne
penalizace přítomnosti	Číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.	Ne	0
trest za frekvenci	Číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.	Ne	0
logitová zkreslenost	objekt	Upravte pravděpodobnost výskytu zadaných tokenů v dokončení. Přijímá objekt JSON, který mapuje tokeny (určené jejich ID tokenu v tokenizátoru) na přidruženou hodnotu předsudku od -100 do 100. Matematicky se před vzorkováním přidá do logitů vygenerovaných modelem. Přesný účinek se bude lišit podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu.	Ne	Nic
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	Ne
zprávy	pole	Seznam zpráv, které tvoří dosud konverzaci.	Ano
zdroje_dat	pole	Položky konfigurace pro rozšíření chatu Azure OpenAI, které je používají. Tato další specifikace je kompatibilní pouze s Azure OpenAI.	Ne
protokoly	Boolean	Zda se mají vrátit pravděpodobnosti protokolu výstupních tokenů, nebo ne. Pokud je pravda, vrátí pravděpodobnosti protokolu každého výstupního tokenu vráceného v hodnotě contentmessage.	Ne	Nepravda
top_logprobs	celočíselný	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu. logprobs parametr musí být nastaven na true hodnotu, pokud je použit tento parametr.	Ne
n	celočíselný	Kolik možností dokončení chatu se má vygenerovat pro každou vstupní zprávu. Mějte na paměti, že se vám bude účtovat na základě počtu vygenerovaných tokenů napříč všemi možnostmi. Udržujte n si přehled o 1 minimalizaci nákladů.	Ne	0
paralelní volání nástrojů	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	Ne	Pravdivé
formát_odpovědi	ResponseFormatText nebo ResponseFormatJsonObject nebo ResponseFormatJsonSchema	Objekt určující formát, který musí model vypíše. Kompatibilní s GPT-4o Nastavení pro { "type": "json_schema", "json_schema": {...} } povolení strukturovaných výstupů, které zaručuje, že model bude odpovídat zadanému schématu JSON. Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON. Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.	Ne
semeno	celočíselný	Tato funkce je v beta verzi. Pokud je zadáno, náš systém se bude snažit vzorkovat deterministicky, aby opakované požadavky se stejnými seed parametry měly vrátit stejný výsledek. Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.	Ne
nářadí	pole	Seznam nástrojů, které model může volat. V současné době se jako nástroj podporují jenom funkce. Pomocí tohoto příkazu můžete poskytnout seznam funkcí, pro které může model generovat vstupy JSON. Podporuje se maximálně 128 funkcí.	Ne
výběr nástroje	chatCompletionToolChoiceOption	Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádný nástroj a místo toho vygeneruje zprávu. auto znamená, že model si může vybrat mezi generováním zprávy nebo voláním jednoho nebo více nástrojů. required znamená, že model musí volat jeden nebo více nástrojů. Zadáním konkrétního nástroje vynutíte {"type": "function", "function": {"name": "my_function"}} model, aby tento nástroj volal. none je výchozí, pokud nejsou k dispozici žádné nástroje. auto je výchozí, pokud jsou k dispozici nástroje.	Ne
volání funkce	string nebo chatCompletionFunctionCallOption	Zastaralá ve prospěch tool_choice. Určuje, která funkce (pokud existuje) volána modelem. none znamená, že model nebude volat funkci a místo toho vygeneruje zprávu. auto znamená, že model může vybrat mezi generováním zprávy nebo voláním funkce. Zadáním konkrétní funkce vynutíte {"name": "my_function"} , aby model volal danou funkci. none je výchozí, pokud nejsou k dispozici žádné funkce. auto je výchozí, pokud jsou k dispozici funkce.	Ne
– funkce	pole	Zastaralá ve prospěch tools. Seznam funkcí, pro které model může generovat vstupy JSON.	Ne

funkce pro dokončení chatu

Název	Typ	Popis	Požaduje se	Výchozí
popis	řetězec	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.	Ne
název	řetězec	Název funkce, která se má volat. Musí být a-z, A-Z, 0-9 nebo obsahovat podtržítka a pomlčky s maximální délkou 64.	Ano
parametry	FunctionParameters	Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON. Příklady najdete v příručce a referenční informace ke schématu JSON pro dokumentaci k formátu. Vynechání parameters definuje funkci s prázdným seznamem parametrů.	Ne

funkce volání chatCompletionOption

Zadáním konkrétní funkce vynutíte {"name": "my_function"} , aby model volal danou funkci.

Název	Typ	Popis	Požaduje se	Výchozí
název	řetězec	Název funkce, která se má volat.	Ano

žádost o dokončení chatu

Tato komponenta může být jedna z následujících:

systémová zpráva pro dokončení žádosti o chat

Název	Typ	Popis	Požaduje se	Výchozí
obsah	řetězec nebo pole	Obsah systémové zprávy.	Ano
úloha	výčet	Role autora zpráv v tomto případě system. Možné hodnoty: systém	Ano
název	řetězec	Volitelné jméno účastníka. Poskytuje informace o modelu pro rozlišení mezi účastníky stejné role.	Ne

chatPožadavekDokončeníZprávyUživatel

Název	Typ	Popis	Požaduje se	Výchozí
obsah	řetězec nebo pole	Obsah zprávy uživatele.	Ano
úloha	výčet	Role autora zpráv v tomto případě user. Možné hodnoty: uživatel	Ano
název	řetězec	Volitelné jméno účastníka. Poskytuje informace o modelu pro rozlišení mezi účastníky stejné role.	Ne

zprávaAsistentaŽádostiODokončeníChatování

Název	Typ	Popis	Požaduje se	Výchozí
obsah	řetězec nebo pole	Obsah zprávy asistenta. Povinné, pokud tool_calls není zadáno.function_call	Ne
odmítnutí	řetězec	Odmítnutí zprávy asistenta.	Ne
úloha	výčet	Role autora zpráv v tomto případě assistant. Možné hodnoty: asistent	Ano
název	řetězec	Volitelné jméno účastníka. Poskytuje informace o modelu pro rozlišení mezi účastníky stejné role.	Ne
volání nástrojů	chatCompletionMessageToolCalls	Nástroj volá volání vygenerovaná modelem, například volání funkcí.	Ne
volání funkce	objekt	Zastaralé a nahrazené .tool_calls Název a argumenty funkce, které by se měly volat, jak je vygeneroval model.	Ne

Vlastnosti pro function_call

argumenty

Název	Typ	Popis	Výchozí
argumenty	řetězec	Argumenty pro volání funkce s vygenerovaným modelem ve formátu JSON. Všimněte si, že model negeneruje vždy platný JSON a může generovat parametry, které nejsou definovány schématem funkce. Před voláním funkce ověřte argumenty v kódu.

název

Název	Typ	Popis	Výchozí
název	řetězec	Název funkce, která se má volat.

chatCompletionRequestToolMessage

Název	Typ	Popis	Požaduje se	Výchozí
úloha	výčet	Role autora zpráv v tomto případě tool. Možné hodnoty: nástroj	Ano
obsah	řetězec nebo pole	Obsah zprávy nástroje	Ano
tool_call_id	řetězec	Volání nástroje, na které tato zpráva reaguje.	Ano

chatCompletionRequestFunctionMessage

Název	Typ	Popis	Požaduje se	Výchozí
úloha	výčet	Role autora zpráv v tomto případě function. Možné hodnoty: funkce	Ano
obsah	řetězec	Obsah zprávy funkce.	Ano
název	řetězec	Název funkce, která se má volat.	Ano

ObsahSystémovéZprávyDokončeníChatu

Tato komponenta může být jedna z následujících:

Obsah zprávy uživatele pro dokončení chatu

Tato komponenta může být jedna z následujících:

ObsahZprávyAsistentaProDokončeníChatu

Tato komponenta může být jedna z následujících:

chatCompletionRequestNástrojZprávaObsahČást

Tato komponenta může být jedna z následujících:

část textu zprávy požadavku na dokončení chatovacího procesu

Název	Typ	Popis	Požaduje se	Výchozí
druh	výčet	Typ části obsahu. Možné hodnoty: text	Ano
Text	řetězec	Textový obsah.	Ano

chatováDokončeníPožadavekObsahČástObrázek

Název	Typ	Popis	Požaduje se	Výchozí
druh	výčet	Typ části obsahu. Možné hodnoty: image_url	Ano
URL_obrázku	objekt		Ano

Vlastnosti pro image_url

adresa URL

Název	Typ	Popis	Výchozí
adresa URL	řetězec	Buď adresa URL obrázku, nebo data s kódováním base64 obrázku.

podrobnost

Název	Typ	Popis	Výchozí
podrobnost	řetězec	Určuje úroveň podrobností obrázku. Další informace najdete v průvodci vision.	Auto

OdmítnutíčástiObsahŽádostiZprávyKompletace

Název	Typ	Popis	Požaduje se	Výchozí
druh	výčet	Typ části obsahu. Možné hodnoty: odmítnutí	Ano
odmítnutí	řetězec	Odmítnutí zprávy generované modelem.	Ano

konfigurace rozšíření Azure Chat

Reprezentace konfiguračních dat pro jedno rozšíření chatu Azure OpenAI Použije se žádost o dokončení chatu, která by měla k rozšíření odpovědí použít rozšíření chatu Azure OpenAI. Použití této konfigurace je kompatibilní pouze s Azure OpenAI.

Název	Typ	Popis	Požaduje se	Výchozí
druh	azureChatExtensionType	Reprezentace konfiguračních dat pro jedno rozšíření chatu Azure OpenAI Ten bude používat chat. žádost o dokončení, která by měla používat rozšíření chatu Azure OpenAI k rozšíření chování odpovědi. Použití této konfigurace je kompatibilní pouze s Azure OpenAI.	Ano

TypRozšířeníAzureChatu

Reprezentace konfiguračních dat pro jedno rozšíření chatu Azure OpenAI Použije se žádost o dokončení chatu, která by měla k rozšíření odpovědí použít rozšíření chatu Azure OpenAI. Použití této konfigurace je kompatibilní pouze s Azure OpenAI.

Popis: Reprezentace konfiguračních dat pro jedno rozšíření chatu Azure OpenAI Použije se žádost o dokončení chatu, která by měla k rozšíření odpovědí použít rozšíření chatu Azure OpenAI. Použití této konfigurace je kompatibilní pouze s Azure OpenAI.

Typ: řetězec

Výchozí:

Název výčtu: AzureChatExtensionType

Hodnoty výčtu:

Hodnota	Popis
Hledání Azure	Představuje použití služby Azure Search jako rozšíření chatu Azure OpenAI.
databáze Azure Cosmos DB	Představuje použití služby Azure Cosmos DB jako rozšíření chatu Azure OpenAI.

AzureVyhledáváníChatuRozšířeníKonfigurace

Konkrétní reprezentace konfigurovatelných možností pro Azure Search při použití jako rozšíření chatu Azure OpenAI

Název	Typ	Popis	Požaduje se	Výchozí
druh	azureChatExtensionType	Reprezentace konfiguračních dat pro jedno rozšíření chatu Azure OpenAI Ten bude používat chat. žádost o dokončení, která by měla používat rozšíření chatu Azure OpenAI k rozšíření chování odpovědi. Použití této konfigurace je kompatibilní pouze s Azure OpenAI.	Ano
parametry	azureSearchChatExtensionParameters	Parametry služby Azure Search při použití jako rozšíření chatu Azure OpenAI	Ne

parametry rozšíření vyhledávání Azure chat

Parametry služby Azure Search při použití jako rozšíření chatu Azure OpenAI

Název	Typ	Popis	Požaduje se	Výchozí
ověřování	onYourDataApiKeyAuthenticationOptions nebo onYourDataSystemAssignedManagedIdentityAuthenticationOptions nebo onYourDataUserAssignedManagedIdentityAuthenticationOptions		Ano
top_n_documents (nejlepší_n_dokumenty)	celočíselný	Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz.	Ne
v rozsahu	Boolean	Určuje, jestli se dotazy mají omezit na použití indexovaných dat.	Ne
přísnost	celočíselný	Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi.	Ne
informace_o_roli	řetězec	Poskytněte modelu pokyny, jak by se měl chovat, a jakýkoli kontext, na který by měl odkazovat při generování odpovědi. Můžete popsat osobnost asistenta a říct jí, jak formátovat odpovědi. Existuje pro něj limit 100 tokenů a počítá se do celkového limitu tokenu.	Ne
koncový bod	řetězec	Absolutní cesta ke koncovému bodu pro prostředek Azure Search, který se má použít.	Ano
název_indexu	řetězec	Název indexu, který se má použít jako dostupný v odkazovaném prostředku služby Azure Search.	Ano
mapování polí	azureSearchIndexFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Služby Azure Search	Ne
typ_dotazu	azureSearchQueryType	Typ vyhledávacího dotazu Služby Azure Search, který se má spustit při použití jako rozšíření chatu Azure OpenAI.	Ne
semantická_konfigurace	řetězec	Další sémantická konfigurace dotazu.	Ne
filtr	řetězec	Filtr hledání.	Ne
vkládání_závislosti	onYourDataEndpointVectorizationSource nebo onYourDataDeploymentNameVectorizationSource		Ne

azureSearchIndexFieldMappingOptions (možnosti mapování polí indexu Azure Search)

Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Služby Azure Search

Název	Typ	Popis	Požaduje se	Výchozí
pole pro název	řetězec	Název pole indexu, které se má použít jako název.	Ne
url_field	řetězec	Název pole indexu, které se má použít jako adresa URL.	Ne
pole cesty k souboru	řetězec	Název pole indexu, které se má použít jako cesta k souboru.	Ne
pole_obsahu	pole	Názvy polí indexu, která by se měla považovat za obsah.	Ne
Oddělovač_položek_obsahu	řetězec	Vzor oddělovače, který mají pole obsahu používat.	Ne
vektorová pole	pole	Názvy polí, která představují vektorová data.	Ne

azureSearchQueryType

Typ vyhledávacího dotazu Služby Azure Search, který se má spustit při použití jako rozšíření chatu Azure OpenAI.

Popis: Typ vyhledávacího dotazu Služby Azure Search, který se má spustit při použití jako rozšíření chatu Azure OpenAI.

Typ: řetězec

Výchozí:

Název výčtu: AzureSearchQueryType

Hodnoty výčtu:

Hodnota	Popis
jednoduchý	Představuje výchozí jednoduchý analyzátor dotazů.
– sémantické	Představuje sémantický analyzátor dotazů pro pokročilé sémantické modelování.
vektor	Představuje vektorové vyhledávání vypočítaných dat.
vektor_jednoduchý_hybrid	Představuje kombinaci jednoduché strategie dotazu s vektorovými daty.
vektorový_sémantický_hybrid	Představuje kombinaci sémantického vyhledávání a dotazování vektorových dat.

azureCosmosDBChatExtensionKonfigurace

Konkrétní reprezentace konfigurovatelných možností pro službu Azure Cosmos DB při použití jako rozšíření chatu Azure OpenAI

Název	Typ	Popis	Požaduje se	Výchozí
druh	azureChatExtensionType	Reprezentace konfiguračních dat pro jedno rozšíření chatu Azure OpenAI Ten bude používat chat. žádost o dokončení, která by měla používat rozšíření chatu Azure OpenAI k rozšíření chování odpovědi. Použití této konfigurace je kompatibilní pouze s Azure OpenAI.	Ano
parametry	azureCosmosDBChatExtensionParameters	Parametry, které se mají použít při konfiguraci rozšíření chatu Azure OpenAI ve vašem datovém chatu při použití služby Azure Cosmos DB pro Virtuální jádro MongoDB	Ne

azureCosmosDBChatExtensionParameters

Parametry, které se mají použít při konfiguraci rozšíření chatu Azure OpenAI ve vašem datovém chatu při použití služby Azure Cosmos DB pro virtuální jádro MongoDB

Název	Typ	Popis	Požaduje se	Výchozí
ověřování	onYourDataConnectionStringAuthenticationOptions	Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití připojovací řetězec	Ano
top_n_documents (nejlepší_n_dokumenty)	celočíselný	Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz.	Ne
v rozsahu	Boolean	Určuje, jestli se dotazy mají omezit na použití indexovaných dat.	Ne
přísnost	celočíselný	Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi.	Ne
informace_o_roli	řetězec	Poskytněte modelu pokyny, jak by se měl chovat, a jakýkoli kontext, na který by měl odkazovat při generování odpovědi. Můžete popsat osobnost asistenta a říct jí, jak formátovat odpovědi. Existuje pro něj limit 100 tokenů a počítá se do celkového limitu tokenu.	Ne
název databáze	řetězec	Název databáze MongoDB vCore, který se má použít se službou Azure Cosmos DB.	Ano
název_kontejneru	řetězec	Název kontejneru prostředků služby Azure Cosmos DB.	Ano
název_indexu	řetězec	Název indexu virtuálních jader MongoDB, který se má použít se službou Azure Cosmos DB.	Ano
mapování polí	azureCosmosDBFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Služby Azure Cosmos DB	Ano
vkládání_závislosti	onYourDataEndpointVectorizationSource nebo onYourDataDeploymentNameVectorizationSource		Ano

azureCosmosDBMožnostiMapováníPolí

Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Služby Azure Cosmos DB

Název	Typ	Popis	Požaduje se	Výchozí
pole pro název	řetězec	Název pole indexu, které se má použít jako název.	Ne
url_field	řetězec	Název pole indexu, které se má použít jako adresa URL.	Ne
pole cesty k souboru	řetězec	Název pole indexu, které se má použít jako cesta k souboru.	Ne
pole_obsahu	pole	Názvy polí indexu, která by se měla považovat za obsah.	Ano
Oddělovač_položek_obsahu	řetězec	Vzor oddělovače, který mají pole obsahu používat.	Ne
vektorová pole	pole	Názvy polí, která představují vektorová data.	Ano

onMožnostiOvěřeníDat

Možnosti ověřování pro Azure OpenAI ve vašich datech

Název	Typ	Popis	Požaduje se	Výchozí
druh	naVašemTypuOvěřeníDat	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Ano

typAutentizaceNaVašichDatech

Typy ověřování podporované v Azure OpenAI ve vašich datech.

Popis: Typy ověřování podporované v Azure OpenAI ve vašich datech.

Typ: řetězec

Výchozí:

Název výčtu: OnYourDataAuthenticationType

Hodnoty výčtu:

Hodnota	Popis
klíč API	Ověřování prostřednictvím klíče rozhraní API
řetězec_připojení	Ověřování prostřednictvím připojovací řetězec.
systémem přidělená spravovaná identita	Ověřování prostřednictvím spravované identity přiřazené systémem
uživatelem přiřazená spravovaná identita	Ověřování prostřednictvím spravované identity přiřazené uživatelem

onYourDataMožnostiAutentizaceApiKlíče

Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití klíče rozhraní API

Název	Typ	Popis	Požaduje se	Výchozí
druh	naVašemTypuOvěřeníDat	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Ano
klíč	řetězec	Klíč rozhraní API, který se má použít k ověřování.	Ne

onYourDataConnectionStringAuthenticationOptions

Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití připojovací řetězec

Název	Typ	Popis	Požaduje se	Výchozí
druh	naVašemTypuOvěřeníDat	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Ano
řetězec_připojení	řetězec	Připojovací řetězec použít k ověřování.	Ne

možnosti ověření spravované identity přiřazené vaším systémem

Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití spravované identity přiřazené systémem

Název	Typ	Popis	Požaduje se	Výchozí
druh	naVašemTypuOvěřeníDat	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Ano

Možnosti autentizace spravované identity přiřazené uživateli - onYourData

Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití spravované identity přiřazené uživatelem.

Název	Typ	Popis	Požaduje se	Výchozí
druh	naVašemTypuOvěřeníDat	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Ano
spravované_identity_id_zdroje	řetězec	ID prostředku spravované identity přiřazené uživatelem, které se má použít k ověřování.	Ne

vektorizaceDatovéhoZdrojovéhoKódu

Abstraktní reprezentace zdroje vektorizace pro Azure OpenAI ve vašich datech s využitím vektorového vyhledávání

Název	Typ	Popis	Požaduje se	Výchozí
druh	naVášTypZdrojDataVektorizace	Představuje dostupné zdroje, které azure OpenAI ve vašich datech může použít ke konfiguraci vektorizace dat pro použití vektorové vyhledávání.	Ano

onYourDataVectorizationSourceType

Představuje dostupné zdroje, které azure OpenAI ve vašich datech může použít ke konfiguraci vektorizace dat pro použití s vektorovým vyhledáváním.

Popis: Představuje dostupné zdroje, které azure OpenAI ve vašich datech může použít ke konfiguraci vektorizace dat pro použití s
vektorové vyhledávání.

Typ: řetězec

Výchozí:

Název výčtu: OnYourDataVectorizationSourceType

Hodnoty výčtu:

Hodnota	Popis
koncový bod	Představuje vektorizaci prováděnou voláními veřejné služby do modelu vkládání Azure OpenAI.
název_nasazení	Představuje název nasazení modelu Ada, který se má použít. Toto nasazení modelu musí být ve stejném prostředku Azure OpenAI, ale Ve vašich datech bude toto nasazení modelu používat prostřednictvím interního volání, nikoli veřejného, což umožňuje vektor. vyhledávání i v privátních sítích.

onYourDataDeploymentNameVectorizationSource

Podrobnosti o vektorizačním zdroji, který používá Azure OpenAI ve vašich datech při použití vektorového vyhledávání, je založený na interním názvu nasazení modelu vkládání ve stejném prostředku Azure OpenAI.

Název	Typ	Popis	Požaduje se	Výchozí
druh	naVášTypZdrojDataVektorizace	Představuje dostupné zdroje, které azure OpenAI ve vašich datech může použít ke konfiguraci vektorizace dat pro použití vektorové vyhledávání.	Ano
název_nasazení	řetězec	Určuje název nasazení modelu, který se má použít pro vektorizaci. Toto nasazení modelu musí být ve stejném prostředku Azure OpenAI, ale ve vašich datech bude toto nasazení modelu používat prostřednictvím interního volání, nikoli veřejného, což umožňuje vektorové vyhledávání i v privátních sítích.	Ne

NaVašeDataKoncovýBodVektorizaceZdroj

Podrobnosti o vektorizačním zdroji, který používá Azure OpenAI ve vašich datech při použití vektorového vyhledávání, která je založená na veřejném volání koncového bodu Azure OpenAI pro vkládání.

Název	Typ	Popis	Požaduje se	Výchozí
druh	naVášTypZdrojDataVektorizace	Představuje dostupné zdroje, které azure OpenAI ve vašich datech může použít ke konfiguraci vektorizace dat pro použití vektorové vyhledávání.	Ano
ověřování	onYourDataMožnostiOvěřováníApiKey	Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití klíče rozhraní API	Ne
koncový bod	řetězec	Určuje koncový bod, který se má použít pro vektorizaci. Tento koncový bod musí být ve stejném prostředku Azure OpenAI, ale ve vašich datech bude tento koncový bod používat prostřednictvím interního volání, nikoli veřejného, což umožňuje vektorové vyhledávání i v privátních sítích.	Ne

azureChatExtensionsMessageContext

Reprezentace dalších kontextových informací dostupných v případech, kdy se rozšíření chatu Azure OpenAI účastní generování odpovídající odpovědi na dokončení chatu. Tyto kontextové informace se naplní pouze při použití požadavku Azure OpenAI nakonfigurovaného na použití odpovídajícího rozšíření.

Název	Typ	Popis	Požaduje se	Výchozí
Citace	pole	Výsledek načtení zdroje dat použitý k vygenerování zprávy asistenta v odpovědi.	Ne
Záměr	řetězec	Rozpoznaný záměr z historie chatu, který se používá k předání do dalšího turnu, který přenese kontext.	Ne

citace

informace o citaci pro zprávu s odpovědí na dokončení chatu

Název	Typ	Popis	Požaduje se	Výchozí
obsah	řetězec	Obsah citace.	Ano
název	řetězec	Název citace.	Ne
adresa URL	řetězec	Adresa URL citace.	Ne
cesta k souboru	řetězec	Cesta k souboru citace.	Ne
identifikátor_chunku	řetězec	ID bloku citace.	Ne

VoláníNástrojeProDokončeníZprávyChat

Název	Typ	Popis	Požaduje se	Výchozí
ID	řetězec	ID volání nástroje.	Ano
druh	typ volání nástrojů	Typ volání nástroje v tomto případě function.	Ano
funkce	objekt	Funkce, kterou model volal.	Ano

Vlastnosti funkce

název

Název	Typ	Popis	Výchozí
název	řetězec	Název funkce, která se má volat.

argumenty

Název	Typ	Popis	Výchozí
argumenty	řetězec	Argumenty pro volání funkce s vygenerovaným modelem ve formátu JSON. Všimněte si, že model negeneruje vždy platný JSON a může generovat parametry, které nejsou definovány schématem funkce. Před voláním funkce ověřte argumenty v kódu.

typ volání nástroje

Typ volání nástroje v tomto případě function.

Popis: Typ volání nástroje, v tomto případě function.

Typ: řetězec

Výchozí:

Název výčtu: ToolCallType

Hodnoty výčtu:

Hodnota	Popis
funkce	Typ volání nástroje je funkce.

Nástroj pro dokončení požadavků na zprávy v chatu

Název	Typ	Popis	Požaduje se	Výchozí
tool_call_id	řetězec	Volání nástroje, na které tato zpráva reaguje.	Ne
obsah	řetězec	Obsah zprávy.	Ne

Funkce žádosti o dokončení zprávy v chatu

Název	Typ	Popis	Požaduje se	Výchozí
úloha	výčet	Role autora zpráv v tomto případě function. Možné hodnoty: funkce	Ne
název	řetězec	Obsah zprávy.	Ne
obsah	řetězec	Obsah zprávy.	Ne

createChatCompletionResponse

Představuje odpověď na dokončení chatu vrácenou modelem na základě zadaného vstupu.

Název	Typ	Popis	Požaduje se	Výchozí
ID	řetězec	Jedinečný identifikátor dokončení chatu.	Ano
výzva_filtr_výsledků	promptFilterResults	Výsledky filtrování obsahu pro nulové nebo více výzev v požadavku V žádosti o streamování můžou výsledky různých výzev dorazit v různých časech nebo v různých objednávkách.	Ne
volby	pole	Seznam možností dokončení chatu Pokud je větší než 1, může být více než jedna n .	Ano
vytvořené	celočíselný	Časové razítko unixu (v sekundách) doby vytvoření dokončení chatu.	Ano
model	řetězec	Model použitý k dokončení chatu.	Ano
systémový otisk prstu	řetězec	Tento otisk prstu představuje konfiguraci back-endu, se kterou model běží. Lze použít společně s parametrem seed požadavku, abyste pochopili, kdy byly provedeny změny back-endu, které by mohly ovlivnit determinismus.	Ne
objekt	výčet	Typ objektu, který je vždy chat.completion. Možné hodnoty: chat.completion	Ano
využití	completionUsage	Statistiky využití žádosti o dokončení	Ne

createChatCompletionStreamResponse

Představuje streamovaný blok odpovědi na dokončení chatu vrácenou modelem na základě zadaného vstupu.

Název	Typ	Popis	Požaduje se	Výchozí
ID	řetězec	Jedinečný identifikátor dokončení chatu. Každý blok dat má stejné ID.	Ano
volby	pole	Seznam možností dokončení chatu Může obsahovat více než jeden prvek, pokud n je větší než 1.	Ano
vytvořené	celočíselný	Časové razítko unixu (v sekundách) doby vytvoření dokončení chatu. Každý blok dat má stejné časové razítko.	Ano
model	řetězec	Model pro vygenerování dokončení.	Ano
systémový otisk prstu	řetězec	Tento otisk prstu představuje konfiguraci back-endu, se kterou model běží. Lze použít společně s parametrem seed požadavku, abyste pochopili, kdy byly provedeny změny back-endu, které by mohly ovlivnit determinismus.	Ne
objekt	výčet	Typ objektu, který je vždy chat.completion.chunk. Možné hodnoty: chat.completion.chunk	Ano

chatCompletionStreamResponseDelta

Rozdíl dokončení chatu vygenerovaný streamovanými odpověďmi modelu

Název	Typ	Popis	Požaduje se	Výchozí
obsah	řetězec	Obsah zprávy bloku dat.	Ne
volání funkce	objekt	Zastaralé a nahrazené .tool_calls Název a argumenty funkce, které by se měly volat, jak je vygeneroval model.	Ne
volání nástrojů	pole		Ne
úloha	výčet	Role autora této zprávy Možné hodnoty: systém, uživatel, asistent, nástroj	Ne
odmítnutí	řetězec	Odmítnutí zprávy generované modelem.	Ne

Vlastnosti pro function_call

argumenty

Název	Typ	Popis	Výchozí
argumenty	řetězec	Argumenty pro volání funkce s vygenerovaným modelem ve formátu JSON. Všimněte si, že model negeneruje vždy platný JSON a může generovat parametry, které nejsou definovány schématem funkce. Před voláním funkce ověřte argumenty v kódu.

název

Název	Typ	Popis	Výchozí
název	řetězec	Název funkce, která se má volat.

chatCompletionMessageToolCallChunk

Název	Typ	Popis	Požaduje se	Výchozí
rejstřík	celočíselný		Ano
ID	řetězec	ID volání nástroje.	Ne
druh	výčet	Typ nástroje. V současné době se podporuje pouze function . Možné hodnoty: funkce	Ne
funkce	objekt		Ne

Vlastnosti funkce

název

Název	Typ	Popis	Výchozí
název	řetězec	Název funkce, která se má volat.

argumenty

Název	Typ	Popis	Výchozí
argumenty	řetězec	Argumenty pro volání funkce s vygenerovaným modelem ve formátu JSON. Všimněte si, že model negeneruje vždy platný JSON a může generovat parametry, které nejsou definovány schématem funkce. Před voláním funkce ověřte argumenty v kódu.

možnosti proudového dokončování chatu

Možnosti pro odpověď streamování Toto nastavení nastavíte pouze při nastavení stream: true.

Název	Typ	Popis	Požaduje se	Výchozí
zahrnout_použití	Boolean	V případě nastavení se před zprávou data: [DONE] streamuje další blok dat. Pole usage na tomto bloku dat zobrazuje statistiku využití tokenu pro celý požadavek a choices pole bude vždy prázdné pole. Všechny ostatní bloky dat budou obsahovat usage také pole, ale s hodnotou null.	Ne

chatCompletionChoiceLogProbs

Protokolování informací o pravděpodobnosti pro volbu

Název	Typ	Popis	Požaduje se	Výchozí
obsah	pole	Seznam tokenů obsahu zpráv s informacemi o pravděpodobnosti protokolu	Ano
odmítnutí	pole	Seznam tokenů odmítnutí zpráv s informacemi o pravděpodobnosti protokolu.	Ne

chatCompletionTokenLogprob

Název	Typ	Popis	Požaduje se	Výchozí
žeton	řetězec	Token.	Ano
logprob	Číslo	Pravděpodobnost protokolu tohoto tokenu.	Ano
bajtů	pole	Seznam celých čísel představujících reprezentaci tokenu UTF-8 bajtů. Užitečné v případech, kdy jsou znaky reprezentovány více tokeny a jejich bajtové reprezentace musí být kombinovány, aby se vygenerovalo správné textové vyjádření. Může to být null v případě, že pro token neexistuje žádná reprezentace bajtů.	Ano
top_logprobs	pole	Seznam nejpravděpodobnějších tokenů a jejich pravděpodobnosti protokolu v této pozici tokenu Ve výjimečných případech může být méně než počet požadovaných vrácených top_logprobs položek.	Ano

zpráva odpovědi dokončení chatu

Zpráva o dokončení chatu vygenerovaná modelem

Název	Typ	Popis	Požaduje se	Výchozí
úloha	chatCompletionResponseMessageRole	Role autora zprávy odpovědi	Ano
odmítnutí	řetězec	Odmítnutí zprávy generované modelem.	Ano
obsah	řetězec	Obsah zprávy.	Ano
volání nástrojů	pole	Nástroj volá volání vygenerovaná modelem, například volání funkcí.	Ne
volání funkce	chatCompletionFunctionCall	Zastaralé a nahrazené .tool_calls Název a argumenty funkce, které by se měly volat, jak je vygeneroval model.	Ne
kontext	azureChatExtensionsMessageContext	Reprezentace dalších kontextových informací dostupných při zapojení rozšíření chatu Azure OpenAI vygenerování odpovídající odpovědi na dokončení chatu. Tyto informace o kontextu jsou vyplněny pouze v případě, že pomocí požadavku Azure OpenAI nakonfigurovaného tak, aby používal odpovídající rozšíření.	Ne

chatCompletionResponseMessageRole

Role autora zprávy odpovědi

Popis: Role autora zprávy odpovědi.

Typ: řetězec

Výchozí:

Hodnoty výčtu:

• asistent

Možnost výběru nástroje pro dokončení chatu

Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádný nástroj a místo toho vygeneruje zprávu. auto znamená, že model si může vybrat mezi generováním zprávy nebo voláním jednoho nebo více nástrojů. required znamená, že model musí volat jeden nebo více nástrojů. Zadáním konkrétního nástroje vynutíte {"type": "function", "function": {"name": "my_function"}} model, aby tento nástroj volal. none je výchozí, pokud nejsou k dispozici žádné nástroje. auto je výchozí, pokud jsou k dispozici nástroje.

Tato komponenta může být jedna z následujících:

VýběrNástrojeProDokončeníChatu

Určuje nástroj, který má model použít. Slouží k vynucení volání konkrétní funkce modelu.

Název	Typ	Popis	Požaduje se	Výchozí
druh	výčet	Typ nástroje. V současné době se podporuje pouze function . Možné hodnoty: funkce	Ano
funkce	objekt		Ano

Vlastnosti funkce

název

Název	Typ	Popis	Výchozí
název	řetězec	Název funkce, která se má volat.

ParallelToolCalls

Zda se má povolit paralelní volání funkcí během použití nástroje.

Pro tuto komponentu nejsou definovány žádné vlastnosti.

Nástroje pro volání zpráv při dokončení chatu

Nástroj volá volání vygenerovaná modelem, například volání funkcí.

Pro tuto komponentu nejsou definovány žádné vlastnosti.

volání funkce dokončení chatu

Zastaralé a nahrazené .tool_calls Název a argumenty funkce, které by se měly volat, jak je vygeneroval model.

Název	Typ	Popis	Požaduje se	Výchozí
název	řetězec	Název funkce, která se má volat.	Ano
argumenty	řetězec	Argumenty pro volání funkce s vygenerovaným modelem ve formátu JSON. Všimněte si, že model negeneruje vždy platný JSON a může generovat parametry, které nejsou definovány schématem funkce. Před voláním funkce ověřte argumenty v kódu.	Ano

použití dokončení

Statistiky využití žádosti o dokončení

Název	Typ	Popis	Požaduje se	Výchozí
tokeny výzvy	celočíselný	Počet tokenů v příkazovém řádku	Ano
dokončovací tokens	celočíselný	Počet tokenů ve vygenerovaném dokončení	Ano
celkový počet tokenů	celočíselný	Celkový počettokench	Ano
Podrobnosti o dokončovacích tokenech	objekt	Rozpis tokenů použitých při dokončování	Ne

Vlastnosti pro completion_tokens_details

důvodové_tokeny

Název	Typ	Popis	Výchozí
důvodové_tokeny	celočíselný	Tokeny vygenerované modelem z důvodu odůvodnění

nástroj pro dokončení chatu

Název	Typ	Popis	Požaduje se	Výchozí
druh	výčet	Typ nástroje. V současné době se podporuje pouze function . Možné hodnoty: funkce	Ano
funkce	FunctionObject		Ano

Parametry funkce

Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON. Příklady najdete v příručce a referenční informace ke schématu JSON pro dokumentaci k formátu.

Vynechání parameters definuje funkci s prázdným seznamem parametrů.

Pro tuto komponentu nejsou definovány žádné vlastnosti.

FunctionObject

Název	Typ	Popis	Požaduje se	Výchozí
popis	řetězec	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.	Ne
název	řetězec	Název funkce, která se má volat. Musí být a-z, A-Z, 0-9 nebo obsahovat podtržítka a pomlčky s maximální délkou 64.	Ano
parametry	FunctionParameters	Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON. Příklady najdete v příručce a referenční informace ke schématu JSON pro dokumentaci k formátu. Vynechání parameters definuje funkci s prázdným seznamem parametrů.	Ne
přísné	Boolean	Zda povolit přísné dodržování schématu při generování volání funkce. Pokud je nastavená hodnota true, model bude dodržovat přesné schéma definované v parameters poli. Pouze podmnožina schématu JSON je podporována, pokud strict je true.	Ne	Nepravda

FormátOdpovědiText

Název	Typ	Popis	Požaduje se	Výchozí
druh	výčet	Typ formátu odpovědi, který se definuje: text Možné hodnoty: text	Ano

ResponseFormatJsonObject (formát odpovědi jako JSON objekt)

Název	Typ	Popis	Požaduje se	Výchozí
druh	výčet	Typ formátu odpovědi, který se definuje: json_object Možné hodnoty: json_object	Ano

Schéma formátu odpovědi ve formátu JSON

Schéma pro formát odpovědi popsané jako objekt schématu JSON.

Pro tuto komponentu nejsou definovány žádné vlastnosti.

FormátOdpovědiJsonSchéma

Název	Typ	Popis	Požaduje se	Výchozí
druh	výčet	Typ formátu odpovědi, který se definuje: json_schema Možné hodnoty: json_schema	Ano
json_schema	objekt		Ano

Vlastnosti pro json_schema

popis

Název	Typ	Popis	Výchozí
popis	řetězec	Popis formátu odpovědi, který model používá k určení způsobu reakce ve formátu.

název

Název	Typ	Popis	Výchozí
název	řetězec	Název formátu odpovědi. Musí být a-z, A-Z, 0-9 nebo obsahovat podtržítka a pomlčky s maximální délkou 64.

schéma

Název	Typ	Popis	Výchozí
schéma	FormátOdpovědiJsonSchemaSchema	Schéma pro formát odpovědi popsané jako objekt schématu JSON.

přísné

Název	Typ	Popis	Výchozí
přísné	Boolean	Zda povolit přísné dodržování schématu při generování výstupu. Pokud je nastavená hodnota true, model bude vždy dodržovat přesné schéma definované v schema poli. Pouze podmnožina schématu JSON je podporována, pokud strict je true.	Nepravda

VolbaDokončeníChatůSpolečná

Název	Typ	Popis	Požaduje se	Výchozí
rejstřík	celočíselný		Ne
důvod ukončení	řetězec		Ne

vytvořit Žádost o Překlad

Žádost o překlad

Název	Typ	Popis	Požaduje se	Výchozí
soubor	řetězec	Zvukový soubor, který chcete přeložit.	Ano
pobídnout	ř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ě.	Ne
formát_odpovědi	audioResponseFormat	Definuje formát výstupu.	Ne
Teplota	Číslo	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.	Ne	0

zvuková odpověď

Odpověď na překlad nebo přepis, když response_format byl json

Název	Typ	Popis	Požaduje se	Výchozí
Text	řetězec	Přeložený nebo přepisovaný text	Ano

audioVerboseResponse

Odpověď na překlad nebo přepis při verbose_json response_format

Název	Typ	Popis	Požaduje se	Výchozí
Text	řetězec	Přeložený nebo přepisovaný text	Ano
úkol	řetězec	Typ zvukového úkolu.	Ne
jazyk	řetězec	Jazyk.	Ne
doba trvání	Číslo	Doba trvání.	Ne
segmenty	pole		Ne

formát zvukové odpovědi

Definuje formát výstupu.

Popis: Definuje formát výstupu.

Typ: řetězec

Výchozí:

Hodnoty výčtu:

• JSON
• Text
• srt
• verbose_json
• vttt

vytvořitŽádostOTranskripci

Žádost o přepis

Název	Typ	Popis	Požaduje se	Výchozí
soubor	řetězec	Objekt zvukového souboru, který se má přepisovat.	Ano
pobídnout	ř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.	Ne
formát_odpovědi	audioResponseFormat	Definuje formát výstupu.	Ne
Teplota	Číslo	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.	Ne	0
jazyk	řetězec	Jazyk vstupního zvuku. Poskytnutí jazyka zadávání vstupu ve formátu ISO-639-1 zlepší přesnost a latenci.	Ne

zvukový segment

Přepis nebo segment překladu

Název	Typ	Popis	Požaduje se	Výchozí
ID	celočíselný	Identifikátor segmentu.	Ne
hledat	Číslo	Posun segmentu.	Ne
začátek	Číslo	Odsazení začátku segmentu	Ne
konec	Číslo	Odsazení konce segmentu	Ne
Text	řetězec	Segmentace textu	Ne
odznaky	pole	Tokeny textu	Ne
Teplota	Číslo	Teplota.	Ne
avg_logprob	Číslo	Průměrná pravděpodobnost protokolu.	Ne
kompresní poměr	Číslo	Poměr komprese.	Ne
pravděpodobnost_žádný_projev	Číslo	no speechPravděpodobnost .	Ne

kvalita obrázku

Kvalita image, která se vygeneruje.

Popis: Kvalita image, která se vygeneruje.

Typ: řetězec

Výchozí: standardní

Název výčtu: Kvalita

Hodnoty výčtu:

Hodnota	Popis
standard	Standardní kvalita vytváří obrázky se standardní kvalitou.
pevný disk	Kvalita HD vytváří obrázky s jemnými podrobnostmi a větší konzistencí v celém obrázku.

formát odezvy obrázků

Formát, ve kterém se vrátí vygenerované obrázky.

Popis: Formát, ve kterém se vrátí vygenerované obrázky.

Typ: řetězec

Výchozí: adresa URL

Název výčtu: ImagesResponseFormat

Hodnoty výčtu:

Hodnota	Popis
adresa URL	Adresa URL, která poskytuje dočasný přístup ke stažení vygenerovaných obrázků.
b64_json	Vygenerované image se vrátí jako řetězec kódovaný v base64.

velikost obrázku

Velikost vygenerovaných obrázků.

Popis: Velikost vygenerovaných obrázků.

Typ: řetězec

Výchozí: 1024x1024

Název výčtu: Velikost

Hodnoty výčtu:

Hodnota	Popis
1792x1024	Požadovaná velikost vygenerovaného obrázku je 1792 × 1024 pixelů.
1024x1792	Požadovaná velikost vygenerovaného obrázku je 1024 × 1792 pixelů.
1024 × 1024	Požadovaná velikost vygenerovaného obrázku je 1024 × 1024 pixelů.

styl obrázku

Styl vygenerovaných obrázků

Popis: Styl vygenerovaných obrázků.

Typ: řetězec

Výchozí: živé

Název výčtu: styl

Hodnoty výčtu:

Hodnota	Popis
živý	Živé vytváří obrázky, které jsou hyperrealistické a dramaticky.
přirozený	Natural vytváří obrázky, které jsou přirozenější a méně hyperrealistické.

požadavek na generování obrázků

Název	Typ	Popis	Požaduje se	Výchozí
pobídnout	řetězec	Textový popispožadovaných Maximální délka je 4 000 znaků.	Ano
n	celočíselný	Počet obrázků, které se mají vygenerovat.	Ne	0
velikost	imageSize	Velikost vygenerovaných obrázků.	Ne	1024 × 1024
formát_odpovědi	imagesResponseFormat	Formát, ve kterém se vrátí vygenerované obrázky.	Ne	adresa URL
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	Ne
kvalita	imageQuality	Kvalita image, která se vygeneruje.	Ne	standard
– styl	imageStyle	Styl vygenerovaných obrázků	Ne	živý

generateImagesResponse

Název	Typ	Popis	Požaduje se	Výchozí
vytvořené	celočíselný	Časové razítko unixu při vytvoření operace.	Ano
údaje	pole	Výsledná data operace, pokud jsou úspěšná	Ano

výsledek obrázku

Adresa URL obrázku nebo zakódovaný obrázek v případě úspěchu a v opačném případě došlo k chybě.

Název	Typ	Popis	Požaduje se	Výchozí
adresa URL	řetězec	Adresa URL obrázku.	Ne
b64_json	řetězec	Zakódovaný obrázek base64	Ne
výsledky filtru obsahu	dalleContentFilterResults	Informace o výsledcích filtrování obsahu	Ne
revidovaný_příkaz	řetězec	Výzva, která byla použita k vygenerování obrázku, pokud došlo k nějaké revizi výzvy.	Ne
výzva_filtr_výsledků	dalleFilterResults	Informace o kategorii filtrování obsahu (nenávist, sexuální, násilí, self_harm), pokud byla zjištěna, a také úroveň závažnosti (very_low, nízká, střední, vysoká, která určuje intenzitu a úroveň rizika škodlivého obsahu) a jestli byla filtrována nebo ne. Informace o obsahu jailbreaku a vulgárních výrazech, pokud byly zjištěny, a pokud byly filtrovány nebo ne. A informace o seznamu blokovaných zákazníků, pokud byl filtrován a jeho ID.	Ne

Rozšíření dokončení

Rozšíření dokončení nejsou součástí nejnovější verze GA specifikace odvozování roviny dat Azure OpenAI.

Chatová zpráva

Objekt zprávy chatu není součástí nejnovější verze GA specifikace odvozování roviny dat Azure OpenAI.

Převod textu na řeč (Preview)

V současné době není součástí nejnovější verze GA Azure OpenAI specifikace odvozování roviny dat Azure OpenAI. Informace o této funkci najdete v nejnovější verzi Preview .

Další kroky

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