Referenční informace k rozhraní Azure OpenAI Service REST API

Článek
11/02/2024

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.

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 Azure AI. 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í	`2024-10-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í	`2024-10-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í, řeč/šeptání, na vaše 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	Type	Popis
endpoint	path	Ano	string 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
deployment-id	path	Ano	string	ID nasazení modelu, který byl nasazen.
verze-api	query	Ano	string	Verze rozhraní API

Hlavička požadavku

Název	Požadováno	Type	Popis
api-key	True	string	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Name	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
best_of	integer	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_tokens` `stop`.	No	0
echo	boolean	Ozvěte výzvu kromě dokončení.	No	False
frequency_penalty	Čí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.	No	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\|> .	No	Nic
protokoly	integer	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.	No	Nic
max_tokens	integer	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.	No	16
n	integer	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_tokens` `stop`.	No	0
presence_penalty	Čí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.	No	0
semeno	integer	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.	No
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í.	No
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 pro data, jakmile budou k dispozici, a datový proud je ukončen zprávou`data: [DONE]`.	No	False
přípona	string	Přípona, která následuje po dokončení vloženého textu. Tento parametr je podporován pouze pro `gpt-3.5-turbo-instruct`.	No	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í.	No	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í.	No	0
user	string	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	No

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	Type	Popis
endpoint	path	Ano	string 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
deployment-id	path	Ano	string
verze-api	query	Ano	string	Verze rozhraní API

Hlavička požadavku

Název	Požadováno	Type	Popis
api-key	True	string	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Name	Typ	Popis	Požaduje se
input	ř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
user	string	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í.	No
input_type	string	vstupní typ vkládání hledání, které se má použít	No
encoding_format	string	Formát pro vrácení vložených objektů. Může to být buď `float` nebo `base64`. Výchozí hodnota `float`je .	No
dimensions	integer	Početdimenzích Podporováno pouze v `text-embedding-3` novějších modelech.	No

Odpovědi

Name	Typ	Požaduje se
objekt	string	Ano
model	string	Ano
data	pole	Ano
využití	objekt	Ano

Vlastnosti pro použití

prompt_tokens

Name	Typ	Popis	Výchozí
prompt_tokens	integer

total_tokens

Name	Typ	Popis	Výchozí
total_tokens	integer

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	Type	Popis
endpoint	path	Ano	string 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
deployment-id	path	Ano	string	ID nasazení modelu, který byl nasazen.
verze-api	query	Ano	string	Verze rozhraní API

Hlavička požadavku

