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

Článek
07/10/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-04-01-preview`	`2023-05-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-05-01-preview`	`2024-06-01`	Soubory specifikace	Rozhraní API pro vytváření roviny dat řídí jemné ladění, nahrávání souborů, úlohy příjmu dat a určité dotazy na úrovni modelu.
Rovina dat – odvozování	`2024-05-01-preview`	`2024-06-01`	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/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-06-01

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-06-01

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 nebo pole řetězců. 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. Maximální povolená velikost seznamu řetězců je 2048.	No
max_tokens	integer	Počet tokenů výzvy plus max_tokens nesmí překročit délku kontextu modelu. Většina modelů má kontextovou délku 2048 tokenů (s výjimkou nejnovějších modelů, které podporují 4096). Má minimálně 0.	No	16
Teplota	Číslo	Jaká teplota vzorkování se má použít. Vyšší hodnoty znamenají, že model bude riskovat více. Zkuste 0,9 pro kreativní aplikace a 0 (arg max vzorkování) pro ty s dobře definovanou odpovědí. Obecně doporučujeme toto nebo top_p změnit, 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 změnit tuto nebo teplotu, ale ne obojí.	No	0
logit_bias	objekt	Výchozí hodnota je null. 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. Tento nástroj tokenizátoru (který funguje pro GPT-2 i GPT-3) můžete použít k převodu textu na ID tokenů. 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
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
n	integer	Kolik dokončení se má vygenerovat pro každou výzvu. Minimálně 1 a maximálně 128 povolených. 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 rozumné nastavení pro max_tokens a zastavit.	No	0
datový proud	boolean	Zda se má streamovat zpět částečný průběh. V případě nastavení se tokeny posílají jako události odesílané jen pro data, jakmile budou dostupné, a datový proud je ukončený daty: [HOTOVO].	No	False
protokoly	integer	Zahrňte pravděpodobnosti protokolu do nejpravděpodobnějších tokenů protokolu a také zvolených tokenů. Pokud je například protokol 5, rozhraní API vrátí seznam 5 nejpravděpodobnějších tokenů. Rozhraní API vždy vrátí protokolprob ukázkového tokenu, takže v odpovědi může být až logprobs+1 prvků. Minimálně 0 a maximálně 5 povolených.	No	Nic
přípona	string	Přípona, která následuje po dokončení vloženého textu.	No
echo	boolean	Ozvěte výzvu kromě dokončení.	No	False
Zastavit	řetězec nebo pole	Až 4 sekvence, ve kterých rozhraní API přestane generovat další tokeny. Vrácený text nebude obsahovat sekvenci zastavení.	No
completion_config	string		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
best_of	integer	Vygeneruje best_of dokončení na straně serveru a vrátí "nejlepší" (definovaný jako ten s nejvyšší pravděpodobností protokolu na token). Výsledky se nedají streamovat. Při použití s argumentem n best_of určuje 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 rozumné nastavení pro max_tokens a zastavit. Má maximální hodnotu 128.	No

Odpovědi

Name	Typ	Popis	Požaduje se
ID	string		Ano
objekt	string		Ano
vytvořil	integer		Ano
model	string		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		Ano
využití	objekt		No

Vlastnosti pro použití

completion_tokens

Name	Typ	Popis	Výchozí
completion_tokens	Číslo
prompt_tokens	Číslo
total_tokens	Číslo

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	objekt

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-06-01

{
 "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-06-01

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 získání vkládání zakódovaný jako řetězec. Pokud chcete získat vkládání pro více vstupů v jednom požadavku, předejte pole řetězců. Každý vstup nesmí překročit délku 2048 tokenů. Pokud nevkládáte kód, doporučujeme nahradit nové řádky (\n) ve vstupu jedním mezerou, protože jsme zaznamenali nižší výsledky, když jsou nové řádky přítomné.	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-06-01

{
 "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,
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Dokončení chatu

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

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ž 4 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).	No	4096
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
zprávy	pole	Seznam zpráv, které tvoří dosud konverzaci. Příklad kódu Pythonu	No
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
n	integer	Kolik možností dokončení chatu se má vygenerovat pro každou vstupní zprávu.	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	0
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`. Tato možnost není v modelu aktuálně dostupná `gpt-4-vision-preview` .	No	False
top_logprobs	integer	Celé číslo v rozmezí od 0 do 5 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
response_format	objekt	Objekt určující formát, který musí model vypíše. Používá se k povolení režimu JSON.	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.	No
tool_choice	chatCompletionToolChoiceOption	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 `{"type": "function", "function": {"name": "my_function"}}` , aby model volal danou funkci.	No
– funkce	pole	Zastaralá ve prospěch `tools`. Seznam funkcí, pro které model může generovat vstupy JSON.	No
function_call	řetězec nebo objekt	Zastaralá ve prospěch `tool_choice`. Určuje, jak model reaguje na volání funkcí. "none" znamená, že model nevolá funkci a reaguje na koncového uživatele. "auto" znamená, že model může vybrat mezi koncovým uživatelem 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

