Referenční informace k rozhraní REST API modelů Azure OpenAI v Azure AI Foundry

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

Specifikace rozhraní API

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

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

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

Důležité

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

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

Ověřování

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

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

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

Správa verzí rozhraní REST API

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

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

Odvození roviny dat

Zbytek článku popisuje 2025-04-01-preview předběžné vydání specifikace inferování datové vrstvy Azure OpenAI.

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

Dokončení – Vytvoření

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

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

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
ID nasazení	cesta	Ano	řetězec
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	createCompletionResponse

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=2025-04-01-preview

{
 "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í – Vytvoření

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

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

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
ID nasazení	cesta	Ano	řetězec	ID nasazení modelu, který byl nasazen.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

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

Odpovědi

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=2025-04-01-preview

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

Dokončení chatu – Vytvoření

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

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

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
ID nasazení	cesta	Ano	řetězec
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
zvuk	objekt	Parametry zvukového výstupu Požadován při vyžádání zvukového výstupu s modalities: ["audio"].	Ne
└─ Formát	výčet	Určuje výstupní formát zvuku. Musí být jednou z wav, mp3, flac, opus nebo pcm16. Možné hodnoty: wav, mp3, flac, opus, pcm16	Ne
└─ hlas	výčet	Určuje typ hlasu. Podporované hlasy jsou alloy, echo, fable, onyx, nova a shimmer. Možné hodnoty: alloy, echo, fable, onyx, novashimmer	Ne
zdroje_dat	pole	Položky konfigurace pro rozšíření chatu Azure OpenAI, které je používají. Tato další specifikace je kompatibilní pouze s Azure OpenAI.	Ne
trest za frekvenci	Číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.	Ne	0
volání funkce	string nebo chatCompletionFunctionCallOption	Zastaralá ve prospěch tool_choice. Určuje, která funkce (pokud existuje) volána modelem. none znamená, že model nebude volat funkci a místo toho vygeneruje zprávu. auto znamená, že model může vybrat mezi generováním zprávy nebo voláním funkce. Zadáním konkrétní funkce vynutíte {"name": "my_function"} , aby model volal danou funkci. none je výchozí, pokud nejsou k dispozici žádné funkce. auto je výchozí, pokud jsou k dispozici funkce.	Ne
– funkce	pole	Zastaralá ve prospěch tools. Seznam funkcí, pro které model může generovat vstupy JSON.	Ne
logit_bias	objekt	Upravte pravděpodobnost výskytu zadaných tokenů v dokončení. Přijímá objekt JSON, který mapuje tokeny (určené jejich ID tokenu v tokenizátoru) na přidruženou hodnotu předsudku od -100 do 100. Matematicky se před vzorkováním přidá do logitů vygenerovaných modelem. Přesný účinek se bude lišit podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu.	Ne	Nic
protokoly	Boolean	Zda se mají vrátit pravděpodobnosti protokolu výstupních tokenů, nebo ne. Pokud je pravda, vrátí pravděpodobnosti protokolu každého výstupního tokenu vráceného v hodnotě contentmessage.	Ne	Nepravda
maximální_počet_tokenů_dokončení	celočíselný	Horní mez počtu tokenů, které lze vygenerovat pro dokončení, včetně viditelných výstupních tokenů a zdůvodnění tokenů. To je podporováno pouze v modelech řady o1. Rozšíří podporu dalších modelů v budoucí verzi rozhraní API.	Ne
maximální počet tokenů	celočíselný	Maximální počet tokenů, které lze vygenerovat v dokončení chatu. Celková délka vstupních tokenů a vygenerovaných tokenů je omezená délkou kontextu modelu.	Ne
zprávy	pole	Seznam zpráv, které tvoří dosud konverzaci. Příklad kódu Pythonu	Ano
metadatové informace	objekt	Značky a hodnoty definované vývojářem používané k filtrování dokončení na řídicím panelu uložených dokončení	Ne
modality	ChatCompletionModalities	Výstupní typy, které chcete, aby model vygeneroval pro tento požadavek. Většina modelů dokáže generovat text, což je výchozí nastavení: ["text"] Model gpt-4o-audio-preview lze také použít k vygenerování zvuku. Pokud chcete požádat, aby tento model generoval textové i zvukové odpovědi, můžete použít: ["text", "audio"]	Ne
n	celočíselný	Kolik možností dokončení chatu se má vygenerovat pro každou vstupní zprávu. Mějte na paměti, že se vám bude účtovat na základě počtu vygenerovaných tokenů napříč všemi možnostmi. Udržujte n si přehled o 1 minimalizaci nákladů.	Ne	0
paralelní volání nástrojů	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	Ne	Pravdivé
předpověď	PredictionContent	Konfigurace predikovaného výstupu, která může výrazně zlepšit dobu odezvy, když jsou velké části odpovědi modelu známé předem. To je nejběžnější při opětovném vygenerování souboru s pouze menšími změnami většiny obsahu.	Ne
penalizace přítomnosti	Číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.	Ne	0
úsilí o usuzování	výčet	Pouze modely o1 Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty jsou low, mediuma high. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi. Možné hodnoty: low, medium, high	Ne
formát_odpovědi	ResponseFormatText nebo ResponseFormatJsonObject nebo ResponseFormatJsonSchema	Objekt určující formát, který musí model vypíše. Kompatibilní s GPT-4o Nastavení pro { "type": "json_schema", "json_schema": {...} } povolení strukturovaných výstupů, které zaručují, že model bude odpovídat zadanému schématu JSON. Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON. Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.	Ne
semeno	celočíselný	Tato funkce je v beta verzi. Pokud je zadáno, náš systém se bude snažit vzorkovat deterministicky, aby opakované požadavky se stejnými seed parametry měly vrátit stejný výsledek. Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.	Ne
Zastavit	řetězec nebo pole	Až 4 sekvence, ve kterých rozhraní API přestane generovat další tokeny.	Ne
obchod	Boolean	Zda chcete uložit výstup této žádosti o dokončení chatu pro použití v našich modelových destilačních nebo vyhodnocovacích produktech.	Ne
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 Příklad kódu Pythonu	Ne	Nepravda
možnosti streamování	chatCompletionStreamOptions	Možnosti pro odpověď streamování Toto nastavení nastavíte pouze při nastavení stream: true.	Ne	Nic
Teplota	Číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne	0
výběr nástroje	chatCompletionToolChoiceOption	Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádný nástroj a místo toho vygeneruje zprávu. auto znamená, že model si může vybrat mezi generováním zprávy nebo voláním jednoho nebo více nástrojů. required znamená, že model musí volat jeden nebo více nástrojů. Zadáním konkrétního nástroje vynutíte {"type": "function", "function": {"name": "my_function"}} model, aby tento nástroj volal. none je výchozí, pokud nejsou k dispozici žádné nástroje. auto je výchozí, pokud jsou k dispozici nástroje.	Ne
nářadí	pole	Seznam nástrojů, které model může volat. V současné době se jako nástroj podporují jenom funkce. Pomocí tohoto příkazu můžete poskytnout seznam funkcí, pro které může model generovat vstupy JSON. Podporuje se maximálně 128 funkcí.	Ne
top_logprobs	celočíselný	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu. logprobs parametr musí být nastaven na true hodnotu, pokud je použit tento parametr.	Ne
top_p	Číslo	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne	0
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	Ne
uživatelský_kontext_bezpečnosti	userSecurityContext	Kontext zabezpečení uživatele obsahuje několik parametrů, které popisují samotnou aplikaci AI, a koncový uživatel, který komunikuje s aplikací AI. Tato pole pomáhají provozním týmům zabezpečení prošetřit a zmírnit bezpečnostní incidenty tím, že poskytují komplexní přístup k ochraně aplikací umělé inteligence. Přečtěte si další informace o ochraně aplikací AI pomocí programu Microsoft Defender for Cloud.	Ne

Odpovědi

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}/chat/completions?api-version=2025-04-01-preview

{
 "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=2025-04-01-preview

{
 "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ě dat vektoru obrázků služby Azure Search.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "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}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

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."
        }
      }
    ],
    "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=2025-04-01-preview