Název	Požadováno	Type	Popis
api-key	True	string	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Name	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í.	No	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í.	No	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]`.	No	False
Zastavit	řetězec nebo pole	Až čtyři sekvence, ve kterých rozhraní API přestane generovat další tokeny.	No
max_tokens	integer	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.	No
max_completion_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro dokončení, včetně viditelných výstupních tokenů a zdůvodnění tokenů.	No
presence_penalty	Čí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.	No	0
frequency_penalty	Čí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.	No	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.	No	Nic
user	string	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	No
zprávy	pole	Seznam zpráv, které tvoří dosud konverzaci.	Ano
data_sources	pole	Položky konfigurace pro rozšíření chatu Azure OpenAI, které je používají. Tato další specifikace je kompatibilní pouze s Azure OpenAI.	No
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ě `content` `message`.	No	False
top_logprobs	integer	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.	No
n	integer	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ů.	No	0
parallel_tool_calls	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	No	True
response_format	ResponseFormatText nebo ResponseFormatJsonObject nebo ResponseFormatJsonSchema	Objekt určující formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4o mini, GPT-4 Turbo a všechny GPT-3.5 Turbo modely novější než `gpt-3.5-turbo-1106`. 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íte také 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.	No
semeno	integer	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.	No
tools	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í.	No
tool_choice	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.	No
function_call	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.	No
– funkce	pole	Zastaralá ve prospěch `tools`. Seznam funkcí, pro které model může generovat vstupy JSON.	No

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	Type	Popis
endpoint	path	Ano	string 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
deployment-id	path	Ano	string	ID nasazení šeptaného modelu.
verze-api	query	Ano	string	Verze rozhraní API

Hlavička požadavku

Název	Požadováno	Type	Popis
api-key	True	string	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: multipart/form-data

Name	Typ	Popis	Požaduje se	Výchozí
soubor	string	Objekt zvukového souboru, který se má přepisovat.	Ano
pobídnout	string	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla odpovídat jazyku zvuku.	No
response_format	audioResponseFormat	Definuje formát výstupu.	No
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.	No	0
jazyk	string	Jazyk vstupního zvuku. Poskytnutí jazyka zadávání vstupu ve formátu ISO-639-1 zlepší přesnost a latenci.	No

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	audioResponse nebo audioVerboseResponse
text/plain	string	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	Type	Popis
endpoint	path	Ano	string 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
deployment-id	path	Ano	string	ID nasazení šeptaného modelu, který byl nasazen.
verze-api	query	Ano	string	Verze rozhraní API

Hlavička požadavku

Název	Požadováno	Type	Popis
api-key	True	string	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: multipart/form-data

Name	Typ	Popis	Požaduje se	Výchozí
soubor	string	Zvukový soubor, který chcete přeložit.	Ano
pobídnout	string	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla být v angličtině.	No
response_format	audioResponseFormat	Definuje formát výstupu.	No
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.	No	0

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	audioResponse nebo audioVerboseResponse
text/plain	string	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	Type	Popis
endpoint	path	Ano	string 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
deployment-id	path	Ano	string	ID nasazení modelu dall-e, který byl nasazen.
verze-api	query	Ano	string	Verze rozhraní API

Hlavička požadavku

Název	Požadováno	Type	Popis
api-key	True	string	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Name	Typ	Popis	Požaduje se	Výchozí
pobídnout	string	Textový popispožadovaných Maximální délka je 4 000 znaků.	Ano
n	integer	Počet obrázků, které se mají vygenerovat.	No	0
size	imageSize	Velikost vygenerovaných obrázků.	No	1024 × 1024
response_format	imagesResponseFormat	Formát, ve kterém se vrátí vygenerované obrázky.	No	url
user	string	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	No
kvalita	imageQuality	Kvalita image, která se vygeneruje.	No	standard
– styl	imageStyle	Styl vygenerovaných obrázků	No	ž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

errorResponse

Name	Typ	Popis	Požaduje se	Výchozí
chyba	chyba		No

errorBase

Name	Typ	Popis	Požaduje se	Výchozí
code	string		No
zpráva	string		No

chyba

Name	Typ	Popis	Požaduje se
Param	string		No
type	string		No
inner_error	innerError	Vnitřní chyba s dalšími podrobnostmi	No

innerError

Vnitřní chyba s dalšími podrobnostmi

Name	Typ	Popis	Požaduje se	Výchozí
code	innerErrorCode	Kódy chyb pro vnitřní objekt chyby.	No
content_filter_results	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.	No

innerErrorCode

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
ResponsibleAIPolicyViolation	Výzva porušila jedno z více pravidel filtru obsahu.

dalleErrorResponse

Name	Typ	Popis	Požaduje se	Výchozí
chyba	dalleError		No

dalleError

Name	Typ	Popis	Požaduje se
Param	string		No
type	string		No
inner_error	dalleInnerError	Vnitřní chyba s dalšími podrobnostmi	No

dalleInnerError

Vnitřní chyba s dalšími podrobnostmi

Name	Typ	Popis	Požaduje se
code	innerErrorCode	Kódy chyb pro vnitřní objekt chyby.	No
content_filter_results	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.	No
revised_prompt	string	Výzva, která byla použita k vygenerování obrázku, pokud došlo k nějaké revizi výzvy.	No

contentFilterResultBase

Name	Typ	Popis	Požaduje se	Výchozí
filtrovaný	boolean		Ano

contentFilterSeverityResult

Name	Typ	Popis	Požaduje se	Výchozí
filtrovaný	boolean		Ano
závažnost	string		No

contentFilterDetectedResult

Name	Typ	Popis	Požaduje se	Výchozí
filtrovaný	boolean		Ano
zjištěný	boolean		No

contentFilterDetectedWithCitationResult

Name	Typ	Popis	Požaduje se	Výchozí
citace	objekt		No

Vlastnosti citace

Adresa URL

Name	Typ	Popis	Výchozí
URL	string

license

Name	Typ	Popis	Výchozí
license	string

contentFilterResultsBase

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

Name	Typ	Požaduje se
sexuální	contentFilterSeverityResult	No
násilí	contentFilterSeverityResult	No
nenávist	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
rouhání	contentFilterDetectedResult	No
chyba	errorBase	No

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.

Name	Typ	Požaduje se
sexuální	contentFilterSeverityResult	No
násilí	contentFilterSeverityResult	No
nenávist	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
rouhání	contentFilterDetectedResult	No
chyba	errorBase	No
útěk z vězení	contentFilterDetectedResult	No

contentFilterChoiceResults

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.

Name	Typ	Požaduje se
sexuální	contentFilterSeverityResult	No
násilí	contentFilterSeverityResult	No
nenávist	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
rouhání	contentFilterDetectedResult	No
chyba	errorBase	No
protected_material_text	contentFilterDetectedResult	No
protected_material_code	contentFilterDetectedWithCitationResult	No

promptFilterResult

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

Name	Typ	Popis	Požaduje se	Výchozí
prompt_index	integer		No
content_filter_results	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.	No

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.

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

dalleContentFilterResults

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

Name	Typ	Požaduje se
sexuální	contentFilterSeverityResult	No
násilí	contentFilterSeverityResult	No
nenávist	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No

dalleFilterResults

Name	Typ	Požaduje se
sexuální	contentFilterSeverityResult	No
násilí	contentFilterSeverityResult	No
nenávist	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
rouhání	contentFilterDetectedResult	No
útěk z vězení	contentFilterDetectedResult	No

chatCompletionsRequestCommon

Name	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í.	No	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í.	No	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]` .	No	False
Zastavit	řetězec nebo pole	Až čtyři sekvence, ve kterých rozhraní API přestane generovat další tokeny.	No
max_tokens	integer	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_tokens`a není kompatibilní s modely řad o1.	No	4096
max_completion_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro dokončení, včetně viditelných výstupních tokenů a zdůvodnění tokenů.	No
presence_penalty	Čí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.	No	0
frequency_penalty	Čí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.	No	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.	No
user	string	Jedinečný identifikátor představující koncového uživatele, který může azure OpenAI pomoct monitorovat a zjišťovat zneužití.	No

createCompletionRequest

Name	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
best_of	integer	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_tokens` `stop`.	No	0
echo	boolean	Ozvěte výzvu kromě dokončení.	No	False
frequency_penalty	Čí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.	No	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\|> .	No	Nic
protokoly	integer	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.	No	Nic
max_tokens	integer	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.	No	16
n	integer	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_tokens` `stop`.	No	0
presence_penalty	Čí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.	No	0
semeno	integer	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.	No
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í.	No
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 pro data, jakmile budou k dispozici, a datový proud je ukončen zprávou`data: [DONE]`.	No	False
přípona	string	Přípona, která následuje po dokončení vloženého textu. Tento parametr je podporován pouze pro `gpt-3.5-turbo-instruct`.	No	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í.	No	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í.	No	0
user	string	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	No

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).

Name	Typ	Popis	Požaduje se
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é	integer	Časové razítko unixu (v sekundách) doby vytvoření dokončení.	Ano
model	string	Model použitý k dokončení.	Ano
prompt_filter_results	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.	No
system_fingerprint	string	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.	No
objekt	enum	Typ objektu, který je vždy "text_completion" Možné hodnoty: text_completion	Ano
využití	completionUsage	Statistiky využití žádosti o dokončení	No

createChatCompletionRequest

Name	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í.	No	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í.	No	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]`.	No	False
Zastavit	řetězec nebo pole	Až čtyři sekvence, ve kterých rozhraní API přestane generovat další tokeny.	No
max_tokens	integer	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.	No
max_completion_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro dokončení, včetně viditelných výstupních tokenů a zdůvodnění tokenů.	No
presence_penalty	Čí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.	No	0
frequency_penalty	Čí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.	No	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.	No	Nic
user	string	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	No
zprávy	pole	Seznam zpráv, které tvoří dosud konverzaci.	Ano
data_sources	pole	Položky konfigurace pro rozšíření chatu Azure OpenAI, které je používají. Tato další specifikace je kompatibilní pouze s Azure OpenAI.	No
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ě `content` `message`.	No	False
top_logprobs	integer	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.	No
n	integer	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ů.	No	0
parallel_tool_calls	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	No	True
response_format	ResponseFormatText nebo ResponseFormatJsonObject nebo ResponseFormatJsonSchema	Objekt určující formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4o mini, GPT-4 Turbo a všechny GPT-3.5 Turbo modely novější než `gpt-3.5-turbo-1106`. 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íte také 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.	No
semeno	integer	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.	No
tools	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í.	No
tool_choice	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.	No
function_call	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.	No
– funkce	pole	Zastaralá ve prospěch `tools`. Seznam funkcí, pro které model může generovat vstupy JSON.	No