Vlastnosti pro response_format

Typ

Název	Typ	Popis	Výchozí
type	chatCompletionResponseFormat	Nastavení pro `json_object` povolení režimu JSON To zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.	text

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	createChatCompletionResponse

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-06-01

{
 "messages": [
  {
   "role": "system",
   "content": "you're 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-06-01

{
 "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-06-01

{
 "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're 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-06-01

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

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

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í modelu šeptu
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-06-01

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-06-01

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

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

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í modelu šeptu, 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-06-01

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

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

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

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 `dall-e` 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	string	Textový popispožadovaných Maximální délka je 4000 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-06-01

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

Licence

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.

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ž 4 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).	No	4096
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

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ž 4 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).	No	4096
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
zprávy	pole	Seznam zpráv, které tvoří dosud konverzaci. Příklad kódu Pythonu	No
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
n	integer	Kolik možností dokončení chatu se má vygenerovat pro každou vstupní zprávu.	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	0
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`. Tato možnost není v modelu aktuálně dostupná `gpt-4-vision-preview` .	No	False
top_logprobs	integer	Celé číslo v rozmezí od 0 do 5 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
response_format	objekt	Objekt určující formát, který musí model vypíše. Používá se k povolení režimu JSON.	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.	No
tool_choice	chatCompletionToolChoiceOption	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 `{"type": "function", "function": {"name": "my_function"}}` , aby model volal danou funkci.	No
– funkce	pole	Zastaralá ve prospěch `tools`. Seznam funkcí, pro které model může generovat vstupy JSON.	No
function_call	řetězec nebo objekt	Zastaralá ve prospěch `tool_choice`. Určuje, jak model reaguje na volání funkcí. "none" znamená, že model nevolá funkci a reaguje na koncového uživatele. "auto" znamená, že model může vybrat mezi koncovým uživatelem 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

Vlastnosti pro response_format

Typ

Název	Typ	Popis	Výchozí
type	chatCompletionResponseFormat	Nastavení pro `json_object` povolení režimu JSON To zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.	text

chatCompletionResponseFormat

Nastavení pro json_object povolení režimu JSON To zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

Popis: Nastavení pro json_object povolení režimu JSON To zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

Typ: řetězec

Výchozí: text

Název výčtu: ChatCompletionResponseFormat

Hodnoty výčtu:

Hodnota	Popis
text	Formát odpovědi je řetězec prostého textu.
json_object	Formát odpovědi je objekt JSON.

chatCompletionFunction

Name	Typ	Popis	Požaduje se
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
popis	string	Popis toho, co funkce dělá.	No
parametry	chatCompletionFunctionParameters	Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON. Dokumentaci k formátu najdete v referenčních informacích ke schématu JSON.	No

chatCompletionFunctionParameters

Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON. Dokumentaci k formátu najdete v referenčních informacích ke schématu JSON.

chatCompletionRequestMessage

Name	Typ	Popis	Požaduje se	Výchozí
role	chatCompletionRequestMessageRole	Role autora zpráv	Ano

chatCompletionRequestMessageRole

Role autora zpráv

Popis: Role autora zpráv.

Typ: řetězec

Výchozí:

Název výčtu: ChatCompletionRequestMessageRole

Hodnoty výčtu:

Hodnota	Popis
systém	Role autora zprávy je systém.
user	Role autora zprávy je uživatel.
asistent	Role autora zprávy je asistent.
nástroj	Role autora zprávy je nástroj.
function	Zastaralé Role autora zprávy je funkce.

chatCompletionRequestMessageSystem

Name	Typ	Popis	Požaduje se	Výchozí
role	chatCompletionRequestMessageRole	Role autora zpráv	Ano
content	string	Obsah zprávy.	No

chatCompletionRequestMessageUser

Name	Typ	Popis	Požaduje se	Výchozí
role	chatCompletionRequestMessageRole	Role autora zpráv	Ano
content	řetězec nebo pole		No

chatCompletionRequestMessageContentPart

Name	Typ	Popis	Požaduje se	Výchozí
type	chatCompletionRequestMessageContentPartType	Typ části obsahu.	Ano

chatCompletionRequestMessageContentPartType

Typ části obsahu.

Popis: Typ části obsahu.

Typ: řetězec

Výchozí:

Název výčtu: ChatCompletionRequestMessageContentPartType

Hodnoty výčtu:

Hodnota	Popis
text	Typ části obsahu je text.
image_url	Typ části obsahu je image_url.

chatCompletionRequestMessageContentPartText

Name	Typ	Popis	Požaduje se	Výchozí
type	chatCompletionRequestMessageContentPartType	Typ části obsahu.	Ano
text	string	Textový obsah.	No

chatCompletionRequestMessageContentPartImage

Name	Typ	Popis	Požaduje se	Výchozí
type	chatCompletionRequestMessageContentPartType	Typ části obsahu.	Ano
url	string	Buď adresa URL obrázku, nebo data s kódováním base64 obrázku.	No
detail	imageDetailLevel	Určuje úroveň podrobností obrázku.	No	auto

imageDetailLevel

Určuje úroveň podrobností obrázku.

Popis: Určuje úroveň podrobností obrázku.

Typ: řetězec

Výchozí: automaticky

Název výčtu: ImageDetailLevel

Hodnoty výčtu:

Hodnota	Popis
auto	Úroveň podrobností obrázku je automatická.
low	Úroveň podrobností obrázku je nízká.
vysoko	Úroveň podrobností obrázku je vysoká.

chatCompletionRequestMessageAssistant

Name	Typ	Popis	Požaduje se
role	chatCompletionRequestMessageRole	Role autora zpráv	Ano
content	string	Obsah zprávy.	No
tool_calls	pole	Nástroj volá volání vygenerovaná modelem, například volání funkcí.	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

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 Ten bude používat chat.
Žádost o dokončení, která by měla k rozšíření chování odpovědi 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 Funkce dat použije toto nasazení modelu prostřednictvím interního volání, nikoli veřejného volání, které 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í, je založený na koncovém bodu veřejného vkládání pro Azure OpenAI.

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

Citace informací o odpovědích 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

Název

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 vaší 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
role	chatCompletionRequestMessageRole	Role autora zpráv	Ano
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	Ano
jméno	string	Obsah zprávy.	No
content	string	Obsah zprávy.	No

createChatCompletionResponse

Name	Typ	Popis	Požaduje se
ID	řetězec	Jedinečný identifikátor dokončení chatu.	Ano
objekt	chatCompletionResponseObject	Typ objektu.	Ano
vytvořil	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
využití	completionUsage	Statistiky využití žádosti o dokončení	No
system_fingerprint	string	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
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		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

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	No
content	string	Obsah zprávy.	No
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á 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 {"type": "function", "function": {"name": "my_function"}} , aby model volal danou funkci.

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	No
function	objekt		No

Vlastnosti funkce

Název

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

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 vaší funkce. Před voláním funkce ověřte argumenty v kódu.	Ano

chatCompletionsResponseCommon

Name	Typ	Popis	Požaduje se
ID	řetězec	Jedinečný identifikátor dokončení chatu.	Ano
objekt	chatCompletionResponseObject	Typ objektu.	Ano
vytvořil	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
využití	completionUsage	Statistiky využití žádosti o dokončení	No
system_fingerprint	string	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

chatCompletionResponseObject

Typ objektu.

Popis: Typ objektu.

Typ: řetězec

Výchozí:

Název výčtu: ChatCompletionResponseObject

Hodnoty výčtu:

Hodnota	Popis
chat.completion	Typ objektu je dokončení chatu.

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

chatCompletionTool

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

Vlastnosti funkce

Popis

Name	Typ	Popis	Výchozí
description	string	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.

Název

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

Parametry

Název	Typ	Popis	Výchozí
parametry	chatCompletionFunctionParameters	Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON. Dokumentaci k formátu najdete v referenčních informacích ke schématu JSON.

chatCompletionToolType

Typ nástroje. V současné době se podporuje pouze function .

Popis: Typ nástroje. V současné době se podporuje pouze function .

Typ: řetězec

Výchozí:

Název výčtu: ChatCompletionToolType

Hodnoty výčtu:

Hodnota	Popis
function	Typ nástroje je funkce.

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	Počáteční posun 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	Pravděpodobnost "bez řeči".	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 4000 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řil	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

Vlastnosti pro použití

completion_tokens

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

Vlastnosti pro response_format

Typ

Odpovědi

Příklady

Příklad

Příklad

Příklad

Příklad

Přepisy

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Příklady

Příklad

Příklad

Překlady

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

Licence

contentFilterResultsBase

contentFilterPromptResults

contentFilterChoiceResults

promptFilterResult