{
 "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=2025-04-01-preview

{
 "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říklad

Vytvoří dokončení pro zadanou databázi Mongo.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "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říklad

Vytvoří dokončení pro zadané Elasticsearch.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

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í pro zadaný zdroj Pinecone.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

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=2025-04-01-preview

Přepisuje zvuk do vstupního jazyka.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
ID nasazení	cesta	Ano	řetězec
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: multipart/form-data

Název	Typ	Popis	Požaduje se	Výchozí
soubor	řetězec	Objekt zvukového souboru, který se má přepisovat.	Ano
jazyk	řetězec	Jazyk vstupního zvuku. Poskytnutí jazyka zadávání vstupu ve formátu ISO-639-1 zlepší přesnost a latenci.	Ne
pobídnout	řetězec	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla odpovídat jazyku zvuku.	Ne
formát_odpovědi	audioResponseFormat	Definuje formát výstupu.	Ne
Teplota	Číslo	Teplota vzorkování mezi 0 a 1. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Pokud je nastavená hodnota 0, model použije pravděpodobnost protokolu k automatickému zvýšení teploty do dosažení určitých prahových hodnot.	Ne	0
časová_zrnitost[]	pole	Členitosti časového razítka, které se mají pro tento přepis naplnit. response_format musí být nastavená verbose_json tak, aby používala členitosti časového razítka. Podporují se obě tyto možnosti: wordnebo segment. Poznámka: U časových označení segmentů není žádná další latence, ale generování časových označení slov způsobuje další latenci.	Ne	['úsek']

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	objekt
text/obyčejný	řetězec	Přepisovaný text ve výstupním formátu (když response_format byl jeden 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=2025-04-01-preview

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=2025-04-01-preview

"---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=2025-04-01-preview

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

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
ID nasazení	cesta	Ano	řetězec
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: multipart/form-data

Název	Typ	Popis	Požaduje se	Výchozí
soubor	řetězec	Zvukový soubor, který chcete přeložit.	Ano
pobídnout	řetězec	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla být v angličtině.	Ne
formát_odpovědi	audioResponseFormat	Definuje formát výstupu.	Ne
Teplota	Číslo	Teplota vzorkování mezi 0 a 1. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Pokud je nastavená hodnota 0, model použije pravděpodobnost protokolu k automatickému zvýšení teploty do dosažení určitých prahových hodnot.	Ne	0

Odpovědi

Stavový kód: 200

Popis: OK

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

Příklady

Příklad

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---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=2025-04-01-preview

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

Speech – Vytvoření

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

Generuje zvuk ze vstupního textu.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
ID nasazení	cesta	Ano	řetězec
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: multipart/form-data

Název	Typ	Popis	Požaduje se	Výchozí
vstup	řetězec	Text pro syntetizaci zvuku. Maximální délka je 4096 znaků.	Ano
formát_odpovědi	výčet	Formát syntetizování zvuku v. Možné hodnoty: mp3, opus, aac, flac, wavpcm	Ne
rychlost	Číslo	Rychlost syntetizovaného zvuku. Vyberte hodnotu od 0.25 do 4.0. 1.0 je výchozí možnost.	Ne	1.0
hlas	výčet	Hlas, který se má použít pro syntézu řeči. Možné hodnoty: alloy, echo, fable, onyx, novashimmer	Ano

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/octet-stream	řetězec

Příklady

Příklad

Syntetizuje zvuk z poskytnutého textu.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

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

Odpovědi: Stavový kód: 200

{
  "body": "101010101"
}

Generace obrázků – Vytvoření

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

Vygeneruje sérii obrázků z textového titulku, při daném nasazení modelu DALLE nebo gpt-image-1.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
ID nasazení	cesta	Ano	řetězec
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
pozadí	imageBackground	Umožňuje nastavit průhlednost pozadí vygenerovaných obrázků. Tento parametr je podporován pouze pro gpt-image-1.	Ne	Auto
n	celočíselný	Počet obrázků, které se mají vygenerovat. Pro dall-e-3 se podporuje pouze n=1.	Ne	0
komprese_výstupu	celočíselný	Úroveň komprese (0–100%) pro vygenerované obrázky. Tento parametr je podporován pouze pro gpt-image-1 s výstupním formátem jpeg.	Ne	100
formát_výstupu	imagesOutputFormat	Formát souboru, ve kterém se vrátí vygenerované obrázky. Podporováno pouze pro gpt-image-1.	Ne	formát PNG
pobídnout	řetězec	Textový popispožadovaných Maximální délka je 32000 znaků pro gpt-image-1 a 4000 znaků pro dall-e-3.	Ano
kvalita	imageQuality	Kvalita image, která se vygeneruje.	Ne	Auto
formát_odpovědi	imagesResponseFormat	Formát, ve kterém se vrátí vygenerované obrázky.	Ne	adresa URL
velikost	imageSize	Velikost vygenerovaných obrázků.	Ne	Auto
– styl	imageStyle	Styl vygenerovaných obrázků Podporováno pouze pro dall-e-3.	Ne	živý
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	Ne

Odpovědi

Stavový kód: 200

Popis: Ok

Typ obsahu	Typ	Popis
application/json	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=2025-04-01-preview

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Generace obrázků – úpravy

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

Upraví obrázek pomocí textového popisku v rámci daného nasazení modelu gpt-image-1.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	adresa URL řetězce	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
ID nasazení	cesta	Ano	řetězec
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: vícedílný formát/form-data

Název	Typ	Popis	Požaduje se	Výchozí
image	řetězec nebo pole	Obrázky, které chcete upravit. Musí to být podporovaný soubor obrázku nebo pole obrázků. Každý obrázek by měl být soubor png nebo jpg menší než 25 MB.	Ano
maska	řetězec	Další obrázek, jehož plně průhledné oblasti (např. kde alfa je nula), označuje, kde má být obrázek upraven. Pokud je k dispozici více obrázků, použije se maska na první obrázek. Musí to být platný soubor PNG, menší než 4 MB a musí mít stejné rozměry jako obrázek.	Ne
n	celočíselný	Počet obrázků, které se mají vygenerovat.	Ne	0
pobídnout	řetězec	Textový popispožadovaných Maximální délka je 32000 znaků.	Ano
kvalita	imageQuality	Kvalita image, která se vygeneruje.	Ne	Auto
formát_odpovědi	imagesResponseFormat	Formát, ve kterém se vrátí vygenerované obrázky.	Ne	adresa URL
velikost	imageSize	Velikost vygenerovaných obrázků.	Ne	Auto
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	Ne

Odpovědi

Stavový kód: 200

Popis: Ok

Typ obsahu	Typ	Popis
application/json	generateImagesResponse

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	dalleErrorResponse

Seznam – asistenti

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Vrátí seznam asistentů.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
omezení	dotaz	Ne	celočíselný	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
objednávka	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné řazení a desc pro sestupné řazení.
po	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, může následující volání zahrnovat after=obj_foo, aby se načte další stránka seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, počínaje obj_foo, může následující volání zahrnovat před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	listAssistantsResponse

Příklady

Příklad

Vrátí seznam asistentů.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Vytvoření – Asistent

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Vytvořte asistenta s modelem a pokyny.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
popis	řetězec	Popis asistenta. Maximální délka je 512 znaků.	Ne
pokyny	řetězec	Systémové pokyny, které asistent používá. Maximální délka je 256 000 znaků.	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
model	řetězec		Ano
jméno	řetězec	Jméno asistenta. Maximální délka je 256 znaků.	Ne
formát_odpovědi	asistentiApiResponseFormatOption	Určuje formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4 Turbo a všemi modely GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Nastavení { "type": "json_schema", "json_schema": {...} } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat vašemu zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy. { "type": "json_object" } Nastavením povolíte režim JSON, který zajistí, že zpráva, kterou model vygeneruje, je platný JSON. Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.	Ne
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.	Ne	0
nástroje a zdroje	objekt	Sada prostředků, které používají nástroje asistenta. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.	Ne
└ code_interpreter	objekt		Ne
└- file_ids	pole	Seznam ID souborů zpřístupněných nástroji code_interpreter . K nástroji může být přidruženo maximálně 20 souborů.	Ne	[]
└─ file_search	objekt		Ne
└─ identifikátory_úložiště_vektorů	pole	Vektorové úložiště připojené k tomuto asistentovi. K asistentovi může být připojeno maximálně 1 vektorové úložiště.	Ne
└vector_stores	pole	Pomocník pro vytvoření vektorového úložiště s file_ids a jeho připojením k tomuto asistentovi. K asistentovi může být připojeno maximálně 1 vektorové úložiště.	Ne
nářadí	pole	Seznam nástrojů povolených v asistentovi. Na asistenta může být maximálně 128 nástrojů. Nástroje mohou být typu code_interpreter, retrievalnebo function.	Ne	[]
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í.	Ne	0

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	assistantObject

Příklady

Příklad

Vytvořte asistenta s modelem a pokyny.

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Získat – asistent

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Načte asistenta.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
identifikátor_asistenta	cesta	Ano	řetězec	ID asistenta, který se má načíst.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	assistantObject

Příklady

Příklad

Načte asistenta.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Úprava – Asistent

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Upraví asistenta.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
assistant_id	cesta	Ano	řetězec	ID asistenta, který chcete upravit.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
popis	řetězec	Popis asistenta. Maximální délka je 512 znaků.	Ne
pokyny	řetězec	Systémové pokyny, které asistent používá. Maximální délka je 32768 znaků.	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
model	řetězec		Ne
jméno	řetězec	Jméno asistenta. Maximální délka je 256 znaků.	Ne
formát_odpovědi	asistentiApiResponseFormatOption	Určuje formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4 Turbo a všemi modely GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Nastavení { "type": "json_schema", "json_schema": {...} } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat vašemu zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy. { "type": "json_object" } Nastavením povolíte režim JSON, který zajistí, že zpráva, kterou model vygeneruje, je platný JSON. Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.	Ne
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.	Ne	0
nástroje a zdroje	objekt	Sada prostředků, které používají nástroje asistenta. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.	Ne
└ code_interpreter	objekt		Ne
└- file_ids	pole	Přepíše seznam ID souborů zpřístupněných nástroji code_interpreter . K nástroji může být přidruženo maximálně 20 souborů.	Ne	[]
└─ file_search	objekt		Ne
└─ identifikátory_úložiště_vektorů	pole	Přepíše vektorové úložiště připojené k tomuto asistentovi. K asistentovi může být připojeno maximálně 1 vektorové úložiště.	Ne
nářadí	pole	Seznam nástrojů povolených v asistentovi. Na asistenta může být maximálně 128 nástrojů. Nástroje mohou být typu code_interpreter, retrievalnebo function.	Ne	[]
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í.	Ne	0

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	assistantObject

Příklady

Příklad

Upraví asistenta.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Odstranit – Asistent

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Odstraňte asistenta.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
assistant_id	cesta	Ano	řetězec	ID asistenta, který chcete odstranit.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	deleteAssistantResponse

Příklady

Příklad

Odstraní asistenta.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

Vytvoření – vlákno

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Vytvořte vlákno.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
zprávy	pole	Seznam zpráv, se kterými se má vlákno spustit.	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
nástroje a zdroje	objekt	Sada prostředků, které jsou zpřístupněny nástrojům asistenta v tomto vlákně. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.	Ne
└ code_interpreter	objekt		Ne
└- file_ids	pole	Seznam ID souborů zpřístupněných nástroji code_interpreter . K nástroji může být přidruženo maximálně 20 souborů.	Ne	[]
└─file_search	objekt		Ne
└─ identifikátory_úložiště_vektorů	pole	Vektorové úložiště připojené k tomuto vláknu. K vláknu může být připojeno maximálně 1 vektorové úložiště.	Ne
└vector_stores	pole	Pomocná rutina pro vytvoření vektorového úložiště s file_ids a jeho připojení k tomuto vláknu. K vláknu může být připojeno maximálně 1 vektorové úložiště.	Ne

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	threadObject

Příklady

Příklad

Vytvoří vlákno.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

Získat – vlákno

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Načte vlákno.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	URL řetězce	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
identifikátor vlákna	cesta	Ano	řetězec	ID vlákna, které se má načíst.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	threadObject

Příklady

Příklad

Načte vlákno.

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

Úprava – vlákno

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Upraví vlákno.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
identifikátor vlákna	cesta	Ano	řetězec	ID vlákna, které chcete upravit. Pouze metadata lze upravit.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
nástroje a zdroje	objekt	Sada prostředků, které jsou zpřístupněny nástrojům asistenta v tomto vlákně. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.	Ne
└ code_interpreter	objekt		Ne
└- file_ids	pole	Seznam ID souborů zpřístupněných nástroji code_interpreter . K nástroji může být přidruženo maximálně 20 souborů.	Ne	[]
└─ file_search	objekt		Ne
└─ identifikátory_úložiště_vektorů	pole	Vektorové úložiště připojené k tomuto vláknu. K vláknu může být připojeno maximálně 1 vektorové úložiště.	Ne

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	threadObject

Příklady

Příklad

Upraví vlákno.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

Odstranění – vlákno

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Odstraňte vlákno.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
identifikátor vlákna	cesta	Ano	řetězec	ID vlákna, které chcete odstranit.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	deleteThreadResponse

Příklady

Příklad

Odstraní vlákno.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

Seznam – zprávy

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Vrátí seznam zpráv pro dané vlákno.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězcový 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
identifikátor vlákna	cesta	Ano	řetězec	ID vláken, do nichž zprávy patří.
omezení	dotaz	Ne	celočíselný	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
objednávka	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné řazení a desc pro sestupné řazení.
po	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, může následující volání zahrnovat after=obj_foo, aby se načte další stránka seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, počínaje obj_foo, může následující volání zahrnovat před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.
run_id	dotaz	Ne	řetězec	Filtrovat zprávy podle ID spuštění, které je vygenerovalo.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	listMessagesResponse

Příklady

Příklad

Výpis zpráv

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Vytvoření – zpráva

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Vytvořit zprávu.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	adresa URL řetězce	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
identifikátor vlákna	cesta	Ano	řetězec	ID vláken pro vytvoření zprávy.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
přílohy	pole	Seznam souborů připojených ke zprávě a nástroje, do které by se měly přidat.	Ne
obsah	řetězec	Obsah zprávy.	Ano
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
úloha	řetězec	Role entity, která vytváří zprávu. Mezi povolené hodnoty patří: - user: Označuje, že zpráva je odeslána skutečným uživatelem a měla by být použita ve většině případů k reprezentaci uživatelem generovaných zpráv. - assistant: Označuje zprávu vygenerovanou asistentem. Tato hodnota slouží k vložení zpráv z asistenta do konverzace.	Ano

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	messageObject

Příklady

Příklad

Vytvořit zprávu.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

Získat – zpráva

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Načtení zprávy

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
identifikátor vlákna	cesta	Ano	řetězec	ID vláken, do kterých tato zpráva patří.
identifikátor zprávy	cesta	Ano	řetězec	ID zprávy, která se má načíst.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	messageObject

Příklady

Příklad

Načtení zprávy

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Upravit – zpráva

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Upraví zprávu.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
identifikátor vlákna	cesta	Ano	řetězec	ID vlákna, do kterého tato zpráva patří.
identifikátor zprávy	cesta	Ano	řetězec	ID zprávy, kterou chcete upravit.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	messageObject

Příklady

Příklad

Umožňuje změnit zprávu.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

Vytvoření – vlákno a spuštění

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

Vytvořte vlákno a spusťte ho v jednom požadavku.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
assistant_id	řetězec	ID pomocníka, který se má použít ke spuštění tohoto spuštění.	Ano
pokyny	řetězec	Přepište výchozí systémovou zprávu asistenta. To je užitečné při úpravě chování na základě spuštění.	Ne
maximální_počet_tokenů_dokončení	celočíselný	Maximální počet tokenů dokončení, které lze použít v průběhu spuštění. Spuštění bude maximálně usilovat o použití pouze zadaného počtu tokenů dokončení, a to napříč několikanásobným otočením spuštění. Pokud spuštění překročí zadaný počet tokenů dokončení, spuštění skončí stavem incomplete. Další informace najdete incomplete_details .	Ne
max_počet_tokenů_v_promptu	celočíselný	Maximální počet výzev tokenů, které se můžou použít v průběhu spuštění. Spuštění bude maximálně usilovat o použití pouze počtu zadaných tokenů výzvy, a to napříč několikanásobným spuštěním. Pokud spuštění překročí zadaný počet zadaných tokenů výzvy, spuštění skončí se stavem incomplete. Další informace najdete incomplete_details .	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
model	řetězec	ID modelů, které mají být použity v tomto procesu. Pokud je zde zadaná hodnota, přepíše model přidružený k asistentovi. Pokud ne, použije se model přidružený k asistentovi.	Ne
paralelní volání nástrojů	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	Ne	Pravdivé
formát_odpovědi	asistentiApiResponseFormatOption	Určuje formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4 Turbo a všemi modely GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Nastavení { "type": "json_schema", "json_schema": {...} } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat vašemu zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy. { "type": "json_object" } Nastavením povolíte režim JSON, který zajistí, že zpráva, kterou model vygeneruje, je platný JSON. Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.	Ne
datový proud	Boolean	Pokud truevrátí datový proud událostí, ke kterým dochází během událostí odesílaných serverem Spustit jako, ukončení při zadání stavu terminálu se zprávou data: [DONE] .	Ne
možnosti streamování	chatCompletionStreamOptions	Možnosti pro odpověď streamování Toto nastavení nastavíte pouze při nastavení stream: true.	Ne	Nic
Teplota	Číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.	Ne	0
vlákno	createThreadRequest		Ne
výběr nástroje	asistentiApiToolChoiceOption	Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádné nástroje a místo toho vygeneruje zprávu. auto je výchozí hodnota a znamená, že model může vybrat mezi generováním zprávy nebo voláním nástroje. Určení konkrétního nástroje, například {"type": "file_search"} nebo {"type": "function", "function": {"name": "my_function"}} vynutí model, aby tento nástroj volal.	Ne
nástroje a zdroje	objekt	Sada prostředků, které používají nástroje asistenta. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.	Ne
└ code_interpreter	objekt		Ne
└- file_ids	pole	Seznam ID souborů zpřístupněných nástroji code_interpreter . K nástroji může být přidruženo maximálně 20 souborů.	Ne	[]
└─file_search	objekt		Ne
└─ identifikátory_úložiště_vektorů	pole	ID vektorového úložiště připojeného k tomuto asistentovi. K asistentovi může být připojeno maximálně 1 vektorové úložiště.	Ne
nářadí	pole	Přepište nástroje, které může pomocník použít pro toto spuštění. To je užitečné při úpravě chování na základě spuštění.	Ne
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í.	Ne	0
strategie zkracování	truncationObject	Určuje, jak bude vlákno před spuštěním zkráceno. Pomocí tohoto příkazu můžete řídit počáteční kontextové okno spuštění.	Ne

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	runObject

Příklady

Příklad

Vytvořte vlákno a spusťte ho v jednom požadavku.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Seznam – spuštění

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Vrátí seznam spuštění patřících do vlákna.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
identifikátor vlákna	cesta	Ano	řetězec	ID vlákna, ke kterému spuštění náleží.
omezení	dotaz	Ne	celočíselný	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
objednávka	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné řazení a desc pro sestupné řazení.
po	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, může následující volání zahrnovat after=obj_foo, aby se načte další stránka seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, počínaje obj_foo, může následující volání zahrnovat před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	listRunsResponse

Příklady

Příklad

Vrátí seznam spuštění patřících do vlákna.

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

Vytvoření – spuštění

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Vytvořte spuštění.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězcová 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
identifikátor vlákna	cesta	Ano	řetězec	ID vlákna, které se má spustit.
include[]	dotaz	Ne	pole	Seznam dalších polí, která se mají zahrnout do odpovědi. Aktuálně je jedinou podporovanou hodnotou step_details.tool_calls[*].file_search.results[*].content pro načtení obsahu výsledků vyhledávání v souboru.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
dodatečné_instrukce	řetězec	Připojí další pokyny na konec pokynů pro spuštění. To je užitečné pro úpravu chování na základě spuštění bez přepsání dalších instrukcí.	Ne
další_zprávy	pole	Před vytvořením spuštění přidá do vlákna další zprávy.	Ne
asistent_id	řetězec	ID pomocníka, který se má použít ke spuštění tohoto spuštění.	Ano
pokyny	řetězec	Přepište výchozí systémovou zprávu asistenta. To je užitečné při úpravě chování na základě spuštění.	Ne
maximální_počet_tokenů_dokončení	celočíselný	Maximální počet tokenů dokončení, které lze použít v průběhu spuštění. Spuštění bude maximálně usilovat o použití pouze zadaného počtu tokenů dokončení, a to napříč několikanásobným otočením spuštění. Pokud spuštění překročí zadaný počet tokenů dokončení, spuštění skončí stavem incomplete. Další informace najdete incomplete_details .	Ne
max_počet_tokenů_v_promptu	celočíselný	Maximální počet výzev tokenů, které se můžou použít v průběhu spuštění. Spuštění bude maximálně usilovat o použití pouze počtu zadaných tokenů výzvy, a to napříč několikanásobným spuštěním. Pokud spuštění překročí zadaný počet zadaných tokenů výzvy, spuštění skončí se stavem incomplete. Další informace najdete incomplete_details .	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
model	řetězec	ID modelu, který se má použít ke spuštění tohoto spuštění. Pokud je zde zadaná hodnota, přepíše model přidružený k asistentovi. Pokud ne, použije se model přidružený k asistentovi.	Ne
paralelní volání nástrojů	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	Ne	Pravdivé
formát_odpovědi	asistentiApiResponseFormatOption	Určuje formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4 Turbo a všemi modely GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Nastavení { "type": "json_schema", "json_schema": {...} } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat vašemu zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy. { "type": "json_object" } Nastavením povolíte režim JSON, který zajistí, že zpráva, kterou model vygeneruje, je platný JSON. Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.	Ne
datový proud	Boolean	Pokud truevrátí datový proud událostí, ke kterým dochází během událostí odesílaných serverem Spustit jako, ukončení při zadání stavu terminálu se zprávou data: [DONE] .	Ne
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.	Ne	0
výběr nástroje	asistentiApiToolChoiceOption	Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádné nástroje a místo toho vygeneruje zprávu. auto je výchozí hodnota a znamená, že model může vybrat mezi generováním zprávy nebo voláním nástroje. Určení konkrétního nástroje, například {"type": "file_search"} nebo {"type": "function", "function": {"name": "my_function"}} vynutí model, aby tento nástroj volal.	Ne
nářadí	pole	Přepište nástroje, které může pomocník použít pro toto spuštění. To je užitečné při úpravě chování na základě spuštění.	Ne
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í.	Ne	0
strategie zkracování	truncationObject	Určuje, jak bude vlákno před spuštěním zkráceno. Pomocí tohoto příkazu můžete řídit počáteční kontextové okno spuštění.	Ne

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	runObject

Příklady

Příklad

Vytvořte spuštění.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Získat – spustit

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Načte spuštění.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
identifikátor vlákna	cesta	Ano	řetězec	ID vláken, která byla spuštěna.
run_id	cesta	Ano	řetězec	ID spuštění, které se má načíst.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	runObject

Příklady

Příklad

Získá spuštění.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

Upravit – spustit

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Upraví spuštění.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
identifikátor vlákna	cesta	Ano	řetězec	ID vláken, která byla spuštěna.
run_id	cesta	Ano	řetězec	ID spuštění, které chcete upravit.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	runObject

Příklady

Příklad

Upraví spuštění.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Odeslání – výstupy nástrojů ke spuštění

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

Po spuštění se status: "requires_action"required_action.typesubmit_tool_outputsdá tento koncový bod použít k odeslání výstupů z volání nástroje, jakmile se dokončí. Všechny výstupy musí být odeslány v jednom požadavku.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	adresa URL řetězce	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
identifikátor vlákna	cesta	Ano	řetězec	ID vláken, do kterých toto spuštění patří.
run_id	cesta	Ano	řetězec	ID spuštění, které vyžaduje odeslání výstupu nástroje.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
datový proud	Boolean	Pokud truevrátí datový proud událostí, ke kterým dochází během událostí odesílaných serverem Spustit jako, ukončení při zadání stavu terminálu se zprávou data: [DONE] .	Ne
výstupy nástroje	pole	Seznam nástrojů, pro které se odesílají výstupy.	Ano

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	runObject

Příklady

Příklad

Po spuštění se status: "requires_action"required_action.typesubmit_tool_outputsdá tento koncový bod použít k odeslání výstupů z volání nástroje, jakmile se dokončí. Všechny výstupy musí být odeslány v jednom požadavku.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Zrušit – spustit

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Zruší spuštění, které je in_progress.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
identifikátor vlákna	cesta	Ano	řetězec	ID vlákna, do kterého toto spuštění patří.
run_id	cesta	Ano	řetězec	ID spuštění, které chcete zrušit.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	runObject

Příklady

Příklad

Zruší spuštění, které je in_progress.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

Seznam – kroky spuštění

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Vrátí seznam kroků spuštění patřících ke spuštění.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
identifikátor vlákna	cesta	Ano	řetězec	ID vlákna, ke kterému patří běh a kroky běhu.
run_id	cesta	Ano	řetězec	ID spuštění, ke kterému patří kroky běhu.
omezení	dotaz	Ne	celočíselný	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
objednávka	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné řazení a desc pro sestupné řazení.
po	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, může následující volání zahrnovat after=obj_foo, aby se načte další stránka seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, počínaje obj_foo, může následující volání zahrnovat před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.
verze-api	dotaz	Ano	řetězec
include[]	dotaz	Ne	pole	Seznam dalších polí, která se mají zahrnout do odpovědi. Aktuálně je jedinou podporovanou hodnotou step_details.tool_calls[*].file_search.results[*].content pro načtení obsahu výsledků vyhledávání v souboru.

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	listRunStepsResponse

Příklady

Příklad

Vrátí seznam kroků spuštění patřících ke spuštění.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

Získání – krok spuštění

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Načte krok spuštění.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec 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
identifikátor vlákna	cesta	Ano	řetězec	ID vlákna, ke kterému patří běh a krok běhu.
run_id	cesta	Ano	řetězec	ID běhu, do kterého fáze spuštění patří.
step_id	cesta	Ano	řetězec	ID kroku spuštění, který se má načíst.
include[]	dotaz	Ne	pole	Seznam dalších polí, která se mají zahrnout do odpovědi. Aktuálně je jedinou podporovanou hodnotou step_details.tool_calls[*].file_search.results[*].content pro načtení obsahu výsledků vyhledávání v souboru.
verze-api	dotaz	Ano	řetězec

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	runStepObject

Příklady

Příklad

Načte krok spuštění.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

Seznam – úložiště vektorů

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Vrátí seznam vektorových úložišť.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	adresa URL řetězce	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
omezení	dotaz	Ne	celočíselný	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
objednávka	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné řazení a desc pro sestupné řazení.
po	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, může následující volání zahrnovat after=obj_foo, aby se načte další stránka seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, počínaje obj_foo, může následující volání zahrnovat před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	listVectorStoresResponse

Příklady

Příklad

Vrátí seznam vektorových úložišť.

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

Vytvoření – Vektorové úložiště

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Vytvořte vektorové úložiště.

Parametry identifikátoru URI

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

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
strategie segmentace	autoChunkingStrategyRequestParam nebo staticChunkingStrategyRequestParam	Strategie vytváření bloků dat použitá k vytvoření bloků souborů. Pokud není nastavená, použije strategii auto . Platí pouze v případě, že file_ids není prázdný.	Ne
vyprší_po	vectorStoreExpirationAfter	Zásady vypršení platnosti pro úložiště vektorů.	Ne
identifikátory_souborů	pole	Seznam ID souborů, které má vektorové úložiště použít. Užitečné pro nástroje, jako je file_search například přístup k souborům.	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
jméno	řetězec	Název úložiště vektorů.	Ne

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	vectorStoreObject

Příklady

Příklad

Vytvoří vektorové úložiště.

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Get – Vector Store

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Načte vektorové úložiště.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	adresa URL řetězce	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
id_skladu_vektorů	cesta	Ano	řetězec	ID úložiště vektorů, které se má načíst.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	vectorStoreObject

Příklady

Příklad

Načte vektorové úložiště.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

Modify – Vektorové úložiště

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Upraví úložiště vektorů.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	adresa URL řetězce	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
id_skladu_vektorů	cesta	Ano	řetězec	ID vektorového úložiště, které chcete upravit.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
vyprší_po	vectorStoreExpirationAfter	Zásady vypršení platnosti pro úložiště vektorů.	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
jméno	řetězec	Název úložiště vektorů.	Ne

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	vectorStoreObject

Příklady

Příklad

Upraví úložiště vektorů.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Delete – Vektorové úložiště

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Odstraňte vektorové úložiště.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
id_skladu_vektorů	cesta	Ano	řetězec	ID úložiště vektorů, které chcete odstranit.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	deleteVectorStoreResponse

Příklady

Příklad

Odstraní vektorové úložiště.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

Seznam – Soubory vektorového úložiště

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Vrátí seznam souborů úložiště vektorů.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
id_skladu_vektorů	cesta	Ano	řetězec	ID vektorového úložiště, do kterého soubory patří.
omezení	dotaz	Ne	celočíselný	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
objednávka	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné řazení a desc pro sestupné řazení.
po	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, může následující volání zahrnovat after=obj_foo, aby se načte další stránka seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, počínaje obj_foo, může následující volání zahrnovat před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.
filtr	dotaz	Ne	řetězec Možné hodnoty: in_progress, completed, failed, cancelled	Filtrovat podle stavu souboru. Jeden z in_progress, completed, failed, cancelled.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	listVectorStoreFilesResponse

Příklady

Příklad

Vrátí seznam souborů úložiště vektorů.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Vytvoření – soubor vektorového úložiště

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Vytvořte soubor vektorového úložiště připojením souboru k vektorovém úložišti.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
id_skladu_vektorů	cesta	Ano	řetězec	ID vektorového úložiště, pro které chcete vytvořit soubor.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
strategie segmentace	chunkingStrategyRequestParam	Strategie vytváření bloků dat použitá k vytvoření bloků souborů. Pokud není nastavená, použije strategii auto .	Ne
ID souboru	řetězec	ID souboru, které má vektorové úložiště použít. Užitečné pro nástroje, jako je file_search například přístup k souborům.	Ano

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	vectorStoreFileObject

Příklady

Příklad

Vytvořte soubor vektorového úložiště připojením souboru k vektorovém úložišti.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Get – Soubor vektorového úložiště

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Načte soubor úložiště vektorů.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
id_skladu_vektorů	cesta	Ano	řetězec	ID vektorového úložiště, do kterého soubor patří.
ID souboru	cesta	Ano	řetězec	ID načteného souboru.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	vectorStoreFileObject

Příklady

Příklad

Načte soubor úložiště vektorů.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Delete – Soubor vektorového úložiště

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Odstraňte soubor úložiště vektorů. Tím se odebere soubor z úložiště vektorů, ale samotný soubor se neodstraní. Pokud chcete soubor odstranit, použijte koncový bod odstranění souboru.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
id_skladu_vektorů	cesta	Ano	řetězec	ID vektorového úložiště, do kterého soubor patří.
ID souboru	cesta	Ano	řetězec	ID souboru, který chcete odstranit.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	deleteVectorStoreFileResponse

Příklady

Příklad

Odstraňte soubor úložiště vektorů. Tím se odebere soubor z úložiště vektorů, ale samotný soubor se neodstraní. Pokud chcete soubor odstranit, použijte koncový bod odstranění souboru.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Aktualizace atributů v souboru úložiště vektorů

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
id_skladu_vektorů	cesta	Ano	řetězec	ID vektorového úložiště, do které soubor patří.
ID souboru	cesta	Ano	řetězec	ID souboru pro aktualizaci atributů.

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
vlastnosti	VectorStoreFileAttributes	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků, pravdivostní hodnoty nebo čísla.	Ano

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	vectorStoreFileObject

Načtení obsahu souboru vektorového úložiště

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

Načtěte analyzovaný obsah souboru úložiště vektorů.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
id_skladu_vektorů	cesta	Ano	řetězec	ID úložiště vektorů.
ID souboru	cesta	Ano	řetězec	ID souboru v úložišti vektorů.

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	VectorStoreFileContentResponse

Vektorová úložiště vyhledávání

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

Vyhledejte v úložišti vektorů relevantní bloky dat na základě filtru atributů dotazu a souboru.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	Řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
id_skladu_vektorů	cesta	Ano	řetězec	ID vektorového úložiště, které se má prohledávat.

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
filtruje	ComparisonFilter nebo CompoundFilter	Filtr, který se použije na základě atributů souboru.	Ne
max_počet_výsledků	celočíselný	Maximální počet výsledků, které se mají vrátit. Toto číslo by mělo být mezi 1 a 50 včetně.	Ne	10
dotaz	řetězec nebo pole	Řetězec dotazu pro hledání	Ano
možnosti hodnocení	objekt	Možnosti řazení pro hledání	Ne
└- ranker	výčet	Možné hodnoty: auto, default-2024-11-15	Ne
└ score_threshold	Číslo		Ne	0
přepsat dotaz	Boolean	Zda se má dotaz v přirozeném jazyce přepsat pro vektorové vyhledávání.	Ne	Nepravda

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
aplikace/json	VectorStoreSearchResultsPage

Vytvoření – batch souborů vektorového úložiště

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

Vytvořte dávku souboru úložiště vektorů.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
id_skladu_vektorů	cesta	Ano	řetězec	ID vektorového úložiště, pro které chcete vytvořit dávku souborů.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
strategie segmentace	chunkingStrategyRequestParam	Strategie vytváření bloků dat použitá k vytvoření bloků souborů. Pokud není nastavená, použije strategii auto .	Ne
identifikátory_souborů	pole	Seznam ID souborů, které má vektorové úložiště použít. Užitečné pro nástroje, jako je file_search například přístup k souborům.	Ano

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	vectorStoreFileBatchObject

Příklady

Příklad

Vytvořte dávku souboru úložiště vektorů.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

Odpovědi: Stavový kód: 200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Get – Batch souborů vektorového úložiště

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Načte dávku souboru úložiště vektorů.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
id_skladu_vektorů	cesta	Ano	řetězec	ID úložiště vektorů, do kterého dávka souboru patří.
batch_id	cesta	Ano	řetězec	ID skupiny souborů, která se načítá.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	vectorStoreFileBatchObject

Příklady

Příklad

Načte dávku souboru úložiště vektorů.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

Zrušit – Batch souborů vektorového úložiště

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Zrušte dávku souboru úložiště vektorů. Tím se co nejdříve pokusíte zrušit zpracování souborů v této dávce.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	řetězec URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
id_skladu_vektorů	cesta	Ano	řetězec	ID úložiště vektorů, do kterého dávka souboru patří.
batch_id	cesta	Ano	řetězec	ID dávky souboru, které chcete zrušit.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	vectorStoreFileBatchObject

Příklady

Příklad

Zrušte dávku souboru úložiště vektorů. Tím se co nejdříve pokusíte zrušit zpracování souborů v této dávce.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

Seznam – Dávkové soubory úložiště vektorů

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Vrátí seznam souborů úložiště vektorů v dávce.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	adresa URL řetězce	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
id_skladu_vektorů	cesta	Ano	řetězec	ID vektorového úložiště, do kterého soubory patří.
batch_id	cesta	Ano	řetězec	ID dávky souboru, do které soubory patří.
omezení	dotaz	Ne	celočíselný	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
objednávka	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné řazení a desc pro sestupné řazení.
po	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, může následující volání zahrnovat after=obj_foo, aby se načte další stránka seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, počínaje obj_foo, může následující volání zahrnovat před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.
filtr	dotaz	Ne	řetězec Možné hodnoty: in_progress, completed, failed, cancelled	Filtrovat podle stavu souboru. Jeden z in_progress, completed, failed, cancelled.
verze-api	dotaz	Ano	řetězec	Verze rozhraní API

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	listVectorStoreFilesResponse

Příklady

Příklad

Vrátí seznam souborů úložiště vektorů.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Odpovědi: Stavový kód: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Vytvoření – realtimesession

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

Vytvořte dočasný token rozhraní API pro použití v aplikacích na straně klienta s rozhraním API v reálném čase. Je možné nakonfigurovat stejné parametry relace jako session.update událost klienta. Odpovídá objektem relace a klíčem client_secret, který obsahuje použitelný dočasný token API, jenž lze použít k autentizaci prohlížečových klientů pro rozhraní Realtime API.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
vstupní_formát_audio	výčet	Formát vstupního zvuku. Možnosti jsou pcm16, g711_ulawnebo g711_alaw. Pro pcm16, vstupní zvuk musí být 16bitový PCM při vzorkovací frekvenci 24kHz, jeden kanál (mono) a minimální-endian bajt pořadí. Možné hodnoty: pcm16, g711_ulaw, g711_alaw	Ne
vstupní redukce šumu zvuku	objekt	Konfigurace pro snížení hluku vstupu zvuku. Nastavte na null pro vypnutí. Filtry redukce šumu jsou přidány do zvukového vstupního vyrovnávacího paměťového bloku před odesláním do VAD a modelu. Filtrování zvuku může zlepšit přesnost detekce vad a otáčení (snížení falešně pozitivních výsledků) a výkon modelu zlepšením vnímání vstupního zvuku.	Ne
└- typ	výčet	Typ snížení šumu. near_field je určená pro mikrofony s blízkým hovorem, jako jsou sluchátka, je určená pro mikrofony vzdáleného pole, far_field jako jsou mikrofony přenosného počítače nebo konferenční místnosti. Možné hodnoty: near_field, far_field	Ne
přepis zvukového vstupu	objekt	Konfigurace pro přepis zvuku z vstupu, ve výchozím nastavení vypnuté, lze nastavit na null, aby se vypnulo, pokud bylo zapnuto. Vstupní přepis zvuku není nativní pro model, protože model využívá zvuk přímo. Přepis probíhá asynchronně prostřednictvím koncového bodu Transcriptions a měl by být chápán jako vodítko k obsahu vstupního zvuku, nikoliv jako přesná reprodukce toho, co model slyšel. Klient může volitelně nastavit jazyk a zobrazit výzvu k přepisu. Tyto pokyny nabízejí další pokyny ke službě přepisu.	Ne
└jazyk	řetězec	Jazyk vstupního zvuku. Poskytnutí jazyka zadávání vstupu ve formátu ISO-639-1 (např. en) zlepší přesnost a latenci.	Ne
└model	řetězec	Model, který se má použít pro přepis, aktuální možnosti jsou gpt-4o-transcribe, gpt-4o-mini-transcribea whisper-1.	Ne
└─ výzva	řetězec	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Pro whisper-1 je výzva seznamem klíčových slov. U gpt-4o-transcribe modelů je výzvou bezplatný textový řetězec, například "očekávat slova související s technologií".	Ne
pokyny	řetězec	Výchozí systémové instrukce (tj. systémová zpráva) připojené k vyžádání modelu. Toto pole umožňuje klientovi řídit model na požadovaných odpovědích. Model lze instruovat o obsahu a formátu odpovědi (např. "buďte velmi stručné", "jednat přátelsky", "tady jsou příklady dobrých odpovědí") a o chování zvuku (např. "rychle mluvit", "vkládat do hlasu emoce", "smět se často"). Není zaručeno, že model bude pokyny dodržovat, ale poskytují modelu vedení ohledně požadovaného chování. Všimněte si, že server nastaví výchozí pokyny, které se použijí, pokud toto pole není nastavené a jsou viditelné v session.created události na začátku relace.	Ne
maximální počet tokenů výstupní odpovědi	celé číslo nebo řetězec	Maximální početvýstupních Zadejte celé číslo mezi 1 a 4096, abyste omezili výstupní tokeny nebo inf maximální dostupné tokeny pro daný model. Výchozí hodnota infje .	Ne
modality		Sada způsobů, kterými může model reagovat. Pokud chcete zvuk zakázat, nastavte ho na ["text"].	Ne
model	řetězec	Název nasazení použitého pro tuto relaci.	Ne
formát_výstupního_zvuku	výčet	Formát výstupního zvuku. Možnosti jsou pcm16, g711_ulawnebo g711_alaw. Pro pcm16, výstupní zvuk je vzorkován rychlostí 24kHz. Možné hodnoty: pcm16, g711_ulaw, g711_alaw	Ne
Teplota	Číslo	Vzorkovací teplota pro model omezená na [0.6, 1.2]. Pro zvukové modely se pro zajištění nejlepšího výkonu důrazně doporučuje teplota 0,8.	Ne	0,8
výběr nástroje	řetězec	Jak model vybírá nástroje. Možnosti jsou auto, none, requirednebo zadat funkci.	Ne	Auto
nářadí	pole	Nástroje (funkce) dostupné pro model	Ne
detekce otočení	objekt	Konfigurace pro detekci otáčení, ether Server VAD nebo sémantický VAD. Toto lze nastavit na null, aby se vypnulo, v takovém případě musí klient ručně vyvolat odpověď modelu. Server VAD znamená, že model rozpozná začátek a konec řeči na základě hlasitosti zvuku a odpoví na konci řeči uživatele. Sémantický VAD je pokročilejší a používá model detekce řečnických přestávek (ve spojení s VAD) pro sémantický odhad, zda uživatel dokončil mluvení, a pak dynamicky nastaví časový limit na základě této pravděpodobnosti. Pokud například uživatelův zvuk se ztratí s uhhm, model bude mít nízkou pravděpodobnost ukončení obratu a počká déle, než uživatel bude pokračovat v mluvení. To může být užitečné pro přirozenější konverzace, ale může mít vyšší latenci.	Ne
└create_response	Boolean	Jestli se má automaticky generovat odpověď, když dojde k události zastavení VAD.	Ne	Pravdivé
└- dychtivost	výčet	Používá se jenom pro semantic_vad režim. Dychtivost modelu reagovat low bude čekat déle, než uživatel bude pokračovat v mluvení, high bude reagovat rychleji. autoje výchozí hodnota a je ekvivalentní .medium Možné hodnoty: low, medium, high, auto	Ne
└interrupt_response	Boolean	Bez ohledu na to, jestli se má automaticky přerušit jakákoli probíhající odpověď s výstupem výchozí konverzace (tj. conversation z auto) při výskytu počáteční události VAD.	Ne	Pravdivé
└- prefix_padding_ms	celočíselný	Používá se jenom pro server_vad režim. Množství zvuku, které se má zahrnout před detekovanou řečí VAD (v milisekundách). Výchozí hodnota je 300 ms.	Ne
└─ trvání_ticha_ms	celočíselný	Používá se jenom pro server_vad režim. Doba ticha pro detekci zastavení řeči (v milisekundách). Výchozí hodnota je 500 ms. S kratšími hodnotami bude model reagovat rychleji, ale může zasahovat během krátkých přestávek uživatele.	Ne
└- prahová hodnota	Číslo	Používá se jenom pro server_vad režim. Prahová hodnota aktivace pro VAD (0,0 až 1,0), výchozí hodnota je 0,5. Vyšší prahová hodnota bude vyžadovat hlasitější zvuk k aktivaci modelu, a proto může fungovat lépe v hlučných prostředích.	Ne
└- typ	výčet	Typ detekce otáčení Možné hodnoty: server_vad, semantic_vad	Ne
hlas	VoiceIdsShared		Ne

Odpovědi

Stavový kód: 200

Popis: Relace byla úspěšně vytvořena.

Typ obsahu	Typ	Popis
application/json	RealtimeSessionCreateResponse

Vytvořit – Přepis Real-Time Session

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

Vytvořte dočasný token rozhraní API pro použití v aplikacích na straně klienta s rozhraním API v reálném čase speciálně pro přepisy v reálném čase. Je možné nakonfigurovat stejné parametry relace jako transcription_session.update událost klienta. Odpovídá objektem relace a klíčem client_secret, který obsahuje použitelný dočasný token API, jenž lze použít k autentizaci prohlížečových klientů pro rozhraní Realtime API.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
zahrnovat	pole	Sada položek, které se mají zahrnout do přepisu. Aktuální dostupné položky jsou: - item.input_audio_transcription.logprobs	Ne
vstupní_formát_audio	výčet	Formát vstupního zvuku. Možnosti jsou pcm16, g711_ulawnebo g711_alaw. Pro pcm16, vstupní zvuk musí být 16bitový PCM při vzorkovací frekvenci 24kHz, jeden kanál (mono) a minimální-endian bajt pořadí. Možné hodnoty: pcm16, g711_ulaw, g711_alaw	Ne
vstupní redukce šumu zvuku	objekt	Konfigurace pro snížení hluku vstupu zvuku. Nastavte na null pro vypnutí. Filtry redukce šumu jsou přidány do zvukového vstupního vyrovnávacího paměťového bloku před odesláním do VAD a modelu. Filtrování zvuku může zlepšit přesnost detekce vad a otáčení (snížení falešně pozitivních výsledků) a výkon modelu zlepšením vnímání vstupního zvuku.	Ne
└- typ	výčet	Typ snížení šumu. near_field je určená pro mikrofony s blízkým hovorem, jako jsou sluchátka, je určená pro mikrofony vzdáleného pole, far_field jako jsou mikrofony přenosného počítače nebo konferenční místnosti. Možné hodnoty: near_field, far_field	Ne
přepis zvukového vstupu	objekt	Konfigurace pro vstupní přepis zvuku Klient může volitelně nastavit jazyk a zobrazit výzvu k přepisu. Tyto pokyny nabízejí další pokyny ke službě přepisu.	Ne
└jazyk	řetězec	Jazyk vstupního zvuku. Poskytnutí jazyka zadávání vstupu ve formátu ISO-639-1 (např. en) zlepší přesnost a latenci.	Ne
└model	výčet	Model, který se má použít pro přepis, aktuální možnosti jsou gpt-4o-transcribe, gpt-4o-mini-transcribea whisper-1. Možné hodnoty: gpt-4o-transcribe, gpt-4o-mini-transcribe, whisper-1	Ne
└─ výzva	řetězec	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Pro whisper-1 je výzva seznamem klíčových slov. U gpt-4o-transcribe modelů je výzvou bezplatný textový řetězec, například "očekávat slova související s technologií".	Ne
modality		Sada způsobů, kterými může model reagovat. Pokud chcete zvuk zakázat, nastavte ho na ["text"].	Ne
detekce otočení	objekt	Konfigurace pro detekci otáčení, ether Server VAD nebo sémantický VAD. Toto lze nastavit na null, aby se vypnulo, v takovém případě musí klient ručně vyvolat odpověď modelu. Server VAD znamená, že model rozpozná začátek a konec řeči na základě hlasitosti zvuku a odpoví na konci řeči uživatele. Sémantický VAD je pokročilejší a používá model detekce řečnických přestávek (ve spojení s VAD) pro sémantický odhad, zda uživatel dokončil mluvení, a pak dynamicky nastaví časový limit na základě této pravděpodobnosti. Pokud například uživatelův zvuk se ztratí s uhhm, model bude mít nízkou pravděpodobnost ukončení obratu a počká déle, než uživatel bude pokračovat v mluvení. To může být užitečné pro přirozenější konverzace, ale může mít vyšší latenci.	Ne
└create_response	Boolean	Jestli se má automaticky generovat odpověď, když dojde k události zastavení VAD. Není k dispozici pro přepisovací relace.	Ne	Pravdivé
└- dychtivost	výčet	Používá se jenom pro semantic_vad režim. Dychtivost modelu reagovat low bude čekat déle, než uživatel bude pokračovat v mluvení, high bude reagovat rychleji. autoje výchozí hodnota a je ekvivalentní .medium Možné hodnoty: low, medium, high, auto	Ne
└interrupt_response	Boolean	Bez ohledu na to, jestli se má automaticky přerušit jakákoli probíhající odpověď s výstupem výchozí konverzace (tj. conversation z auto) při výskytu počáteční události VAD. Není k dispozici pro přepisovací relace.	Ne	Pravdivé
└- prefix_padding_ms	celočíselný	Používá se jenom pro server_vad režim. Množství zvuku, které se má zahrnout před detekovanou řečí VAD (v milisekundách). Výchozí hodnota je 300 ms.	Ne
└─ trvání_ticha_ms	celočíselný	Používá se jenom pro server_vad režim. Doba ticha pro detekci zastavení řeči (v milisekundách). Výchozí hodnota je 500 ms. S kratšími hodnotami bude model reagovat rychleji, ale může zasahovat během krátkých přestávek uživatele.	Ne
└- prahová hodnota	Číslo	Používá se jenom pro server_vad režim. Prahová hodnota aktivace pro VAD (0,0 až 1,0), výchozí hodnota je 0,5. Vyšší prahová hodnota bude vyžadovat hlasitější zvuk k aktivaci modelu, a proto může fungovat lépe v hlučných prostředích.	Ne
└- typ	výčet	Typ detekce otáčení Možné hodnoty: server_vad, semantic_vad	Ne

Odpovědi

Stavový kód: 200

Popis: Relace byla úspěšně vytvořena.

Typ obsahu	Typ	Popis
application/json	RealtimeTranscriptionSessionCreateResponse

Odpovědi

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

Vytvoří modelovou odpověď.

Text požadavku

Content-Type: application/json

Název	Typ	Popis	Požaduje se	Výchozí
zahrnovat	pole		Ne
vstup	řetězec nebo pole	Vstupy modelu	Ano
pokyny	řetězec	Vloží zprávu systému (nebo vývojáře) jako první položku v kontextu modelu. Při použití společně previous_response_idse pokyny z předchozí odpovědi nepřenesou do další odpovědi. Díky tomu je snadné prohodit systémové zprávy (nebo zprávy vývojářů) v nových odpovědích.	Ne
maximální počet výstupních tokenů (max_output_tokens)	celočíselný	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a stavu konverzace.	Ne
paralelní volání nástrojů	Boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ne	Pravdivé
identifikátor_předchozí_odpovědi	řetězec	Jedinečné ID předchozí odpovědi na model. Pomocí této možnosti můžete vytvářet konverzace s více interakcemi. Přečtěte si další informace o stavu konverzace.	Ne
usuzování	Usuzování	Modely řady o-series pouze Možnosti konfigurace pro zdůvodnění modelů	Ne
obchod	Boolean	Zda se má vygenerovaná odpověď modelu uložit pro pozdější načtení prostřednictvím rozhraní API.	Ne	Pravdivé
datový proud	Boolean	Pokud je nastavená hodnota true, data odpovědi modelu se streamují do klienta, protože se generují pomocí událostí odeslaných serverem. Další informace najdete v části Streamování níže.	Ne	Nepravda
Text	objekt	Možnosti konfigurace textové odpovědi z modelu Může to být prostý text nebo strukturovaná data JSON. Další informace: - Textové vstupy a výstupy - Strukturované výstupy	Ne
└─ Formát	TextResponseFormatConfiguration	Objekt určující formát, který musí model vypíše. Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat zadanému schématu JSON. Výchozí formát je { "type": "text" } bez dalších možností. Nedoporučuje se pro gpt-4o a novější modely: Nastavení { "type": "json_object" } umožní původní režim JSON, což zajišťuje, že zpráva vygenerovaná modelem je platný JSON. Použití json_schema je upřednostňované pro modely, které ho podporují.	Ne
výběr nástroje	ToolChoiceOptions nebo ToolChoiceTypes nebo ToolChoiceFunction	Způsob, jakým má model vybrat nástroj (nebo nástroje), který se má použít při generování odpovědi V parametru tools se dozvíte, jak určit nástroje, které model může volat.	Ne
nářadí	pole	Pole nástrojů, které může model volat při generování odpovědi. Pomocí nastavení parametru tool_choice můžete určit, který nástroj chcete použít. Existují dvě kategorie nástrojů, které můžete poskytnout modelu: - Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu	Ne
zkrácení	výčet	Strategie zkrácení, která se má použít pro odpověď modelu. - auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu, model zkrátí odpověď tak, aby se vešel do kontextového okna tak, že vyřazuje vstupní položky uprostřed konverzace. - disabled (výchozí): Pokud odpověď modelu překročí velikost kontextového okna modelu, požadavek selže s chybou 400. Možné hodnoty: auto, disabled	Ne

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	odpověď
text/event-stream	responseStreamEvent

Stavový kód: výchozí

Popis: Služba není k dispozici

Typ obsahu	Typ	Popis
application/json	errorResponse

Rozhraní API pro odpovědi – vstupní položky

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Načte odpověď modelu s daným ID.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	adresa URL řetězce	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
identifikátor_odpovědi	cesta	Ano	řetězec	ID odpovědi, která se má načíst.
zahrnovat	dotaz	Ne	pole	Další pole, která se mají zahrnout do odpovědi. Další informace najdete v parametru include pro vytvoření odpovědi výše.

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	odpověď

Stavový kód: výchozí

Popis: Služba není k dispozici

Typ obsahu	Typ	Popis
application/json	errorResponse

Odstranit odpověď

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Odstraní odpověď modelu s daným ID.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	adresa URL řetězce	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
identifikátor_odpovědi	cesta	Ano	řetězec	ID odpovědi, která se má odstranit.

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Stavový kód: 404

Popis: Nenalezena

Typ obsahu	Typ	Popis
application/json	chyba

Stavový kód: výchozí

Popis: Služba není k dispozici

Typ obsahu	Typ	Popis
application/json	errorResponse

Rozhraní API pro odpovědi – seznam položek odpovědi

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

Vrátí seznam vstupních položek pro danou odpověď.

Parametry identifikátoru URI

Název	V	Požaduje se	Typ	Popis
koncový bod	cesta	Ano	adresa URL řetězce	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
identifikátor_odpovědi	cesta	Ano	řetězec	ID odpovědi, ze které se mají načíst vstupní položky.
omezení	dotaz	Ne	celočíselný	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
objednávka	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí, ve kterém se vracejí vstupní položky. Výchozí hodnota je asc. - asc: Vrátí vstupní položky ve vzestupném pořadí. - desc: Vrátí vstupní položky v sestupném pořadí.
po	dotaz	Ne	řetězec	ID položky, který se používá k výpisu položek následujících po určité položce, slouží pro stránkování.
před	dotaz	Ne	řetězec	ID položky, kterou je třeba uvést před jinými položkami pro použití ve stránkování.

Hlavička požadavku

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

Název	Požaduje se	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu	Typ	Popis
application/json	responseItemList

Komponenty

chybováOdezva

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

errorBase

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

chyba

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

vnitřní chyba

Vnitřní chyba s dalšími podrobnostmi

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

vnitřní chybový kód

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

Vlastnictví	Hodnota
Popis	Kódy chyb pro vnitřní objekt chyby.
Typ	řetězec
Hodnoty	ResponsibleAIPolicyViolation

dalleErrorResponse

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

dalleError

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

dalleInnerError

Vnitřní chyba s dalšími podrobnostmi

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

contentFilterCompletionTextSpan

Popisuje rozsah vygenerovaného textu dokončení. Posun 0 je první bod kódu UTF32 textu dokončení.

Název	Typ	Popis	Požaduje se	Výchozí
hodnota_posunutí_konce_dokončení	celočíselný	Posun prvního bodu kódu UTF32, který je vyloučen z rozsahu. Toto pole se vždy rovná completion_start_offset pro prázdné rozsahy. Toto pole je vždy větší než completion_start_offset u neprázdných úseků.	Ano
výchozí posun dokončení	celočíselný	Posun bodu kódu UTF32, který začíná rozsahem.	Ano

základVýsledkůFiltruObsahu

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

výsledek závažnosti obsahu filtru

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

Výsledek detekce filtru obsahu

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

Detekován filtr obsahu s výsledkem citace

Název	Typ	Popis	Požaduje se	Výchozí
citace	objekt		Ne
└- ADRESA URL	řetězec		Ne
└- licence	řetězec		Ne

Detekován filtr obsahu s výsledkem textových rozmezí dokončení

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

VýsledekIdFiltruObsahu

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

základ výsledků filtru obsahu

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

Název	Typ	Popis	Požaduje se	Výchozí
vlastní seznamy blokací	podrobné výsledky filtrování obsahu	Výsledky filtrování obsahu s podrobnostmi o ID filtru obsahu pro filtrované segmenty	Ne
chyba	errorBase		Ne
nenávist	výsledek závažnosti filtrování obsahu		Ne
rouhání	výsledek detekovaného filtru obsahu		Ne
sebepoškozování	výsledek závažnosti filtrování obsahu		Ne
sexuální	výsledek závažnosti filtrování obsahu		Ne
násilí	výsledek závažnosti filtrování obsahu		Ne

výsledky výzvy filtru obsahu

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

Název	Typ	Popis	Požaduje se	Výchozí
vlastní seznamy blokací	podrobné výsledky filtrování obsahu	Výsledky filtrování obsahu s podrobnostmi o ID filtru obsahu pro filtrované segmenty	Ne
chyba	errorBase		Ne
nenávist	výsledek závažnosti filtrování obsahu		Ne
nepřímý útok	výsledek detekovaného filtru obsahu		Ne
útěk z vězení	výsledek detekovaného filtru obsahu		Ne
rouhání	výsledek detekovaného filtru obsahu		Ne
sebepoškozování	výsledek závažnosti filtrování obsahu		Ne
sexuální	výsledek závažnosti filtrování obsahu		Ne
násilí	výsledek závažnosti filtrování obsahu		Ne

výsledky výběru filtru obsahu

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

Název	Typ	Popis	Požaduje se	Výchozí
vlastní seznamy blokací	podrobné výsledky filtrování obsahu	Výsledky filtrování obsahu s podrobnostmi o ID filtru obsahu pro filtrované segmenty	Ne
chyba	errorBase		Ne
nenávist	výsledek závažnosti filtrování obsahu		Ne
rouhání	výsledek detekovaného filtru obsahu		Ne
kód chráněného materiálu	detekován filtr obsahu s výsledkem citace		Ne
chráněný_materiál_text	výsledek detekovaného filtru obsahu		Ne
sebepoškozování	výsledek závažnosti filtrování obsahu		Ne
sexuální	výsledek závažnosti filtrování obsahu		Ne
neuzemněný materiál	VýsledekDetekceFiltruObsahuSCelosvětovýmiTextovýmiÚseky		Ne
násilí	výsledek závažnosti filtrování obsahu		Ne

podrobné výsledky filtru obsahu

Výsledky filtrování obsahu s podrobnostmi o ID filtru obsahu pro filtrované segmenty

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

výsledek filtrování promptu

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

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

vyzvat k filtrování výsledků

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

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

výsledky filtrování obsahu Dallego

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

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

Výsledky Filtrování Dalle

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

Název	Typ	Popis	Požaduje se	Výchozí
vlastní seznamy blokací	podrobné výsledky filtrování obsahu	Výsledky filtrování obsahu s podrobnostmi o ID filtru obsahu pro filtrované segmenty	Ne
nenávist	výsledek závažnosti filtrování obsahu		Ne
útěk z vězení	výsledek detekovaného filtru obsahu		Ne
rouhání	výsledek detekovaného filtru obsahu		Ne
sebepoškozování	výsledek závažnosti filtrování obsahu		Ne
sexuální	výsledek závažnosti filtrování obsahu		Ne
násilí	výsledek závažnosti filtrování obsahu		Ne

společnáŽádostODokončeníChatu

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

vytvořitPožadavekNaDokončení

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

GenerovatOdezvuNaDokončení

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

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

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

Název	Typ	Popis	Požaduje se	Výchozí
zvuk	objekt	Parametry zvukového výstupu Požadován při vyžádání zvukového výstupu s modalities: ["audio"].	Ne
└─ Formát	výčet	Určuje výstupní formát zvuku. Musí být jednou z wav, mp3, flac, opus nebo pcm16. Možné hodnoty: wav, mp3, flac, opus, pcm16	Ne
└─ hlas	výčet	Určuje typ hlasu. Podporované hlasy jsou alloy, echo, fable, onyx, nova a shimmer. Možné hodnoty: alloy, echo, fable, onyx, novashimmer	Ne
zdroje_dat	pole	Položky konfigurace pro rozšíření chatu Azure OpenAI, které je používají. Tato další specifikace je kompatibilní pouze s Azure OpenAI.	Ne
trest za frekvenci	Číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.	Ne	0
volání funkce	string nebo chatCompletionFunctionCallOption	Zastaralá ve prospěch tool_choice. Určuje, která funkce (pokud existuje) volána modelem. none znamená, že model nebude volat funkci a místo toho vygeneruje zprávu. auto znamená, že model může vybrat mezi generováním zprávy nebo voláním funkce. Zadáním konkrétní funkce vynutíte {"name": "my_function"} , aby model volal danou funkci. none je výchozí, pokud nejsou k dispozici žádné funkce. auto je výchozí, pokud jsou k dispozici funkce.	Ne
– funkce	pole	Zastaralá ve prospěch tools. Seznam funkcí, pro které model může generovat vstupy JSON.	Ne
logit_bias	objekt	Upravte pravděpodobnost výskytu zadaných tokenů v dokončení. Přijímá objekt JSON, který mapuje tokeny (určené jejich ID tokenu v tokenizátoru) na přidruženou hodnotu předsudku od -100 do 100. Matematicky se před vzorkováním přidá do logitů vygenerovaných modelem. Přesný účinek se bude lišit podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu.	Ne	Nic
protokoly	Boolean	Zda se mají vrátit pravděpodobnosti protokolu výstupních tokenů, nebo ne. Pokud je pravda, vrátí pravděpodobnosti protokolu každého výstupního tokenu vráceného v hodnotě contentmessage.	Ne	Nepravda
maximální_počet_tokenů_dokončení	celočíselný	Horní mez počtu tokenů, které lze vygenerovat pro dokončení, včetně viditelných výstupních tokenů a zdůvodnění tokenů. To je podporováno pouze v modelech řady o1. Rozšíří podporu dalších modelů v budoucí verzi rozhraní API.	Ne
maximální počet tokenů	celočíselný	Maximální počet tokenů, které lze vygenerovat v dokončení chatu. Celková délka vstupních tokenů a vygenerovaných tokenů je omezená délkou kontextu modelu.	Ne
zprávy	pole	Seznam zpráv, které tvoří dosud konverzaci. Příklad kódu Pythonu	Ano
metadatové informace	objekt	Značky a hodnoty definované vývojářem používané k filtrování dokončení na řídicím panelu uložených dokončení	Ne
modality	ChatCompletionModalities	Výstupní typy, které chcete, aby model vygeneroval pro tento požadavek. Většina modelů dokáže generovat text, což je výchozí nastavení: ["text"] Model gpt-4o-audio-preview lze také použít k vygenerování zvuku. Pokud chcete požádat, aby tento model generoval textové i zvukové odpovědi, můžete použít: ["text", "audio"]	Ne
n	celočíselný	Kolik možností dokončení chatu se má vygenerovat pro každou vstupní zprávu. Mějte na paměti, že se vám bude účtovat na základě počtu vygenerovaných tokenů napříč všemi možnostmi. Udržujte n si přehled o 1 minimalizaci nákladů.	Ne	0
paralelní volání nástrojů	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	Ne	Pravdivé
předpověď	PredictionContent	Konfigurace predikovaného výstupu, která může výrazně zlepšit dobu odezvy, když jsou velké části odpovědi modelu známé předem. To je nejběžnější při opětovném vygenerování souboru s pouze menšími změnami většiny obsahu.	Ne
penalizace přítomnosti	Číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.	Ne	0
úsilí o usuzování	výčet	Pouze modely o1 Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty jsou low, mediuma high. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi. Možné hodnoty: low, medium, high	Ne
formát_odpovědi	ResponseFormatText nebo ResponseFormatJsonObject nebo ResponseFormatJsonSchema	Objekt určující formát, který musí model vypíše. Kompatibilní s GPT-4o Nastavení pro { "type": "json_schema", "json_schema": {...} } povolení strukturovaných výstupů, které zaručují, že model bude odpovídat zadanému schématu JSON. Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON. Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.	Ne
semeno	celočíselný	Tato funkce je v beta verzi. Pokud je zadáno, náš systém se bude snažit vzorkovat deterministicky, aby opakované požadavky se stejnými seed parametry měly vrátit stejný výsledek. Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.	Ne
Zastavit	řetězec nebo pole	Až 4 sekvence, ve kterých rozhraní API přestane generovat další tokeny.	Ne
obchod	Boolean	Zda chcete uložit výstup této žádosti o dokončení chatu pro použití v našich modelových destilačních nebo vyhodnocovacích produktech.	Ne
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 Příklad kódu Pythonu	Ne	Nepravda
možnosti streamování	chatCompletionStreamOptions	Možnosti pro odpověď streamování Toto nastavení nastavíte pouze při nastavení stream: true.	Ne	Nic
Teplota	Číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne	0
výběr nástroje	chatCompletionToolChoiceOption	Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádný nástroj a místo toho vygeneruje zprávu. auto znamená, že model si může vybrat mezi generováním zprávy nebo voláním jednoho nebo více nástrojů. required znamená, že model musí volat jeden nebo více nástrojů. Zadáním konkrétního nástroje vynutíte {"type": "function", "function": {"name": "my_function"}} model, aby tento nástroj volal. none je výchozí, pokud nejsou k dispozici žádné nástroje. auto je výchozí, pokud jsou k dispozici nástroje.	Ne
nářadí	pole	Seznam nástrojů, které model může volat. V současné době se jako nástroj podporují jenom funkce. Pomocí tohoto příkazu můžete poskytnout seznam funkcí, pro které může model generovat vstupy JSON. Podporuje se maximálně 128 funkcí.	Ne
top_logprobs	celočíselný	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu. logprobs parametr musí být nastaven na true hodnotu, pokud je použit tento parametr.	Ne
top_p	Číslo	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne	0
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	Ne
uživatelský_kontext_bezpečnosti	userSecurityContext	Kontext zabezpečení uživatele obsahuje několik parametrů, které popisují samotnou aplikaci AI, a koncový uživatel, který komunikuje s aplikací AI. Tato pole pomáhají provozním týmům zabezpečení prošetřit a zmírnit bezpečnostní incidenty tím, že poskytují komplexní přístup k ochraně aplikací umělé inteligence. Přečtěte si další informace o ochraně aplikací AI pomocí programu Microsoft Defender for Cloud.	Ne

uživatelský bezpečnostní kontext

Kontext zabezpečení uživatele obsahuje několik parametrů, které popisují samotnou aplikaci AI, a koncový uživatel, který komunikuje s aplikací AI. Tato pole pomáhají provozním týmům zabezpečení prošetřit a zmírnit bezpečnostní incidenty tím, že poskytují komplexní přístup k ochraně aplikací umělé inteligence. Přečtěte si další informace o ochraně aplikací AI pomocí programu Microsoft Defender for Cloud.

Název	Typ	Popis	Požaduje se	Výchozí
název_aplikace	řetězec	Název aplikace. Do tohoto pole by neměly být zahrnuty citlivé osobní údaje.	Ne
ID_koncového_uživatele	řetězec	Tento identifikátor je ID objektu uživatele Microsoft Entra (dříve Azure Active Directory), které se používá k ověřování koncových uživatelů v rámci aplikace generující umělé inteligence. Do tohoto pole by neměly být zahrnuty citlivé osobní údaje.	Ne
ID nájemce koncového uživatele	řetězec	ID tenanta Microsoftu 365, do které koncový uživatel patří. Vyžaduje se, když je aplikace generující AI více tenantů.	Ne
IP adresa zdroje	řetězec	Zachycuje IP adresu původního klienta a přijímá formáty IPv4 i IPv6.	Ne

funkce pro dokončení chatu

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

funkce volání chatCompletionOption

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

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

chatCompletionFunctionParameters

Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON. Podívejte se na příručku/ příklady a referenční informace ke schématu JSON pro dokumentaci k formátu.

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

žádost o dokončení chatu

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

• ChatCompletionRequestDeveloperMessage
• chatCompletionRequestSystemMessage
• chatCompletionRequestUserMessage
• chatCompletionRequestAssistantMessage
• Zpráva nástroje pro dokončení chatu
• chatCompletionRequestFunctionMessage

Zpráva pro vývojáře žádosti o dokončení chatu

Pokyny poskytované vývojářem, které by měl model dodržovat, bez ohledu na zprávy odeslané uživatelem. U modelů o1 a novějších developer nahradí zprávy předchozí system zprávy.

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

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

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

chatPožadavekDokončeníZprávyUživatel

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

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

Název	Typ	Popis	Požaduje se	Výchozí
obsah	řetězec nebo pole	Obsah zprávy asistenta. Povinné, pokud tool_calls není zadáno.function_call	Ne
volání funkce	objekt	Zastaralé a nahrazené .tool_calls Název a argumenty funkce, které by se měly volat, jak je vygeneroval model.	Ne
└argumenty	řetězec	Argumenty pro volání funkce s vygenerovaným modelem ve formátu JSON. Všimněte si, že model negeneruje vždy platný json a může halucinovat parametry, které nejsou definovány schématem vaší funkce. Před voláním funkce ověřte argumenty v kódu.	Ne
└– název	řetězec	Název funkce, která se má volat.	Ne
jméno	řetězec	Volitelné jméno účastníka. Poskytuje informace o modelu pro rozlišení mezi účastníky stejné role.	Ne
odmítnutí	řetězec	Odmítnutí zprávy asistenta.	Ne
úloha	výčet	Role autora zpráv v tomto případě assistant. Možné hodnoty: assistant	Ano
volání nástrojů	chatCompletionMessageToolCalls	Nástroj volá volání vygenerovaná modelem, například volání funkcí.	Ne

chatCompletionRequestToolMessage

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

chatCompletionRequestFunctionMessage

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

chatKompletacePožadavekVývojářZprávaObsahČást

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

• chatCompletionRequestMessageContentPartText

ObsahSystémovéZprávyDokončeníChatu

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

• chatCompletionRequestMessageContentPartText

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

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

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartImage
• chatCompletionRequestMessageContentPartAudio

ObsahZprávyAsistentaProDokončeníChatu

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

• chatCompletionRequestMessageContentPartText
• Odmítnutí části obsahu zprávy o žádosti o dokončení chatu

chatCompletionRequestNástrojZprávaObsahČást

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

• chatCompletionRequestMessageContentPartText

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

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

ŽádostONaDokončeníChatovéZprávyObsahČástZvuk

Název	Typ	Popis	Požaduje se	Výchozí
vstupní_audio	objekt		Ano
└- data	řetězec	Zakódovaná zvuková data base64	Ne
└─ Formát	výčet	Formát zakódovaných zvukových dat. Aktuálně podporuje "wav" a "mp3". Možné hodnoty: wav, mp3	Ne
typ	výčet	Typ části obsahu. Vždy hodnota input_audio. Možné hodnoty: input_audio	Ano

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

Název	Typ	Popis	Požaduje se	Výchozí
URL_obrázku	objekt		Ano
└detail	výčet	Určuje úroveň podrobností obrázku. Další informace najdete v průvodci vision. Možné hodnoty: auto, low, high	Ne
└- adresa URL	řetězec	Buď adresa URL obrázku, nebo data s kódováním base64 obrázku.	Ne
typ	výčet	Typ části obsahu. Možné hodnoty: image_url	Ano

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

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

konfigurace rozšíření Azure Chat

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

###Discriminator pro azureChatExtensionConfiguration

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schéma
azure_search	azureSearchChatExtensionConfiguration
azure_cosmos_db	azureCosmosDBChatExtensionConfiguration
elasticsearch	elasticsearchChatExtensionConfiguration
mongo_db	MongoDBChatExtensionConfiguration
pinecone	pineconeChatExtensionConfiguration

Název	Typ	Popis	Požaduje se	Výchozí
typ	azureChatExtensionType	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.	Ano

TypRozšířeníAzureChatu

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

Vlastnictví	Hodnota
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
Hodnoty	azure_search azure_cosmos_db elasticsearch mongo_db pinecone

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

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

Název	Typ	Popis	Požaduje se	Výchozí
parametry	azureSearchChatExtensionParameters	Parametry služby Azure Search při použití jako rozšíření chatu Azure OpenAI	Ne
typ	azureChatExtensionType	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.	Ano

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

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

Název	Typ	Popis	Požaduje se	Výchozí
povol_částečný_výsledek	Boolean	Pokud je zadána hodnota true, systém povolí použití částečných výsledků hledání a požadavek selže, pokud všechny dotazy selžou. Pokud není zadaný nebo zadaný jako false, požadavek selže, pokud některý vyhledávací dotaz selže.	Ne	Nepravda
ověřování	onYourDataApiKeyAuthenticationOptions nebo onYourDataSystemAssignedManagedIdentityAuthenticationOptions nebo onYourDataUserAssignedManagedIdentityAuthenticationOptions nebo onYourDataAccessTokenAuthenticationOptions		Ano
vkládání_závislosti	onYourDataEndpointVectorizationSource nebo onYourDataDeploymentNameVectorizationSource nebo onYourDataIntegratedVectorizationSource		Ne
koncový bod	řetězec	Absolutní cesta ke koncovému bodu pro prostředek Azure Search, který se má použít.	Ano
mapování polí	Možnosti mapování polí indexu Azure Search	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Služby Azure Search	Ne
filtr	řetězec	Filtr hledání.	Ne
v rozsahu	Boolean	Určuje, jestli se dotazy mají omezit na použití indexovaných dat.	Ne
zahrnout kontexty	pole	Zahrnuté vlastnosti výstupního kontextu. Pokud není zadána, výchozí hodnota je citations a intent.	Ne
název_indexu	řetězec	Název indexu, který se má použít jako dostupný v odkazovaném prostředku služby Azure Search.	Ano
maximální_počet_dotazů_na_vyhledávání	celočíselný	Maximální počet přepsaných dotazů by měl být odeslán poskytovateli vyhledávání pro jednu zprávu uživatele. Pokud není zadaný, systém rozhodne počet dotazů, které se mají odeslat.	Ne
typ_dotazu	azureSearchQueryType	Typ vyhledávacího dotazu Služby Azure Search, který se má spustit při použití jako rozšíření chatu Azure OpenAI.	Ne
semantická_konfigurace	řetězec	Další sémantická konfigurace dotazu.	Ne
přísnost	celočíselný	Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi.	Ne
top_n_documents (nejlepší_n_dokumenty)	celočíselný	Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz.	Ne

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

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

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

Typ dotazu do azureSearch

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

Vlastnictví	Hodnota
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
Hodnoty	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

azureCosmosDBChatExtensionKonfigurace

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

Název	Typ	Popis	Požaduje se	Výchozí
parametry	azureCosmosDBChatExtensionParameters	Parametry, které se mají použít při konfiguraci rozšíření chatu Azure OpenAI ve vašem datovém chatu při použití služby Azure Cosmos DB pro virtuální jádro MongoDB	Ne
typ	azureChatExtensionType	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.	Ano

azureCosmosDBChatExtensionParameters

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

Název	Typ	Popis	Požaduje se	Výchozí
povol_částečný_výsledek	Boolean	Pokud je zadána hodnota true, systém povolí použití částečných výsledků hledání a požadavek selže, pokud všechny dotazy selžou. Pokud není zadaný nebo zadaný jako false, požadavek selže, pokud některý vyhledávací dotaz selže.	Ne	Nepravda
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
název_kontejneru	řetězec	Název kontejneru prostředků služby Azure Cosmos DB.	Ano
název databáze	řetězec	Název databáze MongoDB vCore, který se má použít se službou Azure Cosmos DB.	Ano
vkládání_závislosti	onYourDataEndpointVectorizationSource nebo onYourDataDeploymentNameVectorizationSource		Ano
mapování polí	azureCosmosDBFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Služby Azure Cosmos DB	Ano
v rozsahu	Boolean	Určuje, jestli se dotazy mají omezit na použití indexovaných dat.	Ne
zahrnout kontexty	pole	Zahrnuté vlastnosti výstupního kontextu. Pokud není zadána, výchozí hodnota je citations a intent.	Ne
název_indexu	řetězec	Název indexu virtuálních jader MongoDB, který se má použít se službou Azure Cosmos DB.	Ano
maximální_počet_dotazů_na_vyhledávání	celočíselný	Maximální počet přepsaných dotazů by měl být odeslán poskytovateli vyhledávání pro jednu zprávu uživatele. Pokud není zadaný, systém rozhodne počet dotazů, které se mají odeslat.	Ne
přísnost	celočíselný	Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi.	Ne
top_n_documents (nejlepší_n_dokumenty)	celočíselný	Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz.	Ne

azureCosmosDBMožnostiMapováníPolí

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

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

Konfigurace rozšíření chatu Elasticsearch

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

Název	Typ	Popis	Požaduje se	Výchozí
parametry	elasticsearchChatExtensionParameters	Parametry, které se mají použít při konfiguraci Elasticsearch® jako rozšíření chatu Azure OpenAI	Ne
typ	azureChatExtensionType	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.	Ano

elasticsearchChatExtensionParameters

Parametry, které se mají použít při konfiguraci Elasticsearch® jako rozšíření chatu Azure OpenAI

Název	Typ	Popis	Požaduje se	Výchozí
povol_částečný_výsledek	Boolean	Pokud je zadána hodnota true, systém povolí použití částečných výsledků hledání a požadavek selže, pokud všechny dotazy selžou. Pokud není zadaný nebo zadaný jako false, požadavek selže, pokud některý vyhledávací dotaz selže.	Ne	Nepravda
ověřování	onYourDataKeyAndKeyIdAuthenticationOptions nebo onYourDataEncodedApiKeyAuthenticationOptions		Ano
vkládání_závislosti	onYourDataEndpointVectorizationSource nebo onYourDataDeploymentNameVectorizationSource nebo onYourDataModelIdVectorizationSource		Ne
koncový bod	řetězec	Koncový bod Elasticsearch®.	Ano
mapování polí	elasticsearchIndexFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Elasticsearch®.	Ne
v rozsahu	Boolean	Určuje, jestli se dotazy mají omezit na použití indexovaných dat.	Ne
zahrnout kontexty	pole	Zahrnuté vlastnosti výstupního kontextu. Pokud není zadána, výchozí hodnota je citations a intent.	Ne
název_indexu	řetězec	Název indexu Elasticsearch®.	Ano
maximální_počet_dotazů_na_vyhledávání	celočíselný	Maximální počet přepsaných dotazů by měl být odeslán poskytovateli vyhledávání pro jednu zprávu uživatele. Pokud není zadaný, systém rozhodne počet dotazů, které se mají odeslat.	Ne
typ_dotazu	elasticsearchQueryType	Typ dotazu na načtení Elasticsearch®, který by se měl spustit při použití jako rozšíření chatu Azure OpenAI.	Ne
přísnost	celočíselný	Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi.	Ne
top_n_documents (nejlepší_n_dokumenty)	celočíselný	Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz.	Ne

ElasticSearch možnosti mapování polí indexu

Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Elasticsearch®.

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

elasticsearchQueryType

Typ dotazu na načtení Elasticsearch®, který by se měl spustit při použití jako rozšíření chatu Azure OpenAI.

Vlastnictví	Hodnota
Popis	Typ dotazu na načtení Elasticsearch®, který by se měl spustit při použití jako rozšíření chatu Azure OpenAI.
Typ	řetězec
Hodnoty	simple vector

MongoDBChatExtensionConfiguration

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

Název	Typ	Popis	Požaduje se	Výchozí
parametry	mongoDBChatExtensionParameters	Parametry, které se mají použít při konfiguraci rozšíření chatu Azure OpenAI ve vašem datovém chatu při použití Mongo DB	Ne
typ	azureChatExtensionType	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.	Ano

Parametry rozšíření chatu MongoDB

Parametry, které se mají použít při konfiguraci rozšíření chatu Azure OpenAI ve vašem datovém chatu při použití Mongo DB

Název	Typ	Popis	Požaduje se	Výchozí
povol_částečný_výsledek	Boolean	Pokud je zadána hodnota true, systém povolí použití částečných výsledků hledání a požadavek selže, pokud všechny dotazy selžou. Pokud není zadaný nebo zadaný jako false, požadavek selže, pokud některý vyhledávací dotaz selže.	Ne	Nepravda
název_aplikace	řetězec	Název aplikace Mongo DB.	Ano
ověřování	naMožnostiOvěřeníPřihlašovacímJménemAPřístupovýmHeslem	Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití uživatelského jména a hesla	Ano
název kolekce	řetězec	Název kolekce Mongo DB.	Ano
název databáze	řetězec	Název databáze Mongo DB.	Ano
vkládání_závislosti	onYourDataEndpointVectorizationSource nebo onYourDataDeploymentNameVectorizationSource		Ano
koncový bod	řetězec	Název koncového bodu clusteru Mongo DB.	Ano
mapování polí	MongoDBFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Mongo DB.	Ano
v rozsahu	Boolean	Určuje, jestli se dotazy mají omezit na použití indexovaných dat.	Ne
zahrnout kontexty	pole	Zahrnuté vlastnosti výstupního kontextu. Pokud není zadána, výchozí hodnota je citations a intent.	Ne
název_indexu	řetězec	Název indexu Mongo DB.	Ano
maximální_počet_dotazů_na_vyhledávání	celočíselný	Maximální počet přepsaných dotazů by měl být odeslán poskytovateli vyhledávání pro jednu zprávu uživatele. Pokud není zadaný, systém rozhodne počet dotazů, které se mají odeslat.	Ne
přísnost	celočíselný	Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi.	Ne
top_n_documents (nejlepší_n_dokumenty)	celočíselný	Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz.	Ne

MongoDBFieldMappingOptions

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

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

pineconeChatExtensionConfiguration

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

Název	Typ	Popis	Požaduje se	Výchozí
parametry	pineconeChatExtensionParameters	Parametry pro konfiguraci rozšíření chatu Azure OpenAI Pinecone	Ne
typ	azureChatExtensionType	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.	Ano

pineconeChatExtensionParameters

Parametry pro konfiguraci rozšíření chatu Azure OpenAI Pinecone

Název	Typ	Popis	Požaduje se	Výchozí
povol_částečný_výsledek	Boolean	Pokud je zadána hodnota true, systém povolí použití částečných výsledků hledání a požadavek selže, pokud všechny dotazy selžou. Pokud není zadaný nebo zadaný jako false, požadavek selže, pokud některý vyhledávací dotaz selže.	Ne	Nepravda
ověřování	onYourDataMožnostiOvěřováníApiKey	Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití klíče rozhraní API	Ano
vkládání_závislosti	onYourDataDeploymentNameVectorizationSource	Podrobnosti o vektorizačním zdroji, který azure OpenAI ve vašich datech používá 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.	Ano
prostředí	řetězec	Název prostředí Pinecone.	Ano
mapování polí	pineconeFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Pinecone.	Ano
v rozsahu	Boolean	Určuje, jestli se dotazy mají omezit na použití indexovaných dat.	Ne
zahrnout kontexty	pole	Zahrnuté vlastnosti výstupního kontextu. Pokud není zadána, výchozí hodnota je citations a intent.	Ne
název_indexu	řetězec	Název indexu databáze Pinecone.	Ano
maximální_počet_dotazů_na_vyhledávání	celočíselný	Maximální počet přepsaných dotazů by měl být odeslán poskytovateli vyhledávání pro jednu zprávu uživatele. Pokud není zadaný, systém rozhodne počet dotazů, které se mají odeslat.	Ne
přísnost	celočíselný	Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi.	Ne
top_n_documents (nejlepší_n_dokumenty)	celočíselný	Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz.	Ne

možnosti mapování pole šiška

Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Pinecone.

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

onMožnostiOvěřeníDat

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

Diskriminátor pro onYourDataAuthenticationOptions

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schéma
api_key	onYourDataMožnostiOvěřováníApiKey
connection_string	onYourDataConnectionStringAuthenticationOptions
key_and_key_id	Možnosti autentizace na základě vašich datových klíčů a klíčového identifikátoru
encoded_api_key	onYourDataZakódovanéVolbyOvěřeníApiKlíče
access_token	VašeMožnostiAutentizacePřístupovéhoTokenuData
system_assigned_managed_identity	Možnosti ověřování spravované identity přiřazené vašemu datovému systému
user_assigned_managed_identity	MožnostiAutentizaceSpravovanéIdentityPřiřazenéUživatelemProVašeData
username_and_password	naMožnostiOvěřeníPřihlašovacímJménemAPřístupovýmHeslem

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

naVašiDatovouKontextovouVlastnost

Kontextová vlastnost.

Vlastnictví	Hodnota
Popis	Kontextová vlastnost.
Typ	řetězec
Hodnoty	citations intent all_retrieved_documents

typAutentizaceNaVašichDatech

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

Vlastnictví	Hodnota
Popis	Typy ověřování podporované v Azure OpenAI ve vašich datech.
Typ	řetězec
Hodnoty	api_key connection_string key_and_key_id encoded_api_key access_token system_assigned_managed_identity user_assigned_managed_identity username_and_password

onYourDataMožnostiAutentizaceApiKlíče

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

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

onYourDataConnectionStringAuthenticationOptions

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

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

Možnosti autentizace pomocí klíčů vašich dat a identifikátoru klíče

Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití klíče Elasticsearch a páru ID klíče.

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

MožnostiAutentizaceApiKlíčeZakódovanéVeVašichDatech

Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití klíče rozhraní API s kódováním Elasticsearch.

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

Možnosti Ověření Tokenu Přístupu na Vaše Data

Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití přístupového tokenu.

Název	Typ	Popis	Požaduje se	Výchozí
access_token (přístupový token)	řetězec	Přístupový token, který se má použít k ověřování.	Ne
typ	naVašemTypuOvěřeníDat	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Ano

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

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

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

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

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

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

onVašeDataMožnostiOvěřeníPomocíUživatelskéhoJménaAHesla

Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití uživatelského jména a hesla

Název	Typ	Popis	Požaduje se	Výchozí
Heslo	řetězec	Heslo. použít k ověřování.	Ne
typ	naVašemTypuOvěřeníDat	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Ano
uživatelské jméno	řetězec	Uživatelské jméno, které se má použít k ověřování.	Ne

vektorizaceDatovéhoZdrojovéhoKódu

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

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schéma
endpoint	onVašedataovýKoncovýBodVektorizaceZdroj
deployment_name	naVašemDataNasazeníJménoVektorizačníZdroj
integrated	naVašeDataIntegrovanáVektorizaceZdroj
model_id	naVašemModeluDatIdVektorizaceZdroj

Název	Typ	Popis	Požaduje se	Výchozí
typ	naVášTypZdrojDataVektorizace	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.	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.

Vlastnictví	Hodnota
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ým vyhledáváním.
Typ	řetězec
Hodnoty	endpoint deployment_name integrated model_id

NaVašeDataKoncovýBodVektorizaceZdroj

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

Název	Typ	Popis	Požaduje se	Výchozí
ověřování	onYourDataApiKeyAuthenticationOptions nebo onYourDataAccessTokenAuthenticationOptions		Ne
rozměry	celočíselný	Počet dimenzí, které by měly mít vložené hodnoty. Podporováno pouze v text-embedding-3 novějších modelech.	Ne
koncový bod	řetězec	Určuje adresu URL koncového bodu prostředku, ze které se mají načíst vkládání. Měl by být ve formátu https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Parametr dotazu api-version není povolený.	Ne
typ	naVášTypZdrojDataVektorizace	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.	Ano

onYourDataDeploymentNameVectorizationSource

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

Název	Typ	Popis	Požaduje se	Výchozí
název_nasazení	řetězec	Určuje název nasazení modelu, který se má použít pro vektorizaci. Toto nasazení modelu musí být ve stejném prostředku Azure OpenAI, ale ve vašich datech bude toto nasazení modelu používat prostřednictvím interního volání, nikoli veřejného, což umožňuje vektorové vyhledávání i v privátních sítích.	Ne
rozměry	celočíselný	Počet dimenzí, které by měly mít vložené hodnoty. Podporováno pouze v text-embedding-3 novějších modelech.	Ne
typ	naVášTypZdrojDataVektorizace	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.	Ano

onYourDataIntegrovanýVektorizaceZdroj

Představuje integrovaný vektorizátor definovaný v rámci vyhledávacího prostředku.

Název	Typ	Popis	Požaduje se	Výchozí
typ	naVášTypZdrojDataVektorizace	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.	Ano

onYourDataModelIdVectorizationSource

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 ID modelu vyhledávací služby. V současné době podporuje pouze Elasticsearch®.

Název	Typ	Popis	Požaduje se	Výchozí
identifikátor modelu	řetězec	Určuje ID modelu, které se má použít pro vektorizaci. Toto ID modelu musí být definováno ve vyhledávací službě.	Ne
typ	naVášTypZdrojDataVektorizace	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.	Ano

KontextZprávyChatRozšířeníAzure

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

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

citace

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

Název	Typ	Popis	Požaduje se	Výchozí
identifikátor_chunku	řetězec	ID bloku citace.	Ne
obsah	řetězec	Obsah citace.	Ano
cesta k souboru	řetězec	Cesta k souboru citace.	Ne
skóre přeuspořádání	Číslo	Skóre opětovného pořadí načteného dokumentu.	Ne
název	řetězec	Název citace.	Ne
adresa URL	řetězec	Adresa URL citace.	Ne

dokument získaný

Načtený dokument.

Název	Typ	Popis	Požaduje se	Výchozí
identifikátor_chunku	řetězec	ID bloku citace.	Ne
obsah	řetězec	Obsah citace.	Ano
index_zdroj_dat	celočíselný	Index zdroje dat.	Ne
cesta k souboru	řetězec	Cesta k souboru citace.	Ne
důvod_filtru	filterReason	Důvod filtrování načteného dokumentu.	Ne
původní_skóre_vyhledávání	Číslo	Původní skóre hledání načteného dokumentu.	Ne
skóre přeuspořádání	Číslo	Skóre opětovného pořadí načteného dokumentu.	Ne
vyhledávací dotazy	pole	Vyhledávací dotazy použité k načtení dokumentu.	Ne
název	řetězec	Název citace.	Ne
adresa URL	řetězec	Adresa URL citace.	Ne

důvod filtru

Důvod filtrování načteného dokumentu.

Vlastnictví	Hodnota
Popis	Důvod filtrování načteného dokumentu.
Typ	řetězec
Hodnoty	score rerank

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

Název	Typ	Popis	Požaduje se	Výchozí
funkce	objekt	Funkce, kterou model volal.	Ano
└argumenty	řetězec	Argumenty pro volání funkce s vygenerovaným modelem ve formátu JSON. Všimněte si, že model negeneruje vždy platný json a může halucinovat parametry, které nejsou definovány schématem vaší funkce. Před voláním funkce ověřte argumenty v kódu.	Ne
└– název	řetězec	Název funkce, která se má volat.	Ne
ID	řetězec	ID volání nástroje.	Ano
typ	typ volání nástrojů	Typ volání nástroje v tomto případě function.	Ano

typ volání nástroje

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

Vlastnictví	Hodnota
Popis	Typ volání nástroje v tomto případě function.
Typ	řetězec
Hodnoty	function

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

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

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

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

createChatCompletionResponse

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

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

createChatCompletionStreamResponse

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

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

chatCompletionStreamResponseDelta

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

Název	Typ	Popis	Požaduje se	Výchozí
obsah	řetězec	Obsah zprávy bloku dat.	Ne
volání funkce	objekt	Zastaralé a nahrazené .tool_calls Název a argumenty funkce, které by se měly volat, jak je vygeneroval model.	Ne
└argumenty	řetězec	Argumenty pro volání funkce s vygenerovaným modelem ve formátu JSON. Všimněte si, že model negeneruje vždy platný json a může halucinovat parametry, které nejsou definovány schématem vaší funkce. Před voláním funkce ověřte argumenty v kódu.	Ne
└– název	řetězec	Název funkce, která se má volat.	Ne
odmítnutí	řetězec	Odmítnutí zprávy generované modelem.	Ne
úloha	výčet	Role autora této zprávy Možné hodnoty: system, user, assistant, tool	Ne
volání nástrojů	pole		Ne

chatCompletionMessageToolCallChunk

Název	Typ	Popis	Požaduje se	Výchozí
funkce	objekt		Ne
└argumenty	řetězec	Argumenty pro volání funkce s vygenerovaným modelem ve formátu JSON. Všimněte si, že model negeneruje vždy platný json a může halucinovat parametry, které nejsou definovány schématem vaší funkce. Před voláním funkce ověřte argumenty v kódu.	Ne
└– název	řetězec	Název funkce, která se má volat.	Ne
ID	řetězec	ID volání nástroje.	Ne
rejstřík	celočíselný		Ano
typ	výčet	Typ nástroje. V současné době se podporuje pouze function . Možné hodnoty: function	Ne

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

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

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

chatCompletionChoiceLogProbs

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

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

chatCompletionTokenLogprob

Název	Typ	Popis	Požaduje se	Výchozí
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
logprob	Číslo	Pravděpodobnost protokolu tohoto tokenu.	Ano
žeton	řetězec	Token.	Ano
top_logprobs	pole	Seznam nejpravděpodobnějších tokenů a jejich pravděpodobnosti protokolu v této pozici tokenu Ve výjimečných případech může být méně než počet požadovaných vrácených top_logprobs položek.	Ano

zpráva odpovědi dokončení chatu

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

Název	Typ	Popis	Požaduje se	Výchozí
zvuk	objekt	Pokud je požadován režim zvukového výstupu, tento objekt obsahuje data o zvukové odpovědi z modelu.	Ne
└- data	řetězec	Bajty zvuku vygenerované modelem v kódování Base64 ve formátu zadaném v požadavku	Ne
└- vyprší_dne	celočíselný	Unixové časové razítko (v sekundách) pro dobu, kdy tato zvuková odpověď už nebude přístupná na serveru pro použití ve víceotáčkových konverzacích.	Ne
└- ID	řetězec	Jedinečný identifikátor této zvukové odpovědi.	Ne
└- přepis	řetězec	Přepis zvuku vygenerovaného modelem	Ne
obsah	řetězec	Obsah zprávy.	Ano
kontext	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í.	Ne
volání funkce	chatCompletionFunctionCall	Zastaralé a nahrazené .tool_calls Název a argumenty funkce, které by se měly volat, jak je vygeneroval model.	Ne
odmítnutí	řetězec	Odmítnutí zprávy generované modelem.	Ano
úloha	chatCompletionResponseMessageRole	Role autora zprávy odpovědi	Ano
volání nástrojů	pole	Nástroj volá volání vygenerovaná modelem, například volání funkcí.	Ne

chatCompletionResponseMessageRole

Role autora zprávy odpovědi

Vlastnictví	Hodnota
Popis	Role autora zprávy odpovědi
Typ	řetězec
Hodnoty	assistant

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

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

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

• Výběr pojmenovaného nástroje pro dokončení chatu

VýběrNástrojeProDokončeníChatu

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

Název	Typ	Popis	Požaduje se	Výchozí
funkce	objekt		Ano
└– název	řetězec	Název funkce, která se má volat.	Ne
typ	výčet	Typ nástroje. V současné době se podporuje pouze function . Možné hodnoty: function	Ano

ParallelToolCalls

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

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

ObsahPředpovědi

Statický predikovaný výstupní obsah, například obsah textového souboru, který se generuje znovu.

Název	Typ	Popis	Požaduje se	Výchozí
obsah	řetězec nebo pole	Obsah, který by se měl shodovat při generování odpovědi modelu. Pokud by vygenerované tokeny odpovídaly tomuto obsahu, může se celá odpověď modelu vrátit mnohem rychleji.	Ano
typ	výčet	Typ predikovaného obsahu, který chcete poskytnout. Tento typ je nyní vždy content. Možné hodnoty: content	Ano

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

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

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

Modalities pro dokončení chatu

Výstupní typy, které chcete, aby model vygeneroval pro tento požadavek. Většina modelů dokáže generovat text, což je výchozí nastavení:

["text"]

Model gpt-4o-audio-preview lze také použít k vygenerování zvuku. Pokud chcete požádat, aby tento model generoval textové i zvukové odpovědi, můžete použít:

["text", "audio"]

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

volání funkce dokončení chatu

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

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

použití dokončení

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

Název	Typ	Popis	Požaduje se	Výchozí
dokončovací tokens	celočíselný	Počet tokenů ve vygenerovaném dokončení	Ano
Podrobnosti o dokončovacích tokenech	objekt	Rozpis tokenů použitých při dokončování	Ne
└──────────přijaté_predikční_tokeny	celočíselný	Při použití předpovídané výstupy počet tokenů v predikci, která se objevila v dokončení.	Ne
└audio_tokens	celočíselný	Zvukové vstupní tokeny vygenerované modelem	Ne
└─ "reasoning_tokens"	celočíselný	Tokeny vygenerované modelem z důvodu odůvodnění	Ne
└─ odmítnuté_predikční_toky	celočíselný	Při použití předpovídaného výstupu se počet tokenů v predikci, které se v dokončení nezodpověděly. Podobně jako u zdůvodnění tokenů se tyto tokeny stále započítávají do celkového počtu tokenů dokončení pro účely fakturace, výstupu a limitů kontextových oken.	Ne
tokeny výzvy	celočíselný	Počet tokenů v příkazovém řádku	Ano
podrobnosti_tokenu_výzvy	objekt	Podrobnostioch	Ne
└audio_tokens	celočíselný	Vstupní zvukové tokeny, které jsou přítomné na příkazovém řádku.	Ne
└─ uložené_tokény	celočíselný	Počet tokenů výzvy uložených v mezipaměti.	Ne
celkový počet tokenů	celočíselný	Celkový počettokench	Ano

nástroj pro dokončení chatu

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

Parametry funkce

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

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

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

FunctionObject

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

FormátOdpovědiText

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

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

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

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

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

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

FormátOdpovědiJsonSchéma

Název	Typ	Popis	Požaduje se	Výchozí
JSON schema	objekt		Ano
└- popis	řetězec	Popis formátu odpovědi, který model používá k určení způsobu reakce ve formátu.	Ne
└– název	řetězec	Název formátu odpovědi. Musí být a-z, A-Z, 0-9 nebo obsahovat podtržítka a pomlčky s maximální délkou 64.	Ne
└- schéma	FormátOdpovědiJsonSchemaSchema	Schéma pro formát odpovědi popsané jako objekt schématu JSON.	Ne
└- striktní	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.	Ne	Nepravda
typ	výčet	Typ formátu odpovědi, který se definuje: json_schema Možné hodnoty: json_schema	Ano

VolbaDokončeníChatůSpolečná

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

vytvořit Žádost o Překlad

Žádost o překlad

Název	Typ	Popis	Požaduje se	Výchozí
soubor	řetězec	Zvukový soubor, který chcete přeložit.	Ano
pobídnout	řetězec	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla být v angličtině.	Ne
formát_odpovědi	audioResponseFormat	Definuje formát výstupu.	Ne
Teplota	Číslo	Teplota vzorkování mezi 0 a 1. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Pokud je nastavená hodnota 0, model použije pravděpodobnost protokolu k automatickému zvýšení teploty do dosažení určitých prahových hodnot.	Ne	0

zvuková odpověď

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

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

audioVerboseResponse

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

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

formát zvukové odpovědi

Definuje formát výstupu.

Vlastnictví	Hodnota
Popis	Definuje formát výstupu.
Typ	řetězec
Hodnoty	json text srt verbose_json vtt

vytvořitŽádostOTranskripci

Žádost o přepis

Název	Typ	Popis	Požaduje se	Výchozí
soubor	řetězec	Objekt zvukového souboru, který se má přepisovat.	Ano
jazyk	řetězec	Jazyk vstupního zvuku. Poskytnutí jazyka zadávání vstupu ve formátu ISO-639-1 zlepší přesnost a latenci.	Ne
pobídnout	řetězec	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla odpovídat jazyku zvuku.	Ne
formát_odpovědi	audioResponseFormat	Definuje formát výstupu.	Ne
Teplota	Číslo	Teplota vzorkování mezi 0 a 1. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Pokud je nastavená hodnota 0, model použije pravděpodobnost protokolu k automatickému zvýšení teploty do dosažení určitých prahových hodnot.	Ne	0
časová_zrnitost[]	pole	Členitosti časového razítka, které se mají pro tento přepis naplnit. response_format musí být nastavená verbose_json tak, aby používala členitosti časového razítka. Podporují se obě tyto možnosti: wordnebo segment. Poznámka: U časových označení segmentů není žádná další latence, ale generování časových označení slov způsobuje další latenci.	Ne	['úsek']

zvukový segment

Přepis nebo segment překladu

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

audioWord

Přepis nebo překlad slova

Název	Typ	Popis	Požaduje se	Výchozí
konec	Číslo	Odsazení konce wordu	Ne
začátek	Číslo	Začátek wordového posunu	Ne
slovo	řetězec	Slovo	Ne

vytvořitPožadavekNaŘeč

Žádost o řeč

Název	Typ	Popis	Požaduje se	Výchozí
vstup	řetězec	Text pro syntetizaci zvuku. Maximální délka je 4096 znaků.	Ano
formát_odpovědi	výčet	Formát syntetizování zvuku v. Možné hodnoty: mp3, opus, aac, flac, wavpcm	Ne
rychlost	Číslo	Rychlost syntetizovaného zvuku. Vyberte hodnotu od 0.25 do 4.0. 1.0 je výchozí možnost.	Ne	1.0
hlas	výčet	Hlas, který se má použít pro syntézu řeči. Možné hodnoty: alloy, echo, fable, onyx, novashimmer	Ano

kvalita obrázku

Kvalita image, která se vygeneruje.

Vlastnictví	Hodnota
Popis	Kvalita image, která se vygeneruje.
Typ	řetězec
výchozí	Auto
Hodnoty	auto high medium low hd standard

formát odezvy obrázků

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

Vlastnictví	Hodnota
Popis	Formát, ve kterém se vrátí vygenerované obrázky.
Typ	řetězec
výchozí	adresa URL
Hodnoty	url b64_json

formátVýstupuObrázků

Formát souboru, ve kterém se vrátí vygenerované obrázky. Podporováno pouze pro gpt-image-1.

Vlastnictví	Hodnota
Popis	Formát souboru, ve kterém se vrátí vygenerované obrázky. Podporováno pouze pro gpt-image-1.
Typ	řetězec
výchozí	formát PNG
Hodnoty	png jpeg

velikost obrázku

Velikost vygenerovaných obrázků.

Vlastnictví	Hodnota
Popis	Velikost vygenerovaných obrázků.
Typ	řetězec
výchozí	Auto
Hodnoty	auto 1792x1024 1024x1792 1024x1024 1024x1536 1536x1024

styl obrázku

Styl vygenerovaných obrázků Podporováno pouze pro dall-e-3.

Vlastnictví	Hodnota
Popis	Styl vygenerovaných obrázků Podporováno pouze pro dall-e-3.
Typ	řetězec
výchozí	živý
Hodnoty	vivid natural

pozadí obrazu

Umožňuje nastavit průhlednost pozadí vygenerovaných obrázků. Tento parametr je podporován pouze pro gpt-image-1.

Vlastnictví	Hodnota
Popis	Umožňuje nastavit průhlednost pozadí vygenerovaných obrázků. Tento parametr je podporován pouze pro gpt-image-1.
Typ	řetězec
výchozí	Auto
Hodnoty	transparent opaque auto

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

Název	Typ	Popis	Požaduje se	Výchozí
pozadí	imageBackground	Umožňuje nastavit průhlednost pozadí vygenerovaných obrázků. Tento parametr je podporován pouze pro gpt-image-1.	Ne	Auto
n	celočíselný	Počet obrázků, které se mají vygenerovat. Pro dall-e-3 se podporuje pouze n=1.	Ne	0
komprese_výstupu	celočíselný	Úroveň komprese (0–100%) pro vygenerované obrázky. Tento parametr je podporován pouze pro gpt-image-1 s výstupním formátem jpeg.	Ne	100
formát_výstupu	imagesOutputFormat	Formát souboru, ve kterém se vrátí vygenerované obrázky. Podporováno pouze pro gpt-image-1.	Ne	formát PNG
pobídnout	řetězec	Textový popispožadovaných Maximální délka je 32000 znaků pro gpt-image-1 a 4000 znaků pro dall-e-3.	Ano
kvalita	imageQuality	Kvalita image, která se vygeneruje.	Ne	Auto
formát_odpovědi	imagesResponseFormat	Formát, ve kterém se vrátí vygenerované obrázky.	Ne	adresa URL
velikost	imageSize	Velikost vygenerovaných obrázků.	Ne	Auto
– styl	imageStyle	Styl vygenerovaných obrázků Podporováno pouze pro dall-e-3.	Ne	živý
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	Ne

požadavek na úpravu obrázku

Název	Typ	Popis	Požaduje se	Výchozí
image	řetězec nebo pole	Obrázky, které chcete upravit. Musí to být podporovaný soubor obrázku nebo pole obrázků. Každý obrázek by měl být soubor png nebo jpg menší než 25 MB.	Ano
maska	řetězec	Další obrázek, jehož plně průhledné oblasti (např. kde alfa je nula), označuje, kde má být obrázek upraven. Pokud je k dispozici více obrázků, použije se maska na první obrázek. Musí to být platný soubor PNG, menší než 4 MB a musí mít stejné rozměry jako obrázek.	Ne
n	celočíselný	Počet obrázků, které se mají vygenerovat.	Ne	0
pobídnout	řetězec	Textový popispožadovaných Maximální délka je 32000 znaků.	Ano
kvalita	imageQuality	Kvalita image, která se vygeneruje.	Ne	Auto
formát_odpovědi	imagesResponseFormat	Formát, ve kterém se vrátí vygenerované obrázky.	Ne	adresa URL
velikost	imageSize	Velikost vygenerovaných obrázků.	Ne	Auto
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.	Ne

generateImagesResponse

Název	Typ	Popis	Požaduje se	Výchozí
vytvořené	celočíselný	Časové razítko unixu při vytvoření operace.	Ano
údaje	pole	Výsledná data operace, pokud jsou úspěšná	Ano
využití	imageGenerationsUsage	Představuje podrobnosti o využití tokenu pro žádosti o generování imagí. Pouze pro gpt-image-1.	Ne

výsledek obrázku

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

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

použití generování obrázků

Představuje podrobnosti o využití tokenu pro žádosti o generování imagí. Pouze pro gpt-image-1.

Název	Typ	Popis	Požaduje se	Výchozí
vstupní_tokeny	celočíselný	Počet vstupních tokenů.	Ne
podrobnosti_o_vstupních_tokenech	objekt	Podrobný rozpis vstupních tokenů	Ne
└image_tokens	celočíselný	Počet tokenů image.	Ne
└text_tokens	celočíselný	Počet textových tokenů	Ne
výstupní_tokeny	celočíselný	Počet výstupních tokenů	Ne
celkový počet tokenů	celočíselný	Celkový počet použitých tokenů	Ne

čára

Objekt řádku obsahu, který se skládá ze sousední sekvence prvků obsahu, jako jsou slova a značky výběru.

Název	Typ	Popis	Požaduje se	Výchozí
rozpětí	pole	Pole rozsahů, které představují zjištěné objekty a informace o ohraničujícím rámečku.	Ano
Text	řetězec		Ano

rozpětí

Objekt span, který představuje rozpoznaný objekt a informace o ohraničujícím rámečku.

Název	Typ	Popis	Požaduje se	Výchozí
délka	celočíselný	Délka rozsahu znaků měřená v bodech kódu Unicode.	Ano
ofsetový tisk	celočíselný	Posun znaku v textu, kde začíná rozsah. Tento posun je definován jako pozice prvního znaku rozsahu, počítá se od začátku textu jako znakové body Unicode.	Ano
mnohoúhelník	pole	Pole objektů představujících body v mnohoúhelníku, které ohraničují rozpoznaný objekt.	Ano
Text	řetězec	Textový obsah rozsahu, který představuje zjištěný objekt.	Ano

runCompletionUsage

Statistiky využití související se spuštěním Tato hodnota bude, null pokud spuštění není v terminálovém stavu (tj. in_progress, queuedatd.).

Název	Typ	Popis	Požaduje se	Výchozí
dokončovací tokens	celočíselný	Počet tokenů dokončení použitých v průběhu spuštění	Ano
tokeny výzvy	celočíselný	Počet výzev tokenů použitých v průběhu spuštění	Ano
celkový počet tokenů	celočíselný	Celkový počet použitých tokenů (výzva + dokončení).	Ano

použití dokončení kroku

Statistiky využití související s krokem spuštění Tato hodnota bude null v době, kdy je in_progressstav kroku spuštění .

Název	Typ	Popis	Požaduje se	Výchozí
dokončovací tokens	celočíselný	Počet tokenů dokončení použitých v průběhu kroku spuštění	Ano
tokeny výzvy	celočíselný	Počet výzev tokenů použitých v průběhu kroku spuštění	Ano
celkový počet tokenů	celočíselný	Celkový počet použitých tokenů (výzva + dokončení).	Ano

asistentiApiResponseFormatOption

Určuje formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4 Turbo a všemi modely GPT-3.5 Turbo od .gpt-3.5-turbo-1106

Nastavení { "type": "json_schema", "json_schema": {...} } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat vašemu zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy.

{ "type": "json_object" } Nastavením povolíte režim JSON, který zajistí, že zpráva, kterou model vygeneruje, je platný JSON.

Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.

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

• ResponseFormatText
• ResponseFormatJsonObject
• FormátOdpovědiJsonSchema

asistentiApiResponseFormat

Objekt popisující očekávaný výstup modelu. Je-li json_object povoleno předání pouze function typu tools do spuštění. Pokud text model může vrátit text nebo libovolnou potřebnou hodnotu.

Název	Typ	Popis	Požaduje se	Výchozí
typ	řetězec	Musí to být jedna z text nebo json_object.	Ne	Text

type Enum: FormátOdpovědiAsistentaAPI

Hodnota	Popis
Text
objekt JSON

asistentský objekt

Představuje model assistant , který může volat model a používat nástroje.

Název	Typ	Popis	Požaduje se	Výchozí
datum_vytvoření	celočíselný	Časové razítko unixu (v sekundách) pro vytvoření asistenta.	Ano
popis	řetězec	Popis asistenta. Maximální délka je 512 znaků.	Ano
ID	řetězec	Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.	Ano
pokyny	řetězec	Systémové pokyny, které asistent používá. Maximální délka je 256 000 znaků.	Ano
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ano
model	řetězec	ID modelu, který se má použít.	Ano
jméno	řetězec	Jméno asistenta. Maximální délka je 256 znaků.	Ano
objekt	řetězec	Typ objektu, který je vždy assistant.	Ano
formát_odpovědi	asistentiApiResponseFormatOption	Určuje formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4 Turbo a všemi modely GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Nastavení { "type": "json_schema", "json_schema": {...} } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat vašemu zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy. { "type": "json_object" } Nastavením povolíte režim JSON, který zajistí, že zpráva, kterou model vygeneruje, je platný JSON. Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.	Ne
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.	Ne	0
nástroje a zdroje	objekt	Sada prostředků, které používají nástroje asistenta. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.	Ne
└ code_interpreter	objekt		Ne
└- file_ids	pole	Seznam ID souborů zpřístupněných nástroji code_interpreter . K nástroji může být přidruženo maximálně 20 souborů.	Ne	[]
└─file_search	objekt		Ne
└─ identifikátory_úložiště_vektorů	pole	ID vektorového úložiště připojeného k tomuto asistentovi. K asistentovi může být připojeno maximálně 1 vektorové úložiště.	Ne
nářadí	pole	Seznam nástrojů povolených v asistentovi. Na asistenta může být maximálně 128 nástrojů. Nástroje mohou být typu code_interpreter, file_searchnebo function.	Ano	[]
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í.	Ne	0

object Enum: AssistantObjectType

Hodnota	Popis
asistent	Typ objektu, který je vždy pomocníkem

VytvořitPožadavekNaAsistenta

Název	Typ	Popis	Požaduje se	Výchozí
popis	řetězec	Popis asistenta. Maximální délka je 512 znaků.	Ne
pokyny	řetězec	Systémové pokyny, které asistent používá. Maximální délka je 256 000 znaků.	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
model	řetězec		Ano
jméno	řetězec	Jméno asistenta. Maximální délka je 256 znaků.	Ne
formát_odpovědi	asistentiApiResponseFormatOption	Určuje formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4 Turbo a všemi modely GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Nastavení { "type": "json_schema", "json_schema": {...} } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat vašemu zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy. { "type": "json_object" } Nastavením povolíte režim JSON, který zajistí, že zpráva, kterou model vygeneruje, je platný JSON. Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.	Ne
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.	Ne	0
nástroje a zdroje	objekt	Sada prostředků, které používají nástroje asistenta. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.	Ne
└ code_interpreter	objekt		Ne
└- file_ids	pole	Seznam ID souborů zpřístupněných nástroji code_interpreter . K nástroji může být přidruženo maximálně 20 souborů.	Ne	[]
└─file_search	objekt		Ne
└─ identifikátory_úložiště_vektorů	pole	Vektorové úložiště připojené k tomuto asistentovi. K asistentovi může být připojeno maximálně 1 vektorové úložiště.	Ne
└vector_stores	pole	Pomocník pro vytvoření vektorového úložiště s file_ids a jeho připojením k tomuto asistentovi. K asistentovi může být připojeno maximálně 1 vektorové úložiště.	Ne
nářadí	pole	Seznam nástrojů povolených v asistentovi. Na asistenta může být maximálně 128 nástrojů. Nástroje mohou být typu code_interpreter, retrievalnebo function.	Ne	[]
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í.	Ne	0

upravitPožadavekAsistenta

Název	Typ	Popis	Požaduje se	Výchozí
popis	řetězec	Popis asistenta. Maximální délka je 512 znaků.	Ne
pokyny	řetězec	Systémové pokyny, které asistent používá. Maximální délka je 32768 znaků.	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
model	řetězec		Ne
jméno	řetězec	Jméno asistenta. Maximální délka je 256 znaků.	Ne
formát_odpovědi	asistentiApiResponseFormatOption	Určuje formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4 Turbo a všemi modely GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Nastavení { "type": "json_schema", "json_schema": {...} } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat vašemu zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy. { "type": "json_object" } Nastavením povolíte režim JSON, který zajistí, že zpráva, kterou model vygeneruje, je platný JSON. Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.	Ne
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.	Ne	0
nástroje a zdroje	objekt	Sada prostředků, které používají nástroje asistenta. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.	Ne
└ code_interpreter	objekt		Ne
└- file_ids	pole	Přepíše seznam ID souborů zpřístupněných nástroji code_interpreter . K nástroji může být přidruženo maximálně 20 souborů.	Ne	[]
└─file_search	objekt		Ne
└─ identifikátory_úložiště_vektorů	pole	Přepíše vektorové úložiště připojené k tomuto asistentovi. K asistentovi může být připojeno maximálně 1 vektorové úložiště.	Ne
nářadí	pole	Seznam nástrojů povolených v asistentovi. Na asistenta může být maximálně 128 nástrojů. Nástroje mohou být typu code_interpreter, retrievalnebo function.	Ne	[]
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í.	Ne	0

smazatOdpověďAsistenta

Název	Typ	Popis	Požaduje se	Výchozí
odstraněný	Boolean		Ano
ID	řetězec		Ano
objekt	řetězec		Ano

object Enum: DeleteAssistantResponseState

Hodnota	Popis
asistent.smazán

Odpověď na seznam asistentů

Název	Typ	Popis	Požaduje se	Výchozí
údaje	pole		Ano
first_id	řetězec		Ano
má více	Boolean		Ano
last_id	řetězec		Ano
objekt	řetězec		Ano

kódNástrojůAsistenta

Název	Typ	Popis	Požaduje se	Výchozí
typ	řetězec	Typ definovaného nástroje: code_interpreter	Ano

typ Enum: assistantToolsCodeType

Hodnota	Popis
interpreta kódu

Nástroje asistenta pro vyhledávání souborů

Název	Typ	Popis	Požaduje se	Výchozí
hledání souboru	objekt	Přepisy pro nástroj pro vyhledávání souborů.	Ne
└max_num_results	celočíselný	Maximální počet výsledků by měl být výstupem nástroje pro vyhledávání souborů. Výchozí hodnota je 20 pro modely gpt-4* a 5 pro gpt-3.5-turbo. Toto číslo by mělo být mezi 1 a 50 včetně. Všimněte si, že nástroj pro vyhledávání souborů může vypisovat méně výsledků než max_num_results výsledky.	Ne
typ	řetězec	Typ definovaného nástroje: file_search	Ano

typ Enum: assistantToolsFileSearchType

Hodnota	Popis
hledání souboru

assistantToolsFileSearchTypeOnly

Název	Typ	Popis	Požaduje se	Výchozí
typ	řetězec	Typ definovaného nástroje: file_search	Ano

typ Enum: assistantToolsFileSearchType

Hodnota	Popis
hledání souboru

funkce asistenčních nástrojů

Název	Typ	Popis	Požaduje se	Výchozí
funkce	objekt	Definice funkce.	Ano
└- popis	řetězec	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.	Ne
└– název	řetězec	Název funkce, která se má volat. Musí být a-z, A-Z, 0-9 nebo obsahovat podtržítka a pomlčky s maximální délkou 64.	Ne
└– parametry	chatCompletionFunctionParameters	Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON. Podívejte se na příručku/ příklady a referenční informace ke schématu JSON pro dokumentaci k formátu.	Ne
typ	řetězec	Typ definovaného nástroje: function	Ano

type Enum: assistantToolsFunction

Hodnota	Popis
funkce

truncationObject

Určuje, jak bude vlákno před spuštěním zkráceno. Pomocí tohoto příkazu můžete řídit počáteční kontextové okno spuštění.

Název	Typ	Popis	Požaduje se	Výchozí
poslední_zprávy	celočíselný	Počet nejnovějších zpráv z vlákna při vytváření kontextu pro spuštění.	Ne
typ	řetězec	Strategie zkrácení, která se má použít pro vlákno. Výchozí hodnota je auto. Pokud je nastavená hodnota last_messages, vlákno bude zkráceno na n nejnovější zprávy ve vlákně. Při nastavení na autohodnotu , zprávy uprostřed vlákna budou vynechán tak, aby odpovídaly kontextové délce modelu, max_prompt_tokens.	Ano

type Enum: Typ zkrácení

Hodnota	Popis
Auto
poslední_zprávy

asistentiApiToolChoiceOption

Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádné nástroje a místo toho vygeneruje zprávu. auto je výchozí hodnota a znamená, že model může vybrat mezi generováním zprávy nebo voláním nástroje. Určení konkrétního nástroje, například {"type": "file_search"} nebo {"type": "function", "function": {"name": "my_function"}} vynutí model, aby tento nástroj volal.

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

• assistantsNamedToolChoice

volbaNástrojeNazvanáAsistentem

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

Název	Typ	Popis	Požaduje se	Výchozí
funkce	objekt		Ne
└– název	řetězec	Název funkce, která se má volat.	Ne
typ	řetězec	Typ nástroje. Pokud je functiontyp, musí být nastaven název funkce.	Ano

typ Enum: AssistantsNamedToolChoiceType

Hodnota	Popis
funkce
interpreta kódu
hledání souboru

runObject

Představuje spuštění na vlákně.

Název	Typ	Popis	Požaduje se	Výchozí
asistent_id	řetězec	ID asistenta použitého ke spuštění tohoto spuštění.	Ano
zrušeno_v	celočíselný	Časové razítko unixu (v sekundách) pro zrušení spuštění.	Ano
dokončeno v	celočíselný	Časové razítko unixu (v sekundách) pro dokončení spuštění.	Ano
datum_vytvoření	celočíselný	Časové razítko unixu (v sekundách) pro vytvoření spuštění.	Ano
datum vypršení	celočíselný	Časové razítko unixu (v sekundách) pro vypršení platnosti spuštění.	Ano
selháno_při	celočíselný	Časové razítko unixu (v sekundách) pro dobu, kdy se spuštění nezdařilo.	Ano
ID	řetězec	Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.	Ano
neúplné_detaily	objekt	Podrobnosti o tom, proč je spuštění neúplné. Bude v null případě, že spuštění není neúplné.	Ano
└důvod	řetězec	Důvod, proč je spuštění neúplné. To bude odkazovat na to, ke kterému určitému limitu tokenu bylo dosaženo v průběhu spuštění.	Ne
pokyny	řetězec	Pokyny, které pomocník použil pro toto spuštění.	Ano
poslední chyba	objekt	Poslední chyba přidružená k tomuto spuštění. null Pokud nedojde k žádným chybám.	Ano
└ kód	řetězec	Jeden z server_error nebo rate_limit_exceeded.	Ne
└- zpráva	řetězec	Popis chyby čitelný člověkem.	Ne
maximální_počet_tokenů_dokončení	celočíselný	Maximální počet tokenů dokončení určených k použití v průběhu spuštění.	Ano
max_počet_tokenů_v_promptu	celočíselný	Maximální počet výzev tokenů zadaných k použití v průběhu spuštění.	Ano
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ano
model	řetězec	Model, který pomocník použil pro toto spuštění.	Ano
objekt	řetězec	Typ objektu, který je vždy thread.run.	Ano
paralelní volání nástrojů	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	Ne	Pravdivé
vyžadovaná_činnost	objekt	Podrobnosti o akci potřebné k pokračování ve spuštění Pokud není vyžadována žádná akce, bude tato null akce nutná.	Ano
└─ odeslat_výstupy_nástrojů	objekt	Podrobnosti o výstupech nástrojů potřebných k pokračování tohoto běhu.	Ne
└tool_calls	pole	Seznam příslušných volání nástrojů.	Ne
└- typ	výčet	Prozatím je to vždy submit_tool_outputs. Možné hodnoty: submit_tool_outputs	Ne
formát_odpovědi	asistentiApiResponseFormatOption	Určuje formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4 Turbo a všemi modely GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Nastavení { "type": "json_schema", "json_schema": {...} } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat vašemu zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy. { "type": "json_object" } Nastavením povolíte režim JSON, který zajistí, že zpráva, kterou model vygeneruje, je platný JSON. Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.	Ano
zahájeno_v	celočíselný	Časové razítko unixu (v sekundách) pro spuštění spuštění.	Ano
stav	řetězec	Stav spuštění, který může být buď , , , , , , queued, , , in_progressnebo requires_action. cancellingcancelledfailedcompletedexpired	Ano
Teplota	Číslo	Teplota vzorkování použitá pro toto spuštění. Pokud není nastavená, výchozí hodnota je 1.	Ne
identifikátor vlákna	řetězec	ID vláken, na kterých bylo spuštěno jako součást tohoto spuštění.	Ano
výběr nástroje	asistentiApiToolChoiceOption	Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádné nástroje a místo toho vygeneruje zprávu. auto je výchozí hodnota a znamená, že model může vybrat mezi generováním zprávy nebo voláním nástroje. Určení konkrétního nástroje, například {"type": "file_search"} nebo {"type": "function", "function": {"name": "my_function"}} vynutí model, aby tento nástroj volal.	Ano
nářadí	pole	Seznam nástrojů, které pomocník použil pro toto spuštění.	Ano	[]
top_p	Číslo	Hodnota vzorkování jádra použitá pro toto spuštění. Pokud není nastavená, výchozí hodnota je 1.	Ne
strategie zkracování	truncationObject	Určuje, jak bude vlákno před spuštěním zkráceno. Pomocí tohoto příkazu můžete řídit počáteční kontextové okno spuštění.	Ano
využití	runCompletionUsage	Statistiky využití související se spuštěním Tato hodnota bude, null pokud spuštění není v terminálovém stavu (tj. in_progress, queuedatd.).	Ano

object Enum: runObjectType

Hodnota	Popis
thread.run	Typ objektu run, který je vždy thread.run

status Enum: RunObjectStatus

Hodnota	Popis
zařazený do fronty	Stav zařazený do fronty
probíhá	Stav in_progress
vyžaduje akci	Stav required_action
odvolání	Stav zrušení
odvolaný	Zrušený stav
selhalo	Stav selhání
dokončené	Dokončený stav
prošlý	Stav s vypršenou platností

vytvořitŽádostOProvedení

Název	Typ	Popis	Požaduje se	Výchozí
dodatečné_instrukce	řetězec	Připojí další pokyny na konec pokynů pro spuštění. To je užitečné pro úpravu chování na základě spuštění bez přepsání dalších instrukcí.	Ne
další_zprávy	pole	Před vytvořením spuštění přidá do vlákna další zprávy.	Ne
asistent_id	řetězec	ID pomocníka, který se má použít ke spuštění tohoto spuštění.	Ano
pokyny	řetězec	Přepište výchozí systémovou zprávu asistenta. To je užitečné při úpravě chování na základě spuštění.	Ne
maximální_počet_tokenů_dokončení	celočíselný	Maximální počet tokenů dokončení, které lze použít v průběhu spuštění. Spuštění bude maximálně usilovat o použití pouze zadaného počtu tokenů dokončení, a to napříč několikanásobným otočením spuštění. Pokud spuštění překročí zadaný počet tokenů dokončení, spuštění skončí stavem incomplete. Další informace najdete incomplete_details .	Ne
max_počet_tokenů_v_promptu	celočíselný	Maximální počet výzev tokenů, které se můžou použít v průběhu spuštění. Spuštění bude maximálně usilovat o použití pouze počtu zadaných tokenů výzvy, a to napříč několikanásobným spuštěním. Pokud spuštění překročí zadaný počet zadaných tokenů výzvy, spuštění skončí se stavem incomplete. Další informace najdete incomplete_details .	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
model	řetězec	ID modelu, který se má použít ke spuštění tohoto spuštění. Pokud je zde zadaná hodnota, přepíše model přidružený k asistentovi. Pokud ne, použije se model přidružený k asistentovi.	Ne
paralelní volání nástrojů	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	Ne	Pravdivé
formát_odpovědi	asistentiApiResponseFormatOption	Určuje formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4 Turbo a všemi modely GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Nastavení { "type": "json_schema", "json_schema": {...} } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat vašemu zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy. { "type": "json_object" } Nastavením povolíte režim JSON, který zajistí, že zpráva, kterou model vygeneruje, je platný JSON. Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.	Ne
datový proud	Boolean	Pokud truevrátí datový proud událostí, ke kterým dochází během událostí odesílaných serverem Spustit jako, ukončení při zadání stavu terminálu se zprávou data: [DONE] .	Ne
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.	Ne	0
výběr nástroje	asistentiApiToolChoiceOption	Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádné nástroje a místo toho vygeneruje zprávu. auto je výchozí hodnota a znamená, že model může vybrat mezi generováním zprávy nebo voláním nástroje. Určení konkrétního nástroje, například {"type": "file_search"} nebo {"type": "function", "function": {"name": "my_function"}} vynutí model, aby tento nástroj volal.	Ne
nářadí	pole	Přepište nástroje, které může pomocník použít pro toto spuštění. To je užitečné při úpravě chování na základě spuštění.	Ne
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í.	Ne	0
strategie zkracování	truncationObject	Určuje, jak bude vlákno před spuštěním zkráceno. Pomocí tohoto příkazu můžete řídit počáteční kontextové okno spuštění.	Ne

listRunsResponse

Název	Typ	Popis	Požaduje se	Výchozí
údaje	pole		Ano
first_id	řetězec		Ano
má více	Boolean		Ano
last_id	řetězec		Ano
objekt	řetězec		Ano

úprava požadavku na spuštění

Název	Typ	Popis	Požaduje se	Výchozí
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne

předložitVýstupyNástrojůŽádostOSpuštění

Název	Typ	Popis	Požaduje se	Výchozí
datový proud	Boolean	Pokud truevrátí datový proud událostí, ke kterým dochází během událostí odesílaných serverem Spustit jako, ukončení při zadání stavu terminálu se zprávou data: [DONE] .	Ne
výstupy nástroje	pole	Seznam nástrojů, pro které se odesílají výstupy.	Ano

runToolCallObject

Objekty volání nástrojů

Název	Typ	Popis	Požaduje se	Výchozí
funkce	objekt	Definice funkce.	Ano
└argumenty	řetězec	Argumenty, které model očekává, že funkci předáte.	Ne
└– název	řetězec	Název funkce.	Ne
ID	řetězec	ID volání nástroje. Toto ID se musí uvádět při odesílání výstupů nástroje pomocí odesílacího nástroje, který aktivuje koncový bod.	Ano
typ	řetězec	Typ volání nástroje vyžaduje výstup. Prozatím je to vždy function.	Ano

type Enum: RunToolCallObjectType

Hodnota	Popis
funkce

createThreadAndRunRequest

Název	Typ	Popis	Požaduje se	Výchozí
asistent_id	řetězec	ID pomocníka, který se má použít ke spuštění tohoto spuštění.	Ano
pokyny	řetězec	Přepište výchozí systémovou zprávu asistenta. To je užitečné při úpravě chování na základě spuštění.	Ne
maximální_počet_tokenů_dokončení	celočíselný	Maximální počet tokenů dokončení, které lze použít v průběhu spuštění. Spuštění bude maximálně usilovat o použití pouze zadaného počtu tokenů dokončení, a to napříč několikanásobným otočením spuštění. Pokud spuštění překročí zadaný počet tokenů dokončení, spuštění skončí stavem incomplete. Další informace najdete incomplete_details .	Ne
max_počet_tokenů_v_promptu	celočíselný	Maximální počet výzev tokenů, které se můžou použít v průběhu spuštění. Spuštění bude maximálně usilovat o použití pouze počtu zadaných tokenů výzvy, a to napříč několikanásobným spuštěním. Pokud spuštění překročí zadaný počet zadaných tokenů výzvy, spuštění skončí se stavem incomplete. Další informace najdete incomplete_details .	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
model	řetězec	ID modelů, které mají být použity v tomto procesu. Pokud je zde zadaná hodnota, přepíše model přidružený k asistentovi. Pokud ne, použije se model přidružený k asistentovi.	Ne
paralelní volání nástrojů	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	Ne	Pravdivé
formát_odpovědi	asistentiApiResponseFormatOption	Určuje formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4 Turbo a všemi modely GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Nastavení { "type": "json_schema", "json_schema": {...} } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat vašemu zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy. { "type": "json_object" } Nastavením povolíte režim JSON, který zajistí, že zpráva, kterou model vygeneruje, je platný JSON. Důležité: Pokud používáte režim JSON, musítetaké dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.	Ne
datový proud	Boolean	Pokud truevrátí datový proud událostí, ke kterým dochází během událostí odesílaných serverem Spustit jako, ukončení při zadání stavu terminálu se zprávou data: [DONE] .	Ne
možnosti streamování	chatCompletionStreamOptions	Možnosti pro odpověď streamování Toto nastavení nastavíte pouze při nastavení stream: true.	Ne	Nic
Teplota	Číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.	Ne	0
vlákno	createThreadRequest		Ne
výběr nástroje	asistentiApiToolChoiceOption	Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádné nástroje a místo toho vygeneruje zprávu. auto je výchozí hodnota a znamená, že model může vybrat mezi generováním zprávy nebo voláním nástroje. Určení konkrétního nástroje, například {"type": "file_search"} nebo {"type": "function", "function": {"name": "my_function"}} vynutí model, aby tento nástroj volal.	Ne
nástroje a zdroje	objekt	Sada prostředků, které používají nástroje asistenta. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.	Ne
└ code_interpreter	objekt		Ne
└- file_ids	pole	Seznam ID souborů zpřístupněných nástroji code_interpreter . K nástroji může být přidruženo maximálně 20 souborů.	Ne	[]
└─file_search	objekt		Ne
└─ identifikátory_úložiště_vektorů	pole	ID vektorového úložiště připojeného k tomuto asistentovi. K asistentovi může být připojeno maximálně 1 vektorové úložiště.	Ne
nářadí	pole	Přepište nástroje, které může pomocník použít pro toto spuštění. To je užitečné při úpravě chování na základě spuštění.	Ne
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í.	Ne	0
strategie zkracování	truncationObject	Určuje, jak bude vlákno před spuštěním zkráceno. Pomocí tohoto příkazu můžete řídit počáteční kontextové okno spuštění.	Ne

threadObject

Představuje vlákno, které obsahuje zprávy.

Název	Typ	Popis	Požaduje se	Výchozí
datum_vytvoření	celočíselný	Časové razítko unixu (v sekundách) pro vytvoření vlákna.	Ano
ID	řetězec	Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.	Ano
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ano
objekt	řetězec	Typ objektu, který je vždy thread.	Ano
nástroje a zdroje	objekt	Sada prostředků, které jsou zpřístupněny nástrojům asistenta v tomto vlákně. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.	Ano
└ code_interpreter	objekt		Ne
└- file_ids	pole	Seznam ID souborů zpřístupněných nástroji code_interpreter . K nástroji může být přidruženo maximálně 20 souborů.	Ne	[]
└─file_search	objekt		Ne
└─ identifikátory_úložiště_vektorů	pole	Vektorové úložiště připojené k tomuto vláknu. K vláknu může být připojeno maximálně 1 vektorové úložiště.	Ne

object Enum: ThreadObjectType

Hodnota	Popis
vlákno	Typ objektu vlákna, který je vždy thread

žádost o vytvoření vlákna

Název	Typ	Popis	Požaduje se	Výchozí
zprávy	pole	Seznam zpráv, se kterými se má vlákno spustit.	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
nástroje a zdroje	objekt	Sada prostředků, které jsou zpřístupněny nástrojům asistenta v tomto vlákně. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.	Ne
└ code_interpreter	objekt		Ne
└- file_ids	pole	Seznam ID souborů zpřístupněných nástroji code_interpreter . K nástroji může být přidruženo maximálně 20 souborů.	Ne	[]
└─file_search	objekt		Ne
└─ identifikátory_úložiště_vektorů	pole	Vektorové úložiště připojené k tomuto vláknu. K vláknu může být připojeno maximálně 1 vektorové úložiště.	Ne
└vector_stores	pole	Pomocná rutina pro vytvoření vektorového úložiště s file_ids a jeho připojení k tomuto vláknu. K vláknu může být připojeno maximálně 1 vektorové úložiště.	Ne

upravitŽádostOvlákno

Název	Typ	Popis	Požaduje se	Výchozí
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
nástroje a zdroje	objekt	Sada prostředků, které jsou zpřístupněny nástrojům asistenta v tomto vlákně. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.	Ne
└ code_interpreter	objekt		Ne
└- file_ids	pole	Seznam ID souborů zpřístupněných nástroji code_interpreter . K nástroji může být přidruženo maximálně 20 souborů.	Ne	[]
└─file_search	objekt		Ne
└─ identifikátory_úložiště_vektorů	pole	Vektorové úložiště připojené k tomuto vláknu. K vláknu může být připojeno maximálně 1 vektorové úložiště.	Ne

Smazat odpověď na vlákno

Název	Typ	Popis	Požaduje se	Výchozí
odstraněný	Boolean		Ano
ID	řetězec		Ano
objekt	řetězec		Ano

object Enum: DeleteThreadResponseObjectState

Hodnota	Popis
vlákno smazáno	Stav objektu odpovědi na odstranění vlákna, který je thread.deleted

listThreadsResponse

Název	Typ	Popis	Požaduje se	Výchozí
údaje	pole		Ano
first_id	řetězec		Ano
má více	Boolean		Ano
last_id	řetězec		Ano
objekt	řetězec		Ano

objekt zprávy

Představuje zprávu v rámci vláken.

Název	Typ	Popis	Požaduje se	Výchozí
asistent_id	řetězec	Pokud je to možné, ID asistenta, který tuto zprávu vytvořil.	Ano
přílohy	pole	Seznam souborů připojených ke zprávě a nástroje, do které byly přidány.	Ano
dokončeno v	celočíselný	Časové razítko unixu (v sekundách) pro dokončení zprávy.	Ano
obsah	pole	Obsah zprávy v poli textu nebo obrázků.	Ano
datum_vytvoření	celočíselný	Časové razítko unixu (v sekundách) pro vytvoření zprávy.	Ano
ID	řetězec	Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.	Ano
incomplete_at	celočíselný	Časové razítko unixu (v sekundách) pro dobu, kdy byla zpráva označena jako neúplná.	Ano
neúplné_detaily	objekt	V neúplné zprávě jsou podrobnosti o tom, proč je zpráva neúplná.	Ano
└důvod	řetězec	Důvod, proč je zpráva neúplná.	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ano
objekt	řetězec	Typ objektu, který je vždy thread.message.	Ano
úloha	řetězec	Entita, která zprávu vytvořila. Jeden z user nebo assistant.	Ano
run_id	řetězec	Pokud je to možné, ID spuštění přidruženého k vytváření této zprávy.	Ano
stav	řetězec	Stav zprávy, která může být buď in_progress, incompletenebo completed.	Ano
identifikátor vlákna	řetězec	ID vláken, do kterého tato zpráva patří.	Ano

object Enum: MessageObjectType

Hodnota	Popis
vlákno.zpráva	Typ objektu zprávy, který je thread.message

status Enum: Status objektu zprávy

Hodnota	Popis
probíhá
neúplný
dokončené

role Enum: MessageObjectRole

Hodnota	Popis
uživatel
asistent

messageDeltaObject

Představuje rozdíl zprávy, tj. všechna změněná pole zprávy během streamování.

Název	Typ	Popis	Požaduje se	Výchozí
Delta	objekt	Rozdíl obsahující pole, která se změnila ve zprávě.	Ano
└- obsah	pole	Obsah zprávy v poli textu nebo obrázků.	Ne
Role └─	řetězec	Entita, která zprávu vytvořila. Jeden z user nebo assistant.	Ne
ID	řetězec	Identifikátor zprávy, na kterou lze odkazovat v koncových bodech rozhraní API.	Ano
objekt	řetězec	Typ objektu, který je vždy thread.message.delta.	Ano

objekt Enum: MessageDeltaObjectType

Hodnota	Popis
vlákno.zpráva.delta

vytvořit požadavek na zprávu (createMessageRequest)

Název	Typ	Popis	Požaduje se	Výchozí
přílohy	pole	Seznam souborů připojených ke zprávě a nástroje, do které by se měly přidat.	Ne
obsah	řetězec	Obsah zprávy.	Ano
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
úloha	řetězec	Role entity, která vytváří zprávu. Mezi povolené hodnoty patří: - user: Označuje, že zpráva je odeslána skutečným uživatelem a měla by být použita ve většině případů k reprezentaci uživatelem generovaných zpráv. - assistant: Označuje zprávu vygenerovanou asistentem. Tato hodnota slouží k vložení zpráv z asistenta do konverzace.	Ano

role Enum: CreateMessageRequestRole

Hodnota	Popis
uživatel
asistent

modifyMessageRequest

Název	Typ	Popis	Požaduje se	Výchozí
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne

odpověď na smazání zprávy

Název	Typ	Popis	Požaduje se	Výchozí
odstraněný	Boolean		Ano
ID	řetězec		Ano
objekt	řetězec		Ano

object Enum: DeleteMessageResponseObject

Hodnota	Popis
Vlákno.zpráva.odstraněna	Stav objektu odpovědi na odstranění zprávy

odpověď na seznam zpráv

Název	Typ	Popis	Požaduje se	Výchozí
údaje	pole		Ano
first_id	řetězec		Ano
má více	Boolean		Ano
last_id	řetězec		Ano
objekt	řetězec		Ano

messageContentImageFileObject

Odkazuje na soubor obrázku v obsahu zprávy.

Název	Typ	Popis	Požaduje se	Výchozí
obrázkový soubor	objekt		Ano
└ file_id	řetězec	ID souboru obrázku v obsahu zprávy.	Ne
typ	řetězec	Vždy hodnota image_file.	Ano

type Enum: Typ objektu souboru obrazů MessageContentImageFileObjectType

Hodnota	Popis
obrázkový soubor	Typ souboru obrázku obsahu zprávy

objekt textu obsahu zprávy

Textový obsah, který je součástí zprávy.

Název	Typ	Popis	Požaduje se	Výchozí
Text	objekt		Ano
└– poznámky	pole		Ne
└– hodnota	řetězec	Data, která tvoří text.	Ne
typ	řetězec	Vždy hodnota text.	Ano

type Enum: messageContentTextObjectType

Hodnota	Popis
Text	Typ textového objektu obsahu zprávy

obsahZprávyTextovéAnotaceCitaceSouboruObjekt

Citace ve zprávě, která odkazuje na konkrétní citaci z konkrétního souboru přidruženého k asistentovi nebo zprávě. Vygenerováno, když pomocník používá nástroj pro načítání k hledání souborů.

Název	Typ	Popis	Požaduje se	Výchozí
koncový index	celočíselný		Ano
citace souboru	objekt		Ano
└ file_id	řetězec	ID konkrétního souboru, ze které citace pochází.	Ne
start_index	celočíselný		Ano
Text	řetězec	Text v obsahu zprávy, který je potřeba nahradit.	Ano
typ	řetězec	Vždy hodnota file_citation.	Ano

typ Enum: FileCitationObjectType

Hodnota	Popis
citace souboru	Typ objektu citace souboru

messageContentTextAnnotationsFilePathObject

Adresa URL souboru, který se vygeneruje, když pomocník použil code_interpreter nástroj k vygenerování souboru.

Název	Typ	Popis	Požaduje se	Výchozí
koncový index	celočíselný		Ano
cesta k souboru	objekt		Ano
└ file_id	řetězec	ID vygenerovaného souboru.	Ne
start_index	celočíselný		Ano
Text	řetězec	Text v obsahu zprávy, který je potřeba nahradit.	Ano
typ	řetězec	Vždy hodnota file_path.	Ano

typ Enum: FilePathObjectType

Hodnota	Popis
cesta k souboru	Typ objektu cesty k souboru

messageDeltaContentImageFileObject

Odkazuje na soubor obrázku v obsahu zprávy.

Název	Typ	Popis	Požaduje se	Výchozí
obrázkový soubor	objekt		Ne
└ file_id	řetězec	ID souboru obrázku v obsahu zprávy.	Ne
rejstřík	celočíselný	Index části obsahu ve zprávě.	Ano
typ	řetězec	Vždy hodnota image_file.	Ano

type Enum: MessageDeltaContentImageFileObjectType

Hodnota	Popis
obrázkový soubor

messageDeltaContentTextObject

Textový obsah, který je součástí zprávy.

Název	Typ	Popis	Požaduje se	Výchozí
rejstřík	celočíselný	Index části obsahu ve zprávě.	Ano
Text	objekt		Ne
└– poznámky	pole		Ne
└– hodnota	řetězec	Data, která tvoří text.	Ne
typ	řetězec	Vždy hodnota text.	Ano

type Enum: MessageDeltaContentTextObjectType

Hodnota	Popis
Text

ZprávaDeltaObsahTextAnotaceSouborCitaceObjekt

Citace ve zprávě, která odkazuje na konkrétní citaci z konkrétního souboru přidruženého k asistentovi nebo zprávě. Generuje se, když pomocník používá nástroj "file_search" k hledání souborů.

Název	Typ	Popis	Požaduje se	Výchozí
koncový index	celočíselný		Ne
citace souboru	objekt		Ne
└ file_id	řetězec	ID konkrétního souboru, ze které citace pochází.	Ne
└- citace	řetězec	Konkrétní citace v souboru.	Ne
rejstřík	celočíselný	Index poznámky v textové části obsahu.	Ano
start_index	celočíselný		Ne
Text	řetězec	Text v obsahu zprávy, který je potřeba nahradit.	Ne
typ	řetězec	Vždy hodnota file_citation.	Ano

type Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

Hodnota	Popis
citace souboru

messageDeltaContentTextAnnotationsFilePathObject

Adresa URL souboru, který se vygeneruje, když pomocník použil code_interpreter nástroj k vygenerování souboru.

Název	Typ	Popis	Požaduje se	Výchozí
koncový index	celočíselný		Ne
cesta k souboru	objekt		Ne
└ file_id	řetězec	ID vygenerovaného souboru.	Ne
rejstřík	celočíselný	Index poznámky v textové části obsahu.	Ano
start_index	celočíselný		Ne
Text	řetězec	Text v obsahu zprávy, který je potřeba nahradit.	Ne
typ	řetězec	Vždy hodnota file_path.	Ano

type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

Hodnota	Popis
cesta k souboru

runStepObject

Představuje krok při spuštění spuštění.

Název	Typ	Popis	Požaduje se	Výchozí
asistent_id	řetězec	ID asistenta přidruženého ke kroku spuštění.	Ano
zrušeno_v	celočíselný	Časové razítko unixu (v sekundách) pro zrušení kroku spuštění.	Ano
dokončeno v	celočíselný	Časové razítko unixu (v sekundách) pro dokončení kroku spuštění.	Ano
datum_vytvoření	celočíselný	Časové razítko unixu (v sekundách) pro vytvoření kroku spuštění.	Ano
vypršelo dne	celočíselný	Časové razítko unixu (v sekundách) pro vypršení platnosti kroku spuštění. Pokud vypršela platnost nadřazeného spuštění, považuje se za prošlý krok.	Ano
selháno_při	celočíselný	Časové razítko unixu (v sekundách) pro selhání kroku spuštění.	Ano
ID	řetězec	Identifikátor kroku spuštění, na který lze odkazovat v koncových bodech rozhraní API.	Ano
poslední chyba	objekt	Poslední chyba přidružená k tomuto kroku spuštění null Pokud nedojde k žádným chybám.	Ano
└ kód	řetězec	Jeden z server_error nebo rate_limit_exceeded.	Ne
└- zpráva	řetězec	Popis chyby čitelný člověkem.	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ano
objekt	řetězec	Typ objektu, který je vždy assistant.run.step.	Ano
run_id	řetězec	ID spuštění, ve které je tento krok spuštění součástí.	Ano
stav	řetězec	Stav spuštění, který může být buď in_progress, cancelled, failed, completednebo expired.	Ano
Detaily kroku	runStepDetailsMessageCreationObject nebo runStepDetailsToolCallsObject	Podrobnosti o kroku spuštění	Ano
identifikátor vlákna	řetězec	ID vláken, která byla spuštěna.	Ano
typ	řetězec	Typ kroku spuštění, který může být buď message_creation nebo tool_calls.	Ano

object Enum: RunStepObjectType

Hodnota	Popis
assistant.run.step	Typ objektu, který je vždy assistant.run.step

type Enum: RunStepObjectType

Hodnota	Popis
vytvoření zprávy	Krok spuštění message_creation
volání nástrojů	Krok spuštění tool_calls

status Enum: RunStepObjectStatus

Hodnota	Popis
probíhá	Stav spuštění in_progress
odvolaný	Stav zrušeného spuštění
selhalo	Stav zrušeného spuštění
dokončené	Stav zrušeného spuštění
prošlý	Stav zrušeného spuštění

runStepDeltaObject

Představuje rozdílový krok spuštění, tj. všechna změněná pole v kroku spuštění během streamování.

Název	Typ	Popis	Požaduje se	Výchozí
Delta	objekt	Rozdíl obsahující pole, která se změnila v kroku spuštění	Ano
└─ podrobnosti_kroku	runStepDeltaStepDetailsMessageCreationObject nebo runStepDeltaStepDetailsToolCallsObject	Podrobnosti o kroku spuštění	Ne
ID	řetězec	Identifikátor kroku spuštění, na který lze odkazovat v koncových bodech rozhraní API.	Ano
objekt	řetězec	Typ objektu, který je vždy thread.run.step.delta.	Ano

object Enum: RunStepDeltaObjectType

Hodnota	Popis
thread.run.step.delta

seznamKrokůProbíhajícíOdezvy

Název	Typ	Popis	Požaduje se	Výchozí
údaje	pole		Ano
first_id	řetězec		Ano
má více	Boolean		Ano
last_id	řetězec		Ano
objekt	řetězec		Ano

vytvořitObjektZprávyPodrobnostíKrokuBěhu

Podrobnosti o vytvoření zprávy v kroku spuštění

Název	Typ	Popis	Požaduje se	Výchozí
vytvoření zprávy	objekt		Ano
└message_id	řetězec	ID zprávy vytvořené tímto krokem spuštění.	Ne
typ	řetězec	Vždy hodnota message_creation.	Ano

type Enum: RunStepDetailsMessageCreationObjectType

Hodnota	Popis
vytvoření zprávy

SpustitKrokDeltaKrokPodrobnostiVytvořeníZprávyObjekt

Podrobnosti o vytvoření zprávy v kroku spuštění

Název	Typ	Popis	Požaduje se	Výchozí
vytvoření zprávy	objekt		Ne
└message_id	řetězec	ID zprávy vytvořené tímto krokem spuštění.	Ne
typ	řetězec	Vždy hodnota message_creation.	Ano

typ Enum: RunStepDeltaStepDetailsMessageCreationObjectType

Hodnota	Popis
vytvoření zprávy

runStepDetailsToolCallsObject

Podrobnosti o volání nástroje

Název	Typ	Popis	Požaduje se	Výchozí
volání nástrojů	pole	Do kroku spuštění bylo zapojeno pole nástrojů. Mohou být přidruženy k jednomu ze tří typů nástrojů: code_interpreternebo retrievalfunction.	Ano
typ	řetězec	Vždy hodnota tool_calls.	Ano

Typ Enum: Objektový typ RunStepDetailsToolCalls

Hodnota	Popis
volání nástrojů

spustitKrokDeltaKrokDetailyNástrojeVoláObjekt

Podrobnosti o volání nástroje

Název	Typ	Popis	Požaduje se	Výchozí
volání nástrojů	pole	Do kroku spuštění bylo zapojeno pole nástrojů. Mohou být přidruženy k jednomu ze tří typů nástrojů: code_interpreternebo file_searchfunction.	Ne
typ	řetězec	Vždy hodnota tool_calls.	Ano

type Enum: RunStepDeltaStepDetailsToolCallsObjectType

Hodnota	Popis
volání nástrojů

runStepDetailsToolCallsCodeObject

Podrobnosti o volání nástroje Interpret kódu, ke kterému byl zapojen krok spuštění.

Název	Typ	Popis	Požaduje se	Výchozí
interpreta kódu	objekt	Definice volání nástroje Interpret kódu.	Ano
└─ vstup	řetězec	Vstup do volání nástroje Interpret kódu.	Ne
└– výstupy	pole	Výstupy volání nástroje Interpret kódu. Interpret kódu může výstupem jedné nebo více položek, včetně textu (logs) nebo obrázků (image). Každý z nich je reprezentován jiným typem objektu.	Ne
ID	řetězec	ID volání nástroje.	Ano
typ	řetězec	Typ volání nástroje. Toto bude code_interpreter vždy pro tento typ volání nástroje.	Ano

type Enum: RunStepDetailsToolCallsCodeObjectType

Hodnota	Popis
interpreta kódu

Spusťte krokDeltaPodrobnostiNástrojeVoláníKódObjektu

Podrobnosti o volání nástroje Interpret kódu, ke kterému byl zapojen krok spuštění.

Název	Typ	Popis	Požaduje se	Výchozí
interpreta kódu	objekt	Definice volání nástroje Interpret kódu.	Ne
└─ vstup	řetězec	Vstup do volání nástroje Interpret kódu.	Ne
└– výstupy	pole	Výstupy volání nástroje Interpret kódu. Interpret kódu může výstupem jedné nebo více položek, včetně textu (logs) nebo obrázků (image). Každý z nich je reprezentován jiným typem objektu.	Ne
ID	řetězec	ID volání nástroje.	Ne
rejstřík	celočíselný	Index volání nástroje v nástroji volá pole.	Ano
typ	řetězec	Typ volání nástroje. Toto bude code_interpreter vždy pro tento typ volání nástroje.	Ano

type Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

Hodnota	Popis
interpreta kódu

Podrobnosti kroku spuštění volání nástroje výstup kódu protokoly objekt

Textový výstup z volání nástroje Interpret kódu v rámci kroku spuštění

Název	Typ	Popis	Požaduje se	Výchozí
Protokoly	řetězec	Textový výstup volání nástroje Interpret kódu.	Ano
typ	řetězec	Vždy hodnota logs.	Ano

type Enum: RunStepDetailsToolCallsCodeOutputLogsObjectType

Hodnota	Popis
Protokoly

spustitKrokDeltaKrokPodrobnostiNástrojVoláKódVýstupProtokolyObjekt

Textový výstup z volání nástroje Interpret kódu v rámci kroku spuštění

Název	Typ	Popis	Požaduje se	Výchozí
rejstřík	celočíselný	Index výstupu v poli výstupů.	Ano
Protokoly	řetězec	Textový výstup volání nástroje Interpret kódu.	Ne
typ	řetězec	Vždy hodnota logs.	Ano

typ Enum: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

Hodnota	Popis
Protokoly

PrůběhKrokuPodrobnostiNástrojVoláníKóduVýstupObrazObjekt

Název	Typ	Popis	Požaduje se	Výchozí
image	objekt		Ano
└ file_id	řetězec	ID souboru obrázku.	Ne
typ	řetězec	Vždy hodnota image.	Ano

type Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

Hodnota	Popis
image

spustitKrokDeltaKrokPodrobnostiNástrojVyvoláníKóduVýstupObjektObrázku

Název	Typ	Popis	Požaduje se	Výchozí
image	objekt		Ne
└ file_id	řetězec	ID souboru obrázku.	Ne
rejstřík	celočíselný	Index výstupu v poli výstupů.	Ano
typ	řetězec	Vždy hodnota image.	Ano

typ Enum: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

Hodnota	Popis
image

Příkaz runStepDetailsToolCallsFileSearchObject

Název	Typ	Popis	Požaduje se	Výchozí
hledání souboru	objekt	Prozatím to bude vždy prázdný objekt.	Ano
└─ výsledky	pole	Výsledky hledání souboru.	Ne
ID	řetězec	ID objektu volání nástroje.	Ano
typ	řetězec	Typ volání nástroje. Toto bude file_search vždy pro tento typ volání nástroje.	Ano

type Enum: RunStepDetailsToolCallsFileSearchObjectType

Hodnota	Popis
hledání souboru

SpuštěníPodrobnostíKrokůNástrojůVoláníSouborVyhledáváníVýsledekObjekt

Výsledná instance hledání souboru.

Název	Typ	Popis	Požaduje se	Výchozí
obsah	pole	Obsah nalezeného výsledku. Obsah je zahrnutý pouze v případě, že je požadován prostřednictvím parametru dotazu include.	Ne
ID souboru	řetězec	ID souboru, ve který byl výsledek nalezen.	Ano
název_souboru	řetězec	Název souboru, ve který byl výsledek nalezen.	Ano
partitura	Číslo	Skóre výsledku Všechny hodnoty musí být číslo s plovoucí desetinou čárkou mezi 0 a 1.	Ano

SpustitKrokDeltaKrokPodrobnostiNástrojeVoláníSouboruVyhledáváníObjektu

Název	Typ	Popis	Požaduje se	Výchozí
hledání souboru	objekt	Prozatím to bude vždy prázdný objekt.	Ano
ID	řetězec	ID objektu volání nástroje.	Ne
rejstřík	celočíselný	Index volání nástroje v nástroji volá pole.	Ano
typ	řetězec	Typ volání nástroje. Toto bude retrieval vždy pro tento typ volání nástroje.	Ano

type Enum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Hodnota	Popis
hledání souboru

runStepDetailsToolCallsFunctionObject

Název	Typ	Popis	Požaduje se	Výchozí
funkce	objekt	Definice funkce, která byla volána.	Ano
└argumenty	řetězec	Argumenty předané funkci.	Ne
└– název	řetězec	Název funkce.	Ne
└─ výstup	řetězec	Výstup funkce. To bude v null případě, že se výstupy ještě neodeslaly.	Ne
ID	řetězec	ID objektu volání nástroje.	Ano
typ	řetězec	Typ volání nástroje. Toto bude function vždy pro tento typ volání nástroje.	Ano

typ Enum: Nástroj pro podrobnosti kroku spuštění volá funkci objektového typu

Hodnota	Popis
funkce

spuštěníKrokDeltaKrokPodrobnostiNástrojVoláFunkciObjekt

Název	Typ	Popis	Požaduje se	Výchozí
funkce	objekt	Definice funkce, která byla volána.	Ne
└argumenty	řetězec	Argumenty předané funkci.	Ne
└– název	řetězec	Název funkce.	Ne
└─ výstup	řetězec	Výstup funkce. To bude v null případě, že se výstupy ještě neodeslaly.	Ne
ID	řetězec	ID objektu volání nástroje.	Ne
rejstřík	celočíselný	Index volání nástroje v nástroji volá pole.	Ano
typ	řetězec	Typ volání nástroje. Toto bude function vždy pro tento typ volání nástroje.	Ano

type Enum: RunStepDetailsToolCallsFunctionObjectType

Hodnota	Popis
funkce

Doba vypršení platnosti úložiště vektoru

Zásady vypršení platnosti pro úložiště vektorů.

Název	Typ	Popis	Požaduje se	Výchozí
ukotvení	řetězec	Ukotvení časového razítka, po kterém se zásada vypršení platnosti použije. Podporované kotvy: last_active_at.	Ano
dny (dní)	celočíselný	Počet dní po ukotvení, kdy platnost úložiště vektorů vyprší.	Ano

anchor Enum: VectorStoreExpirationAfterAnchor

Hodnota	Popis
poslední_aktivita_dne	Časové razítko ukotvení, po kterém se zásada vypršení platnosti použije.

vectorStoreObject

Vektorové úložiště je kolekce zpracovaných souborů, kterou může nástroj použít file_search .

Název	Typ	Popis	Požaduje se	Výchozí
datum_vytvoření	celočíselný	Časové razítko unixu (v sekundách) pro vytvoření vektorového úložiště.	Ano
vyprší_po	vectorStoreExpirationAfter	Zásady vypršení platnosti pro úložiště vektorů.	Ne
datum vypršení	celočíselný	Časové razítko unixu (v sekundách) pro vypršení platnosti úložiště vektorů.	Ne
počet_souborů	objekt		Ano
└- zrušeno	celočíselný	Počet zrušených souborů.	Ne
└- dokončeno	celočíselný	Počet úspěšně zpracovaných souborů.	Ne
└– selhalo	celočíselný	Počet souborů, které se nepodařilo zpracovat.	Ne
└─ probíhá	celočíselný	Počet souborů, které se právě zpracovávají.	Ne
└- celkem	celočíselný	Celkový počet souborů.	Ne
ID	řetězec	Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.	Ano
poslední_aktivita_dne	celočíselný	Časové razítko unixu (v sekundách) doby, kdy bylo úložiště vektorů naposledy aktivní.	Ano
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ano
jméno	řetězec	Název úložiště vektorů.	Ano
objekt	výčet	Typ objektu, který je vždy vector_store. Možné hodnoty: vector_store	Ano
stav	řetězec	Stav úložiště vektorů, který může být buď expired, in_progressnebo completed. Stav indikuje, že úložiště vektorů completed je připravené k použití.	Ano
využití_v_bajtech	celočíselný	Celkový počet bajtů používaných soubory v úložišti vektorů.	Ano

status Enum: VectorStoreObjectStatus

Hodnota	Popis
prošlý
probíhá
dokončené

PožadavekNaVytvořeníÚložištěVektorů

Název	Typ	Popis	Požaduje se	Výchozí
strategie segmentace	autoChunkingStrategyRequestParam nebo staticChunkingStrategyRequestParam	Strategie vytváření bloků dat použitá k vytvoření bloků souborů. Pokud není nastavená, použije strategii auto . Platí pouze v případě, že file_ids není prázdný.	Ne
vyprší_po	vectorStoreExpirationAfter	Zásady vypršení platnosti pro úložiště vektorů.	Ne
identifikátory_souborů	pole	Seznam ID souborů, které má vektorové úložiště použít. Užitečné pro nástroje, jako je file_search například přístup k souborům.	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
jméno	řetězec	Název úložiště vektorů.	Ne

aktualizovatPožadavekNaUloženíVektoru

Název	Typ	Popis	Požaduje se	Výchozí
vyprší_po	vectorStoreExpirationAfter	Zásady vypršení platnosti pro úložiště vektorů.	Ne
metadatové informace	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.	Ne
jméno	řetězec	Název úložiště vektorů.	Ne

listVectorStoresResponse

Název	Typ	Popis	Požaduje se	Výchozí
údaje	pole		Ano
first_id	řetězec		Ano
má více	Boolean		Ano
last_id	řetězec		Ano
objekt	řetězec		Ano

deleteVectorStoreResponse

Název	Typ	Popis	Požaduje se	Výchozí
odstraněný	Boolean		Ano
ID	řetězec		Ano
objekt	řetězec		Ano

object Enum: DeleteVectorStoreResponseObject

Hodnota	Popis
obchod_vektorů.smazáno	Stav objektu odpovědi pro odstranění vektorového úložiště

vektorový objekt souboru úložiště

Seznam souborů připojených k úložišti vektorů

Název	Typ	Popis	Požaduje se	Výchozí
strategie segmentace	autoChunkingStrategyRequestParam nebo staticChunkingStrategyRequestParam	Strategie vytváření bloků dat použitá k vytvoření bloků souborů. Pokud není nastavená, použije strategii auto . Platí pouze v případě, že file_ids není prázdný.	Ne
datum_vytvoření	celočíselný	Časové razítko unixu (v sekundách) pro vytvoření souboru úložiště vektorů.	Ano
ID	řetězec	Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.	Ano
poslední chyba	objekt	Poslední chyba přidružená k tomuto souboru úložiště vektorů. null Pokud nedojde k žádným chybám.	Ano
└ kód	řetězec	Jeden z server_error nebo invalid_file nebo unsupported_file.	Ne
└- zpráva	řetězec	Popis chyby čitelný člověkem.	Ne
objekt	řetězec	Typ objektu, který je vždy vector_store.file.	Ano
stav	řetězec	Stav souboru úložiště vektorů, který může být buď in_progress, completed, cancellednebo failed. Stav completed označuje, že soubor úložiště vektorů je připravený k použití.	Ano
využití_v_bajtech	celočíselný	Celkové využití vektorového úložiště v bajtech. Všimněte si, že se může lišit od původní velikosti souboru.	Ano
id_skladu_vektorů	řetězec	ID vektorového úložiště, ke kterému je soubor připojen.	Ano

objekt Enum: Typ objektu souboru VectorStore

Hodnota	Popis
vector_store.file

status Enum: StavObjektuSouboruVeVektorovémUložení

Hodnota	Popis
probíhá
dokončené
odvolaný
selhalo

parametrOdezvyJinéStrategieRozdělení

Tato hodnota se vrátí, když je strategie vytváření bloků dat neznámá. Důvodem je obvykle to, že soubor byl indexován před chunking_strategy zavedením konceptu v rozhraní API.

Název	Typ	Popis	Požaduje se	Výchozí
typ	řetězec	Vždy hodnota other.	Ano

typ Enum: OtherChunkingStrategyResponseParamType

Hodnota	Popis
ostatní

staticChunkingStrategyResponseParam

Název	Typ	Popis	Požaduje se	Výchozí
statický	staticChunkingStrategy		Ano
typ	řetězec	Vždy hodnota static.	Ano

typ Enum: StaticChunkingStrategyResponseParamType

Hodnota	Popis
statický

statická strategie chunkování

Název	Typ	Popis	Požaduje se	Výchozí
překrývající se tokeny bloku	celočíselný	Počet tokenů, které se překrývají mezi bloky dat. Výchozí hodnota je 400. Všimněte si, že překrytí nesmí překročit polovinu .max_chunk_size_tokens	Ano
max_velikost_bloku_tokenů	celočíselný	Maximální počet tokenů v každém bloku dat. Výchozí hodnota je 800. Minimální hodnota je 100 a maximální hodnota je 4096.	Ano

autoChunkingStrategyRequestParam

Výchozí strategie. Tato strategie v současné době používá max_chunk_size_tokens800chunk_overlap_tokens400

Název	Typ	Popis	Požaduje se	Výchozí
typ	výčet	Vždy hodnota auto. Možné hodnoty: auto	Ano

statická strategie chunkingu - požadavek parametru

Název	Typ	Popis	Požaduje se	Výchozí
statický	staticChunkingStrategy		Ano
typ	výčet	Vždy hodnota static. Možné hodnoty: static	Ano

parametrPožadavkuProStrategiiChunkování

Strategie vytváření bloků dat použitá k vytvoření bloků souborů. Pokud není nastavená, použije strategii auto .

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

• autoChunkingStrategyRequestParam
• parametr statické chunkovací strategie

vytvořPožadavekNaSouborÚložištěVektorů

Název	Typ	Popis	Požaduje se	Výchozí
strategie segmentace	chunkingStrategyRequestParam	Strategie vytváření bloků dat použitá k vytvoření bloků souborů. Pokud není nastavená, použije strategii auto .	Ne
ID souboru	řetězec	ID souboru, které má vektorové úložiště použít. Užitečné pro nástroje, jako je file_search například přístup k souborům.	Ano

Zobrazit odpověď na příkaz listVectorStoreFilesResponse

Název	Typ	Popis	Požaduje se	Výchozí
údaje	pole		Ano
first_id	řetězec		Ano
má více	Boolean		Ano
last_id	řetězec		Ano
objekt	řetězec		Ano

deleteVectorStoreFileResponse

Název	Typ	Popis	Požaduje se	Výchozí
odstraněný	Boolean		Ano
ID	řetězec		Ano
objekt	řetězec		Ano

object Enum: DeleteVectorStoreFileResponseObject

Hodnota	Popis
vektorový_sklad.soubor.smazán

vectorStoreFileBatchObject

Dávka souborů připojených k úložišti vektorů.

Název	Typ	Popis	Požaduje se	Výchozí
datum_vytvoření	celočíselný	Časové razítko unixu (v sekundách) pro vytvoření dávky souborů úložiště vektorů.	Ano
počet_souborů	objekt		Ano
└- zrušeno	celočíselný	Počet zrušených souborů.	Ne
└- dokončeno	celočíselný	Počet zpracovaných souborů.	Ne
└– selhalo	celočíselný	Počet souborů, které se nepodařilo zpracovat.	Ne
└─ probíhá	celočíselný	Počet souborů, které se právě zpracovávají.	Ne
└- celkem	celočíselný	Celkový počet souborů.	Ne
ID	řetězec	Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.	Ano
objekt	řetězec	Typ objektu, který je vždy vector_store.file_batch.	Ano
stav	řetězec	Stav dávky souborů úložiště vektorů, které mohou být buď in_progress, completednebo cancelledfailed.	Ano
id_skladu_vektorů	řetězec	ID vektorového úložiště, ke kterému je soubor připojen.	Ano

objekt Enum: VectorStoreFileBatchObjectType

Hodnota	Popis
úložiště vektorů.souborová dávka

status Enum: VectorStoreFileBatchObjectStatus

Hodnota	Popis
probíhá
dokončené
odvolaný
selhalo

createVectorStoreFileBatchRequest

Název	Typ	Popis	Požaduje se	Výchozí
strategie segmentace	chunkingStrategyRequestParam	Strategie vytváření bloků dat použitá k vytvoření bloků souborů. Pokud není nastavená, použije strategii auto .	Ne
identifikátory_souborů	pole	Seznam ID souborů, které má vektorové úložiště použít. Užitečné pro nástroje, jako je file_search například přístup k souborům.	Ano

assistantStreamEvent

Představuje událost vygenerovaná při streamování spuštění.

Každá událost v datovém proudu událostí odeslaných serverem má vlastnost event a data vlastnost:

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

Události generujeme pokaždé, když se vytvoří nový objekt, přejde do nového stavu nebo se streamuje v částech (rozdíly). Například vygenerujeme thread.run.created , když se vytvoří nové spuštění, thread.run.completed po dokončení spuštění atd. Když se Pomocník rozhodne vytvořit zprávu během spuštění, vygenerujeme thread.message.created eventthread.message.in_progress událost, mnoho thread.message.delta událostí a nakonec thread.message.completed událost.

V průběhu času můžeme přidat další události, proto doporučujeme v kódu řádně zpracovávat neznámé události.

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

• threadStreamEvent
• runStreamEvent
• runStepStreamEvent
• messageStreamEvent
• errorEvent
• doneEvent

threadStreamEvent

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

vlákno.vytvořeno

Nastane při vytvoření nového vlákna.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	threadObject	Představuje vlákno, které obsahuje zprávy.	Ano
událost	řetězec		Ano

Data: threadObject

Výčet událostí: ThreadStreamEventEnum

Hodnota	Popis
vlákno.vytvořeno	Událost vytvoření vlákna

---

runStreamEvent

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

vlákno.běh.vytvořeno

Nastane při vytvoření nového spuštění.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runObject	Představuje spuštění na vlákně.	Ano
událost	řetězec		Ano

Data: runObject

Výčet událostí: RunStreamEventCreated

Hodnota	Popis
vlákno.běh.vytvořeno

---

thread.run.queued

Nastane, když se spuštění přesune do queued stavu.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runObject	Představuje spuštění na vlákně.	Ano
událost	řetězec		Ano

Data: runObject

Výčet událostí: RunStreamEventQueued

Hodnota	Popis
thread.run.queued

---

vlákno.provoz.probíhá

Nastane, když se spuštění přesune do in_progress stavu.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runObject	Představuje spuštění na vlákně.	Ano
událost	řetězec		Ano

Data: runObject

Výčet událostí: RunStreamEventInProgress

Hodnota	Popis
vlákno.provoz.probíhá

---

vlákno.spustit.vyžaduje_akci

Nastane, když se spuštění přesune do requires_action stavu.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runObject	Představuje spuštění na vlákně.	Ano
událost	řetězec		Ano

Data: runObject

Výčet událostí: RunStreamEventRequiresAction

Hodnota	Popis
vlákno.spustit.vyžaduje_akci

---

vlákno.běh.dokončeno

Nastane při dokončení spuštění.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runObject	Představuje spuštění na vlákně.	Ano
událost	řetězec		Ano

Data: runObject

Výčet událostí: RunStreamEventCompleted

Hodnota	Popis
vlákno.běh.dokončeno

---

thread.run.failed

Nastane, když se spuštění nezdaří.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runObject	Představuje spuštění na vlákně.	Ano
událost	řetězec		Ano

Data: runObject

Výčet událostí: RunStreamEventFailed

Hodnota	Popis
thread.run.failed

---

thread.run.cancelling

Nastane, když se spuštění přesune do cancelling stavu.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runObject	Představuje spuštění na vlákně.	Ano
událost	řetězec		Ano

Data: runObject

Výčet událostí: RunStreamEventCancelling

Hodnota	Popis
thread.run.cancelling

---

thread.run.zrušeno

Nastane při zrušení spuštění.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runObject	Představuje spuštění na vlákně.	Ano
událost	řetězec		Ano

Data: runObject

Výčet událostí: RunStreamEventCancelled

Hodnota	Popis
thread.run.zrušeno

---

vlákno.proběhlo.vypršelo

Nastane, když vyprší platnost spuštění.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runObject	Představuje spuštění na vlákně.	Ano
událost	řetězec		Ano

Data: runObject

Výčet událostí: RunStreamEventExpired

Hodnota	Popis
vlákno.proběhlo.vypršelo

---

runStepStreamEvent

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

vlákno.spustit.krok.vytvořeno

Nastane při vytvoření kroku spuštění.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runStepObject	Představuje krok při spuštění spuštění.	Ano
událost	řetězec		Ano

Data: runStepObject

Výčet událostí: RunStepStreamEventCreated

Hodnota	Popis
vlákno.spustit.krok.vytvořeno

---

vlákno.spustit.krok.probíhá

Nastane, když se krok spuštění přesune do in_progress stavu.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runStepObject	Představuje krok při spuštění spuštění.	Ano
událost	řetězec		Ano

Data: runStepObject

Výčet událostí: RunStepStreamEventInProgress

Hodnota	Popis
vlákno.spustit.krok.probíhá

---

thread.run.step.delta

Nastane, když se streamují části kroku spuštění.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runStepDeltaObject	Představuje rozdílový krok spuštění, tj. všechna změněná pole v kroku spuštění během streamování.	Ano
událost	řetězec		Ano

Data: runStepDeltaObject

Výčet událostí: RunStepStreamEventDelta

Hodnota	Popis
thread.run.step.delta

---

vlákno.proběh.krok.dokončen

Nastane při dokončení kroku spuštění.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runStepObject	Představuje krok při spuštění spuštění.	Ano
událost	řetězec		Ano

Data: runStepObject

Výčet událostí: RunStepStreamEventCompleted

Hodnota	Popis
vlákno.proběh.krok.dokončen

---

vlákno.run.krok.selhal

Nastane, když selže krok spuštění.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runStepObject	Představuje krok při spuštění spuštění.	Ano
událost	řetězec		Ano

Data: runStepObject

Výčet událostí: RunStepStreamEventFailed

Hodnota	Popis
vlákno.run.krok.selhal

---

vlákno.spustit.krok.zrušeno

Nastane při zrušení kroku spuštění.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runStepObject	Představuje krok při spuštění spuštění.	Ano
událost	řetězec		Ano

Data: runStepObject

Výčet událostí: RunStepStreamEventCancelled

Hodnota	Popis
vlákno.spustit.krok.zrušeno

---

vlákno.běh.krok.vypršel

Nastane, když vyprší platnost kroku spuštění.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	runStepObject	Představuje krok při spuštění spuštění.	Ano
událost	řetězec		Ano

Data: runStepObject

Výčet událostí: RunStepStreamEventExpired

Hodnota	Popis
vlákno.běh.krok.vypršel

---

messageStreamEvent

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

vlákno.zpráva.vytvořeno

Nastane při vytvoření zprávy.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	messageObject	Představuje zprávu v rámci vláken.	Ano
událost	řetězec		Ano

Data: messageObject

Výčet událostí: MessageStreamEventCreated

Hodnota	Popis
vlákno.zpráva.vytvořeno

---

vlákno.zpráva.probíhá

Nastane, když se zpráva přesune do in_progress stavu.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	messageObject	Představuje zprávu v rámci vláken.	Ano
událost	řetězec		Ano

Data: messageObject

Výčet událostí: MessageStreamEventInProgress

Hodnota	Popis
vlákno.zpráva.probíhá

---

thread.message.delta

Nastane, když se streamují části zprávy.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	messageDeltaObject	Představuje rozdíl zprávy, tj. všechna změněná pole zprávy během streamování.	Ano
událost	řetězec		Ano

Data: messageDeltaObject

Výčet událostí: MessageStreamEventDelta

Hodnota	Popis
vlákno.zpráva.delta

---

vlákno.zpráva.dokončeno

Nastane při dokončení zprávy.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	messageObject	Představuje zprávu v rámci vláken.	Ano
událost	řetězec		Ano

Data: messageObject

Výčet událostí: MessageStreamEventCompleted

Hodnota	Popis
vlákno.zpráva.dokončeno

---

vlákno.zpráva.neúplná

Nastane, když zpráva skončí před dokončením.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	messageObject	Představuje zprávu v rámci vláken.	Ano
událost	řetězec		Ano

Data: messageObject

Výčet událostí: MessageStreamEventIncomplete

Hodnota	Popis
vlákno.zpráva.neúplná

---

Poznámka

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

• FileCitation
• UrlCitation
• Cesta k souboru

Klikněte

Kliknutí myší.

Název	Typ	Popis	Požaduje se	Výchozí
knoflík	výčet	Označuje, které tlačítko myši bylo během kliknutí stisknuto. Jeden z left, , rightwheel, backnebo forward. Možné hodnoty: left, right, wheel, back, forward	Ano
typ	výčet	Určuje typ události. U akce kliknutí je tato vlastnost vždy nastavena na clickhodnotu . Možné hodnoty: click	Ano
x	celočíselný	Souřadnice x, kde došlo k kliknutí.	Ano
y	celočíselný	Souřadnice y, kde došlo k kliknutí.	Ano

VýstupZeSouboruInterpretuKódu

Výstup volání nástroje interpretu kódu, který je souborem.

Název	Typ	Popis	Požaduje se	Výchozí
soubory	pole		Ano
typ	výčet	Typ výstupu souboru interpretu kódu. Vždy hodnota files. Možné hodnoty: files	Ano

Výstup Textového Interpretátoru Kódu

Výstup volání nástroje interpreta kódu, který je text.

Název	Typ	Popis	Požaduje se	Výchozí
Protokoly	řetězec	Protokoly volání nástroje interpreta kódu.	Ano
typ	výčet	Typ textového výstupu interpreta kódu. Vždy hodnota logs. Možné hodnoty: logs	Ano

CodeInterpreterTool

Nástroj, který spouští kód.

Název	Typ	Popis	Požaduje se	Výchozí
identifikátory_souborů	pole	ID souborů pro spuštění kódu.	Ano
typ	výčet	Typ nástroje pro interpret kódu. Vždy hodnota code_interpreter. Možné hodnoty: code_interpreter	Ano

CodeInterpreterToolCall

Volání nástroje ke spuštění kódu

Název	Typ	Popis	Požaduje se	Výchozí
kód	řetězec	Kód, který se má spustit.	Ano
ID	řetězec	Jedinečné ID volání nástroje interpretu kódu.	Ano
výsledky	pole	Výsledky volání nástroje interpreta kódu.	Ano
stav	výčet	Stav volání nástroje interpreta kódu. Možné hodnoty: in_progress, interpreting, completed	Ano
typ	výčet	Typ volání nástroje interpreta kódu. Vždy hodnota code_interpreter_call. Možné hodnoty: code_interpreter_call	Ano

VýstupNástrojeProInterpretaciKódu

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

• CodeInterpreterTextOutput
• CodeInterpreterFileOutput

Porovnávací filtr

Filtr použitý k porovnání zadaného klíče atributu s danou hodnotou pomocí definované operace porovnání.

Název	Typ	Popis	Požaduje se	Výchozí
klíč	řetězec	Klíč k porovnání s hodnotou.	Ano
typ	výčet	Určuje relační operátor: eq, ne, gtgte, lt, , lte. - eq:rovná se - ne: nerovná se - gt: větší než - gte: větší nebo rovno - lt:méně než - lte: menší než nebo rovno Možné hodnoty: eq, ne, gt, gte, ltlte	Ano
hodnota	řetězec nebo číslo nebo logická hodnota	Hodnota, která se má porovnat s klíčem atributu; podporuje typy řetězců, čísel nebo logických hodnot.	Ano

Sloučený filtr

Kombinování více filtrů pomocí and nebo or.

Název	Typ	Popis	Požaduje se	Výchozí
filtruje	pole	Pole filtrů k kombinování. Položky mohou být ComparisonFilter nebo CompoundFilter.	Ano
typ	výčet	Typ operace: and nebo or. Možné hodnoty: and, or	Ano

ComputerAction

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

• Klikněte
• DoubleClick
• přetáhněte
• Keypress
• Přesunout
• Snímek obrazovky
• posouvání
• Typ
• Wait (Čekání)

Snímek obrazovky počítače

Snímek obrazovky počítače použitý s nástrojem pro použití počítače

Název	Typ	Popis	Požaduje se	Výchozí
ID souboru	řetězec	Identifikátor nahraného souboru, který obsahuje snímek obrazovky.	Ne
URL_obrázku	řetězec	Adresa URL obrázku snímku obrazovky	Ne
typ	výčet	Určuje typ události. U snímku obrazovky počítače je tato vlastnost vždy nastavena na computer_screenshothodnotu . Možné hodnoty: computer_screenshot	Ano

ComputerTool

Nástroj, který řídí virtuální počítač.

Název	Typ	Popis	Požaduje se	Výchozí
výška displeje	Číslo	Výška displeje počítače.	Ano
šířka displeje	Číslo	Šířka displeje počítače.	Ano
prostředí	výčet	Typ počítačového prostředí, které se má řídit. Možné hodnoty: mac, windows, ubuntu, browser	Ano
typ	výčet	Typ nástroje pro použití počítače. Vždy hodnota computer_use_preview. Možné hodnoty: computer-use-preview	Ano

ComputerToolCall

Zavolání nástroje k použití s počítačovým nástrojem.

Název	Typ	Popis	Požaduje se	Výchozí
akce	ComputerAction		Ano
ID hovoru	řetězec	Identifikátor použitý při odpovídání na volání nástroje s výstupem.	Ano
ID	řetězec	Jedinečné ID počítačového volání.	Ano
čekající bezpečnostní kontroly	pole	Čekající bezpečnostní kontroly volání počítače.	Ano
stav	výčet	Stav položky. Jeden z in_progress, completednebo incomplete. Naplněno při vrácení položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ano
typ	výčet	Typ hovoru počítačem. Vždy hodnota computer_call. Možné hodnoty: computer_call	Ano

Výstup volání počítačového nástroje

Výstup z volání počítačového nástroje.

Název	Typ	Popis	Požaduje se	Výchozí
potvrzené_bezpečnostní_kontroly	pole	Bezpečnostní kontroly hlášené rozhraním API, které vývojář potvrdil.	Ne
ID hovoru	řetězec	ID volání počítačového nástroje, které vytvořilo výstup.	Ano
ID	řetězec	ID výstupu volání počítačového nástroje.	Ne
výstup	ComputerScreenshotImage	Snímek obrazovky počítače použitý s nástrojem pro použití počítače	Ano
stav	výčet	Stav vstupu zprávy. Jeden z in_progress, completednebo incomplete. Naplněno při vrácení vstupních položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ne
typ	výčet	Typ výstupu volání počítačového nástroje. Vždy hodnota computer_call_output. Možné hodnoty: computer_call_output	Ano

Výstupní zdroj volání počítačového nástroje

Název	Typ	Popis	Požaduje se	Výchozí
potvrzené_bezpečnostní_kontroly	pole	Bezpečnostní kontroly hlášené rozhraním API, které vývojář potvrdil.	Ne
ID hovoru	řetězec	ID volání počítačového nástroje, které vytvořilo výstup.	Ano
ID	řetězec	Jedinečné ID výstupu nástroje pro počítačový hovor.	Ano
výstup	ComputerScreenshotImage	Snímek obrazovky počítače použitý s nástrojem pro použití počítače	Ano
stav	výčet	Stav vstupu zprávy. Jeden z in_progress, completednebo incomplete. Naplněno při vrácení vstupních položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ne
typ	výčet	Typ výstupu volání počítačového nástroje. Vždy hodnota computer_call_output. Možné hodnoty: computer_call_output	Ano

Bezpečnostní Kontrola Volání Nástroje Počítače

Čekající bezpečnostní kontrola pro počítačové volání.

Název	Typ	Popis	Požaduje se	Výchozí
kód	řetězec	Typ čekající bezpečnostní kontroly.	Ano
ID	řetězec	ID čekající bezpečnostní kontroly.	Ano
zpráva	řetězec	Podrobnosti o čekající bezpečnostní kontrole	Ano

Obsah

Multimodální vstupní a výstupní obsah

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

• InputContent
• OutputContent

Souřadnice

Dvojice souřadnic x/y, například { x: 100, y: 200 }.

Název	Typ	Popis	Požaduje se	Výchozí
x	celočíselný	Souřadnice x.	Ano
y	celočíselný	Souřadnice y.	Ano

VytvořitVlastnostiOdpovědiModelu

Název	Typ	Popis	Požaduje se	Výchozí
metadatové informace	Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne
model	řetězec	Model použitý k vygenerování odpovědí	Ne
Teplota	Číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne	0
top_p	Číslo	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne	0
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct OpenAI monitorovat a zjišťovat zneužití. .	Ne

createResponse

Název	Typ	Popis	Požaduje se	Výchozí
zahrnovat	pole	{"$ref": "#/components/schemas/includable/description"}	Ne
vstup	řetězec nebo pole	Textové, obrázkové nebo souborové vstupy do modelu, které se používají k vygenerování odpovědi.	Ano
pokyny	řetězec	Vloží zprávu systému (nebo vývojáře) jako první položku v kontextu modelu. Při použití společně previous_response_idse pokyny z předchozí odpovědi nepřenesou do další odpovědi. Díky tomu je snadné prohodit systémové zprávy (nebo zprávy vývojářů) v nových odpovědích.	Ne
maximální počet výstupních tokenů (max_output_tokens)	celočíselný	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a zdůvodnění tokenů.	Ne
paralelní volání nástrojů	Boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ne	Pravdivé
identifikátor_předchozí_odpovědi	řetězec	Jedinečné ID předchozí odpovědi na model. Pomocí této možnosti můžete vytvářet konverzace s více interakcemi.	Ne
usuzování	Usuzování	Modely řady o-series pouze Možnosti konfigurace pro zdůvodnění modelů	Ne
obchod	Boolean	Zda se má vygenerovaná odpověď modelu uložit pro pozdější načtení prostřednictvím rozhraní API.	Ne	Pravdivé
datový proud	Boolean	Pokud je nastavená hodnota true, data odpovědi modelu se streamují do klienta, protože se generují pomocí událostí odeslaných serverem.	Ne	Nepravda
Text	objekt	Možnosti konfigurace textové odpovědi z modelu Může to být prostý text nebo strukturovaná data JSON. Další informace: - textové vstupy a výstupy - Strukturované výstupy	Ne
└─ Formát	TextResponseFormatConfiguration	Objekt určující formát, který musí model vypíše. Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat zadanému schématu JSON. Výchozí formát je { "type": "text" } bez dalších možností. Nedoporučuje se pro gpt-4o a novější modely: Nastavení { "type": "json_object" } umožní původní režim JSON, což zajišťuje, že zpráva vygenerovaná modelem je platný JSON. Použití json_schema je upřednostňované pro modely, které ho podporují.	Ne
výběr nástroje	ToolChoiceOptions nebo ToolChoiceTypes nebo ToolChoiceFunction	Způsob, jakým má model vybrat nástroj (nebo nástroje), který se má použít při generování odpovědi V parametru tools se dozvíte, jak určit nástroje, které model může volat.	Ne
nářadí	pole	Pole nástrojů, které může model volat při generování odpovědi. Pomocí nastavení parametru tool_choice můžete určit, který nástroj chcete použít. Existují dvě kategorie nástrojů, které můžete poskytnout modelu: - Integrované nástroje	Ne
zkrácení	výčet	Strategie zkrácení, která se má použít pro odpověď modelu. - auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu, model zkrátí hodnotu odpověď pro přizpůsobení kontextového okna odstraněním vstupních položek uprostřed konverzace. - disabled (výchozí): Pokud odpověď modelu překročí velikost kontextového okna modelu, požadavek selže s chybou 400. Možné hodnoty: auto, disabled	Ne

DoubleClick

Akce dvojkliku.

Název	Typ	Popis	Požaduje se	Výchozí
typ	výčet	Určuje typ události. U akce poklikání je tato vlastnost vždy nastavena na double_click. Možné hodnoty: double_click	Ano
x	celočíselný	Souřadnice x, kde došlo k dvojitému kliknutí.	Ano
y	celočíselný	Souřadnice y, kde došlo k dvojitému kliknutí.	Ano

Táhnout

Akce přetažení

Název	Typ	Popis	Požaduje se	Výchozí
cesta	pole	Pole souřadnic představující cestu přetahování Souřadnice se zobrazí jako pole objektů, např.[{ x: 100, y: 200 }, { x: 200, y: 300 }]	Ano
typ	výčet	Určuje typ události. U akce přetažení je tato vlastnost vždy nastavena na drag. Možné hodnoty: drag	Ano

JednoducháZprávaVstupu

Vstup zprávy do modelu s rolí, která označuje dodržování hierarchie pokynů. Pokyny, které mají roli developer nebo system, mají přednost před pokyny s rolí user. U zpráv s rolí assistant se předpokládá, že byly vygenerovány modelem v předchozích interakcích.

Název	Typ	Popis	Požaduje se	Výchozí
obsah	string nebo InputMessageContentList	Text, obrázek nebo zvukový vstup do modelu, který se používá k vygenerování odpovědi. Může také obsahovat předchozí odpovědi asistenta.	Ano
úloha	výčet	Role vstupu zprávy. Jeden z user, assistant, systemnebo developer. Možné hodnoty: user, assistant, system, developer	Ano
typ	výčet	Typ vstupu zprávy. Vždy hodnota message. Možné hodnoty: message	Ne

FileCitation

Citace souboru.

Název	Typ	Popis	Požaduje se	Výchozí
ID souboru	řetězec	ID souboru.	Ano
rejstřík	celočíselný	Index souboru v seznamu souborů.	Ano
typ	výčet	Typ citace souboru. Vždy hodnota file_citation. Možné hodnoty: file_citation	Ano

Cesta k souboru

Cesta k souboru.

Název	Typ	Popis	Požaduje se	Výchozí
ID souboru	řetězec	ID souboru.	Ano
rejstřík	celočíselný	Index souboru v seznamu souborů.	Ano
typ	výčet	Typ cesty k souboru. Vždy hodnota file_path. Možné hodnoty: file_path	Ano

FileSearchRanker

Ranker, který se má použít pro vyhledávání souborů. Pokud není specifikován, bude použit hodnotící systém auto.

Vlastnictví	Hodnota
Popis	Ranker, který se má použít pro vyhledávání souborů. Pokud není specifikován, bude použit hodnotící systém auto.
Typ	řetězec
Hodnoty	auto default_2024_08_21

Nástroj pro hledání souborů

Nástroj, který hledá relevantní obsah z nahraných souborů.

Název	Typ	Popis	Požaduje se	Výchozí
filtruje	ComparisonFilter nebo CompoundFilter	Filtr, který se použije na základě atributů souboru.	Ne
max_počet_výsledků	celočíselný	Maximální počet výsledků, které se mají vrátit. Toto číslo by mělo být mezi 1 a 50 včetně.	Ne
možnosti hodnocení	objekt	Možnosti řazení pro hledání	Ne
└- ranker	výčet	Ranker, který se má použít pro vyhledávání souborů. Možné hodnoty: auto, default-2024-11-15	Ne
└ score_threshold	Číslo	Prahová hodnota skóre pro hledání souboru je číslo v rozmezí od 0 do 1. Čísla blížící se 1 se pokusí vrátit pouze nejrelevantní výsledky, ale můžou vrátit méně výsledků.	Ne	0
typ	výčet	Typ nástroje pro vyhledávání souborů. Vždy hodnota file_search. Možné hodnoty: file_search	Ano
identifikátory_vektorového_úložiště	pole	ID vektorových úložišť, která se mají prohledávat.	Ano

FileSearchToolCall

Výsledky volání nástroje pro vyhledávání souborů.

Název	Typ	Popis	Požaduje se	Výchozí
ID	řetězec	Jedinečné ID volání nástroje pro vyhledávání souborů.	Ano
dotazy	pole	Dotazy používané k hledání souborů.	Ano
výsledky	pole	Výsledky volání nástroje pro vyhledávání souborů.	Ne
stav	výčet	Stav volání nástroje pro vyhledávání souborů. Jeden z in_progress, searchingnebo incompletefailed, Možné hodnoty: in_progress, searching, completed, incomplete, failed	Ano
typ	výčet	Typ volání nástroje pro vyhledávání souborů. Vždy hodnota file_search_call. Možné hodnoty: file_search_call	Ano

FunctionTool

Ve vašem vlastním kódu definuje funkci, kterou může model volitelně volat.

Název	Typ	Popis	Požaduje se	Výchozí
popis	řetězec	Popis funkce. Model se používá k rozhodnutí, zda má být funkce volána či nikoliv.	Ne
jméno	řetězec	Název funkce, která se má volat.	Ano
parametry	objekt	Objekt schématu JSON popisující parametry funkce.	Ano
přísné	Boolean	Určuje, jestli se má vynutit přísné ověřování parametrů. Výchozí true.	Ano
typ	výčet	Typ nástroje funkce. Vždy hodnota function. Možné hodnoty: function	Ano

FunctionToolCall

Volání nástroje ke spuštění funkce

Název	Typ	Popis	Požaduje se	Výchozí
argumenty	řetězec	Řetězec JSON obsahující argumenty, které mají být předány funkci.	Ano
ID hovoru	řetězec	Jedinečné ID volání nástroje funkcí vygenerované modelem.	Ano
ID	řetězec	Jedinečné ID volání nástroje funkcí.	Ano
jméno	řetězec	Název funkce, která se má spustit.	Ano
stav	výčet	Stav položky. Jeden z in_progress, completednebo incomplete. Naplněno při vrácení položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ne
typ	výčet	Typ volání funkčního nástroje. Vždy hodnota function_call. Možné hodnoty: function_call	Ano

FunctionToolCallOutput

Výstup z volání funkčního nástroje.

Název	Typ	Popis	Požaduje se	Výchozí
ID hovoru	řetězec	Jedinečné ID volání nástroje funkcí vygenerované modelem.	Ano
ID	řetězec	Jedinečné ID výstupu volání funkčního nástroje. Naplněno při vrácení této položky přes rozhraní API.	Ne
výstup	řetězec	Řetězec JSON výstupu volání nástroje funkcí.	Ano
stav	výčet	Stav položky. Jeden z in_progress, completednebo incomplete. Naplněno při vrácení položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ne
typ	výčet	Typ výstupu volání nástroje funkce. Vždy hodnota function_call_output. Možné hodnoty: function_call_output	Ano

FunctionToolCallOutputResource

Název	Typ	Popis	Požaduje se	Výchozí
ID hovoru	řetězec	Jedinečné ID volání nástroje funkcí vygenerované modelem.	Ano
ID	řetězec	Jedinečné ID výstupu nástroje volání funkce.	Ano
výstup	řetězec	Řetězec JSON výstupu volání nástroje funkcí.	Ano
stav	výčet	Stav položky. Jeden z in_progress, completednebo incomplete. Naplněno při vrácení položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ne
typ	výčet	Typ výstupu volání nástroje funkce. Vždy hodnota function_call_output. Možné hodnoty: function_call_output	Ano

zahrnutelný

Zadejte další výstupní data, která se mají zahrnout do odpovědi modelu. Aktuálně podporované hodnoty jsou:

• file_search_call.results: Zahrňte výsledky vyhledávání nástroje pro hledání souborů.
• message.input_image.image_url: Zahrňte adresy URL obrázků ze vstupní zprávy.
• computer_call_output.output.image_url: Zahrňte adresy URL obrázků z výsledku počítačového volání.

Vlastnictví	Hodnota
Popis	Zadejte další výstupní data, která se mají zahrnout do odpovědi modelu. Aktuálně podporované hodnoty jsou: - file_search_call.results: Zahrňte výsledky volání nástroje pro hledání souborů. - message.input_image.image_url: Zahrňte adresy URL obrázků ze vstupní zprávy. - computer_call_output.output.image_url: Zahrňte adresy URL obrázků z výstupu počítačového programu.
Typ	řetězec
Hodnoty	file_search_call.results message.input_image.image_url computer_call_output.output.image_url

InputAudio

Zvukový vstup do modelu.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	řetězec	Zvuková data s kódováním Base64	Ano
formát	výčet	Formát zvukových dat. Aktuálně podporované formáty jsou mp3 a wav. Možné hodnoty: mp3, wav	Ano
typ	výčet	Typ vstupní položky. Vždy hodnota input_audio. Možné hodnoty: input_audio	Ano

ObsahVstupu

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

• InputText
• InputImage
• InputFile

Vstupní soubor

Vstup souboru do modelu.

Název	Typ	Popis	Požaduje se	Výchozí
souborová data	řetězec	Obsah souboru, který se má odeslat do modelu.	Ne
ID souboru	řetězec	ID souboru, který se má odeslat do modelu.	Ne
jméno souboru	řetězec	Název souboru, který se má odeslat do modelu.	Ne
typ	výčet	Typ vstupní položky. Vždy hodnota input_file. Možné hodnoty: input_file	Ano

InputImage

Vstup obrázku do modelu.

Název	Typ	Popis	Požaduje se	Výchozí
podrobnost	výčet	Úroveň podrobností obrázku, která se má odeslat do modelu. Jeden z high, lownebo auto. Výchozí hodnota autoje . Možné hodnoty: high, low, auto	Ano
ID souboru	řetězec	ID souboru, který se má odeslat do modelu.	Ne
URL_obrázku	řetězec	Adresa URL obrázku, který se má odeslat do modelu. Plně kvalifikovaná adresa URL nebo obrázek s kódováním Base64 v adrese URL dat.	Ne
typ	výčet	Typ vstupní položky. Vždy hodnota input_image. Možné hodnoty: input_image	Ano

Položka Vstupu

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

• EasyInputMessage
• Položka
• ItemReference

Zpráva pro vstup

Vstup zprávy do modelu s rolí, která označuje dodržování hierarchie pokynů. Pokyny, které mají roli developer nebo system, mají přednost před pokyny s rolí user.

Název	Typ	Popis	Požaduje se	Výchozí
obsah	InputMessageContentList	Seznam jedné nebo více vstupních položek modelu obsahující jiný obsah typy.	Ano
úloha	výčet	Role vstupu zprávy. Jeden z user, systemnebo developer. Možné hodnoty: user, system, developer	Ano
stav	výčet	Stav položky. Jeden z in_progress, completednebo incomplete. Naplněno při vrácení položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ne
typ	výčet	Typ vstupu zprávy. Vždy je nastavená na message. Možné hodnoty: message	Ne

SeznamObsahuVstupníZprávy

Seznam jedné nebo více vstupních položek modelu, který obsahuje různé typy obsahu.

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

VstupníZprávaZdroj

Název	Typ	Popis	Požaduje se	Výchozí
obsah	InputMessageContentList	Seznam jedné nebo více vstupních položek modelu obsahující jiný obsah typy.	Ano
ID	řetězec	Jedinečné ID vstupu zprávy.	Ano
úloha	výčet	Role vstupu zprávy. Jeden z user, systemnebo developer. Možné hodnoty: user, system, developer	Ano
stav	výčet	Stav položky. Jeden z in_progress, completednebo incomplete. Naplněno při vrácení položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ne
typ	výčet	Typ vstupu zprávy. Vždy je nastavená na message. Možné hodnoty: message	Ne

InputText

Textový vstup do modelu.

Název	Typ	Popis	Požaduje se	Výchozí
Text	řetězec	Textový vstup do modelu.	Ano
typ	výčet	Typ vstupní položky. Vždy hodnota input_text. Možné hodnoty: input_text	Ano

Položka

Položka obsahu použitá k vygenerování odpovědi

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

• InputMessage
• OutputMessage
• FileSearchToolCall
• ComputerToolCall
• ComputerToolCallOutput
• FunctionToolCall
• FunctionToolCallOutput
• Argumentační položka

Referenční položka

Interní identifikátor položky, na kterou se má odkazovat.

Název	Typ	Popis	Požaduje se	Výchozí
ID	řetězec	ID položky, na kterou chcete odkazovat.	Ano
typ	výčet	Typ položky, na kterou chcete odkazovat. Vždy hodnota item_reference. Možné hodnoty: item_reference	Ano

Položkový zdroj

Položka obsahu použitá k vygenerování odpovědi

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

• InputMessageResource
• OutputMessage
• FileSearchToolCall
• ComputerToolCall
• ComputerToolCallOutputResource
• FunctionToolCall
• FunctionToolCallOutputResource

Keypress

Kolekce klávesových stisků, které model chce provést.

Název	Typ	Popis	Požaduje se	Výchozí
klíče	pole	Kombinace kláves, které model žádá stisknout. Toto je pole řetězců, z nichž každý představuje klíč.	Ano
typ	výčet	Určuje typ události. U akce keypress je tato vlastnost vždy nastavena na keypress. Možné hodnoty: keypress	Ano

Metadatové informace

Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu.

Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.

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

ModelResponseProperties

Název	Typ	Popis	Požaduje se	Výchozí
metadatové informace	Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne
model	řetězec	Model použitý k vygenerování odpovědí	Ne
Teplota	Číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne	0
top_p	Číslo	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne	0
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct OpenAI monitorovat a zjišťovat zneužití. .	Ne

Přesun

Akce přesunutí myší.

Název	Typ	Popis	Požaduje se	Výchozí
typ	výčet	Určuje typ události. U akce přesunutí je tato vlastnost vždy nastavena na movehodnotu . Možné hodnoty: move	Ano
x	celočíselný	Souřadnice x, ke které se chcete přesunout.	Ano
y	celočíselný	Souřadnice y, ke které se chcete přesunout.	Ano

VýstupZvuku

Zvukový výstup z modelu.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	řetězec	Zvuková data s kódováním Base64 z modelu.	Ano
přepis	řetězec	Přepis zvukových dat z modelu.	Ano
typ	výčet	Typ výstupního zvuku. Vždy hodnota output_audio. Možné hodnoty: output_audio	Ano

Výstupní obsah

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

• Výstupní text
• Odmítnutí

Výstupní položka

Název	Typ	Popis	Požaduje se	Výchozí
akce	ComputerAction		Ano
argumenty	řetězec	Řetězec JSON obsahující argumenty, které mají být předány funkci.	Ano
ID hovoru	řetězec	Identifikátor použitý při odpovídání na volání nástroje s výstupem.	Ano
obsah	pole	Zdůvodnění obsahu textu	Ano
ID	řetězec	Jedinečný identifikátor obsahu odůvodnění.	Ano
jméno	řetězec	Název funkce, která se má spustit.	Ano
čekající bezpečnostní kontroly	pole	Čekající bezpečnostní kontroly volání počítače.	Ano
dotazy	pole	Dotazy používané k hledání souborů.	Ano
výsledky	pole	Výsledky volání nástroje pro vyhledávání souborů.	Ne
úloha	výčet	Role výstupní zprávy. Vždy hodnota assistant. Možné hodnoty: assistant	Ano
stav	výčet	Stav položky. Jeden z in_progress, completednebo incomplete. Naplněno při vrácení položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ano
typ	výčet	Typ objektu. Vždy hodnota reasoning. Možné hodnoty: reasoning	Ano

VýstupníZpráva

Výstupní zpráva z modelu

Název	Typ	Popis	Požaduje se	Výchozí
obsah	pole	Obsah výstupní zprávy.	Ano
ID	řetězec	Jedinečné ID výstupní zprávy.	Ano
úloha	výčet	Role výstupní zprávy. Vždy hodnota assistant. Možné hodnoty: assistant	Ano
stav	výčet	Stav vstupu zprávy. Jeden z in_progress, completednebo incomplete. Naplněno při vrácení vstupních položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ano
typ	výčet	Typ výstupní zprávy. Vždy hodnota message. Možné hodnoty: message	Ano

Výstupní text

Textový výstup z modelu.

Název	Typ	Popis	Požaduje se	Výchozí
anotace	pole	Poznámky textového výstupu.	Ano
Text	řetězec	Textový výstup z modelu.	Ano
typ	výčet	Typ výstupního textu. Vždy hodnota output_text. Možné hodnoty: output_text	Ano

Požadavek na vytvoření sezení v reálném čase

Konfigurace objektu relace v reálném čase.

Název	Typ	Popis	Požaduje se	Výchozí
vstupní_formát_audio	výčet	Formát vstupního zvuku. Možnosti jsou pcm16, g711_ulawnebo g711_alaw. Pro pcm16, vstupní zvuk musí být 16bitový PCM při vzorkovací frekvenci 24kHz, jeden kanál (mono) a minimální-endian bajt pořadí. Možné hodnoty: pcm16, g711_ulaw, g711_alaw	Ne
vstupní redukce šumu zvuku	objekt	Konfigurace pro snížení hluku vstupu zvuku. Nastavte na null pro vypnutí. Filtry redukce šumu jsou přidány do zvukového vstupního vyrovnávacího paměťového bloku před odesláním do VAD a modelu. Filtrování zvuku může zlepšit přesnost detekce vad a otáčení (snížení falešně pozitivních výsledků) a výkon modelu zlepšením vnímání vstupního zvuku.	Ne
└- typ	výčet	Typ snížení šumu. near_field je určená pro mikrofony s blízkým hovorem, jako jsou sluchátka, je určená pro mikrofony vzdáleného pole, far_field jako jsou mikrofony přenosného počítače nebo konferenční místnosti. Možné hodnoty: near_field, far_field	Ne
přepis zvukového vstupu	objekt	Konfigurace pro přepis zvuku z vstupu, ve výchozím nastavení vypnuté, lze nastavit na null, aby se vypnulo, pokud bylo zapnuto. Vstupní přepis zvuku není nativní pro model, protože model využívá zvuk přímo. Přepis probíhá asynchronně prostřednictvím koncového bodu Transcriptions a měl by být chápán jako vodítko k obsahu vstupního zvuku, nikoliv jako přesná reprodukce toho, co model slyšel. Klient může volitelně nastavit jazyk a zobrazit výzvu k přepisu. Tyto pokyny nabízejí další pokyny ke službě přepisu.	Ne
└jazyk	řetězec	Jazyk vstupního zvuku. Poskytnutí jazyka zadávání vstupu ve formátu ISO-639-1 (např. en) zlepší přesnost a latenci.	Ne
└model	řetězec	Model, který se má použít pro přepis, aktuální možnosti jsou gpt-4o-transcribe, gpt-4o-mini-transcribea whisper-1.	Ne
└─ výzva	řetězec	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Pro whisper-1 je výzva seznamem klíčových slov. U gpt-4o-transcribe modelů je výzvou bezplatný textový řetězec, například "očekávat slova související s technologií".	Ne
pokyny	řetězec	Výchozí systémové instrukce (tj. systémová zpráva) připojené k vyžádání modelu. Toto pole umožňuje klientovi řídit model na požadovaných odpovědích. Model lze instruovat o obsahu a formátu odpovědi (např. "buďte velmi stručné", "jednat přátelsky", "tady jsou příklady dobrých odpovědí") a o chování zvuku (např. "rychle mluvit", "vkládat do hlasu emoce", "smět se často"). Není zaručeno, že model bude pokyny dodržovat, ale poskytují modelu vedení ohledně požadovaného chování. Všimněte si, že server nastaví výchozí pokyny, které se použijí, pokud toto pole není nastavené a jsou viditelné v session.created události na začátku relace.	Ne
maximální počet tokenů výstupní odpovědi	celé číslo nebo řetězec	Maximální početvýstupních Zadejte celé číslo mezi 1 a 4096, abyste omezili výstupní tokeny nebo inf maximální dostupné tokeny pro daný model. Výchozí hodnota infje .	Ne
modality		Sada způsobů, kterými může model reagovat. Pokud chcete zvuk zakázat, nastavte ho na ["text"].	Ne
model	řetězec	Název nasazení použitého pro tuto relaci.	Ne
formát_výstupního_zvuku	výčet	Formát výstupního zvuku. Možnosti jsou pcm16, g711_ulawnebo g711_alaw. Pro pcm16, výstupní zvuk je vzorkován rychlostí 24kHz. Možné hodnoty: pcm16, g711_ulaw, g711_alaw	Ne
Teplota	Číslo	Vzorkovací teplota pro model omezená na [0.6, 1.2]. Pro zvukové modely se pro zajištění nejlepšího výkonu důrazně doporučuje teplota 0,8.	Ne	0,8
výběr nástroje	řetězec	Jak model vybírá nástroje. Možnosti jsou auto, none, requirednebo zadat funkci.	Ne	Auto
nářadí	pole	Nástroje (funkce) dostupné pro model	Ne
detekce otočení	objekt	Konfigurace pro detekci otáčení, ether Server VAD nebo sémantický VAD. Toto lze nastavit na null, aby se vypnulo, v takovém případě musí klient ručně vyvolat odpověď modelu. Server VAD znamená, že model rozpozná začátek a konec řeči na základě hlasitosti zvuku a odpoví na konci řeči uživatele. Sémantický VAD je pokročilejší a používá model detekce řečnických přestávek (ve spojení s VAD) pro sémantický odhad, zda uživatel dokončil mluvení, a pak dynamicky nastaví časový limit na základě této pravděpodobnosti. Pokud například uživatelův zvuk se ztratí s uhhm, model bude mít nízkou pravděpodobnost ukončení obratu a počká déle, než uživatel bude pokračovat v mluvení. To může být užitečné pro přirozenější konverzace, ale může mít vyšší latenci.	Ne
└create_response	Boolean	Jestli se má automaticky generovat odpověď, když dojde k události zastavení VAD.	Ne	Pravdivé
└- dychtivost	výčet	Používá se jenom pro semantic_vad režim. Dychtivost modelu reagovat low bude čekat déle, než uživatel bude pokračovat v mluvení, high bude reagovat rychleji. autoje výchozí hodnota a je ekvivalentní .medium Možné hodnoty: low, medium, high, auto	Ne
└interrupt_response	Boolean	Bez ohledu na to, jestli se má automaticky přerušit jakákoli probíhající odpověď s výstupem výchozí konverzace (tj. conversation z auto) při výskytu počáteční události VAD.	Ne	Pravdivé
└- prefix_padding_ms	celočíselný	Používá se jenom pro server_vad režim. Množství zvuku, které se má zahrnout před detekovanou řečí VAD (v milisekundách). Výchozí hodnota je 300 ms.	Ne
└─ trvání_ticha_ms	celočíselný	Používá se jenom pro server_vad režim. Doba ticha pro detekci zastavení řeči (v milisekundách). Výchozí hodnota je 500 ms. S kratšími hodnotami bude model reagovat rychleji, ale může zasahovat během krátkých přestávek uživatele.	Ne
└- prahová hodnota	Číslo	Používá se jenom pro server_vad režim. Prahová hodnota aktivace pro VAD (0,0 až 1,0), výchozí hodnota je 0,5. Vyšší prahová hodnota bude vyžadovat hlasitější zvuk k aktivaci modelu, a proto může fungovat lépe v hlučných prostředích.	Ne
└- typ	výčet	Typ detekce otáčení Možné hodnoty: server_vad, semantic_vad	Ne
hlas	VoiceIdsShared		Ne

RealtimeSessionCreateResponse

Nová konfigurace relace v reálném čase s přechodným klíčem. Výchozí hodnota TTL pro klíče je jedna minuta.

Název	Typ	Popis	Požaduje se	Výchozí
tajný klíč klienta	objekt	Dočasný klíč vrácený rozhraním API	Ano
└- vyprší_dne	celočíselný	Časové razítko pro vypršení platnosti tokenu V současné době vyprší platnost všech tokenů po jedné minutě.	Ne
└– hodnota	řetězec	Dočasný klíč použitelný v klientských prostředích k ověřování připojení k rozhraní API v reálném čase. Použijte ho v prostředích na straně klienta místo standardního tokenu rozhraní API, který by se měl používat jenom na straně serveru.	Ne
vstupní_formát_audio	řetězec	Formát vstupního zvuku. Možnosti jsou pcm16, g711_ulawnebo g711_alaw.	Ne
přepis zvukového vstupu	objekt	Konfigurace pro přepis zvuku z vstupu, ve výchozím nastavení vypnuté, lze nastavit na null, aby se vypnulo, pokud bylo zapnuto. Vstupní přepis zvuku není nativní pro model, protože model využívá zvuk přímo. Přepis běží asynchronně prostřednictvím šeptače a měl by se považovat za hrubé pokyny, nikoli jako reprezentaci, které model rozumí.	Ne
└model	řetězec	Model, který se má použít pro přepis, whisper-1 je jediným aktuálně podporovaným modelem.	Ne
pokyny	řetězec	Výchozí systémové instrukce (tj. systémová zpráva) připojené k vyžádání modelu. Toto pole umožňuje klientovi řídit model na požadovaných odpovědích. Model lze instruovat o obsahu a formátu odpovědi (např. "buďte velmi stručné", "jednat přívětivé", "tady jsou příklady dobrých odpovědí") a o chování zvuku (např. "rychle mluvit", "injektáž emocí do hlasu", "smích často"). Není zaručeno, že model bude pokyny dodržovat, ale poskytují modelu vedení ohledně požadovaného chování. Všimněte si, že server nastaví výchozí pokyny, které se použijí, pokud toto pole není nastavené a jsou viditelné v session.created události na začátku relace.	Ne
maximální počet tokenů výstupní odpovědi	celé číslo nebo řetězec	Maximální početvýstupních Zadejte celé číslo mezi 1 a 4096, abyste omezili výstupní tokeny nebo inf maximální dostupné tokeny pro daný model. Výchozí hodnota infje .	Ne
modality		Sada způsobů, kterými může model reagovat. Pokud chcete zvuk zakázat, nastavte ho na ["text"].	Ne
formát_výstupního_zvuku	řetězec	Formát výstupního zvuku. Možnosti jsou pcm16, g711_ulawnebo g711_alaw.	Ne
Teplota	Číslo	Vzorkovací teplota pro model omezená na [0.6, 1.2]. Výchozí hodnota je 0,8.	Ne
výběr nástroje	řetězec	Jak model vybírá nástroje. Možnosti jsou auto, none, requirednebo zadat funkci.	Ne
nářadí	pole	Nástroje (funkce) dostupné pro model	Ne
detekce otočení	objekt	Konfigurace pro detekci otáčení Nastavte na null, abyste vypnuli. Server VAD znamená, že model rozpozná začátek a konec řeči na základě hlasitosti zvuku a odpoví na konci řeči uživatele.	Ne
└- prefix_padding_ms	celočíselný	Množství zvuku, které se má zahrnout před detekovanou řečí VAD (v milisekundách). Výchozí hodnota je 300 ms.	Ne
└─ trvání_ticha_ms	celočíselný	Doba ticha pro detekci zastavení řeči (v milisekundách). Výchozí hodnota je 500 ms. S kratšími hodnotami bude model reagovat rychleji, ale může zasahovat během krátkých přestávek uživatele.	Ne
└- prahová hodnota	Číslo	Prahová hodnota aktivace pro VAD (0,0 až 1,0), výchozí hodnota je 0,5. Vyšší prahová hodnota bude vyžadovat hlasitější zvuk k aktivaci modelu, a proto může fungovat lépe v hlučných prostředích.	Ne
└- typ	řetězec	Aktuálně je podporován pouze typ detekce otáčení server_vad.	Ne
hlas	VoiceIdsShared		Ne

Žádost o vytvoření relace pro živou transkripci

Konfigurace objektu relace přepisu v reálném čase

Název	Typ	Popis	Požaduje se	Výchozí
zahrnovat	pole	Sada položek, které se mají zahrnout do přepisu. Aktuální dostupné položky jsou: - item.input_audio_transcription.logprobs	Ne
vstupní_formát_audio	výčet	Formát vstupního zvuku. Možnosti jsou pcm16, g711_ulawnebo g711_alaw. Pro pcm16, vstupní zvuk musí být 16bitový PCM při vzorkovací frekvenci 24kHz, jeden kanál (mono) a minimální-endian bajt pořadí. Možné hodnoty: pcm16, g711_ulaw, g711_alaw	Ne
vstupní redukce šumu zvuku	objekt	Konfigurace pro snížení hluku vstupu zvuku. Nastavte na null pro vypnutí. Filtry redukce šumu jsou přidány do zvukového vstupního vyrovnávacího paměťového bloku před odesláním do VAD a modelu. Filtrování zvuku může zlepšit přesnost detekce vad a otáčení (snížení falešně pozitivních výsledků) a výkon modelu zlepšením vnímání vstupního zvuku.	Ne
└- typ	výčet	Typ snížení šumu. near_field je určená pro mikrofony s blízkým hovorem, jako jsou sluchátka, je určená pro mikrofony vzdáleného pole, far_field jako jsou mikrofony přenosného počítače nebo konferenční místnosti. Možné hodnoty: near_field, far_field	Ne
přepis zvukového vstupu	objekt	Konfigurace pro vstupní přepis zvuku Klient může volitelně nastavit jazyk a zobrazit výzvu k přepisu. Tyto pokyny nabízejí další pokyny ke službě přepisu.	Ne
└jazyk	řetězec	Jazyk vstupního zvuku. Poskytnutí jazyka zadávání vstupu ve formátu ISO-639-1 (např. en) zlepší přesnost a latenci.	Ne
└model	výčet	Model, který se má použít pro přepis, aktuální možnosti jsou gpt-4o-transcribe, gpt-4o-mini-transcribea whisper-1. Možné hodnoty: gpt-4o-transcribe, gpt-4o-mini-transcribe, whisper-1	Ne
└─ výzva	řetězec	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Pro whisper-1 je výzva seznamem klíčových slov. U gpt-4o-transcribe modelů je výzvou bezplatný textový řetězec, například "očekávat slova související s technologií".	Ne
modality		Sada způsobů, kterými může model reagovat. Pokud chcete zvuk zakázat, nastavte ho na ["text"].	Ne
detekce otočení	objekt	Konfigurace pro detekci otáčení, ether Server VAD nebo sémantický VAD. Toto lze nastavit na null, aby se vypnulo, v takovém případě musí klient ručně vyvolat odpověď modelu. Server VAD znamená, že model rozpozná začátek a konec řeči na základě hlasitosti zvuku a odpoví na konci řeči uživatele. Sémantický VAD je pokročilejší a používá model detekce řečnických přestávek (ve spojení s VAD) pro sémantický odhad, zda uživatel dokončil mluvení, a pak dynamicky nastaví časový limit na základě této pravděpodobnosti. Pokud například uživatelův zvuk se ztratí s uhhm, model bude mít nízkou pravděpodobnost ukončení obratu a počká déle, než uživatel bude pokračovat v mluvení. To může být užitečné pro přirozenější konverzace, ale může mít vyšší latenci.	Ne
└create_response	Boolean	Jestli se má automaticky generovat odpověď, když dojde k události zastavení VAD. Není k dispozici pro přepisovací relace.	Ne	Pravdivé
└- dychtivost	výčet	Používá se jenom pro semantic_vad režim. Dychtivost modelu reagovat low bude čekat déle, než uživatel bude pokračovat v mluvení, high bude reagovat rychleji. autoje výchozí hodnota a je ekvivalentní .medium Možné hodnoty: low, medium, high, auto	Ne
└interrupt_response	Boolean	Bez ohledu na to, jestli se má automaticky přerušit jakákoli probíhající odpověď s výstupem výchozí konverzace (tj. conversation z auto) při výskytu počáteční události VAD. Není k dispozici pro přepisovací relace.	Ne	Pravdivé
└- prefix_padding_ms	celočíselný	Používá se jenom pro server_vad režim. Množství zvuku, které se má zahrnout před detekovanou řečí VAD (v milisekundách). Výchozí hodnota je 300 ms.	Ne
└─ trvání_ticha_ms	celočíselný	Používá se jenom pro server_vad režim. Doba ticha pro detekci zastavení řeči (v milisekundách). Výchozí hodnota je 500 ms. S kratšími hodnotami bude model reagovat rychleji, ale může zasahovat během krátkých přestávek uživatele.	Ne
└- prahová hodnota	Číslo	Používá se jenom pro server_vad režim. Prahová hodnota aktivace pro VAD (0,0 až 1,0), výchozí hodnota je 0,5. Vyšší prahová hodnota bude vyžadovat hlasitější zvuk k aktivaci modelu, a proto může fungovat lépe v hlučných prostředích.	Ne
└- typ	výčet	Typ detekce otáčení Možné hodnoty: server_vad, semantic_vad	Ne

RealtimeTranscriptionSessionCreateResponse

Nová konfigurace relace přepisování v reálném čase.

Při vytvoření relace na serveru prostřednictvím rozhraní REST API obsahuje objekt relace také dočasný klíč. Výchozí hodnota TTL pro klíče je jedna minuta. Tato vlastnost není k dispozici, pokud je relace aktualizována prostřednictvím rozhraní WebSocket API.

Název	Typ	Popis	Požaduje se	Výchozí
tajný klíč klienta	objekt	Dočasný klíč vrácený rozhraním API K dispozici pouze v době, kdy se relace vytvoří na serveru prostřednictvím rozhraní REST API.	Ano
└- vyprší_dne	celočíselný	Časové razítko pro vypršení platnosti tokenu V současné době vyprší platnost všech tokenů po jedné minutě.	Ne
└– hodnota	řetězec	Dočasný klíč použitelný v klientských prostředích k ověřování připojení k rozhraní API v reálném čase. Použijte ho v prostředích na straně klienta místo standardního tokenu rozhraní API, který by se měl používat jenom na straně serveru.	Ne
vstupní_formát_audio	řetězec	Formát vstupního zvuku. Možnosti jsou pcm16, g711_ulawnebo g711_alaw.	Ne
přepis zvukového vstupu	objekt	Konfigurace modelu přepisu	Ne
└jazyk	řetězec	Jazyk vstupního zvuku. Poskytnutí jazyka zadávání vstupu ve formátu ISO-639-1 (např. en) zlepší přesnost a latenci.	Ne
└model	výčet	Model, který se má použít k přepisu. Může být gpt-4o-transcribe, gpt-4o-mini-transcribenebo whisper-1. Možné hodnoty: gpt-4o-transcribe, gpt-4o-mini-transcribe, whisper-1	Ne
└─ výzva	řetězec	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla odpovídat jazyku zvuku.	Ne
modality		Sada způsobů, kterými může model reagovat. Pokud chcete zvuk zakázat, nastavte ho na ["text"].	Ne
detekce otočení	objekt	Konfigurace pro detekci otáčení Nastavte na null, abyste vypnuli. Server VAD znamená, že model rozpozná začátek a konec řeči na základě hlasitosti zvuku a odpoví na konci řeči uživatele.	Ne
└- prefix_padding_ms	celočíselný	Množství zvuku, které se má zahrnout před detekovanou řečí VAD (v milisekundách). Výchozí hodnota je 300 ms.	Ne
└─ trvání_ticha_ms	celočíselný	Doba ticha pro detekci zastavení řeči (v milisekundách). Výchozí hodnota je 500 ms. S kratšími hodnotami bude model reagovat rychleji, ale může zasahovat během krátkých přestávek uživatele.	Ne
└- prahová hodnota	Číslo	Prahová hodnota aktivace pro VAD (0,0 až 1,0), výchozí hodnota je 0,5. Vyšší prahová hodnota bude vyžadovat hlasitější zvuk k aktivaci modelu, a proto může fungovat lépe v hlučných prostředích.	Ne
└- typ	řetězec	Aktuálně je podporován pouze typ detekce otáčení server_vad.	Ne

Uvažování

Modely řady o-series pouze

Možnosti konfigurace pro zdůvodnění modelů

Název	Typ	Popis	Požaduje se	Výchozí
úsilí	Úsilí při zdůvodňování	Modely řady o-series pouze Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty jsou low, mediuma high. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi.	Ano	Středně
Souhrn	výčet	Modely řady o-series pouze Souhrn důvodů provedených modelem To může být užitečné pro ladění a pochopení procesu odůvodnění modelu. Jeden z concise nebo detailed. Možné hodnoty: concise, detailed	Ne

Položka uvažování

Popis řetězce myšlenky používaného modelem odůvodnění při generování odpovědi.

Název	Typ	Popis	Požaduje se	Výchozí
obsah	pole	Zdůvodnění obsahu textu	Ano
ID	řetězec	Jedinečný identifikátor obsahu odůvodnění.	Ano
stav	výčet	Stav položky. Jeden z in_progress, completednebo incomplete. Naplněno při vrácení položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ne
typ	výčet	Typ objektu. Vždy hodnota reasoning. Možné hodnoty: reasoning	Ano

Odmítnutí

Odmítnutí modelu.

Název	Typ	Popis	Požaduje se	Výchozí
odmítnutí	řetězec	Vysvětlení zamítnutí od modelu.	Ano
typ	výčet	Typ odmítnutí. Vždy hodnota refusal. Možné hodnoty: refusal	Ano

odpověď

Název	Typ	Popis	Požaduje se	Výchozí
datum_vytvoření	Číslo	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ano
chyba	ResponseError	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ano
ID	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ano
neúplné_detaily	objekt	Podrobnosti o tom, proč je odpověď neúplná.	Ano
└důvod	výčet	Důvod, proč je odpověď neúplná. Možné hodnoty: max_output_tokens, content_filter	Ne
pokyny	řetězec	Vloží zprávu systému (nebo vývojáře) jako první položku v kontextu modelu. Při použití společně previous_response_idse pokyny z předchozí odpovědi nepřenesou do další odpovědi. Díky tomu je snadné prohodit systémové zprávy (nebo zprávy vývojářů) v nových odpovědích.	Ano
maximální počet výstupních tokenů (max_output_tokens)	celočíselný	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a stavu konverzace.	Ne
metadatové informace	Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ano
model	řetězec	Model použitý k vygenerování odpovědí	Ano
objekt	výčet	Typ objektu tohoto prostředku – vždy nastaven na response. Možné hodnoty: response	Ano
výstup	pole	Pole položek obsahu vygenerovaných modelem – Délka a pořadí položek v output poli závisí na odpovědi modelu. - Místo přístupu k první položce v poli output a předpokladu, že se jedná o assistant zprávu s obsahem vygenerovaným modelem, můžete zvážit použití vlastnosti output_text, kde je to podporováno v sadách SDK.	Ano
output_text	řetězec	Vlastnost určená pouze pro SDK, která obsahuje souhrnný textový výstup ze všech položek output_text v poli output, pokud jsou přítomny. Podporováno v SDK pro Python a JavaScript.	Ne
paralelní volání nástrojů	Boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ano	Pravdivé
identifikátor_předchozí_odpovědi	řetězec	Jedinečné ID předchozí odpovědi na model. Pomocí této možnosti můžete vytvářet konverzace s více interakcemi.	Ne
usuzování	Usuzování	Modely řady o-series pouze Možnosti konfigurace pro zdůvodnění modelů	Ne
stav	výčet	Stav generování odpovědi. Jeden z completed, failed, in_progressnebo incomplete. Možné hodnoty: completed, failed, in_progress, incomplete	Ne
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í.	Ano	0
Text	objekt	Možnosti konfigurace textové odpovědi z modelu Může to být prostý text nebo strukturovaná data JSON. Další informace: - textové vstupy a výstupy - Strukturované výstupy	Ne
└─ Formát	TextResponseFormatConfiguration	Objekt určující formát, který musí model vypíše. Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat zadanému schématu JSON. Výchozí formát je { "type": "text" } bez dalších možností. Nedoporučuje se pro gpt-4o a novější modely: Nastavení { "type": "json_object" } umožní původní režim JSON, což zajišťuje, že zpráva vygenerovaná modelem je platný JSON. Použití json_schema je upřednostňované pro modely, které ho podporují.	Ne
výběr nástroje	ToolChoiceOptions nebo ToolChoiceTypes nebo ToolChoiceFunction	Způsob, jakým má model vybrat nástroj (nebo nástroje), který se má použít při generování odpovědi V parametru tools se dozvíte, jak určit nástroje, které model může volat.	Ano
nářadí	pole	Pole nástrojů, které může model volat při generování odpovědi. Pomocí nastavení parametru tool_choice můžete určit, který nástroj chcete použít. Existují dvě kategorie nástrojů, které můžete poskytnout modelu: - Integrované nástroje	Ano
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í.	Ano	0
zkrácení	výčet	Strategie zkrácení, která se má použít pro odpověď modelu. - auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu, model zkrátí odpověď tak, aby se vešel do kontextového okna tak, že vyřazuje vstupní položky uprostřed konverzace. - disabled (výchozí): Pokud odpověď modelu překročí velikost kontextového okna modelu, požadavek selže s chybou 400. Možné hodnoty: auto, disabled	Ne
využití	ResponseUsage	Představuje podrobnosti o využití tokenů, včetně vstupních tokenů, výstupních tokenů, rozpisu výstupních tokenů a celkových použitých tokenů.	Ne
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct OpenAI monitorovat a zjišťovat zneužití. .	Ne

ResponseAudioDeltaEvent

Vygenerováno, pokud je k dispozici částečná zvuková odpověď.

Název	Typ	Popis	Požaduje se	Výchozí
Delta	řetězec	Blok odeslaných zvukových bajtů zakódovaných pomocí Base64.	Ano
typ	výčet	Typ události. Vždy hodnota response.audio.delta. Možné hodnoty: response.audio.delta	Ano

UdálostDokončeníZvukovéOdpovědi

Po dokončení zvukové odpovědi dojde k vysílání.

Název	Typ	Popis	Požaduje se	Výchozí
typ	výčet	Typ události. Vždy hodnota response.audio.done. Možné hodnoty: response.audio.done	Ano

ResponseAudioTranscriptDeltaEvent

Vygenerováno, pokud je k dispozici částečný přepis zvuku.

Název	Typ	Popis	Požaduje se	Výchozí
Delta	řetězec	Částečný přepis zvukové odpovědi.	Ano
typ	výčet	Typ události. Vždy hodnota response.audio.transcript.delta. Možné hodnoty: response.audio.transcript.delta	Ano

UdálostDokončeníPřepisuZvuku

Emitování nastane po dokončení úplného přepisu zvuku.

Název	Typ	Popis	Požaduje se	Výchozí
typ	výčet	Typ události. Vždy hodnota response.audio.transcript.done. Možné hodnoty: response.audio.transcript.done	Ano

InterpretátorOdezvovéhoKóduVolacíhoKóduDeltaUdálosti

Vygeneruje se při přidání částečného fragmentu kódu interpretem kódu.

Název	Typ	Popis	Požaduje se	Výchozí
Delta	řetězec	Částečný fragment kódu přidaný interpretem kódu.	Ano
výstupní_index	celočíselný	Index výstupní položky, u níž právě probíhá volání interpreta kódu.	Ano
typ	výčet	Typ události. Vždy hodnota response.code_interpreter_call.code.delta. Možné hodnoty: response.code_interpreter_call.code.delta	Ano

ResponseCodeInterpreterCallCodeDoneEvent

Emitováno, když je výstup fragmentu kódu finalizován interpretem kódu.

Název	Typ	Popis	Požaduje se	Výchozí
kód	řetězec	Výstup konečného fragmentu kódu interpretem kódu.	Ano
výstupní_index	celočíselný	Index výstupní položky, u níž právě probíhá volání interpreta kódu.	Ano
typ	výčet	Typ události. Vždy hodnota response.code_interpreter_call.code.done. Možné hodnoty: response.code_interpreter_call.code.done	Ano

ResponseCodeInterpreterCallCompletedEvent

Po dokončení volání interpreta kódu se vysílá.

Název	Typ	Popis	Požaduje se	Výchozí
volání interpreteru kódu	CodeInterpreterToolCall	Volání nástroje ke spuštění kódu	Ano
výstupní_index	celočíselný	Index výstupní položky, u níž právě probíhá volání interpreta kódu.	Ano
typ	výčet	Typ události. Vždy hodnota response.code_interpreter_call.completed. Možné hodnoty: response.code_interpreter_call.completed	Ano

ResponseCodeInterpreterCallInProgressEvent

Vygenerováno, když probíhá volání interpreta kódu.

Název	Typ	Popis	Požaduje se	Výchozí
volání interpreteru kódu	CodeInterpreterToolCall	Volání nástroje ke spuštění kódu	Ano
výstupní_index	celočíselný	Index výstupní položky, u níž právě probíhá volání interpreta kódu.	Ano
typ	výčet	Typ události. Vždy hodnota response.code_interpreter_call.in_progress. Možné hodnoty: response.code_interpreter_call.in_progress	Ano

KódOdpovědiInterpretVoláníInterpretaceUdálost

Vygeneruje se, když interpret kódu aktivně interpretuje fragment kódu.

Název	Typ	Popis	Požaduje se	Výchozí
volání interpreteru kódu	CodeInterpreterToolCall	Volání nástroje ke spuštění kódu	Ano
výstupní_index	celočíselný	Index výstupní položky, u níž právě probíhá volání interpreta kódu.	Ano
typ	výčet	Typ události. Vždy hodnota response.code_interpreter_call.interpreting. Možné hodnoty: response.code_interpreter_call.interpreting	Ano

UdálostDokončeníOdpovědi

Po dokončení odpovědi modelu se aktivuje.

Název	Typ	Popis	Požaduje se	Výchozí
odpověď	odpověď		Ano
typ	výčet	Typ události. Vždy hodnota response.completed. Možné hodnoty: response.completed	Ano

UdálostPřidáníČástiObsahuReakce

Vygeneruje se při přidání nové části obsahu.

Název	Typ	Popis	Požaduje se	Výchozí
index obsahu	celočíselný	Index přidané části obsahu.	Ano
ID položky	řetězec	ID výstupní položky, do které byla část obsahu přidána.	Ano
výstupní_index	celočíselný	Index výstupní položky, do které byla část obsahu přidána.	Ano
část	OutputContent		Ano
typ	výčet	Typ události. Vždy hodnota response.content_part.added. Možné hodnoty: response.content_part.added	Ano

UdálostDokončeníObsahuOdpovědi

Vydává se, když je část obsahu hotová.

Název	Typ	Popis	Požaduje se	Výchozí
index obsahu	celočíselný	Index části obsahu, která je dokončena.	Ano
ID položky	řetězec	ID výstupní položky, do které byla část obsahu přidána.	Ano
výstupní_index	celočíselný	Index výstupní položky, do které byla část obsahu přidána.	Ano
část	OutputContent		Ano
typ	výčet	Typ události. Vždy hodnota response.content_part.done. Možné hodnoty: response.content_part.done	Ano

UdálostVytvořeníOdpovědi

Událost, která se vygeneruje při vytvoření odpovědi.

Název	Typ	Popis	Požaduje se	Výchozí
odpověď	odpověď		Ano
typ	výčet	Typ události. Vždy hodnota response.created. Možné hodnoty: response.created	Ano

Chyba odpovědi

Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.

Název	Typ	Popis	Požaduje se	Výchozí
kód	ResponseErrorCode	Kód chyby pro odpověď.	Ano
zpráva	řetězec	Popis chyby čitelný člověkem.	Ano

Kód chyby odpovědi

Kód chyby pro odpověď.

Vlastnictví	Hodnota
Popis	Kód chyby pro odpověď.
Typ	řetězec
Hodnoty	server_error rate_limit_exceeded invalid_prompt vector_store_timeout invalid_image invalid_image_format invalid_base64_image invalid_image_url image_too_large image_too_small image_parse_error image_content_policy_violation invalid_image_mode image_file_too_large unsupported_image_media_type empty_image_file failed_to_download_image image_file_not_found

ResponseErrorEvent

Vygenerováno, když dojde k chybě.

Název	Typ	Popis	Požaduje se	Výchozí
kód	řetězec	Kód chyby.	Ano
zpráva	řetězec	Chybová zpráva.	Ano
Param	řetězec	Parametr chyby.	Ano
typ	výčet	Typ události. Vždy hodnota error. Možné hodnoty: error	Ano

UdálostSelháníOdpovědi

Událost, která se vygeneruje v případě selhání odpovědi.

Název	Typ	Popis	Požaduje se	Výchozí
odpověď	odpověď		Ano
typ	výčet	Typ události. Vždy hodnota response.failed. Možné hodnoty: response.failed	Ano

UdálostDokončenaVoláníVyhledáváníVResponseFile

Vygenerováno při dokončení volání hledání souborů (nalezeny výsledky).

Název	Typ	Popis	Požaduje se	Výchozí
ID položky	řetězec	ID výstupní položky, kterou je inicializováno volání hledání souborů.	Ano
výstupní_index	celočíselný	Index výstupní položky, kterou je inicializováno volání hledání souborů.	Ano
typ	výčet	Typ události. Vždy hodnota response.file_search_call.completed. Možné hodnoty: response.file_search_call.completed	Ano

ResponseFileSearchCallInProgressEvent

Vygenerováno při zahájení volání hledání souboru.

Název	Typ	Popis	Požaduje se	Výchozí
ID položky	řetězec	ID výstupní položky, kterou je inicializováno volání hledání souborů.	Ano
výstupní_index	celočíselný	Index výstupní položky, kterou je inicializováno volání hledání souborů.	Ano
typ	výčet	Typ události. Vždy hodnota response.file_search_call.in_progress. Možné hodnoty: response.file_search_call.in_progress	Ano

Událost vyhledávání v souboru odezvy

Vygenerováno při hledání souborů, které právě hledáte.

Název	Typ	Popis	Požaduje se	Výchozí
ID položky	řetězec	ID výstupní položky, kterou je inicializováno volání hledání souborů.	Ano
výstupní_index	celočíselný	Index výstupní položky, kterou hledá volání hledání souboru.	Ano
typ	výčet	Typ události. Vždy hodnota response.file_search_call.searching. Možné hodnoty: response.file_search_call.searching	Ano

ResponseFunctionCallArgumentsDeltaEvent

Vygenerováno v případě, že existuje rozdíl argumentů částečného volání funkce.

Název	Typ	Popis	Požaduje se	Výchozí
Delta	řetězec	Argumenty volání funkce delta, které se přidají.	Ano
ID položky	řetězec	ID konkrétní výstupní položky, ke které se přičítá delta argumentů volání funkce.	Ano
výstupní_index	celočíselný	Index výstupní položky, ke které je přidána delta argumentů volání funkce.	Ano
typ	výčet	Typ události. Vždy hodnota response.function_call_arguments.delta. Možné hodnoty: response.function_call_arguments.delta	Ano

UdálostDokončeníArgumentůVoláníFunkceOdpovědi

Vygenerováno, když jsou argumenty volání funkce finalizovány.

Název	Typ	Popis	Požaduje se	Výchozí
argumenty	řetězec	Argumenty volání funkce.	Ano
ID položky	řetězec	ID položky.	Ano
výstupní_index	celočíselný	Index výstupní položky.	Ano
typ	výčet	Možné hodnoty: response.function_call_arguments.done	Ano

ResponseInProgressEvent

Vygenerováno, když probíhá odpověď.

Název	Typ	Popis	Požaduje se	Výchozí
odpověď	odpověď		Ano
typ	výčet	Typ události. Vždy hodnota response.in_progress. Možné hodnoty: response.in_progress	Ano

UdálostNeúplnéOdpovědi (ResponseIncompleteEvent)

Událost, která se vygeneruje, když se odpověď dokončí jako neúplná.

Název	Typ	Popis	Požaduje se	Výchozí
odpověď	odpověď		Ano
typ	výčet	Typ události. Vždy hodnota response.incomplete. Možné hodnoty: response.incomplete	Ano

seznamPoložekOdpovědí

Seznam položek odpovědi.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	pole	Seznam položek použitých k vygenerování této odpovědi	Ano
first_id	řetězec	ID první položky v seznamu.	Ano
má více	Boolean	Jestli je k dispozici více položek.	Ano
last_id	řetězec	ID poslední položky v seznamu.	Ano
objekt	výčet	Typ vráceného objektu musí být list. Možné hodnoty: list	Ano

Reakční modality

Výstupní typy, které chcete, aby model vygeneroval. Většina modelů dokáže generovat text, což je výchozí nastavení:

["text"]

Model gpt-4o-audio-preview lze také použít k vygenerování zvuku. Pokud chcete požádat, aby tento model generoval textové i zvukové odpovědi, můžete použít:

["text", "audio"]

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

RežimyOdpovědiPouzeText

Výstupní typy, které chcete, aby model vygeneroval. Většina modelů dokáže generovat text, což je výchozí nastavení:

["text"]

Toto rozhraní API brzy bude podporovat další výstupní způsoby, včetně zvuku a obrázků.

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

UdálostPoložkyVýstupuPřidányOdpovědi

Dojde k emisi, když je přidána nová výstupní položka.

Název	Typ	Popis	Požaduje se	Výchozí
položka	OutputItem		Ano
výstupní_index	celočíselný	Index přidané výstupní položky.	Ano
typ	výčet	Typ události. Vždy hodnota response.output_item.added. Možné hodnoty: response.output_item.added	Ano

UdálostHotovéhoVýstupuOdpovědi

Vygenerováno, když je výstupní položka označena jako dokončená.

Název	Typ	Popis	Požaduje se	Výchozí
položka	OutputItem		Ano
výstupní_index	celočíselný	Index výstupní položky, která byla označena jako dokončená.	Ano
typ	výčet	Typ události. Vždy hodnota response.output_item.done. Možné hodnoty: response.output_item.done	Ano

VlastnostiOdezvy

Název	Typ	Popis	Požaduje se	Výchozí
pokyny	řetězec	Vloží zprávu systému (nebo vývojáře) jako první položku v kontextu modelu. Při použití společně previous_response_idse pokyny z předchozí odpovědi nepřenesou do další odpovědi. Díky tomu je snadné prohodit systémové zprávy (nebo zprávy vývojářů) v nových odpovědích.	Ne
maximální počet výstupních tokenů (max_output_tokens)	celočíselný	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a stavu konverzace.	Ne
identifikátor_předchozí_odpovědi	řetězec	Jedinečné ID předchozí odpovědi na model. Pomocí této možnosti můžete vytvářet konverzace s více interakcemi.	Ne
usuzování	Usuzování	Modely řady o-series pouze Možnosti konfigurace pro zdůvodnění modelů	Ne
Text	objekt	Možnosti konfigurace textové odpovědi z modelu Může to být prostý text nebo strukturovaná data JSON. Další informace: - textové vstupy a výstupy - Strukturované výstupy	Ne
└─ Formát	TextResponseFormatConfiguration	Objekt určující formát, který musí model vypíše. Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat zadanému schématu JSON. Výchozí formát je { "type": "text" } bez dalších možností. Nedoporučuje se pro gpt-4o a novější modely: Nastavení { "type": "json_object" } umožní původní režim JSON, což zajišťuje, že zpráva vygenerovaná modelem je platný JSON. Použití json_schema je upřednostňované pro modely, které ho podporují.	Ne
výběr nástroje	ToolChoiceOptions nebo ToolChoiceTypes nebo ToolChoiceFunction	Způsob, jakým má model vybrat nástroj (nebo nástroje), který se má použít při generování odpovědi V parametru tools se dozvíte, jak určit nástroje, které model může volat.	Ne
nářadí	pole	Pole nástrojů, které může model volat při generování odpovědi. Pomocí nastavení parametru tool_choice můžete určit, který nástroj chcete použít. Existují dvě kategorie nástrojů, které můžete poskytnout modelu: - Integrované nástroje	Ne
zkrácení	výčet	Strategie zkrácení, která se má použít pro odpověď modelu. - auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu, model zkrátí odpověď tak, aby se vešel do kontextového okna tak, že vyřazuje vstupní položky uprostřed konverzace. - disabled (výchozí): Pokud odpověď modelu překročí velikost kontextového okna modelu, požadavek selže s chybou 400. Možné hodnoty: auto, disabled	Ne

OdmítnutíOdpovědiDeltaUdálost

Vygenerováno v případě částečného odmítnutí textu.

Název	Typ	Popis	Požaduje se	Výchozí
index obsahu	celočíselný	Index části obsahu, do které se přidává text odmítnutí.	Ano
Delta	řetězec	Text o odmítnutí, který je přidán.	Ano
ID položky	řetězec	ID výstupní položky, do které je přidán text odmítnutí.	Ano
výstupní_index	celočíselný	Index výstupní položky, do které je přidán text zamítnutí.	Ano
typ	výčet	Typ události. Vždy hodnota response.refusal.delta. Možné hodnoty: response.refusal.delta	Ano

UdálostDokončenéhoOdmitnutíOdpovědi

Emitováno, když je dokončen text odmítnutí.

Název	Typ	Popis	Požaduje se	Výchozí
index obsahu	celočíselný	Index části obsahu, ve které je text odmítnutí finalizován.	Ano
ID položky	řetězec	ID výstupní položky, kterou je zamítnutý text finalizován.	Ano
výstupní_index	celočíselný	Index výstupní položky, kdy je zamítnutý text finalizován.	Ano
odmítnutí	řetězec	Text odmítnutí, který je finalizován.	Ano
typ	výčet	Typ události. Vždy hodnota response.refusal.done. Možné hodnoty: response.refusal.done	Ano

responseStreamEvent

Název	Typ	Popis	Požaduje se	Výchozí
anotace	poznámky		Ano
index anotací	celočíselný	Index přidané poznámky.	Ano
argumenty	řetězec	Argumenty volání funkce.	Ano
kód	řetězec	Kód chyby.	Ano
volání interpreteru kódu	CodeInterpreterToolCall	Volání nástroje ke spuštění kódu	Ano
index obsahu	celočíselný	Index té části obsahu, ve které je textový obsah finalizován.	Ano
Delta	řetězec	Text delta, který byl přidán.	Ano
položka	OutputItem	Výstupní položka, která byla označena jako hotová.	Ano
ID položky	řetězec	ID výstupní položky, kterou je textový obsah finalizován.	Ano
zpráva	řetězec	Chybová zpráva.	Ano
výstupní_index	celočíselný	Index výstupní položky, který finalizuje textový obsah.	Ano
Param	řetězec	Parametr chyby.	Ano
část	OutputContent	Část obsahu, která je hotová.	Ano
odmítnutí	řetězec	Text odmítnutí, který je finalizován.	Ano
odpověď	odpověď	Odpověď, která byla neúplná.	Ano
Text	řetězec	Textový obsah, který je finalizován.	Ano
typ	výčet	Typ události. Vždy hodnota response.output_text.done. Možné hodnoty: response.output_text.done	Ano

ResponseTextAnnotationDeltaEvent

Při přidání textové poznámky se vygeneruje.

Název	Typ	Popis	Požaduje se	Výchozí
anotace	poznámky		Ano
index anotací	celočíselný	Index přidané poznámky.	Ano
index obsahu	celočíselný	Index části obsahu, do které byla přidána textová poznámka.	Ano
ID položky	řetězec	ID výstupní položky, do které byla přidána textová poznámka.	Ano
výstupní_index	celočíselný	Index výstupní položky, do které byla přidána textová poznámka.	Ano
typ	výčet	Typ události. Vždy hodnota response.output_text.annotation.added. Možné hodnoty: response.output_text.annotation.added	Ano

ResponseTextDeltaEvent

Emitováno, když je k dispozici dodatečný textový delta.

Název	Typ	Popis	Požaduje se	Výchozí
index obsahu	celočíselný	Index části obsahu, do které byla přidána textová delta.	Ano
Delta	řetězec	Text delta, který byl přidán.	Ano
ID položky	řetězec	ID výstupní položky, ke které byla přidána textová delta.	Ano
výstupní_index	celočíselný	Index výstupní položky, do které byl přidán rozdíl textu.	Ano
typ	výčet	Typ události. Vždy hodnota response.output_text.delta. Možné hodnoty: response.output_text.delta	Ano

UdálostDokončeníTextovéOdpovědi

Vygenerováno při finalizaci textového obsahu.

Název	Typ	Popis	Požaduje se	Výchozí
index obsahu	celočíselný	Index té části obsahu, ve které je textový obsah finalizován.	Ano
ID položky	řetězec	ID výstupní položky, kterou je textový obsah finalizován.	Ano
výstupní_index	celočíselný	Index výstupní položky, který finalizuje textový obsah.	Ano
Text	řetězec	Textový obsah, který je finalizován.	Ano
typ	výčet	Typ události. Vždy hodnota response.output_text.done. Možné hodnoty: response.output_text.done	Ano

VyužitíOdezvy

Představuje podrobnosti o využití tokenů, včetně vstupních tokenů, výstupních tokenů, rozpisu výstupních tokenů a celkových použitých tokenů.

Název	Typ	Popis	Požaduje se	Výchozí
vstupní_tokeny	celočíselný	Počet vstupních tokenů.	Ano
výstupní_tokeny	celočíselný	Počet výstupních tokenů	Ano
podrobnosti_výstupních_tokenů	objekt	Podrobný rozpis výstupních tokenů	Ano
└─ "reasoning_tokens"	celočíselný	Počet tokenů pro logické uvažování.	Ne
celkový počet tokenů	celočíselný	Celkový počet použitých tokenů	Ano

Snímek obrazovky

Akce snímku obrazovky

Název	Typ	Popis	Požaduje se	Výchozí
typ	výčet	Určuje typ události. U akce snímku obrazovky je tato vlastnost vždy nastavena na screenshot. Možné hodnoty: screenshot	Ano

Posunovat

Akce scrollování

Název	Typ	Popis	Požaduje se	Výchozí
scroll_x	celočíselný	Vodorovná vzdálenost posouvání.	Ano
scroll_y	celočíselný	Svislá posuvná vzdálenost.	Ano
typ	výčet	Určuje typ události. U akce posouvání je tato vlastnost vždy nastavena na scrollhodnotu . Možné hodnoty: scroll	Ano
x	celočíselný	Souřadnice x, kde došlo k posunu.	Ano
y	celočíselný	Souřadnice y, kde došlo ke scrollování.	Ano

ZastavitKonfiguraci

Až 4 sekvence, ve kterých rozhraní API přestane generovat další tokeny. Vrácený text nebude obsahovat sekvenci zastavení.

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

Konfigurace formátu odpovědi textu

Objekt určující formát, který musí model vypíše.

Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, které zajistí, aby model odpovídal zadanému schématu JSON.

Výchozí formát je { "type": "text" } bez dalších možností.

Nedoporučuje se pro gpt-4o a novější modely:

Nastavení { "type": "json_object" } umožní původní režim JSON, což zajišťuje, že zpráva vygenerovaná modelem je platný JSON. Použití json_schema je upřednostňované pro modely, které ho podporují.

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

• ResponseFormatText
• FormátTextovéOdpovědiJsonSchéma
• ResponseFormatJsonObject

TextResponseFormatJsonSchema

Formát odpovědi schématu JSON Slouží ke generování strukturovaných odpovědí JSON. Přečtěte si další informace o strukturovaných výstupech.

Název	Typ	Popis	Požaduje se	Výchozí
popis	řetězec	Popis formátu odpovědi, který model používá k určení způsobu reakce ve formátu.	Ne
jméno	řetězec	Název formátu odpovědi. Musí být a-z, A-Z, 0-9 nebo obsahovat podtržítka a pomlčky s maximální délkou 64.	Ne
schéma	FormátOdpovědiJsonSchemaSchema	Schéma pro formát odpovědi popsané jako objekt schématu JSON.	Ano
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.	Ne	Nepravda
typ	výčet	Typ formátu odpovědi, který se definuje. Vždy hodnota json_schema. Možné hodnoty: json_schema	Ano

Nástroj

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

• FileSearchTool
• FunctionTool
• ComputerTool

Funkce výběru nástroje

Tuto možnost použijte k vynucení volání konkrétní funkce modelu.

Název	Typ	Popis	Požaduje se	Výchozí
jméno	řetězec	Název funkce, která se má volat.	Ano
typ	výčet	Pro volání funkce je typ vždy function. Možné hodnoty: function	Ano

Možnosti výběru nástroje

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

Vlastnictví	Hodnota
Popis	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ů.
Typ	řetězec
Hodnoty	none auto required

TypyVolbyNástrojů

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj.

Název	Typ	Popis	Požaduje se	Výchozí
typ	výčet	Typ hostovaného nástroje, který by měl model použít. Povolené hodnoty jsou: - file_search - computer_use_preview Možné hodnoty: file_search, computer_use_preview	Ano

Typ

Akce pro zadávání textu.

Název	Typ	Popis	Požaduje se	Výchozí
Text	řetězec	Text, který chcete zadat.	Ano
typ	výčet	Určuje typ události. U akce typu je tato vlastnost vždy nastavena na typehodnotu . Možné hodnoty: type	Ano

PožadavekNaAktualizaciAtributůSouboruVectorStore

Název	Typ	Popis	Požaduje se	Výchozí
vlastnosti	VectorStoreFileAttributes	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků, pravdivostní hodnoty nebo čísla.	Ano

Citace URL

Citace webového prostředku použitého k vygenerování odpovědi modelu

Název	Typ	Popis	Požaduje se	Výchozí
koncový index	celočíselný	Index posledního znaku citace adresy URL ve zprávě.	Ano
start_index	celočíselný	Index prvního znaku citace adresy URL ve zprávě.	Ano
název	řetězec	Název webového prostředku.	Ano
typ	výčet	Typ citace adresy URL. Vždy hodnota url_citation. Možné hodnoty: url_citation	Ano
adresa URL	řetězec	Adresa URL webového prostředku.	Ano

VectorStoreFileAttributes

Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků, pravdivostní hodnoty nebo čísla.

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

OdpověďNaObsahSouboruVectorStore

Představuje analyzovaný obsah souboru vektorového úložiště.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	pole	Parsovaný obsah souboru	Ano
má více	Boolean	Označuje, zda je třeba načíst více stránek obsahu.	Ano
další_stránka	řetězec	Token pro další stránku, pokud existuje.	Ano
objekt	výčet	Typ objektu, který je vždy vector_store.file_content.page Možné hodnoty: vector_store.file_content.page	Ano

ŽádostOVyhledáváníVÚložištiVektorů

Název	Typ	Popis	Požaduje se	Výchozí
filtruje	ComparisonFilter nebo CompoundFilter	Filtr, který se použije na základě atributů souboru.	Ne
max_počet_výsledků	celočíselný	Maximální počet výsledků, které se mají vrátit. Toto číslo by mělo být mezi 1 a 50 včetně.	Ne	10
dotaz	řetězec nebo pole	Řetězec dotazu pro hledání	Ano
možnosti hodnocení	objekt	Možnosti řazení pro hledání	Ne
└- ranker	výčet	Možné hodnoty: auto, default-2024-11-15	Ne
└ score_threshold	Číslo		Ne	0
přepsat dotaz	Boolean	Zda se má dotaz v přirozeném jazyce přepsat pro vektorové vyhledávání.	Ne	Nepravda

VectorStoreVyhledávacíVýsledekObsahovýObjekt

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

VectorStoreSearchResultItem

Název	Typ	Popis	Požaduje se	Výchozí
vlastnosti	VectorStoreFileAttributes	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků, pravdivostní hodnoty nebo čísla.	Ano
obsah	pole	Bloky obsahu ze souboru.	Ano
ID souboru	řetězec	ID souboru úložiště vektorů.	Ano
jméno souboru	řetězec	Název souboru úložiště vektorů.	Ano
partitura	Číslo	Skóre podobnosti výsledku	Ano

Stránka výsledků vyhledávání ve VectorStore

Název	Typ	Popis	Požaduje se	Výchozí
údaje	pole	Seznam položek výsledků hledání	Ano
má více	Boolean	Označuje, zda existují další výsledky ke stažení.	Ano
další_stránka	řetězec	Token pro další stránku, pokud existuje.	Ano
objekt	výčet	Typ objektu, který je vždy vector_store.search_results.page Možné hodnoty: vector_store.search_results.page	Ano
vyhledávací dotaz	pole		Ano

VoiceIdsShared

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

Počkej

Akce čekání.

Název	Typ	Popis	Požaduje se	Výchozí
typ	výčet	Určuje typ události. U akce čekání je tato vlastnost vždy nastavena na waithodnotu . Možné hodnoty: wait	Ano

Úsilí na zdůvodnění

Modely řady o-series pouze

Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty jsou low, mediuma high. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi.

Vlastnictví	Hodnota
Popis	Modely řady o-series pouze Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty jsou low, mediuma high. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi.
Typ	řetězec
výchozí	Středně
Hodnoty	low medium high

událost chyby

Nastane, když dojde k chybě. K tomu může dojít kvůli vnitřní chybě serveru nebo vypršení časového limitu.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	chyba		Ano
událost	řetězec		Ano

event Enum: ErrorEventEnum

Hodnota	Popis
chyba

doneEvent

Nastane, když datový proud skončí.

Název	Typ	Popis	Požaduje se	Výchozí
údaje	řetězec		Ano
událost	řetězec		Ano

event Enum: DoneEventEnum

Hodnota	Popis
Hotovo

datový výčet: DoneEventDataEnum

Hodnota	Popis
[HOTOVO]

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.