chatCompletionFunctions

Name	Typ	Popis	Požaduje se
description	string	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.	No
name	string	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ů.	No

chatCompletionFunctionCallOption

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

Name	Typ	Popis	Požaduje se	Výchozí
name	string	Název funkce, která se má volat.	Ano

chatCompletionRequestMessage

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

chatCompletionRequestSystemMessage

Name	Typ	Popis	Požaduje se
content	řetězec nebo pole	Obsah systémové zprávy.	Ano
role	enum	Role autora zpráv v tomto případě `system`. Možné hodnoty: systém	Ano
jméno	string	Volitelné jméno účastníka. Poskytuje informace o modelu pro rozlišení mezi účastníky stejné role.	No

chatCompletionRequestUserMessage

Name	Typ	Popis	Požaduje se
content	řetězec nebo pole	Obsah zprávy uživatele.	Ano
role	enum	Role autora zpráv v tomto případě `user`. Možné hodnoty: uživatel	Ano
jméno	string	Volitelné jméno účastníka. Poskytuje informace o modelu pro rozlišení mezi účastníky stejné role.	No

chatCompletionRequestAssistantMessage

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

Vlastnosti pro function_call

argumenty

Name	Typ	Popis	Výchozí
argumenty	string	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.

name

Name	Typ	Popis	Výchozí
name	string	Název funkce, která se má volat.

chatCompletionRequestToolMessage

Name	Typ	Popis	Požaduje se
role	enum	Role autora zpráv v tomto případě `tool`. Možné hodnoty: nástroj	Ano
content	řetězec nebo pole	Obsah zprávy nástroje	Ano
tool_call_id	string	Volání nástroje, na které tato zpráva reaguje.	Ano

chatCompletionRequestFunctionMessage

Name	Typ	Popis	Požaduje se
role	enum	Role autora zpráv v tomto případě `function`. Možné hodnoty: funkce	Ano
content	string	Obsah zprávy funkce.	Ano
jméno	string	Název funkce, která se má volat.	Ano

chatCompletionRequestSystemMessageContentPart

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

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestAssistantMessageContentPart

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

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

Name	Typ	Popis	Požaduje se	Výchozí
type	enum	Typ části obsahu. Možné hodnoty: text	Ano
text	string	Textový obsah.	Ano

chatCompletionRequestMessageContentPartImage

Name	Typ	Popis	Požaduje se	Výchozí
type	enum	Typ části obsahu. Možné hodnoty: image_url	Ano
image_url	objekt		Ano

Vlastnosti pro image_url

url

Name	Typ	Popis	Výchozí
url	string	Buď adresa URL obrázku, nebo data s kódováním base64 obrázku.

detail

Name	Typ	Popis	Výchozí
detail	string	Určuje úroveň podrobností obrázku. Další informace najdete v průvodci vision.	auto

chatCompletionRequestMessageContentPartRefusal

Name	Typ	Popis	Požaduje se	Výchozí
type	enum	Typ části obsahu. Možné hodnoty: odmítnutí	Ano
odmítnutí	string	Odmítnutí zprávy generované modelem.	Ano

azureChatExtensionConfiguration

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.

Name	Typ	Popis	Požaduje se	Výchozí
type	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

azureChatExtensionType

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
azure_search	Představuje použití služby Azure Search jako rozšíření chatu Azure OpenAI.
azure_cosmos_db	Představuje použití služby Azure Cosmos DB jako rozšíření chatu Azure OpenAI.

azureSearchChatExtensionConfiguration

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

Name	Typ	Popis	Požaduje se	Výchozí
type	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	No

azureSearchChatExtensionParameters

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

Name	Typ	Popis	Požaduje se
ověřování	onYourDataApiKeyAuthenticationOptions nebo onYourDataSystemAssignedManagedIdentityAuthenticationOptions nebo onYourDataUserAssignedManagedIdentityAuthenticationOptions		Ano
top_n_documents	integer	Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz.	No
in_scope	boolean	Určuje, jestli se dotazy mají omezit na použití indexovaných dat.	No
přísnost	integer	Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi.	No
role_information	string	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.	No
endpoint	string	Absolutní cesta ke koncovému bodu pro prostředek Azure Search, který se má použít.	Ano
index_name	string	Název indexu, který se má použít jako dostupný v odkazovaném prostředku služby Azure Search.	Ano
fields_mapping	azureSearchIndexFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Služby Azure Search	No
query_type	azureSearchQueryType	Typ vyhledávacího dotazu Služby Azure Search, který se má spustit při použití jako rozšíření chatu Azure OpenAI.	No
semantic_configuration	string	Další sémantická konfigurace dotazu.	No
filter	string	Filtr hledání.	No
embedding_dependency	onYourDataEndpointVectorizationSource nebo onYourDataDeploymentNameVectorizationSource		No

azureSearchIndexFieldMappingOptions

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

Name	Typ	Popis	Požaduje se
title_field	string	Název pole indexu, které se má použít jako název.	No
url_field	string	Název pole indexu, které se má použít jako adresa URL.	No
filepath_field	string	Název pole indexu, které se má použít jako cesta k souboru.	No
content_fields	pole	Názvy polí indexu, která by se měla považovat za obsah.	No
content_fields_separator	string	Vzor oddělovače, který mají pole obsahu používat.	No
vector_fields	pole	Názvy polí, která představují vektorová data.	No

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.
vector_simple_hybrid	Představuje kombinaci jednoduché strategie dotazu s vektorovými daty.
vector_semantic_hybrid	Představuje kombinaci sémantického vyhledávání a dotazování vektorových dat.

azureCosmosDBChatExtensionConfiguration

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

Name	Typ	Popis	Požaduje se	Výchozí
type	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	No

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

Name	Typ	Popis	Požaduje se
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	integer	Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz.	No
in_scope	boolean	Určuje, jestli se dotazy mají omezit na použití indexovaných dat.	No
přísnost	integer	Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi.	No
role_information	string	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.	No
database_name	string	Název databáze MongoDB vCore, který se má použít se službou Azure Cosmos DB.	Ano
container_name	string	Název kontejneru prostředků služby Azure Cosmos DB.	Ano
index_name	string	Název indexu virtuálních jader MongoDB, který se má použít se službou Azure Cosmos DB.	Ano
fields_mapping	azureCosmosDBFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Služby Azure Cosmos DB	Ano
embedding_dependency	onYourDataEndpointVectorizationSource nebo onYourDataDeploymentNameVectorizationSource		Ano

azureCosmosDBFieldMappingOptions

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

Name	Typ	Popis	Požaduje se
title_field	string	Název pole indexu, které se má použít jako název.	No
url_field	string	Název pole indexu, které se má použít jako adresa URL.	No
filepath_field	string	Název pole indexu, které se má použít jako cesta k souboru.	No
content_fields	pole	Názvy polí indexu, která by se měla považovat za obsah.	Ano
content_fields_separator	string	Vzor oddělovače, který mají pole obsahu používat.	No
vector_fields	pole	Názvy polí, která představují vektorová data.	Ano

onYourDataAuthenticationOptions

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

Name	Typ	Popis	Požaduje se	Výchozí
type	onYourDataAuthenticationType	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Ano

onYourDataAuthenticationType

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
api_key	Ověřování prostřednictvím klíče rozhraní API
connection_string	Ověřování prostřednictvím připojovací řetězec.
system_assigned_managed_identity	Ověřování prostřednictvím spravované identity přiřazené systémem
user_assigned_managed_identity	Ověřování prostřednictvím spravované identity přiřazené uživatelem

onYourDataApiKeyAuthenticationOptions

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

Name	Typ	Popis	Požaduje se	Výchozí
type	onYourDataAuthenticationType	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Ano
klíč	string	Klíč rozhraní API, který se má použít k ověřování.	No

onYourDataConnectionStringAuthenticationOptions

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

Name	Typ	Popis	Požaduje se	Výchozí
type	onYourDataAuthenticationType	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Ano
connection_string	string	Připojovací řetězec použít k ověřování.	No

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

Name	Typ	Popis	Požaduje se	Výchozí
type	onYourDataAuthenticationType	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Ano

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

Name	Typ	Popis	Požaduje se	Výchozí
type	onYourDataAuthenticationType	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Ano
managed_identity_resource_id	string	ID prostředku spravované identity přiřazené uživatelem, které se má použít k ověřování.	No

onYourDataVectorizationSource

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

Name	Typ	Popis	Požaduje se	Výchozí
type	onYourDataVectorizationSourceType	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
endpoint	Představuje vektorizaci prováděnou voláními veřejné služby do modelu vkládání Azure OpenAI.
deployment_name	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.

Name	Typ	Popis	Požaduje se	Výchozí
type	onYourDataVectorizationSourceType	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
deployment_name	string	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.	No

onYourDataEndpointVectorizationSource

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í.

Name	Typ	Popis	Požaduje se
type	onYourDataVectorizationSourceType	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í	onYourDataApiKeyAuthenticationOptions	Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití klíče rozhraní API	No
endpoint	string	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.	No

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í.

Name	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.	No
Záměr	string	Rozpoznaný záměr z historie chatu, který se používá k předání do dalšího turnu, který přenese kontext.	No

citace

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

Name	Typ	Popis	Požaduje se
content	string	Obsah citace.	Ano
title	string	Název citace.	No
url	string	Adresa URL citace.	No
cesta k souboru	string	Cesta k souboru citace.	No
chunk_id	string	ID bloku citace.	No

chatCompletionMessageToolCall

Name	Typ	Popis	Požaduje se
ID	řetězec	ID volání nástroje.	Ano
type	toolCallType	Typ volání nástroje v tomto případě `function`.	Ano
function	objekt	Funkce, kterou model volal.	Ano

Vlastnosti funkce

name

Name	Typ	Popis	Výchozí
name	string	Název funkce, která se má volat.

argumenty

Name	Typ	Popis	Výchozí
argumenty	string	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.

toolCallType

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
function	Typ volání nástroje je funkce.

chatCompletionRequestMessageTool

Name	Typ	Popis	Požaduje se	Výchozí
tool_call_id	string	Volání nástroje, na které tato zpráva reaguje.	No
content	string	Obsah zprávy.	No

chatCompletionRequestMessageFunction

Name	Typ	Popis	Požaduje se
role	enum	Role autora zpráv v tomto případě `function`. Možné hodnoty: funkce	No
name	string	Obsah zprávy.	No
content	string	Obsah zprávy.	No

createChatCompletionResponse

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

Name	Typ	Popis	Požaduje se
ID	řetězec	Jedinečný identifikátor dokončení chatu.	Ano
prompt_filter_results	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.	No
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é	integer	Časové razítko unixu (v sekundách) doby vytvoření dokončení chatu.	Ano
model	string	Model použitý k dokončení chatu.	Ano
system_fingerprint	string	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.	No
objekt	enum	Typ objektu, který je vždy `chat.completion`. Možné hodnoty: chat.completion	Ano
využití	completionUsage	Statistiky využití žádosti o dokončení	No

createChatCompletionStreamResponse

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

Name	Typ	Popis	Požaduje se
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é	integer	Časové razítko unixu (v sekundách) doby vytvoření dokončení chatu. Každý blok dat má stejné časové razítko.	Ano
model	string	Model pro vygenerování dokončení.	Ano
system_fingerprint	string	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.	No
objekt	enum	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

Name	Typ	Popis	Požaduje se
content	string	Obsah zprávy bloku dat.	No
function_call	objekt	Zastaralé a nahrazené .`tool_calls` Název a argumenty funkce, které by se měly volat, jak je vygeneroval model.	No
tool_calls	pole		No
role	enum	Role autora této zprávy Možné hodnoty: systém, uživatel, asistent, nástroj	No
odmítnutí	string	Odmítnutí zprávy generované modelem.	No

Vlastnosti pro function_call

argumenty

Name	Typ	Popis	Výchozí
argumenty	string	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.

name

Name	Typ	Popis	Výchozí
name	string	Název funkce, která se má volat.

chatCompletionMessageToolCallChunk

Name	Typ	Popis	Požaduje se
index	integer		Ano
ID	řetězec	ID volání nástroje.	No
type	enum	Typ nástroje. V současné době se podporuje pouze `function` . Možné hodnoty: funkce	No
function	objekt		No

Vlastnosti funkce

name

Name	Typ	Popis	Výchozí
name	string	Název funkce, která se má volat.

argumenty

Name	Typ	Popis	Výchozí
argumenty	string	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.

chatCompletionStreamOptions

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

Name	Typ	Popis	Požaduje se	Výchozí
include_usage	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.	No

chatCompletionChoiceLogProbs

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

Name	Typ	Popis	Požaduje se	Výchozí
content	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.	No

chatCompletionTokenLogprob

Name	Typ	Popis	Požaduje se
token	string	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

chatCompletionResponseMessage

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

Name	Typ	Popis	Požaduje se
role	chatCompletionResponseMessageRole	Role autora zprávy odpovědi	Ano
odmítnutí	string	Odmítnutí zprávy generované modelem.	Ano
content	string	Obsah zprávy.	Ano
tool_calls	pole	Nástroj volá volání vygenerovaná modelem, například volání funkcí.	No
function_call	chatCompletionFunctionCall	Zastaralé a nahrazené .`tool_calls` Název a argumenty funkce, které by se měly volat, jak je vygeneroval model.	No
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í.	No

chatCompletionResponseMessageRole

Role autora zprávy odpovědi

Popis: Role autora zprávy odpovědi.

Typ: řetězec

Výchozí:

Hodnoty výčtu:

asistent

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.

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

chatCompletionNamedToolChoice

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

Name	Typ	Popis	Požaduje se	Výchozí
type	enum	Typ nástroje. V současné době se podporuje pouze `function` . Možné hodnoty: funkce	Ano
function	objekt		Ano

Vlastnosti funkce

name

Name	Typ	Popis	Výchozí
name	string	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.

chatCompletionMessageToolCalls

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

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

chatCompletionFunctionCall

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

Name	Typ	Popis	Požaduje se	Výchozí
name	string	Název funkce, která se má volat.	Ano
argumenty	string	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

completionUsage

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

Name	Typ	Popis	Požaduje se
prompt_tokens	integer	Počet tokenů v příkazovém řádku	Ano
completion_tokens	integer	Počet tokenů ve vygenerovaném dokončení	Ano
total_tokens	integer	Celkový počettokench	Ano
completion_tokens_details	objekt	Rozpis tokenů použitých při dokončování	No

Vlastnosti pro completion_tokens_details

reasoning_tokens

Name	Typ	Popis	Výchozí
reasoning_tokens	integer	Tokeny vygenerované modelem z důvodu odůvodnění

chatCompletionTool

Name	Typ	Popis	Požaduje se	Výchozí
type	enum	Typ nástroje. V současné době se podporuje pouze `function` . Možné hodnoty: funkce	Ano
function	FunctionObject		Ano

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ů.

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

FunctionObject

Name	Typ	Popis	Požaduje se	Výchozí
description	string	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.	No
name	string	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ů.	No
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`.	No	False

ResponseFormatText

Name	Typ	Popis	Požaduje se	Výchozí
type	enum	Typ formátu odpovědi, který se definuje: `text` Možné hodnoty: text	Ano

ResponseFormatJsonObject

Name	Typ	Popis	Požaduje se	Výchozí
type	enum	Typ formátu odpovědi, který se definuje: `json_object` Možné hodnoty: json_object	Ano

ResponseFormatJsonSchemaSchema

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

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

ResponseFormatJsonSchema

Name	Typ	Popis	Požaduje se	Výchozí
type	enum	Typ formátu odpovědi, který se definuje: `json_schema` Možné hodnoty: json_schema	Ano
json_schema	objekt		Ano

Vlastnosti pro json_schema

description

Name	Typ	Popis	Výchozí
description	string	Popis formátu odpovědi, který model používá k určení způsobu reakce ve formátu.

name

Name	Typ	Popis	Výchozí
name	string	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.

schema

Name	Typ	Popis	Výchozí
schema	ResponseFormatJsonSchemaSchema	Schéma pro formát odpovědi popsané jako objekt schématu JSON.

přísné

Name	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`.	False

chatCompletionChoiceCommon

Name	Typ	Popis	Požaduje se	Výchozí
index	integer		No
finish_reason	string		No

createTranslationRequest

Žádost o překlad

Name	Typ	Popis	Požaduje se	Výchozí
soubor	string	Zvukový soubor, který chcete přeložit.	Ano
pobídnout	string	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla být v angličtině.	No
response_format	audioResponseFormat	Definuje formát výstupu.	No
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.	No	0

audioResponse

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

Name	Typ	Popis	Požaduje se	Výchozí
text	string	Přeložený nebo přepisovaný text	Ano

audioVerboseResponse

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

Name	Typ	Popis	Požaduje se
text	string	Přeložený nebo přepisovaný text	Ano
úkol	string	Typ zvukového úkolu.	No
jazyk	string	Jazyk.	No
doba trvání	Číslo	Doba trvání.	No
segmenty	pole		No

audioResponseFormat

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

createTranscriptionRequest

Žádost o přepis

Name	Typ	Popis	Požaduje se	Výchozí
soubor	string	Objekt zvukového souboru, který se má přepisovat.	Ano
pobídnout	string	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla odpovídat jazyku zvuku.	No
response_format	audioResponseFormat	Definuje formát výstupu.	No
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.	No	0
jazyk	string	Jazyk vstupního zvuku. Poskytnutí jazyka zadávání vstupu ve formátu ISO-639-1 zlepší přesnost a latenci.	No

audioSegment

Přepis nebo segment překladu

Name	Typ	Popis	Požaduje se
ID	integer	Identifikátor segmentu.	No
hledat	Číslo	Posun segmentu.	No
start	Číslo	Odsazení začátku segmentu	No
end	Číslo	Odsazení konce segmentu	No
text	string	Segmentace textu	No
odznaky	pole	Tokeny textu	No
Teplota	Číslo	Teplota.	No
avg_logprob	Číslo	Průměrná pravděpodobnost protokolu.	No
compression_ratio	Číslo	Poměr komprese.	No
no_speech_prob	Číslo	`no speech`Pravděpodobnost .	No

imageQuality

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.

imagesResponseFormat

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

imageSize

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ů.

imageStyle

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é.

imageGenerationsRequest

Name	Typ	Popis	Požaduje se	Výchozí
pobídnout	string	Textový popispožadovaných Maximální délka je 4 000 znaků.	Ano
n	integer	Počet obrázků, které se mají vygenerovat.	No	0
size	imageSize	Velikost vygenerovaných obrázků.	No	1024 × 1024
response_format	imagesResponseFormat	Formát, ve kterém se vrátí vygenerované obrázky.	No	url
user	string	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	No
kvalita	imageQuality	Kvalita image, která se vygeneruje.	No	standard
– styl	imageStyle	Styl vygenerovaných obrázků	No	živý

generateImagesResponse

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

imageResult

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ě.

Name	Typ	Popis	Požaduje se
url	string	Adresa URL obrázku.	No
b64_json	string	Zakódovaný obrázek base64	No
content_filter_results	dalleContentFilterResults	Informace o výsledcích filtrování obsahu	No
revised_prompt	string	Výzva, která byla použita k vygenerování obrázku, pokud došlo k nějaké revizi výzvy.	No
prompt_filter_results	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.	No

Rozšíření dokončení

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

Chatmessage

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

Text na řeč

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.

Sdílet prostřednictvím

Referenční informace k rozhraní Azure OpenAI Service REST API

Specifikace rozhraní API

Ověřování

Správa verzí rozhraní REST API

Odvození roviny dat

Dokončení

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Příklady

Příklad

Vkládání

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Vlastnosti pro použití

prompt_tokens

total_tokens

Příklady

Příklad

Dokončení chatu

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Příklady

Příklad

Příklad

Příklad

Příklad

Přepisy – vytvoření

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Příklady

Příklad

Příklad

Překlady – Vytvoření

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Příklady

Příklad

Příklad

Generování obrázků

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Příklady

Příklad

Komponenty

errorResponse

errorBase

chyba

innerError

innerErrorCode

dalleErrorResponse

dalleError

dalleInnerError

contentFilterResultBase

contentFilterSeverityResult

contentFilterDetectedResult

contentFilterDetectedWithCitationResult

Vlastnosti citace

Adresa URL

license

contentFilterResultsBase

contentFilterPromptResults

contentFilterChoiceResults

promptFilterResult

promptFilterResults

dalleContentFilterResults

dalleFilterResults

chatCompletionsRequestCommon