Referenční dokumentace k rozhraní REST API pro Azure OpenAI v modelech Microsoft Foundry

Poznámka:

Tento dokument se týká portálu Microsoft Foundry (Classic).

🔍Informace o novém portálu najdete v dokumentaci k Microsoft Foundry (nové).

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:

• Úroveň řízení
• 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.

Important

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

API	Nejnovější verze Preview	Nejnovější verze GA	Specifications	Description
Řídicí rovina	2025-07-01-preview	2025-06-01	Soubory specifikace	Rozhraní API roviny řízení se používá pro operace, jako jsou vytváření prostředků, nasazení modelu a další úlohy správy prostředků vyšší úrovně. Řídicí rovina také řídí možnosti, jako je Azure Resource Manager, Bicep, Terraform a Azure CLI.
Datová rovina	v1 preview	v1	Soubory specifikace	Rozhraní API roviny dat řídí operace odvozování a vytváření.

Authentication

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
deployment-id	cesta	Yes	řetězec
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
best_of	integer	Vygeneruje best_of dokončení na straně serveru a vrátí "nejlepší" (ten s nejvyšší pravděpodobností protokolu na token). Výsledky se nedají streamovat. 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.	No	1
echo	boolean	Ozvěte výzvu kromě dokončení.	No	False
frequency_penalty	number	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.	No	0
logit_bias	objekt	Upravte pravděpodobnost výskytu zadaných tokenů v dokončení. Přijímá objekt JSON, který mapuje tokeny (určené jejich ID tokenu v tokenizátoru GPT) na přidruženou hodnotu předsudku od -100 do 100. Matematicky se před vzorkováním přidá do logitů vygenerovaných modelem. Přesný účinek se liší podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu. Můžete například předat {"50256": -100} , abyste zabránili generování tokenu <|endoftext|> .	No	None
logprobs	integer	Zahrňte pravděpodobnosti protokolu u nejpravděpodobnějších logprobs výstupních tokenů a vybraných tokenů. Pokud je například logprobs 5, vrátí rozhraní API seznam 5 nejpravděpodobnějších tokenů. Rozhraní API vždy vrátí logprob vzorkovaného tokenu, takže v odpovědi může být až logprobs+1 prvků. Maximální hodnota je logprobs 5.	No	None
max_tokens	integer	Maximální počet tokenů, které lze vygenerovat v dokončení. Počet tokenů výzvy plus max_tokens nesmí překročit délku kontextu modelu.	No	16
n	integer	Kolik dokončení se má vygenerovat pro každou výzvu. Poznámka: Protože tento parametr generuje mnoho dokončení, může rychle spotřebovat kvótu tokenu. Pečlivě používejte a ujistěte se, že máte přiměřené nastavení a max_tokensstop.	No	1
presence_penalty	number	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.	No	0
požádat	řetězec nebo pole	Výzva k vygenerování dokončení, 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 používá během trénování, takže pokud není zadán podnět, model generuje, jako by byl na začátku nového dokumentu.	Yes
seed	integer	Pokud je zadáno, náš systém se snaží vzorkovat deterministicky, takže opakované požadavky se stejnými seed parametry by měly vrátit stejný výsledek. Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.	No
stop	řetězec nebo pole	Až čtyři sekvence, ve kterých rozhraní API přestane generovat další tokeny. Vrácený text nebude obsahovat sekvenci zastavení.	No
datový proud	boolean	Zda se má streamovat zpět částečný průběh. Pokud je tato možnost nastavena, tokeny se posílají jako serverem odesílané události jakmile jsou dostupné, a datový proud se ukončí zprávou data: [DONE]. Příklad kódu Pythonu	No	False
suffix	ř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.	No	None
temperature	number	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, umožňují větší zaměření a determinismus. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	No	1
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	No	1
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í.	No

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	createCompletionResponse

Stavový kód: výchozí

Popis: Služba není k dispozici

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
deployment-id	cesta	Yes	řetězec	ID nasazení nasazeného modelu.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
dimensions	integer	Početdimenzích Podporováno pouze v text-embedding-3 novějších modelech.	No
encoding_format	řetězec	Formát pro vrácení vložených objektů. Může to být buď float nebo base64. Výchozí hodnota je float.	No
vstup	řetězec nebo pole	Vstupní text pro vložení, kódovaný jako řetězec nebo pole tokenů. Pokud chcete vložit více vstupů do jednoho požadavku, předejte pole řetězců nebo pole polí tokenů. Vstup nesmí překročit maximální počet vstupních tokenů modelu (8 192 tokenů pro text-embedding-ada-002), nesmí být prázdný řetězec a jakékoli pole musí mít maximálně 2 048 dimenzí nebo méně.	Yes
input_type	řetězec	vstupní typ vkládání hledání, které se má použít	No
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í.	No

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	objekt

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
deployment-id	cesta	Yes	řetězec
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
audio	objekt	Parametry zvukového výstupu Požadován při vyžádání zvukového výstupu s modalities: ["audio"].	No
└─ 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	No
└─ 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	No
data_sources	pole	Položky konfigurace pro rozšíření chatu Azure OpenAI, které je používají. Tato další specifikace je kompatibilní pouze s Azure OpenAI.	No
frequency_penalty	number	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.	No	0
function_call	string nebo chatCompletionFunctionCallOption	Zastaralá ve prospěch tool_choice. Určuje, která funkce (pokud existuje) volána modelem. none znamená, že model nebude volat funkci a místo toho vygeneruje zprávu. auto znamená, že model může vybrat mezi generováním zprávy nebo voláním funkce. Zadáním konkrétní funkce vynutíte {"name": "my_function"} , aby model volal danou funkci. none je výchozí, pokud nejsou k dispozici žádné funkce. auto je výchozí, pokud jsou k dispozici funkce.	No
functions	pole	Zastaralá ve prospěch tools. Seznam funkcí, pro které model může generovat vstupy JSON.	No
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 liší podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu.	No	None
logprobs	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.	No	False
max_completion_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro dokončení, včetně viditelných výstupních tokenů a zdůvodnění tokenů.	No
max_tokens	integer	Maximální počet tokenů, které lze vygenerovat v dokončení chatu. Celková délka vstupních tokenů a vygenerovaných tokenů je omezená délkou kontextu modelu.	No
messages	pole	Seznam zpráv, které tvoří dosud konverzaci. Příklad kódu Pythonu	Yes
metadata	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í	No
modalities	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"]	No
n	integer	Kolik možností dokončení chatu se má vygenerovat pro každou vstupní zprávu. Na základě počtu vygenerovaných tokenů ve všech možnostech se vám budou účtovat poplatky. Udržujte n si přehled o 1 minimalizaci nákladů.	No	1
parallel_tool_calls	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	No	True
predikce	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.	No
presence_penalty	number	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.	No	0
reasoning_effort	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	No
response_format	ResponseFormatText nebo ResponseFormatJsonObject nebo ResponseFormatJsonSchema	Objekt určující formát, který musí model vypíše. Kompatibilní s GPT-4o Nastavení { "type": "json_schema", "json_schema": {...} } povolí strukturované výstupy, které zaručují, že model se shoduje s vaším zadaným schématem 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.	No
seed	integer	Tato funkce je v beta verzi. Pokud je zadáno, náš systém se snaží vzorkovat deterministicky, takže opakované požadavky se stejnými seed parametry by měly vrátit stejný výsledek. Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.	No
stop	řetězec nebo pole	Až 4 sekvence, ve kterých rozhraní API přestane generovat další tokeny.	No
uložit	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.	No
datový proud	boolean	Pokud je tato možnost nastavena, odesílají se částečné změny zpráv, například v ChatGPT. Tokeny jsou odesílány jako události odesílané serverem pouze s daty, jakmile jsou k dispozici, a proud je ukončen zprávou data: [DONE]. Příklad kódu Pythonu	No	False
stream_options	chatCompletionStreamOptions	Možnosti pro odpověď streamování Toto nastavení nastavíte pouze při nastavení stream: true.	No	None
temperature	number	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, umožňují větší zaměření a determinismus. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	No	1
tool_choice	chatCompletionToolChoiceOption	Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádný nástroj a místo toho vygeneruje zprávu. auto znamená, že model si může vybrat mezi generováním zprávy nebo voláním jednoho nebo více nástrojů. required znamená, že model musí volat jeden nebo více nástrojů. Zadáním konkrétního nástroje vynutíte {"type": "function", "function": {"name": "my_function"}} model, aby tento nástroj volal. none je výchozí, pokud nejsou k dispozici žádné nástroje. auto je výchozí, pokud jsou k dispozici nástroje.	No
tools	pole	Seznam nástrojů, které model může volat. V současné době se jako nástroj podporují jenom funkce. Pomocí tohoto příkazu můžete poskytnout seznam funkcí, pro které může model generovat vstupy JSON. Podporuje se maximálně 128 funkcí.	No
top_logprobs	integer	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu. logprobs parametr musí být nastaven na true hodnotu, pokud je použit tento parametr.	No
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	No	1
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í.	No
user_security_context	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.	No

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	objekt

Stavový kód: výchozí

Popis: Služba není k dispozici

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

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

Example

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

Example

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

Example

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

Example

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

Example

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

Example

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

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
deployment-id	cesta	Yes	řetězec
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: multipart/form-data

Name	Typ	Description	Required	Default
soubor	řetězec	Objekt zvukového souboru, který se má přepisovat.	Yes
jazyk	řetězec	Jazyk vstupního zvuku. Poskytování jazyka zadávání vstupu ve formátu ISO-639-1 zlepšuje přesnost a latenci.	No
požádat	řetězec	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla odpovídat jazyku zvuku.	No
response_format	audioResponseFormat	Definuje formát výstupu.	No
temperature	number	Teplota vzorkování mezi 0 a 1. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Pokud je nastavená hodnota na 0, model používá logaritmickou pravděpodobnost k automatickému zvýšení teploty, dokud nejsou dosaženy určité prahové hodnoty.	No	0
timestamp_granularities[]	pole	Členitosti časového razítka, které se mají pro tento přepis naplnit. response_format musí být nastavená verbose_json tak, aby používala členitosti časového razítka. Podporují se obě tyto možnosti: wordnebo segment. Poznámka: U časových označení segmentů není žádná další latence, ale generování časových označení slov způsobuje další latenci.	No	['segment']

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	objekt
text/plain	řetězec	Přepisovaný text ve výstupním formátu (když response_format byl jeden z text, vtt nebo srt).

Examples

Example

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

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
deployment-id	cesta	Yes	řetězec
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: multipart/form-data

Name	Typ	Description	Required	Default
soubor	řetězec	Zvukový soubor, který chcete přeložit.	Yes
požádat	řetězec	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla být v angličtině.	No
response_format	audioResponseFormat	Definuje formát výstupu.	No
temperature	number	Teplota vzorkování mezi 0 a 1. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Pokud je nastavená hodnota na 0, model používá logaritmickou pravděpodobnost k automatickému zvýšení teploty, dokud nejsou dosaženy určité prahové hodnoty.	No	0

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	objekt
text/plain	řetězec	Přepis textu ve výstupním formátu (když response_format byl jedním z textů, vtt nebo srt).

Examples

Example

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

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
deployment-id	cesta	Yes	řetězec
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: multipart/form-data

Name	Typ	Description	Required	Default
vstup	řetězec	Text pro syntetizaci zvuku. Maximální délka je 4 096 znaků.	Yes
response_format	výčet	Formát syntetizování zvuku v. Možné hodnoty: mp3, opus, aac, flac, wavpcm	No
speed	number	Rychlost syntetizovaného zvuku. Vyberte hodnotu od 0.25 do 4.0. 1.0 je výchozí.	No	1.0
voice	výčet	Hlas, který se má použít pro syntézu řeči. Možné hodnoty: alloy, echo, fable, onyx, novashimmer	Yes

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/octet-stream	řetězec

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
deployment-id	cesta	Yes	řetězec
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
na pozadí	imageBackground	Umožňuje nastavit průhlednost pozadí vygenerovaných obrázků. Tento parametr je podporován pouze pro gpt-image-1.	No	auto
n	integer	Počet obrázků, které se mají vygenerovat. Pro dall-e-3 se podporuje pouze n=1.	No	1
output_compression	integer	Ú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.	No	100
output_format	imagesOutputFormat	Formát souboru, ve kterém se vrátí vygenerované obrázky. Podporováno pouze pro gpt-image-1.	No	png
požádat	řetězec	Textový popispožadovaných Maximální délka je 32000 znaků pro gpt-image-1 a 4000 znaků pro dall-e-3.	Yes
partial_images	integer	Počet částečných imagí, které se mají vygenerovat. Tento parametr se používá pro streamované odpovědi, které vracejí dílčí obrázky. Hodnota musí být v rozsahu 0 až 3. Když nastavíte hodnotu 0, odpověď bude jedna image odeslaná v jedné události streamování. Všimněte si, že poslední obrázek se může odeslat před vygenerování celého počtu částečných imagí, pokud se celý obrázek vygeneruje rychleji.	0
datový proud	boolean	Upravte obrázek v režimu streamování.	no	false
quality	imageQuality	Kvalita image, která se vygeneruje.	No	auto
response_format	imagesResponseFormat	Formát, ve kterém se vrátí vygenerované obrázky. Tento parametr není podporován pro gpt-image-1, které bude vždy vracet obrázky s kódováním base64. Možné hodnoty: url, b64_json.	No	url
size	imageSize	Velikost vygenerovaných obrázků.	No	auto
styl	imageStyle	Styl vygenerovaných obrázků Podporováno pouze pro dall-e-3.	No	vivid
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í.	No

Responses

Stavový kód: 200

Popis: Ok

Content-Type	Type	Description
application/json	generateImagesResponse

Stavový kód: výchozí

Popis: Došlo k chybě.

Content-Type	Type	Description
application/json	dalleErrorResponse

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
deployment-id	cesta	Yes	řetězec
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: multipart/form-data

Name	Typ	Description	Required	Default
bitová kopie	ř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ž 50 MB.	Yes
input_fidelity	řetězec	Určete, kolik úsilí bude model vyvíjet, aby odpovídal stylu a funkcím, zejména obličejových rysů, vstupních obrázků. Tento parametr je podporován pouze pro gpt-image-1. Podporuje high a low.	no	low.
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.	No
n	integer	Počet obrázků, které se mají vygenerovat. Musí být mezi 1 a 10.	No	1
požádat	řetězec	Textový popispožadovaných Maximální délka je 32000 znaků.	Yes
quality	imageQuality	Kvalita image, která se vygeneruje.	No	auto
partial_images	Počet částečných imagí, které se mají vygenerovat. Tento parametr se používá pro streamované odpovědi, které vracejí dílčí obrázky. Hodnota musí být v rozsahu 0 až 3. Když nastavíte hodnotu 0, odpověď bude jedna image odeslaná v jedné události streamování. Všimněte si, že poslední obrázek se může odeslat před vygenerování celého počtu částečných imagí, pokud se celý obrázek vygeneruje rychleji.
datový proud	boolean	Upravte obrázek v režimu streamování.	no	false
response_format	imagesResponseFormat	Formát, ve kterém se vrátí vygenerované obrázky.	No	url
size	imageSize	Velikost vygenerovaných obrázků.	No	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í.	No

Responses

Stavový kód: 200

Popis: Ok

Content-Type	Type	Description
application/json	generateImagesResponse

Stavový kód: výchozí

Popis: Došlo k chybě.

Content-Type	Type	Description
application/json	dalleErrorResponse

Seznam – asistenti

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

Vrátí seznam asistentů.

Parametry identifikátoru URI

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
limit	dotaz	No	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
pořadí	dotaz	No	ř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í.
after	dotaz	No	ř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.
before	dotaz	No	ř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.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	listAssistantsResponse

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
description	řetězec	Popis asistenta. Maximální délka je 512 znaků.	No
instructions	řetězec	Systémové pokyny, které asistent používá. Maximální délka je 256 000 znaků.	No
metadata	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ů.	No
model	řetězec		Yes
name	řetězec	Jméno asistenta. Maximální délka je 256 znaků.	No
response_format	assistantsApiResponseFormatOption	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 { "type": "json_schema", "json_schema": {...} } Nastavením povolíte strukturované výstupy, které zajistí, že model odpovídá 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.	No
temperature	number	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.	No	1
tool_resources	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ů.	No
└ code_interpreter	objekt		No
└- 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ů.	No	[]
└file_search	objekt		No
└─ 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ě.	No
└ 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ě.	No
tools	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.	No	[]
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.	No	1

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	assistantObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
assistant_id	cesta	Yes	řetězec	ID asistenta, který se má načíst.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	assistantObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
assistant_id	cesta	Yes	řetězec	ID asistenta, který chcete upravit.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
description	řetězec	Popis asistenta. Maximální délka je 512 znaků.	No
instructions	řetězec	Systémové pokyny, které asistent používá. Maximální délka je 32768 znaků.	No
metadata	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ů.	No
model	řetězec		No
name	řetězec	Jméno asistenta. Maximální délka je 256 znaků.	No
response_format	assistantsApiResponseFormatOption	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 { "type": "json_schema", "json_schema": {...} } Nastavením povolíte strukturované výstupy, které zajistí, že model odpovídá 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.	No
temperature	number	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.	No	1
tool_resources	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ů.	No
└ code_interpreter	objekt		No
└- 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ů.	No	[]
└file_search	objekt		No
└─ 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ě.	No
tools	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.	No	[]
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.	No	1

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	assistantObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
assistant_id	cesta	Yes	řetězec	ID asistenta, který chcete odstranit.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	deleteAssistantResponse

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
messages	pole	Seznam zpráv, se kterými se má vlákno spustit.	No
metadata	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ů.	No
tool_resources	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ů.	No
└ code_interpreter	objekt		No
└- 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ů.	No	[]
└file_search	objekt		No
└─ 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ě.	No
└ 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ě.	No

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	threadObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vlákna, které se má načíst.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	threadObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vlákna, které chcete upravit. Pouze metadata lze upravit.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
metadata	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ů.	No
tool_resources	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ů.	No
└ code_interpreter	objekt		No
└- 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ů.	No	[]
└file_search	objekt		No
└─ 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ě.	No

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	threadObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vlákna, které chcete odstranit.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	deleteThreadResponse

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vláken, do nichž zprávy patří.
limit	dotaz	No	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
pořadí	dotaz	No	ř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í.
after	dotaz	No	ř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.
before	dotaz	No	ř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	No	řetězec	Filtrovat zprávy podle ID spuštění, které je vygenerovalo.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	listMessagesResponse

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vláken pro vytvoření zprávy.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
attachments	pole	Seznam souborů připojených ke zprávě a nástroje, do které by se měly přidat.	No
obsah	řetězec	Obsah zprávy.	Yes
metadata	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ů.	No
role	ř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.	Yes

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	messageObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vláken, do kterých tato zpráva patří.
message_id	cesta	Yes	řetězec	ID zprávy, která se má načíst.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	messageObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vlákna, do kterého tato zpráva patří.
message_id	cesta	Yes	řetězec	ID zprávy, kterou chcete upravit.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
metadata	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ů.	No

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	messageObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
assistant_id	řetězec	ID pomocníka, který se má použít ke spuštění tohoto spuštění.	Yes
instructions	ř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í.	No
max_completion_tokens	integer	Maximální počet tokenů dokončení, které lze použít v průběhu spuštění. Spuštění co nejlépe využívá pouze specifikovaný počet dokončovacích tokenů, a to během několika cyklů spuštění. Pokud spuštění překročí zadaný počet tokenů dokončení, spuštění skončí stavem incomplete. Další informace najdete v incomplete_details.	No
max_prompt_tokens	integer	Maximální počet výzev tokenů, které se můžou použít v průběhu spuštění. Spuštění se maximálně snaží použít pouze specifikovaný počet tokenů výzvy během několika fází spuštění. Pokud spuštění překročí zadaný počet zadaných tokenů výzvy, spuštění skončí se stavem incomplete. Další informace najdete v incomplete_details.	No
metadata	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ů.	No
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.	No
parallel_tool_calls	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	No	True
response_format	assistantsApiResponseFormatOption	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 { "type": "json_schema", "json_schema": {...} } Nastavením povolíte strukturované výstupy, které zajistí, že model odpovídá 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.	No
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] .	No
stream_options	chatCompletionStreamOptions	Možnosti pro odpověď streamování Toto nastavení nastavíte pouze při nastavení stream: true.	No	None
temperature	number	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.	No	1
podproces	createThreadRequest		No
tool_choice	assistantsApiToolChoiceOption	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.	No
tool_resources	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ů.	No
└ code_interpreter	objekt		No
└- 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ů.	No	[]
└file_search	objekt		No
└─ 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ě.	No
tools	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í.	No
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.	No	1
truncation_strategy	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í.	No

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vlákna, ke kterému spuštění náleží.
limit	dotaz	No	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
pořadí	dotaz	No	ř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í.
after	dotaz	No	ř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.
before	dotaz	No	ř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.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	listRunsResponse

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vlákna, které se má spustit.
include[]	dotaz	No	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.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
additional_instructions	ř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í.	No
additional_messages	pole	Před vytvořením spuštění přidá do vlákna další zprávy.	No
assistant_id	řetězec	ID pomocníka, který se má použít ke spuštění tohoto spuštění.	Yes
instructions	ř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í.	No
max_completion_tokens	integer	Maximální počet tokenů dokončení, které lze použít v průběhu spuštění. Spuštění co nejlépe využívá pouze specifikovaný počet dokončovacích tokenů, a to během několika cyklů spuštění. Pokud spuštění překročí zadaný počet tokenů dokončení, spuštění skončí stavem incomplete. Další informace najdete v incomplete_details.	No
max_prompt_tokens	integer	Maximální počet výzev tokenů, které se můžou použít v průběhu spuštění. Spuštění se maximálně snaží použít pouze specifikovaný počet tokenů výzvy během několika fází spuštění. Pokud spuštění překročí zadaný počet zadaných tokenů výzvy, spuštění skončí se stavem incomplete. Další informace najdete v incomplete_details.	No
metadata	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ů.	No
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.	No
parallel_tool_calls	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	No	True
response_format	assistantsApiResponseFormatOption	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 { "type": "json_schema", "json_schema": {...} } Nastavením povolíte strukturované výstupy, které zajistí, že model odpovídá 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.	No
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] .	No
temperature	number	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.	No	1
tool_choice	assistantsApiToolChoiceOption	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.	No
tools	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í.	No
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.	No	1
truncation_strategy	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í.	No

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vláken, která byla spuštěna.
run_id	cesta	Yes	řetězec	ID spuštění, které se má načíst.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vláken, která byla spuštěna.
run_id	cesta	Yes	řetězec	ID spuštění, které chcete upravit.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
metadata	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ů.	No

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vláken, do kterých toto spuštění patří.
run_id	cesta	Yes	řetězec	ID spuštění, které vyžaduje odeslání výstupu nástroje.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
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] .	No
tool_outputs	pole	Seznam nástrojů, pro které se odesílají výstupy.	Yes

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vlákna, do kterého toto spuštění patří.
run_id	cesta	Yes	řetězec	ID spuštění, které chcete zrušit.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vlákna, ke kterému patří běh a kroky běhu.
run_id	cesta	Yes	řetězec	ID spuštění, ke kterému patří kroky běhu.
limit	dotaz	No	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
pořadí	dotaz	No	ř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í.
after	dotaz	No	ř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.
before	dotaz	No	ř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.
api-version	dotaz	Yes	řetězec
include[]	dotaz	No	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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	listRunStepsResponse

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
thread_id	cesta	Yes	řetězec	ID vlákna, ke kterému patří běh a krok běhu.
run_id	cesta	Yes	řetězec	ID běhu, do kterého fáze spuštění patří.
step_id	cesta	Yes	řetězec	ID kroku spuštění, který se má načíst.
include[]	dotaz	No	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.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	runStepObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
limit	dotaz	No	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
pořadí	dotaz	No	ř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í.
after	dotaz	No	ř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.
before	dotaz	No	ř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.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	listVectorStoresResponse

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
chunking_strategy	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ý.	No
expires_after	vectorStoreExpirationAfter	Zásady vypršení platnosti pro úložiště vektorů.	No
file_ids	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.	No
metadata	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ů.	No
name	řetězec	Název úložiště vektorů.	No

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	vectorStoreObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
vector_store_id	cesta	Yes	řetězec	ID úložiště vektorů, které se má načíst.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	vectorStoreObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
vector_store_id	cesta	Yes	řetězec	ID vektorového úložiště, které chcete upravit.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
expires_after	vectorStoreExpirationAfter	Zásady vypršení platnosti pro úložiště vektorů.	No
metadata	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ů.	No
name	řetězec	Název úložiště vektorů.	No

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	vectorStoreObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
vector_store_id	cesta	Yes	řetězec	ID úložiště vektorů, které chcete odstranit.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	deleteVectorStoreResponse

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
vector_store_id	cesta	Yes	řetězec	ID vektorového úložiště, do kterého soubory patří.
limit	dotaz	No	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
pořadí	dotaz	No	ř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í.
after	dotaz	No	ř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.
before	dotaz	No	ř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	No	řetězec Možné hodnoty: in_progress, completed, failed, cancelled	Filtrovat podle stavu souboru. Jeden z in_progress, completed, failed, cancelled.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	listVectorStoreFilesResponse

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
vector_store_id	cesta	Yes	řetězec	ID vektorového úložiště, pro které chcete vytvořit soubor.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
chunking_strategy	chunkingStrategyRequestParam	Strategie vytváření bloků dat použitá k vytvoření bloků souborů. Pokud není nastavená, použije strategii auto .	No
file_id	ř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.	Yes

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	vectorStoreFileObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
vector_store_id	cesta	Yes	řetězec	ID vektorového úložiště, do kterého soubor patří.
file_id	cesta	Yes	řetězec	ID načteného souboru.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	vectorStoreFileObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
vector_store_id	cesta	Yes	řetězec	ID vektorového úložiště, do kterého soubor patří.
file_id	cesta	Yes	řetězec	ID souboru, který chcete odstranit.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	deleteVectorStoreFileResponse

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
vector_store_id	cesta	Yes	řetězec	ID vektorového úložiště, do které soubor patří.
file_id	cesta	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
attributes	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.	Yes

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
vector_store_id	cesta	Yes	řetězec	ID úložiště vektorů.
file_id	cesta	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
vector_store_id	cesta	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
filters	ComparisonFilter nebo CompoundFilter	Filtr, který se použije na základě atributů souboru.	No
max_num_results	integer	Maximální počet výsledků, které se mají vrátit. Toto číslo by mělo být mezi 1 a 50 včetně.	No	10
dotaz	řetězec nebo pole	Řetězec dotazu pro hledání	Yes
ranking_options	objekt	Možnosti řazení pro hledání	No
└- ranker	výčet	Možné hodnoty: auto, default-2024-11-15	No
└ score_threshold	number		No	0
rewrite_query	boolean	Zda se má dotaz v přirozeném jazyce přepsat pro vektorové vyhledávání.	No	False

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
vector_store_id	cesta	Yes	řetězec	ID vektorového úložiště, pro které chcete vytvořit dávku souborů.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
chunking_strategy	chunkingStrategyRequestParam	Strategie vytváření bloků dat použitá k vytvoření bloků souborů. Pokud není nastavená, použije strategii auto .	No
file_ids	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.	Yes

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	vectorStoreFileBatchObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
vector_store_id	cesta	Yes	řetězec	ID úložiště vektorů, do kterého dávka souboru patří.
batch_id	cesta	Yes	řetězec	ID skupiny souborů, která se načítá.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	vectorStoreFileBatchObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
vector_store_id	cesta	Yes	řetězec	ID úložiště vektorů, do kterého dávka souboru patří.
batch_id	cesta	Yes	řetězec	ID dávky souboru, které chcete zrušit.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	vectorStoreFileBatchObject

Examples

Example

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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
vector_store_id	cesta	Yes	řetězec	ID vektorového úložiště, do kterého soubory patří.
batch_id	cesta	Yes	řetězec	ID dávky souboru, do které soubory patří.
limit	dotaz	No	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
pořadí	dotaz	No	ř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í.
after	dotaz	No	ř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.
before	dotaz	No	ř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	No	řetězec Možné hodnoty: in_progress, completed, failed, cancelled	Filtrovat podle stavu souboru. Jeden z in_progress, completed, failed, cancelled.
api-version	dotaz	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	listVectorStoreFilesResponse

Examples

Example

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.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
input_audio_format	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	No
input_audio_noise_reduction	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.	No
└- 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	No
input_audio_transcription	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.	No
└jazyk	řetězec	Jazyk vstupního zvuku. Zadávání jazyka zadávání ve formátu ISO-639-1 (např. en) zlepšuje přesnost a latenci.	No
└model	řetězec	Model, který se má použít pro přepis, aktuální možnosti jsou gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribea whisper-1.	No
└─ 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í".	No
instructions	ř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.	No
max_response_output_tokens	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 je inf.	No
modalities		Sada způsobů, kterými může model reagovat. Pokud chcete zvuk zakázat, nastavte ho na ["text"].	No
model	řetězec	Název nasazení použitého pro tuto relaci.	No
output_audio_format	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	No
temperature	number	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.	No	0.8
tool_choice	řetězec	Jak model vybírá nástroje. Možnosti jsou auto, none, requirednebo zadat funkci.	No	auto
tools	pole	Nástroje (funkce) dostupné pro model	No
turn_detection	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.	No
└create_response	boolean	Jestli se má automaticky generovat odpověď, když dojde k události zastavení VAD.	No	True
└- 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	No
└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.	No	True
└- prefix_padding_ms	integer	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.	No
└─ trvání_ticha_ms	integer	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.	No
└- prahová hodnota	number	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.	No
└- typ	výčet	Typ detekce otáčení Možné hodnoty: server_vad, semantic_vad	No
voice	VoiceIdsShared		No

Responses

Stavový kód: 200

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

Content-Type	Type	Description
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.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
include	pole	Sada položek, které se mají zahrnout do přepisu. Aktuální dostupné položky jsou: - item.input_audio_transcription.logprobs	No
input_audio_format	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	No
input_audio_noise_reduction	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.	No
└- 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	No
input_audio_transcription	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.	No
└jazyk	řetězec	Jazyk vstupního zvuku. Zadávání jazyka zadávání ve formátu ISO-639-1 (např. en) zlepšuje přesnost a latenci.	No
└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	No
└─ 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í".	No
modalities		Sada způsobů, kterými může model reagovat. Pokud chcete zvuk zakázat, nastavte ho na ["text"].	No
turn_detection	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.	No
└create_response	boolean	Jestli se má automaticky generovat odpověď, když dojde k události zastavení VAD. Není k dispozici pro přepisovací relace.	No	True
└- 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	No
└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.	No	True
└- prefix_padding_ms	integer	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.	No
└─ trvání_ticha_ms	integer	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.	No
└- prahová hodnota	number	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.	No
└- typ	výčet	Typ detekce otáčení Možné hodnoty: server_vad, semantic_vad	No

Responses

Stavový kód: 200

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

Content-Type	Type	Description
application/json	RealtimeTranscriptionSessionCreateResponse

Responses

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

Vytvoří modelovou odpověď.

Tělo žádosti

Content-Type: application/json

Name	Typ	Description	Required	Default
include	pole		No
vstup	řetězec nebo pole	Vstupy modelu	Yes
instructions	ř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.	No
max_output_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a stavu konverzace.	No
parallel_tool_calls	boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	No	True
previous_response_id	ř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.	No
reasoning	Reasoning	Možnosti konfigurace pro zdůvodnění modelů	No
uložit	boolean	Zda se má vygenerovaná odpověď modelu uložit pro pozdější načtení prostřednictvím rozhraní API.	No	True
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.	No	False
poslat SMS	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	No
└─ Formát	TextResponseFormatConfiguration	Objekt určující formát, který musí model vypíše. Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, což zajišťuje, že model odpovídá 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í.	No
tool_choice	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.	No
tools	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	No
truncation	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	No

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	response
text/event-stream	responseStreamEvent

Stavový kód: výchozí

Popis: Služba není k dispozici

Content-Type	Type	Description
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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
response_id	cesta	Yes	řetězec	ID odpovědi, která se má načíst.
include	dotaz	No	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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	response

Stavový kód: výchozí

Popis: Služba není k dispozici

Content-Type	Type	Description
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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
response_id	cesta	Yes	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Stavový kód: 404

Popis: Nenalezena

Content-Type	Type	Description
application/json	error

Stavový kód: výchozí

Popis: Služba není k dispozici

Content-Type	Type	Description
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

Name	In	Required	Typ	Description
koncový bod	cesta	Yes	ř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://{your-resource-name}.openai.azure.com
response_id	cesta	Yes	řetězec	ID odpovědi, ze které se mají načíst vstupní položky.
limit	dotaz	No	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.
pořadí	dotaz	No	ř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í.
after	dotaz	No	ř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í.
before	dotaz	No	ř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ší.

Name	Required	Typ	Description
Authorization	True	ř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-key	True	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Responses

Stavový kód: 200

Popis: OK

Content-Type	Type	Description
application/json	responseItemList

Components

errorResponse

Name	Typ	Description	Required	Default
chyba	error		No

errorBase

Name	Typ	Description	Required	Default
kód	řetězec		No
zpráva	řetězec		No

chyba

Name	Typ	Description	Required	Default
inner_error	innerError	Vnitřní chyba s dalšími podrobnostmi	No
param	řetězec		No
typ	řetězec		No

innerError

Vnitřní chyba s dalšími podrobnostmi

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

innerErrorCode

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

Property	Value
Description	Kódy chyb pro vnitřní objekt chyby.
Type	řetězec
Values	ResponsibleAIPolicyViolation

dalleErrorResponse

Name	Typ	Description	Required	Default
chyba	dalleError		No

dalleError

Name	Typ	Description	Required	Default
inner_error	dalleInnerError	Vnitřní chyba s dalšími podrobnostmi	No
param	řetězec		No
typ	řetězec		No

dalleInnerError

Vnitřní chyba s dalšími podrobnostmi

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

contentFilterCompletionTextSpan

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

Name	Typ	Description	Required	Default
completion_end_offset	integer	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ů.	Yes
completion_start_offset	integer	Posun bodu kódu UTF32, který začíná rozsahem.	Yes

contentFilterResultBase

Name	Typ	Description	Required	Default
filtered	boolean		Yes

contentFilterSeverityResult

Name	Typ	Description	Required	Default
filtered	boolean		Yes
severity	řetězec		No

contentFilterDetectedResult

Name	Typ	Description	Required	Default
detected	boolean		No
filtered	boolean		Yes

contentFilterDetectedWithCitationResult

Name	Typ	Description	Required	Default
citation	objekt		No
└- ADRESA URL	řetězec		No
└- licence	řetězec		No

contentFilterDetectedWithCompletionTextSpansResult

Name	Typ	Description	Required	Default
details	pole		No

contentFilterIdResult

Name	Typ	Description	Required	Default
filtered	boolean		Yes
id	řetězec		No

contentFilterResultsBase

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

Name	Typ	Description	Required	Default
custom_blocklists	contentFilterDetailedResults	Výsledky filtrování obsahu s podrobnostmi o ID filtru obsahu pro filtrované segmenty	No
chyba	errorBase		No
hate	contentFilterSeverityResult		No
profanity	contentFilterDetectedResult		No
self_harm	contentFilterSeverityResult		No
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No

contentFilterPromptResults

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

Name	Typ	Description	Required	Default
custom_blocklists	contentFilterDetailedResults	Výsledky filtrování obsahu s podrobnostmi o ID filtru obsahu pro filtrované segmenty	No
chyba	errorBase		No
hate	contentFilterSeverityResult		No
indirect_attack	contentFilterDetectedResult		No
jailbreak	contentFilterDetectedResult		No
profanity	contentFilterDetectedResult		No
self_harm	contentFilterSeverityResult		No
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No

contentFilterChoiceResults

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

Name	Typ	Description	Required	Default
custom_blocklists	contentFilterDetailedResults	Výsledky filtrování obsahu s podrobnostmi o ID filtru obsahu pro filtrované segmenty	No
chyba	errorBase		No
hate	contentFilterSeverityResult		No
profanity	contentFilterDetectedResult		No
protected_material_code	contentFilterDetectedWithCitationResult		No
protected_material_text	contentFilterDetectedResult		No
self_harm	contentFilterSeverityResult		No
sexual	contentFilterSeverityResult		No
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		No
violence	contentFilterSeverityResult		No

contentFilterDetailedResults

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

Name	Typ	Description	Required	Default
details	pole		No
filtered	boolean		Yes

promptFilterResult

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

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

promptFilterResults

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

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

dalleContentFilterResults

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

Name	Typ	Description	Required	Default
hate	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No

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.

Name	Typ	Description	Required	Default
custom_blocklists	contentFilterDetailedResults	Výsledky filtrování obsahu s podrobnostmi o ID filtru obsahu pro filtrované segmenty	No
hate	contentFilterSeverityResult		No
jailbreak	contentFilterDetectedResult		No
profanity	contentFilterDetectedResult		No
self_harm	contentFilterSeverityResult		No
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No

chatCompletionsRequestCommon

Name	Typ	Description	Required	Default
frequency_penalty	number	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.	No	0
logit_bias	objekt	Upravte pravděpodobnost výskytu zadaných tokenů v dokončení. Přijímá objekt JSON, který mapuje tokeny (určené jejich ID tokenu v tokenizátoru) na přidruženou hodnotu předsudku od -100 do 100. Matematicky se před vzorkováním přidá do logitů vygenerovaných modelem. Přesný účinek se liší podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu.	No
max_completion_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro dokončení, včetně viditelných výstupních tokenů a zdůvodnění tokenů.	No
max_tokens	integer	Maximální počet tokenů povolených pro vygenerovanou odpověď. Ve výchozím nastavení bude počet tokenů, které model může vrátit, (4096 – tokeny výzvy). To není kompatibilní s modely řady o1.	No	4096
metadata	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í	No
presence_penalty	number	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.	No	0
stop	řetězec nebo pole	Až 4 sekvence, ve kterých rozhraní API přestane generovat další tokeny.	No
uložit	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.	No
datový proud	boolean	Pokud je tato možnost nastavena, odesílají se částečné změny zpráv, například v ChatGPT. Tokeny se odesílají jako serverem posílané události pouze pro data, jakmile jsou k dispozici, přičemž datový tok je ukončen zprávou data: [DONE].	No	False
temperature	number	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	No	1
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	No	1
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í.	No

createCompletionRequest

Name	Typ	Description	Required	Default
best_of	integer	Vygeneruje best_of dokončení na straně serveru a vrátí "nejlepší" (ten s nejvyšší pravděpodobností protokolu na token). Výsledky se nedají streamovat. 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.	No	1
echo	boolean	Ozvěte výzvu kromě dokončení.	No	False
frequency_penalty	number	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.	No	0
logit_bias	objekt	Upravte pravděpodobnost výskytu zadaných tokenů v dokončení. Přijímá objekt JSON, který mapuje tokeny (určené jejich ID tokenu v tokenizátoru GPT) na přidruženou hodnotu předsudku od -100 do 100. Matematicky se před vzorkováním přidá do logitů vygenerovaných modelem. Přesný účinek se liší podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu. Můžete například předat {"50256": -100} , abyste zabránili generování tokenu <|endoftext|> .	No	None
logprobs	integer	Zahrňte pravděpodobnosti protokolu u nejpravděpodobnějších logprobs výstupních tokenů a vybraných tokenů. Pokud je například logprobs 5, rozhraní API vrátí seznam 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.	No	None
max_tokens	integer	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.	No	16
n	integer	Kolik dokončení se má vygenerovat pro každou výzvu. Poznámka: Protože tento parametr generuje mnoho dokončení, může rychle spotřebovat kvótu tokenu. Pečlivě používejte a ujistěte se, že máte přiměřené nastavení a max_tokensstop.	No	1
presence_penalty	number	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.	No	0
požádat	ř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.	Yes
seed	integer	Pokud je zadáno, náš systém se snaží vzorkovat deterministicky, takže opakované požadavky se stejnými seed parametry by měly vrátit stejný výsledek. Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.	No
stop	řetězec nebo pole	Až 4 sekvence, ve kterých rozhraní API přestane generovat další tokeny. Vrácený text nebude obsahovat sekvenci zastavení.	No
datový proud	boolean	Zda se má streamovat zpět částečný průběh. Pokud je tato možnost nastavena, tokeny se posílají jako serverem odesílané události jakmile jsou dostupné, a datový proud se ukončí zprávou data: [DONE]. Příklad kódu Pythonu	No	False
suffix	ř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.	No	None
temperature	number	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	No	1
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	No	1
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í.	No

createCompletionResponse

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

Name	Typ	Description	Required	Default
choices	pole	Seznam voleb dokončení, které model vygeneroval pro vstupní výzvu.	Yes
created	integer	Časové razítko unixu (v sekundách) doby vytvoření dokončení.	Yes
id	řetězec	Jedinečný identifikátor dokončení.	Yes
model	řetězec	Model použitý k dokončení.	Yes
objekt	výčet	Typ objektu, který je vždy "text_completion" Možné hodnoty: text_completion	Yes
prompt_filter_results	promptFilterResults	Výsledky filtrování obsahu pro nulové nebo více výzev v požadavku V žádosti o streamování můžou výsledky různých výzev dorazit v různých časech nebo v různých objednávkách.	No
system_fingerprint	ř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.	No
využití	completionUsage	Statistiky využití žádosti o dokončení	No

createChatCompletionRequest

Name	Typ	Description	Required	Default
audio	objekt	Parametry zvukového výstupu Požadován při vyžádání zvukového výstupu s modalities: ["audio"].	No
└─ 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	No
└─ 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	No
data_sources	pole	Položky konfigurace pro rozšíření chatu Azure OpenAI, které je používají. Tato další specifikace je kompatibilní pouze s Azure OpenAI.	No
frequency_penalty	number	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.	No	0
function_call	string nebo chatCompletionFunctionCallOption	Zastaralá ve prospěch tool_choice. Určuje, která funkce (pokud existuje) volána modelem. none znamená, že model nebude volat funkci a místo toho vygeneruje zprávu. auto znamená, že model může vybrat mezi generováním zprávy nebo voláním funkce. Zadáním konkrétní funkce vynutíte {"name": "my_function"} , aby model volal danou funkci. none je výchozí, pokud nejsou k dispozici žádné funkce. auto je výchozí, pokud jsou k dispozici funkce.	No
functions	pole	Zastaralá ve prospěch tools. Seznam funkcí, pro které model může generovat vstupy JSON.	No
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 liší podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu.	No	None
logprobs	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.	No	False
max_completion_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro dokončení, včetně viditelných výstupních tokenů a zdůvodnění tokenů.	No
max_tokens	integer	Maximální počet tokenů, které lze vygenerovat v dokončení chatu. Celková délka vstupních tokenů a vygenerovaných tokenů je omezená délkou kontextu modelu.	No
messages	pole	Seznam zpráv, které tvoří dosud konverzaci. Příklad kódu Pythonu	Yes
metadata	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í	No
modalities	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"]	No
n	integer	Kolik možností dokončení chatu se má vygenerovat pro každou vstupní zprávu. Mějte na paměti, že se vám bude účtovat na základě počtu vygenerovaných tokenů napříč všemi možnostmi. Udržujte n si přehled o 1 minimalizaci nákladů.	No	1
parallel_tool_calls	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	No	True
predikce	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.	No
presence_penalty	number	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.	No	0
reasoning_effort	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	No
response_format	ResponseFormatText nebo ResponseFormatJsonObject nebo ResponseFormatJsonSchema	Objekt určující formát, který musí model vypíše. Kompatibilní s GPT-4o { "type": "json_schema", "json_schema": {...} } Nastavením povolíte strukturované výstupy, které zaručují, že model odpovídá 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.	No
seed	integer	Tato funkce je v beta verzi. Pokud je zadáno, náš systém se snaží vzorkovat deterministicky, takže opakované požadavky se stejnými seed parametry by měly vrátit stejný výsledek. Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.	No
stop	řetězec nebo pole	Až 4 sekvence, ve kterých rozhraní API přestane generovat další tokeny.	No
uložit	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.	No
datový proud	boolean	Pokud je tato možnost nastavena, odesílají se částečné změny zpráv, například v ChatGPT. Tokeny jsou odesílány jako události odesílané serverem pouze s daty, jakmile jsou k dispozici, a proud je ukončen zprávou data: [DONE]. Příklad kódu Pythonu	No	False
stream_options	chatCompletionStreamOptions	Možnosti pro odpověď streamování Toto nastavení nastavíte pouze při nastavení stream: true.	No	None
temperature	number	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	No	1
tool_choice	chatCompletionToolChoiceOption	Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádný nástroj a místo toho vygeneruje zprávu. auto znamená, že model si může vybrat mezi generováním zprávy nebo voláním jednoho nebo více nástrojů. required znamená, že model musí volat jeden nebo více nástrojů. Zadáním konkrétního nástroje vynutíte {"type": "function", "function": {"name": "my_function"}} model, aby tento nástroj volal. none je výchozí, pokud nejsou k dispozici žádné nástroje. auto je výchozí, pokud jsou k dispozici nástroje.	No
tools	pole	Seznam nástrojů, které model může volat. V současné době se jako nástroj podporují jenom funkce. Pomocí tohoto příkazu můžete poskytnout seznam funkcí, pro které může model generovat vstupy JSON. Podporuje se maximálně 128 funkcí.	No
top_logprobs	integer	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu. logprobs parametr musí být nastaven na true hodnotu, pokud je použit tento parametr.	No
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	No	1
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í.	No
user_security_context	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.	No

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.

Name	Typ	Description	Required	Default
application_name	řetězec	Název aplikace. Do tohoto pole by neměly být zahrnuty citlivé osobní údaje.	No
end_user_id	ř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.	No
end_user_tenant_id	řetězec	ID tenanta Microsoftu 365, do které koncový uživatel patří. Vyžaduje se, když je aplikace generující AI více tenantů.	No
source_ip	řetězec	Zachycuje IP adresu původního klienta a přijímá formáty IPv4 i IPv6.	No

chatCompletionFunctions

Name	Typ	Description	Required	Default
description	řetězec	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.	No
name	ř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.	Yes
parameters	FunctionParameters	Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON. Příklady najdete v příručce a referenční informace ke schématu JSON pro dokumentaci k formátu. Vynechání parameters definuje funkci s prázdným seznamem parametrů.	No

chatCompletionFunctionCallOption

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

Name	Typ	Description	Required	Default
name	řetězec	Název funkce, která se má volat.	Yes

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.

chatCompletionRequestMessage

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

• ChatCompletionRequestDeveloperMessage
• chatCompletionRequestSystemMessage
• chatCompletionRequestUserMessage
• chatCompletionRequestAssistantMessage
• chatCompletionRequestToolMessage
• chatCompletionRequestFunctionMessage

ChatCompletionRequestDeveloperMessage

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.

Name	Typ	Description	Required	Default
obsah	řetězec nebo pole	Obsah zprávy vývojáře.	Yes
name	řetězec	Volitelné jméno účastníka. Poskytuje informace o modelu pro rozlišení mezi účastníky stejné role.	No
role	výčet	Role autora zpráv v tomto případě developer. Možné hodnoty: developer	Yes

chatCompletionRequestSystemMessage

Name	Typ	Description	Required	Default
obsah	řetězec nebo pole	Obsah systémové zprávy.	Yes
name	řetězec	Volitelné jméno účastníka. Poskytuje informace o modelu pro rozlišení mezi účastníky stejné role.	No
role	výčet	Role autora zpráv v tomto případě system. Možné hodnoty: system	Yes

chatCompletionRequestUserMessage

Name	Typ	Description	Required	Default
obsah	řetězec nebo pole	Obsah zprávy uživatele.	Yes
name	řetězec	Volitelné jméno účastníka. Poskytuje informace o modelu pro rozlišení mezi účastníky stejné role.	No
role	výčet	Role autora zpráv v tomto případě user. Možné hodnoty: user	Yes

chatCompletionRequestAssistantMessage

Name	Typ	Description	Required	Default
obsah	řetězec nebo pole	Obsah zprávy asistenta. Povinné, pokud tool_calls není zadáno.function_call	No
function_call	objekt	Zastaralé a nahrazené .tool_calls Název a argumenty funkce, které by se měly volat, jak je vygeneroval model.	No
└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.	No
└– název	řetězec	Název funkce, která se má volat.	No
name	řetězec	Volitelné jméno účastníka. Poskytuje informace o modelu pro rozlišení mezi účastníky stejné role.	No
refusal	řetězec	Odmítnutí zprávy asistenta.	No
role	výčet	Role autora zpráv v tomto případě assistant. Možné hodnoty: assistant	Yes
tool_calls	chatCompletionMessageToolCalls	Nástroj volá volání vygenerovaná modelem, například volání funkcí.	No

chatCompletionRequestToolMessage

Name	Typ	Description	Required	Default
obsah	řetězec nebo pole	Obsah zprávy nástroje	Yes
role	výčet	Role autora zpráv v tomto případě tool. Možné hodnoty: tool	Yes
tool_call_id	řetězec	Volání nástroje, na které tato zpráva reaguje.	Yes

chatCompletionRequestFunctionMessage

Name	Typ	Description	Required	Default
obsah	řetězec	Obsah zprávy funkce.	Yes
name	řetězec	Název funkce, která se má volat.	Yes
role	výčet	Role autora zpráv v tomto případě function. Možné hodnoty: function	Yes

chatCompletionRequestDeveloperMessageContentPart

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

• chatCompletionRequestMessageContentPartText

chatCompletionRequestSystemMessageContentPart

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

• chatCompletionRequestMessageContentPartText

chatCompletionRequestUserMessageContentPart

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

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartImage
• chatCompletionRequestMessageContentPartAudio

chatCompletionRequestAssistantMessageContentPart

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

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartRefusal

chatCompletionRequestToolMessageContentPart

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

• chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartText

Name	Typ	Description	Required	Default
poslat SMS	řetězec	Textový obsah.	Yes
typ	výčet	Typ části obsahu. Možné hodnoty: text	Yes

chatCompletionRequestMessageContentPartAudio

Name	Typ	Description	Required	Default
input_audio	objekt		Yes
└- data	řetězec	Zakódovaná zvuková data base64	No
└─ Formát	výčet	Formát zakódovaných zvukových dat. Aktuálně podporuje "wav" a "mp3". Možné hodnoty: wav, mp3	No
typ	výčet	Typ části obsahu. Vždy input_audio. Možné hodnoty: input_audio	Yes

chatCompletionRequestMessageContentPartImage

Name	Typ	Description	Required	Default
image_url	objekt		Yes
└detail	výčet	Určuje úroveň podrobností obrázku. Další informace najdete v průvodci vision. Možné hodnoty: auto, low, high	No
└- adresa URL	řetězec	Buď adresa URL obrázku, nebo data s kódováním base64 obrázku.	No
typ	výčet	Typ části obsahu. Možné hodnoty: image_url	Yes

chatCompletionRequestMessageContentPartRefusal

Name	Typ	Description	Required	Default
refusal	řetězec	Odmítnutí zprávy generované modelem.	Yes
typ	výčet	Typ části obsahu. Možné hodnoty: refusal	Yes

azureChatExtensionConfiguration

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

###Discriminator pro azureChatExtensionConfiguration

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

Hodnota typu	Schema
azure_search	azureSearchChatExtensionConfiguration
azure_cosmos_db	azureCosmosDBChatExtensionConfiguration
elasticsearch	elasticsearchChatExtensionConfiguration
mongo_db	mongoDBChatExtensionConfiguration
pinecone	pineconeChatExtensionConfiguration

Name	Typ	Description	Required	Default
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.	Yes

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.

Property	Value
Description	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.
Type	řetězec
Values	azure_search azure_cosmos_db elasticsearch mongo_db pinecone

azureSearchChatExtensionConfiguration

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

Name	Typ	Description	Required	Default
parameters	azureSearchChatExtensionParameters	Parametry služby Azure Search při použití jako rozšíření chatu Azure OpenAI	No
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.	Yes

azureSearchChatExtensionParameters

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

Name	Typ	Description	Required	Default
allow_partial_result	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.	No	False
ověřování	onYourDataApiKeyAuthenticationOptions nebo onYourDataSystemAssignedManagedIdentityAuthenticationOptions nebo onYourDataUserAssignedManagedIdentityAuthenticationOptions nebo onYourDataAccessTokenAuthenticationOptions		Yes
embedding_dependency	onYourDataEndpointVectorizationSource nebo onYourDataDeploymentNameVectorizationSource nebo onYourDataIntegratedVectorizationSource		No
koncový bod	řetězec	Absolutní cesta ke koncovému bodu pro prostředek Azure Search, který se má použít.	Yes
fields_mapping	azureSearchIndexFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Služby Azure Search	No
filtr	řetězec	Filtr hledání.	No
in_scope	boolean	Určuje, jestli se dotazy mají omezit na použití indexovaných dat.	No
include_contexts	pole	Zahrnuté vlastnosti výstupního kontextu. Pokud není zadána, výchozí hodnota je citations a intent.	No
index_name	řetězec	Název indexu, který se má použít jako dostupný v odkazovaném prostředku služby Azure Search.	Yes
max_search_queries	integer	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.	No
query_type	azureSearchQueryType	Typ vyhledávacího dotazu Služby Azure Search, který se má spustit při použití jako rozšíření chatu Azure OpenAI.	No
semantic_configuration	řetězec	Další sémantická konfigurace dotazu.	No
strictness	integer	Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi.	No
top_n_documents	integer	Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz.	No

azureSearchIndexFieldMappingOptions

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

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

azureSearchQueryType

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

Property	Value
Description	Typ vyhledávacího dotazu Služby Azure Search, který se má spustit při použití jako rozšíření chatu Azure OpenAI.
Type	řetězec
Values	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

azureCosmosDBChatExtensionConfiguration

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

Name	Typ	Description	Required	Default
parameters	azureCosmosDBChatExtensionParameters	Parametry, které se mají použít při konfiguraci rozšíření chatu Azure OpenAI ve vašem datovém chatu při použití služby Azure Cosmos DB pro virtuální jádro MongoDB	No
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.	Yes

azureCosmosDBChatExtensionParameters

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

Name	Typ	Description	Required	Default
allow_partial_result	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.	No	False
ověřování	onYourDataConnectionStringAuthenticationOptions	Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití připojovací řetězec	Yes
container_name	řetězec	Název kontejneru prostředků služby Azure Cosmos DB.	Yes
database_name	řetězec	Název databáze MongoDB vCore, který se má použít se službou Azure Cosmos DB.	Yes
embedding_dependency	onYourDataEndpointVectorizationSource nebo onYourDataDeploymentNameVectorizationSource		Yes
fields_mapping	azureCosmosDBFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Služby Azure Cosmos DB	Yes
in_scope	boolean	Určuje, jestli se dotazy mají omezit na použití indexovaných dat.	No
include_contexts	pole	Zahrnuté vlastnosti výstupního kontextu. Pokud není zadána, výchozí hodnota je citations a intent.	No
index_name	řetězec	Název indexu virtuálních jader MongoDB, který se má použít se službou Azure Cosmos DB.	Yes
max_search_queries	integer	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.	No
strictness	integer	Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi.	No
top_n_documents	integer	Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz.	No

azureCosmosDBFieldMappingOptions

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

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

elasticsearchChatExtensionConfiguration

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

Name	Typ	Description	Required	Default
parameters	elasticsearchChatExtensionParameters	Parametry, které se mají použít při konfiguraci Elasticsearch® jako rozšíření chatu Azure OpenAI	No
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.	Yes

elasticsearchChatExtensionParameters

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

Name	Typ	Description	Required	Default
allow_partial_result	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.	No	False
ověřování	onYourDataKeyAndKeyIdAuthenticationOptions nebo onYourDataEncodedApiKeyAuthenticationOptions		Yes
embedding_dependency	onYourDataEndpointVectorizationSource nebo onYourDataDeploymentNameVectorizationSource nebo onYourDataModelIdVectorizationSource		No
koncový bod	řetězec	Koncový bod Elasticsearch®.	Yes
fields_mapping	elasticsearchIndexFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Elasticsearch®.	No
in_scope	boolean	Určuje, jestli se dotazy mají omezit na použití indexovaných dat.	No
include_contexts	pole	Zahrnuté vlastnosti výstupního kontextu. Pokud není zadána, výchozí hodnota je citations a intent.	No
index_name	řetězec	Název indexu Elasticsearch®.	Yes
max_search_queries	integer	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.	No
query_type	elasticsearchQueryType	Typ dotazu na načtení Elasticsearch®, který by se měl spustit při použití jako rozšíření chatu Azure OpenAI.	No
strictness	integer	Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi.	No
top_n_documents	integer	Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz.	No

elasticsearchIndexFieldMappingOptions

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

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

elasticsearchQueryType

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

Property	Value
Description	Typ dotazu na načtení Elasticsearch®, který by se měl spustit při použití jako rozšíření chatu Azure OpenAI.
Type	řetězec
Values	simple vector

mongoDBChatExtensionConfiguration

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

Name	Typ	Description	Required	Default
parameters	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	No
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.	Yes

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

Name	Typ	Description	Required	Default
allow_partial_result	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.	No	False
app_name	řetězec	Název aplikace Mongo DB.	Yes
ověřování	onYourDataUsernameAndPasswordAuthenticationOptions	Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití uživatelského jména a hesla	Yes
collection_name	řetězec	Název kolekce Mongo DB.	Yes
database_name	řetězec	Název databáze Mongo DB.	Yes
embedding_dependency	onYourDataEndpointVectorizationSource nebo onYourDataDeploymentNameVectorizationSource		Yes
koncový bod	řetězec	Název koncového bodu clusteru Mongo DB.	Yes
fields_mapping	mongoDBFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Mongo DB.	Yes
in_scope	boolean	Určuje, jestli se dotazy mají omezit na použití indexovaných dat.	No
include_contexts	pole	Zahrnuté vlastnosti výstupního kontextu. Pokud není zadána, výchozí hodnota je citations a intent.	No
index_name	řetězec	Název indexu Mongo DB.	Yes
max_search_queries	integer	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.	No
strictness	integer	Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi.	No
top_n_documents	integer	Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz.	No

mongoDBFieldMappingOptions

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

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

pineconeChatExtensionConfiguration

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

Name	Typ	Description	Required	Default
parameters	pineconeChatExtensionParameters	Parametry pro konfiguraci rozšíření chatu Azure OpenAI Pinecone	No
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.	Yes

pineconeChatExtensionParameters

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

Name	Typ	Description	Required	Default
allow_partial_result	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.	No	False
ověřování	onYourDataApiKeyAuthenticationOptions	Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití klíče rozhraní API	Yes
embedding_dependency	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.	Yes
prostředí	řetězec	Název prostředí Pinecone.	Yes
fields_mapping	pineconeFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Pinecone.	Yes
in_scope	boolean	Určuje, jestli se dotazy mají omezit na použití indexovaných dat.	No
include_contexts	pole	Zahrnuté vlastnosti výstupního kontextu. Pokud není zadána, výchozí hodnota je citations a intent.	No
index_name	řetězec	Název indexu databáze Pinecone.	Yes
max_search_queries	integer	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.	No
strictness	integer	Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi.	No
top_n_documents	integer	Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz.	No

pineconeFieldMappingOptions

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

Name	Typ	Description	Required	Default
content_fields	pole	Názvy polí indexu, která by se měla považovat za obsah.	Yes
content_fields_separator	řetězec	Vzor oddělovače, který mají pole obsahu používat.	No
filepath_field	řetězec	Název pole indexu, které se má použít jako cesta k souboru.	No
title_field	řetězec	Název pole indexu, které se má použít jako název.	No
url_field	řetězec	Název pole indexu, které se má použít jako adresa URL.	No

onYourDataAuthenticationOptions

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	Schema
api_key	onYourDataApiKeyAuthenticationOptions
connection_string	onYourDataConnectionStringAuthenticationOptions
key_and_key_id	onYourDataKeyAndKeyIdAuthenticationOptions
encoded_api_key	onYourDataEncodedApiKeyAuthenticationOptions
access_token	onYourDataAccessTokenAuthenticationOptions
system_assigned_managed_identity	onYourDataSystemAssignedManagedIdentityAuthenticationOptions
user_assigned_managed_identity	onYourDataUserAssignedManagedIdentityAuthenticationOptions
username_and_password	onYourDataUsernameAndPasswordAuthenticationOptions

Name	Typ	Description	Required	Default
typ	onYourDataAuthenticationType	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Yes

onYourDataContextProperty

Kontextová vlastnost.

Property	Value
Description	Kontextová vlastnost.
Type	řetězec
Values	citations intent all_retrieved_documents

onYourDataAuthenticationType

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

Property	Value
Description	Typy ověřování podporované v Azure OpenAI ve vašich datech.
Type	řetězec
Values	api_key connection_string key_and_key_id encoded_api_key access_token system_assigned_managed_identity user_assigned_managed_identity username_and_password

onYourDataApiKeyAuthenticationOptions

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

Name	Typ	Description	Required	Default
klíč	řetězec	Klíč rozhraní API, který se má použít k ověřování.	No
typ	onYourDataAuthenticationType	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Yes

onYourDataConnectionStringAuthenticationOptions

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

Name	Typ	Description	Required	Default
connection_string	řetězec	Připojovací řetězec použít k ověřování.	No
typ	onYourDataAuthenticationType	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Yes

onYourDataKeyAndKeyIdAuthenticationOptions

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.

Name	Typ	Description	Required	Default
klíč	řetězec	Klíč Elasticsearch, který se má použít k ověřování.	No
key_id	řetězec	ID klíče Elasticsearch, které se má použít k ověřování.	No
typ	onYourDataAuthenticationType	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Yes

onYourDataEncodedApiKeyAuthenticationOptions

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.

Name	Typ	Description	Required	Default
encoded_api_key	řetězec	Kódovaný klíč rozhraní API Elasticsearch, který se má použít k ověřování.	No
typ	onYourDataAuthenticationType	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Yes

onYourDataAccessTokenAuthenticationOptions

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

Name	Typ	Description	Required	Default
access_token	řetězec	Přístupový token, který se má použít k ověřování.	No
typ	onYourDataAuthenticationType	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Yes

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

Name	Typ	Description	Required	Default
typ	onYourDataAuthenticationType	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Yes

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

Name	Typ	Description	Required	Default
managed_identity_resource_id	řetězec	ID prostředku spravované identity přiřazené uživatelem, které se má použít k ověřování.	No
typ	onYourDataAuthenticationType	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Yes

onYourDataUsernameAndPasswordAuthenticationOptions

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

Name	Typ	Description	Required	Default
heslo	řetězec	Heslo. použít k ověřování.	No
typ	onYourDataAuthenticationType	Typy ověřování podporované v Azure OpenAI ve vašich datech.	Yes
uživatelské jméno	řetězec	Uživatelské jméno, které se má použít k ověřování.	No

onYourDataVectorizationSource

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

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

Hodnota typu	Schema
endpoint	onYourDataEndpointVectorizationSource
deployment_name	onYourDataDeploymentNameVectorizationSource
integrated	onYourDataIntegratedVectorizationSource
model_id	onYourDataModelIdVectorizationSource

Name	Typ	Description	Required	Default
typ	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.	Yes

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.

Property	Value
Description	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.
Type	řetězec
Values	endpoint deployment_name integrated model_id

onYourDataEndpointVectorizationSource

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

Name	Typ	Description	Required	Default
ověřování	onYourDataApiKeyAuthenticationOptions nebo onYourDataAccessTokenAuthenticationOptions		No
dimensions	integer	Počet dimenzí, které by měly mít vložené hodnoty. Podporováno pouze v text-embedding-3 novějších modelech.	No
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ý.	No
typ	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.	Yes

onYourDataDeploymentNameVectorizationSource

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

Name	Typ	Description	Required	Default
deployment_name	ř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.	No
dimensions	integer	Počet dimenzí, které by měly mít vložené hodnoty. Podporováno pouze v text-embedding-3 novějších modelech.	No
typ	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.	Yes

onYourDataIntegratedVectorizationSource

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

Name	Typ	Description	Required	Default
typ	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.	Yes

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

Name	Typ	Description	Required	Default
model_id	ř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ě.	No
typ	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.	Yes

azureChatExtensionsMessageContext

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

Name	Typ	Description	Required	Default
all_retrieved_documents	pole	Všechny načtené dokumenty.	No
citations	pole	Výsledek načtení zdroje dat použitý k vygenerování zprávy asistenta v odpovědi.	No
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.	No

citation

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

Name	Typ	Description	Required	Default
chunk_id	řetězec	ID bloku citace.	No
obsah	řetězec	Obsah citace.	Yes
filepath	řetězec	Cesta k souboru citace.	No
rerank_score	number	Skóre opětovného pořadí načteného dokumentu.	No
title	řetězec	Název citace.	No
url	řetězec	Adresa URL citace.	No

retrievedDocument

Načtený dokument.

Name	Typ	Description	Required	Default
chunk_id	řetězec	ID bloku citace.	No
obsah	řetězec	Obsah citace.	Yes
data_source_index	integer	Index zdroje dat.	No
filepath	řetězec	Cesta k souboru citace.	No
filter_reason	filterReason	Důvod filtrování načteného dokumentu.	No
original_search_score	number	Původní skóre hledání načteného dokumentu.	No
rerank_score	number	Skóre opětovného pořadí načteného dokumentu.	No
search_queries	pole	Vyhledávací dotazy použité k načtení dokumentu.	No
title	řetězec	Název citace.	No
url	řetězec	Adresa URL citace.	No

filterReason

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

Property	Value
Description	Důvod filtrování načteného dokumentu.
Type	řetězec
Values	score rerank

chatCompletionMessageToolCall

Name	Typ	Description	Required	Default
funkce	objekt	Funkce, kterou model volal.	Yes
└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.	No
└– název	řetězec	Název funkce, která se má volat.	No
id	řetězec	ID volání nástroje.	Yes
typ	toolCallType	Typ volání nástroje v tomto případě function.	Yes

toolCallType

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

Property	Value
Description	Typ volání nástroje v tomto případě function.
Type	řetězec
Values	function

chatCompletionRequestMessageTool

Name	Typ	Description	Required	Default
obsah	řetězec	Obsah zprávy.	No
tool_call_id	řetězec	Volání nástroje, na které tato zpráva reaguje.	No

chatCompletionRequestMessageFunction

Name	Typ	Description	Required	Default
obsah	řetězec	Obsah zprávy.	No
name	řetězec	Obsah zprávy.	No
role	výčet	Role autora zpráv v tomto případě function. Možné hodnoty: function	No

createChatCompletionResponse

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

Name	Typ	Description	Required	Default
choices	pole	Seznam možností dokončení chatu Pokud je větší než 1, může být více než jedna n .	Yes
created	integer	Časové razítko unixu (v sekundách) doby vytvoření dokončení chatu.	Yes
id	řetězec	Jedinečný identifikátor dokončení chatu.	Yes
model	řetězec	Model použitý k dokončení chatu.	Yes
objekt	výčet	Typ objektu, který je vždy chat.completion. Možné hodnoty: chat.completion	Yes
prompt_filter_results	promptFilterResults	Výsledky filtrování obsahu pro nulové nebo více výzev v požadavku V žádosti o streamování můžou výsledky různých výzev dorazit v různých časech nebo v různých objednávkách.	No
system_fingerprint	ř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.	No
využití	completionUsage	Statistiky využití žádosti o dokončení	No

createChatCompletionStreamResponse

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

Name	Typ	Description	Required	Default
choices	pole	Seznam možností dokončení chatu Může obsahovat více než jeden prvek, pokud n je větší než 1.	Yes
created	integer	Časové razítko unixu (v sekundách) doby vytvoření dokončení chatu. Každý blok dat má stejné časové razítko.	Yes
id	řetězec	Jedinečný identifikátor dokončení chatu. Každý blok dat má stejné ID.	Yes
model	řetězec	Model pro vygenerování dokončení.	Yes
objekt	výčet	Typ objektu, který je vždy chat.completion.chunk. Možné hodnoty: chat.completion.chunk	Yes
system_fingerprint	ř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.	No

chatCompletionStreamResponseDelta

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

Name	Typ	Description	Required	Default
obsah	řetězec	Obsah zprávy bloku dat.	No
function_call	objekt	Zastaralé a nahrazené .tool_calls Název a argumenty funkce, které by se měly volat, jak je vygeneroval model.	No
└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.	No
└– název	řetězec	Název funkce, která se má volat.	No
refusal	řetězec	Odmítnutí zprávy generované modelem.	No
role	výčet	Role autora této zprávy Možné hodnoty: system, user, assistant, tool	No
tool_calls	pole		No

chatCompletionMessageToolCallChunk

Name	Typ	Description	Required	Default
funkce	objekt		No
└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.	No
└– název	řetězec	Název funkce, která se má volat.	No
id	řetězec	ID volání nástroje.	No
index	integer		Yes
typ	výčet	Typ nástroje. V současné době se podporuje pouze function . Možné hodnoty: function	No

chatCompletionStreamOptions

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

Name	Typ	Description	Required	Default
include_usage	boolean	V případě nastavení se před zprávou data: [DONE] streamuje další blok dat. Pole usage na tomto bloku dat zobrazuje statistiku využití tokenu pro celý požadavek a choices pole bude vždy prázdné pole. Všechny ostatní bloky dat budou obsahovat usage také pole, ale s hodnotou null.	No

chatCompletionChoiceLogProbs

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

Name	Typ	Description	Required	Default
obsah	pole	Seznam tokenů obsahu zpráv s informacemi o pravděpodobnosti protokolu	Yes
refusal	pole	Seznam tokenů odmítnutí zpráv s informacemi o pravděpodobnosti protokolu.	No

chatCompletionTokenLogprob

Name	Typ	Description	Required	Default
bytes	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ů.	Yes
logprob	number	Pravděpodobnost protokolu tohoto tokenu.	Yes
token	řetězec	Token.	Yes
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.	Yes

chatCompletionResponseMessage

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

Name	Typ	Description	Required	Default
audio	objekt	Pokud je požadován režim zvukového výstupu, tento objekt obsahuje data o zvukové odpovědi z modelu.	No
└- data	řetězec	Bajty zvuku vygenerované modelem v kódování Base64 ve formátu zadaném v požadavku	No
└- vyprší_dne	integer	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.	No
└- ID	řetězec	Jedinečný identifikátor této zvukové odpovědi.	No
└- přepis	řetězec	Přepis zvuku vygenerovaného modelem	No
obsah	řetězec	Obsah zprávy.	Yes
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í.	No
function_call	chatCompletionFunctionCall	Zastaralé a nahrazené .tool_calls Název a argumenty funkce, které by se měly volat, jak je vygeneroval model.	No
refusal	řetězec	Odmítnutí zprávy generované modelem.	Yes
role	chatCompletionResponseMessageRole	Role autora zprávy odpovědi	Yes
tool_calls	pole	Nástroj volá volání vygenerovaná modelem, například volání funkcí.	No

chatCompletionResponseMessageRole

Role autora zprávy odpovědi

Property	Value
Description	Role autora zprávy odpovědi
Type	řetězec
Values	assistant

chatCompletionToolChoiceOption

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

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

• chatCompletionNamedToolChoice

chatCompletionNamedToolChoice

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

Name	Typ	Description	Required	Default
funkce	objekt		Yes
└– název	řetězec	Název funkce, která se má volat.	No
typ	výčet	Typ nástroje. V současné době se podporuje pouze function . Možné hodnoty: function	Yes

ParallelToolCalls

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

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

PredictionContent

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

Name	Typ	Description	Required	Default
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.	Yes
typ	výčet	Typ predikovaného obsahu, který chcete poskytnout. Tento typ je nyní vždy content. Možné hodnoty: content	Yes

chatCompletionMessageToolCalls

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

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

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

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

chatCompletionFunctionCall

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

Name	Typ	Description	Required	Default
arguments	ř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.	Yes
name	řetězec	Název funkce, která se má volat.	Yes

completionUsage

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

Name	Typ	Description	Required	Default
completion_tokens	integer	Počet tokenů ve vygenerovaném dokončení	Yes
completion_tokens_details	objekt	Rozpis tokenů použitých při dokončování	No
└──────────přijaté_predikční_tokeny	integer	Při použití předpovídané výstupy počet tokenů v predikci, která se objevila v dokončení.	No
└audio_tokens	integer	Zvukové vstupní tokeny vygenerované modelem	No
└─ "reasoning_tokens"	integer	Tokeny vygenerované modelem z důvodu odůvodnění	No
└─ odmítnuté_predikční_toky	integer	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.	No
prompt_tokens	integer	Počet tokenů v příkazovém řádku	Yes
prompt_tokens_details	objekt	Podrobnostioch	No
└audio_tokens	integer	Vstupní zvukové tokeny, které jsou přítomné na příkazovém řádku.	No
└─ uložené_tokény	integer	Počet tokenů výzvy uložených v mezipaměti.	No
total_tokens	integer	Celkový počettokench	Yes

chatCompletionTool

Name	Typ	Description	Required	Default
funkce	FunctionObject		Yes
typ	výčet	Typ nástroje. V současné době se podporuje pouze function . Možné hodnoty: function	Yes

FunctionParameters

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

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

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

FunctionObject

Name	Typ	Description	Required	Default
description	řetězec	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.	No
name	ř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.	Yes
parameters	FunctionParameters	Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON. Příklady najdete v příručce a referenční informace ke schématu JSON pro dokumentaci k formátu. Vynechání parameters definuje funkci s prázdným seznamem parametrů.	No
strict	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. Pokud je stricttrue, podporuje se pouze podmnožina schématu JSON.	No	False

ResponseFormatText

Name	Typ	Description	Required	Default
typ	výčet	Typ formátu odpovědi, který se definuje: text Možné hodnoty: text	Yes

ResponseFormatJsonObject

Name	Typ	Description	Required	Default
typ	výčet	Typ formátu odpovědi, který se definuje: json_object Možné hodnoty: json_object	Yes

ResponseFormatJsonSchemaSchema

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

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

ResponseFormatJsonSchema

Name	Typ	Description	Required	Default
json_schema	objekt		Yes
└- popis	řetězec	Popis formátu odpovědi, který model používá k určení způsobu reakce v tomto formátu.	No
└– 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.	No
└- schéma	ResponseFormatJsonSchemaSchema	Schéma pro formát odpovědi popsané jako objekt schématu JSON.	No
└- 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. Pokud je stricttrue, podporuje se pouze podmnožina schématu JSON.	No	False
typ	výčet	Typ formátu odpovědi, který se definuje: json_schema Možné hodnoty: json_schema	Yes

chatCompletionChoiceCommon

Name	Typ	Description	Required	Default
finish_reason	řetězec		No
index	integer		No

createTranslationRequest

Žádost o překlad

Name	Typ	Description	Required	Default
soubor	řetězec	Zvukový soubor, který chcete přeložit.	Yes
požádat	řetězec	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla být v angličtině.	No
response_format	audioResponseFormat	Definuje formát výstupu.	No
temperature	number	Teplota vzorkování mezi 0 a 1. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Pokud je nastavená hodnota na 0, model používá logaritmickou pravděpodobnost k automatickému zvýšení teploty, dokud nejsou dosaženy určité prahové hodnoty.	No	0

audioResponse

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

Name	Typ	Description	Required	Default
poslat SMS	řetězec	Přeložený nebo přepisovaný text	Yes

audioVerboseResponse

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

Name	Typ	Description	Required	Default
duration	number	Duration.	No
jazyk	řetězec	Language.	No
segments	pole		No
úkol	řetězec	Typ zvukového úkolu.	No
poslat SMS	řetězec	Přeložený nebo přepisovaný text	Yes
words	pole		No

audioResponseFormat

Definuje formát výstupu.

Property	Value
Description	Definuje formát výstupu.
Type	řetězec
Values	json text srt verbose_json vtt

createTranscriptionRequest

Žádost o přepis

Name	Typ	Description	Required	Default
soubor	řetězec	Objekt zvukového souboru, který se má přepisovat.	Yes
jazyk	řetězec	Jazyk vstupního zvuku. Poskytování jazyka zadávání vstupu ve formátu ISO-639-1 zlepšuje přesnost a latenci.	No
požádat	řetězec	Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla odpovídat jazyku zvuku.	No
response_format	audioResponseFormat	Definuje formát výstupu.	No
temperature	number	Teplota vzorkování mezi 0 a 1. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Pokud je nastavená hodnota na 0, model používá logaritmickou pravděpodobnost k automatickému zvýšení teploty, dokud nejsou dosaženy určité prahové hodnoty.	No	0
timestamp_granularities[]	pole	Členitosti časového razítka, které se mají pro tento přepis naplnit. response_format musí být nastavená verbose_json tak, aby používala členitosti časového razítka. Podporují se obě tyto možnosti: wordnebo segment. Poznámka: U časových označení segmentů není žádná další latence, ale generování časových označení slov způsobuje další latenci.	No	['segment']

audioSegment

Přepis nebo segment překladu

Name	Typ	Description	Required	Default
avg_logprob	number	Průměrná pravděpodobnost protokolu.	No
compression_ratio	number	Poměr komprese.	No
end	number	Odsazení konce segmentu	No
id	integer	Identifikátor segmentu.	No
no_speech_prob	number	Pravděpodobnost "bez řeči".	No
seek	number	Posun segmentu.	No
start	number	Odsazení začátku segmentu	No
temperature	number	Temperature.	No
poslat SMS	řetězec	Segmentace textu	No
tokens	pole	Tokeny textu	No

audioWord

Přepis nebo překlad slova

Name	Typ	Description	Required	Default
end	number	Odsazení konce wordu	No
start	number	Začátek wordového posunu	No
slovo	řetězec	Word	No

createSpeechRequest

Žádost o řeč

Name	Typ	Description	Required	Default
vstup	řetězec	Text pro syntetizaci zvuku. Maximální délka je 4 096 znaků.	Yes
response_format	výčet	Formát syntetizování zvuku v. Možné hodnoty: mp3, opus, aac, flac, wavpcm	No
speed	number	Rychlost syntetizovaného zvuku. Vyberte hodnotu od 0.25 do 4.0. 1.0 je výchozí.	No	1.0
voice	výčet	Hlas, který se má použít pro syntézu řeči. Možné hodnoty: alloy, echo, fable, onyx, novashimmer	Yes

imageQuality

Kvalita image, která se vygeneruje.

Property	Value
Description	Kvalita image, která se vygeneruje.
Type	řetězec
Default	auto
Values	auto high medium low hd standard

imagesResponseFormat

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

Property	Value
Description	Formát, ve kterém se vrátí vygenerované obrázky.
Type	řetězec
Default	url
Values	url b64_json

imagesOutputFormat

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

Property	Value
Description	Formát souboru, ve kterém se vrátí vygenerované obrázky. Podporováno pouze pro gpt-image-1.
Type	řetězec
Default	png
Values	png jpeg

imageSize

Velikost vygenerovaných obrázků.

Property	Value
Description	Velikost vygenerovaných obrázků.
Type	řetězec
Default	auto
Values	auto 1792x1024 1024x1792 1024x1024 1024x1536 1536x1024

imageStyle

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

Property	Value
Description	Styl vygenerovaných obrázků Podporováno pouze pro dall-e-3.
Type	řetězec
Default	vivid
Values	vivid natural

imageBackground

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

Property	Value
Description	Umožňuje nastavit průhlednost pozadí vygenerovaných obrázků. Tento parametr je podporován pouze pro gpt-image-1.
Type	řetězec
Default	auto
Values	transparent opaque auto

imageGenerationsRequest

Name	Typ	Description	Required	Default
na pozadí	imageBackground	Umožňuje nastavit průhlednost pozadí vygenerovaných obrázků. Tento parametr je podporován pouze pro gpt-image-1.	No	auto
n	integer	Počet obrázků, které se mají vygenerovat. Pro dall-e-3 se podporuje pouze n=1.	No	1
output_compression	integer	Ú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.	No	100
output_format	imagesOutputFormat	Formát souboru, ve kterém se vrátí vygenerované obrázky. Podporováno pouze pro gpt-image-1.	No	png
požádat	řetězec	Textový popispožadovaných Maximální délka je 32000 znaků pro gpt-image-1 a 4000 znaků pro dall-e-3.	Yes
quality	imageQuality	Kvalita image, která se vygeneruje.	No	auto
response_format	imagesResponseFormat	Formát, ve kterém se vrátí vygenerované obrázky. Podporováno pouze pro dall-e-3.	No	url
size	imageSize	Velikost vygenerovaných obrázků.	No	auto
styl	imageStyle	Styl vygenerovaných obrázků Podporováno pouze pro dall-e-3.	No	vivid
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í.	No

imageEditsRequest

Name	Typ	Description	Required	Default
bitová kopie	ř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.	Yes
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.	No
n	integer	Počet obrázků, které se mají vygenerovat.	No	1
požádat	řetězec	Textový popispožadovaných Maximální délka je 32000 znaků.	Yes
quality	imageQuality	Kvalita image, která se vygeneruje.	No	auto
response_format	imagesResponseFormat	Formát, ve kterém se vrátí vygenerované obrázky.	No	url
size	imageSize	Velikost vygenerovaných obrázků.	No	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í.	No

generateImagesResponse

Name	Typ	Description	Required	Default
created	integer	Časové razítko unixu při vytvoření operace.	Yes
data	pole	Výsledná data operace, pokud jsou úspěšná	Yes
využití	imageGenerationsUsage	Představuje podrobnosti o využití tokenu pro žádosti o generování imagí. Pouze pro gpt-image-1.	No

imageResult

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

Name	Typ	Description	Required	Default
b64_json	řetězec	Zakódovaný obrázek base64	No
content_filter_results	dalleContentFilterResults	Informace o výsledcích filtrování obsahu	No
prompt_filter_results	dalleFilterResults	Informace o kategorii filtrování obsahu (nenávist, sexuální, násilí, self_harm), pokud byla zjištěna, a také úroveň závažnosti (very_low, nízká, střední, vysoká, která určuje intenzitu a úroveň rizika škodlivého obsahu) a jestli byla filtrována nebo ne. Informace o obsahu jailbreaku a vulgárních výrazech, pokud byly zjištěny, a pokud byly filtrovány nebo ne. A informace o seznamu blokovaných zákazníků, pokud byl filtrován a jeho ID.	No
revised_prompt	řetězec	Výzva, která byla použita k vygenerování obrázku, pokud došlo k nějaké revizi výzvy.	No
url	řetězec	Adresa URL obrázku.	No

imageGenerationsUsage

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

Name	Typ	Description	Required	Default
input_tokens	integer	Počet vstupních tokenů.	No
input_tokens_details	objekt	Podrobný rozpis vstupních tokenů	No
└image_tokens	integer	Počet tokenů image.	No
└text_tokens	integer	Počet textových tokenů	No
output_tokens	integer	Počet výstupních tokenů	No
total_tokens	integer	Celkový počet použitých tokenů	No

čára

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

Name	Typ	Description	Required	Default
spans	pole	Pole rozsahů, které představují zjištěné objekty a informace o ohraničujícím rámečku.	Yes
poslat SMS	řetězec		Yes

span

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

Name	Typ	Description	Required	Default
length	integer	Délka rozsahu znaků měřená v bodech kódu Unicode.	Yes
posun	integer	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.	Yes
mnohoúhelník	pole	Pole objektů představujících body v mnohoúhelníku, které ohraničují rozpoznaný objekt.	Yes
poslat SMS	řetězec	Textový obsah rozsahu, který představuje zjištěný objekt.	Yes

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

Name	Typ	Description	Required	Default
completion_tokens	integer	Počet tokenů dokončení použitých v průběhu spuštění	Yes
prompt_tokens	integer	Počet výzev tokenů použitých v průběhu spuštění	Yes
total_tokens	integer	Celkový počet použitých tokenů (výzva + dokončení).	Yes

runStepCompletionUsage

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

Name	Typ	Description	Required	Default
completion_tokens	integer	Počet tokenů dokončení použitých v průběhu kroku spuštění	Yes
prompt_tokens	integer	Počet výzev tokenů použitých v průběhu kroku spuštění	Yes
total_tokens	integer	Celkový počet použitých tokenů (výzva + dokončení).	Yes

assistantsApiResponseFormatOption

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

{ "type": "json_schema", "json_schema": {...} } Nastavením povolíte strukturované výstupy, které zajistí, že model odpovídá 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
• ResponseFormatJsonSchema

assistantsApiResponseFormat

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.

Name	Typ	Description	Required	Default
typ	řetězec	Musí to být jeden z text nebo json_object.	No	poslat SMS

type Enum: FormátOdpovědiAsistentaAPI

Value	Description
poslat SMS
json_object

assistantObject

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

Name	Typ	Description	Required	Default
created_at	integer	Časové razítko unixu (v sekundách) pro vytvoření asistenta.	Yes
description	řetězec	Popis asistenta. Maximální délka je 512 znaků.	Yes
id	řetězec	Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.	Yes
instructions	řetězec	Systémové pokyny, které asistent používá. Maximální délka je 256 000 znaků.	Yes
metadata	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ů.	Yes
model	řetězec	ID modelu, který se má použít.	Yes
name	řetězec	Jméno asistenta. Maximální délka je 256 znaků.	Yes
objekt	řetězec	Typ objektu, který je vždy assistant.	Yes
response_format	assistantsApiResponseFormatOption	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 { "type": "json_schema", "json_schema": {...} } Nastavením povolíte strukturované výstupy, které zajistí, že model odpovídá 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.	No
temperature	number	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.	No	1
tool_resources	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ů.	No
└ code_interpreter	objekt		No
└- 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ů.	No	[]
└file_search	objekt		No
└─ 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ě.	No
tools	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.	Yes	[]
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.	No	1

object Enum: AssistantObjectType

Value	Description
asistent	Typ objektu, který je vždy pomocníkem

createAssistantRequest

Name	Typ	Description	Required	Default
description	řetězec	Popis asistenta. Maximální délka je 512 znaků.	No
instructions	řetězec	Systémové pokyny, které asistent používá. Maximální délka je 256 000 znaků.	No
metadata	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ů.	No
model	řetězec		Yes
name	řetězec	Jméno asistenta. Maximální délka je 256 znaků.	No
response_format	assistantsApiResponseFormatOption	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 { "type": "json_schema", "json_schema": {...} } Nastavením povolíte strukturované výstupy, které zajistí, že model odpovídá 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.	No
temperature	number	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.	No	1
tool_resources	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ů.	No
└ code_interpreter	objekt		No
└- 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ů.	No	[]
└file_search	objekt		No
└─ 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ě.	No
└ 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ě.	No
tools	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.	No	[]
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.	No	1

modifyAssistantRequest

Name	Typ	Description	Required	Default
description	řetězec	Popis asistenta. Maximální délka je 512 znaků.	No
instructions	řetězec	Systémové pokyny, které asistent používá. Maximální délka je 32768 znaků.	No
metadata	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ů.	No
model	řetězec		No
name	řetězec	Jméno asistenta. Maximální délka je 256 znaků.	No
response_format	assistantsApiResponseFormatOption	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 { "type": "json_schema", "json_schema": {...} } Nastavením povolíte strukturované výstupy, které zajistí, že model odpovídá 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.	No
temperature	number	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.	No	1
tool_resources	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ů.	No
└ code_interpreter	objekt		No
└- 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ů.	No	[]
└file_search	objekt		No
└─ 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ě.	No
tools	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.	No	[]
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.	No	1

deleteAssistantResponse

Name	Typ	Description	Required	Default
deleted	boolean		Yes
id	řetězec		Yes
objekt	řetězec		Yes

object Enum: DeleteAssistantResponseState

Value	Description
assistant.deleted

listAssistantsResponse

Name	Typ	Description	Required	Default
data	pole		Yes
first_id	řetězec		Yes
has_more	boolean		Yes
last_id	řetězec		Yes
objekt	řetězec		Yes

assistantToolsCode

Name	Typ	Description	Required	Default
typ	řetězec	Typ definovaného nástroje: code_interpreter	Yes

typ Enum: assistantToolsCodeType

Value	Description
code_interpreter

assistantToolsFileSearch

Name	Typ	Description	Required	Default
file_search	objekt	Přepisy pro nástroj pro vyhledávání souborů.	No
└max_num_results	integer	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.	No
typ	řetězec	Typ definovaného nástroje: file_search	Yes

typ Enum: assistantToolsFileSearchType

Value	Description
file_search

assistantToolsFileSearchTypeOnly

Name	Typ	Description	Required	Default
typ	řetězec	Typ definovaného nástroje: file_search	Yes

typ Enum: assistantToolsFileSearchType

Value	Description
file_search

assistantToolsFunction

Name	Typ	Description	Required	Default
funkce	objekt	Definice funkce.	Yes
└- popis	řetězec	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.	No
└– 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.	No
└– 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.	No
typ	řetězec	Typ definovaného nástroje: function	Yes

typ Enum: funkce asistenčního nástroje

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

Name	Typ	Description	Required	Default
last_messages	integer	Počet nejnovějších zpráv z vlákna při vytváření kontextu pro spuštění.	No
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.	Yes

type Enum: Typ zkrácení

Value	Description
auto
last_messages

assistantsApiToolChoiceOption

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

assistantsNamedToolChoice

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

Name	Typ	Description	Required	Default
funkce	objekt		No
└– název	řetězec	Název funkce, která se má volat.	No
typ	řetězec	Typ nástroje. Pokud je functiontyp, musí být nastaven název funkce.	Yes

typ Enum: AssistantsNamedToolChoiceType

Value	Description
funkce
code_interpreter
file_search

runObject

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

Name	Typ	Description	Required	Default
assistant_id	řetězec	ID asistenta použitého ke spuštění tohoto spuštění.	Yes
cancelled_at	integer	Časové razítko unixu (v sekundách) pro zrušení spuštění.	Yes
completed_at	integer	Časové razítko unixu (v sekundách) pro dokončení spuštění.	Yes
created_at	integer	Časové razítko unixu (v sekundách) pro vytvoření spuštění.	Yes
expires_at	integer	Časové razítko unixu (v sekundách) pro vypršení platnosti spuštění.	Yes
failed_at	integer	Časové razítko unixu (v sekundách) pro dobu, kdy se spuštění nezdařilo.	Yes
id	řetězec	Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.	Yes
incomplete_details	objekt	Podrobnosti o tom, proč je spuštění neúplné. Bude v null případě, že spuštění není neúplné.	Yes
└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í.	No
instructions	řetězec	Pokyny, které pomocník použil pro toto spuštění.	Yes
last_error	objekt	Poslední chyba přidružená k tomuto spuštění. null Pokud nedojde k žádným chybám.	Yes
└ kód	řetězec	Jedna z možností: server_error nebo rate_limit_exceeded	No
└- zpráva	řetězec	Popis chyby čitelný člověkem.	No
max_completion_tokens	integer	Maximální počet tokenů dokončení určených k použití v průběhu spuštění.	Yes
max_prompt_tokens	integer	Maximální počet výzev tokenů zadaných k použití v průběhu spuštění.	Yes
metadata	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ů.	Yes
model	řetězec	Model, který pomocník použil pro toto spuštění.	Yes
objekt	řetězec	Typ objektu, který je vždy thread.run.	Yes
parallel_tool_calls	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	No	True
required_action	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á.	Yes
└─ odeslat_výstupy_nástrojů	objekt	Podrobnosti o výstupech nástrojů potřebných k pokračování tohoto běhu.	No
└tool_calls	pole	Seznam příslušných volání nástrojů.	No
└- typ	výčet	Prozatím je to vždy submit_tool_outputs. Možné hodnoty: submit_tool_outputs	No
response_format	assistantsApiResponseFormatOption	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 { "type": "json_schema", "json_schema": {...} } Nastavením povolíte strukturované výstupy, které zajistí, že model odpovídá 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.	Yes
started_at	integer	Časové razítko unixu (v sekundách) pro spuštění spuštění.	Yes
stav	řetězec	Stav spuštění, který může být buď , , , , , , queued, , , in_progressnebo requires_action. cancellingcancelledfailedcompletedexpired	Yes
temperature	number	Teplota vzorkování použitá pro toto spuštění. Pokud není nastavená, výchozí hodnota je 1.	No
thread_id	řetězec	ID vláken, na kterých bylo spuštěno jako součást tohoto spuštění.	Yes
tool_choice	assistantsApiToolChoiceOption	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.	Yes
tools	pole	Seznam nástrojů, které pomocník použil pro toto spuštění.	Yes	[]
top_p	number	Hodnota vzorkování jádra použitá pro toto spuštění. Pokud není nastavená, výchozí hodnota je 1.	No
truncation_strategy	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í.	Yes
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.).	Yes

object Enum: runObjectType

Value	Description
thread.run	Typ objektu run, který je vždy thread.run

status Enum: RunObjectStatus

Value	Description
ve frontě	Stav zařazený do fronty
in_progress	Stav in_progress
requires_action	Stav required_action
cancelling	Stav zrušení
cancelled	Zrušený stav
failed	Stav selhání
completed	Dokončený stav
expired	Stav s vypršenou platností

createRunRequest

Name	Typ	Description	Required	Default
additional_instructions	ř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í.	No
additional_messages	pole	Před vytvořením spuštění přidá do vlákna další zprávy.	No
assistant_id	řetězec	ID pomocníka, který se má použít ke spuštění tohoto spuštění.	Yes
instructions	ř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í.	No
max_completion_tokens	integer	Maximální počet tokenů dokončení, které lze použít v průběhu spuštění. Spuštění co nejlépe využívá pouze specifikovaný počet dokončovacích tokenů, a to během několika cyklů spuštění. Pokud spuštění překročí zadaný počet tokenů dokončení, spuštění skončí stavem incomplete. Další informace najdete v incomplete_details.	No
max_prompt_tokens	integer	Maximální počet výzev tokenů, které se můžou použít v průběhu spuštění. Spuštění se maximálně snaží použít pouze specifikovaný počet tokenů výzvy během několika fází spuštění. Pokud spuštění překročí zadaný počet zadaných tokenů výzvy, spuštění skončí se stavem incomplete. Další informace najdete v incomplete_details.	No
metadata	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ů.	No
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.	No
parallel_tool_calls	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	No	True
response_format	assistantsApiResponseFormatOption	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 { "type": "json_schema", "json_schema": {...} } Nastavením povolíte strukturované výstupy, které zajistí, že model odpovídá 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.	No
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] .	No
temperature	number	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.	No	1
tool_choice	assistantsApiToolChoiceOption	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.	No
tools	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í.	No
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.	No	1
truncation_strategy	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í.	No

listRunsResponse

Name	Typ	Description	Required	Default
data	pole		Yes
first_id	řetězec		Yes
has_more	boolean		Yes
last_id	řetězec		Yes
objekt	řetězec		Yes

modifyRunRequest

Name	Typ	Description	Required	Default
metadata	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ů.	No

submitToolOutputsRunRequest

Name	Typ	Description	Required	Default
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] .	No
tool_outputs	pole	Seznam nástrojů, pro které se odesílají výstupy.	Yes

runToolCallObject

Objekty volání nástrojů

Name	Typ	Description	Required	Default
funkce	objekt	Definice funkce.	Yes
└argumenty	řetězec	Argumenty, které model očekává, že funkci předáte.	No
└– název	řetězec	Název funkce.	No
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.	Yes
typ	řetězec	Typ volání nástroje vyžaduje výstup. Prozatím je to vždy function.	Yes

type Enum: RunToolCallObjectType

Value	Description
funkce

createThreadAndRunRequest

Name	Typ	Description	Required	Default
assistant_id	řetězec	ID pomocníka, který se má použít ke spuštění tohoto spuštění.	Yes
instructions	ř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í.	No
max_completion_tokens	integer	Maximální počet tokenů dokončení, které lze použít v průběhu spuštění. Spuštění co nejlépe využívá pouze specifikovaný počet dokončovacích tokenů, a to během několika cyklů spuštění. Pokud spuštění překročí zadaný počet tokenů dokončení, spuštění skončí stavem incomplete. Další informace najdete v incomplete_details.	No
max_prompt_tokens	integer	Maximální počet výzev tokenů, které se můžou použít v průběhu spuštění. Spuštění se maximálně snaží použít pouze specifikovaný počet tokenů výzvy během několika fází spuštění. Pokud spuštění překročí zadaný počet zadaných tokenů výzvy, spuštění skončí se stavem incomplete. Další informace najdete v incomplete_details.	No
metadata	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ů.	No
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.	No
parallel_tool_calls	ParallelToolCalls	Zda se má povolit paralelní volání funkcí během použití nástroje.	No	True
response_format	assistantsApiResponseFormatOption	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 { "type": "json_schema", "json_schema": {...} } Nastavením povolíte strukturované výstupy, které zajistí, že model odpovídá 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.	No
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] .	No
stream_options	chatCompletionStreamOptions	Možnosti pro odpověď streamování Toto nastavení nastavíte pouze při nastavení stream: true.	No	None
temperature	number	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.	No	1
podproces	createThreadRequest		No
tool_choice	assistantsApiToolChoiceOption	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.	No
tool_resources	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ů.	No
└ code_interpreter	objekt		No
└- 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ů.	No	[]
└file_search	objekt		No
└─ 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ě.	No
tools	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í.	No
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.	No	1
truncation_strategy	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í.	No

threadObject

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

Name	Typ	Description	Required	Default
created_at	integer	Časové razítko unixu (v sekundách) pro vytvoření vlákna.	Yes
id	řetězec	Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.	Yes
metadata	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ů.	Yes
objekt	řetězec	Typ objektu, který je vždy thread.	Yes
tool_resources	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ů.	Yes
└ code_interpreter	objekt		No
└- 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ů.	No	[]
└file_search	objekt		No
└─ 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ě.	No

object Enum: ThreadObjectType

Value	Description
podproces	Typ objektu vlákna, který je vždy thread

createThreadRequest

Name	Typ	Description	Required	Default
messages	pole	Seznam zpráv, se kterými se má vlákno spustit.	No
metadata	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ů.	No
tool_resources	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ů.	No
└ code_interpreter	objekt		No
└- 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ů.	No	[]
└file_search	objekt		No
└─ 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ě.	No
└ 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ě.	No

modifyThreadRequest

Name	Typ	Description	Required	Default
metadata	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ů.	No
tool_resources	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ů.	No
└ code_interpreter	objekt		No
└- 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ů.	No	[]
└file_search	objekt		No
└─ 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ě.	No

deleteThreadResponse

Name	Typ	Description	Required	Default
deleted	boolean		Yes
id	řetězec		Yes
objekt	řetězec		Yes

object Enum: DeleteThreadResponseObjectState

Value	Description
thread.deleted	Stav objektu odpovědi na odstranění vlákna, který je thread.deleted

listThreadsResponse

Name	Typ	Description	Required	Default
data	pole		Yes
first_id	řetězec		Yes
has_more	boolean		Yes
last_id	řetězec		Yes
objekt	řetězec		Yes

messageObject

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

Name	Typ	Description	Required	Default
assistant_id	řetězec	Pokud je to možné, ID asistenta, který tuto zprávu vytvořil.	Yes
attachments	pole	Seznam souborů připojených ke zprávě a nástroje, do které byly přidány.	Yes
completed_at	integer	Časové razítko unixu (v sekundách) pro dokončení zprávy.	Yes
obsah	pole	Obsah zprávy v poli textu nebo obrázků.	Yes
created_at	integer	Časové razítko unixu (v sekundách) pro vytvoření zprávy.	Yes
id	řetězec	Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.	Yes
incomplete_at	integer	Časové razítko unixu (v sekundách) pro dobu, kdy byla zpráva označena jako neúplná.	Yes
incomplete_details	objekt	V neúplné zprávě jsou podrobnosti o tom, proč je zpráva neúplná.	Yes
└důvod	řetězec	Důvod, proč je zpráva neúplná.	No
metadata	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ů.	Yes
objekt	řetězec	Typ objektu, který je vždy thread.message.	Yes
role	řetězec	Entita, která zprávu vytvořila. Jedna z možností: user nebo assistant	Yes
run_id	řetězec	Pokud je to možné, ID spuštění přidruženého k vytváření této zprávy.	Yes
stav	řetězec	Stav zprávy, která může být buď in_progress, incompletenebo completed.	Yes
thread_id	řetězec	ID vláken, do kterého tato zpráva patří.	Yes

object Enum: MessageObjectType

Value	Description
thread.message	Typ objektu zprávy, který je thread.message

status Enum: Status objektu zprávy

Value	Description
in_progress
incomplete
completed

role Enum: MessageObjectRole

Value	Description
uživatel
asistent

messageDeltaObject

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

Name	Typ	Description	Required	Default
delta	objekt	Rozdíl obsahující pole, která se změnila ve zprávě.	Yes
└- obsah	pole	Obsah zprávy v poli textu nebo obrázků.	No
Role └•	řetězec	Entita, která zprávu vytvořila. Jedna z možností: user nebo assistant	No
id	řetězec	Identifikátor zprávy, na kterou lze odkazovat v koncových bodech rozhraní API.	Yes
objekt	řetězec	Typ objektu, který je vždy thread.message.delta.	Yes

objekt Enum: MessageDeltaObjectType

Value	Description
thread.message.delta

createMessageRequest

Name	Typ	Description	Required	Default
attachments	pole	Seznam souborů připojených ke zprávě a nástroje, do které by se měly přidat.	No
obsah	řetězec	Obsah zprávy.	Yes
metadata	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ů.	No
role	ř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.	Yes

role Enum: Role pro vytváření požadavků na zprávy

Value	Description
uživatel
asistent

modifyMessageRequest

Name	Typ	Description	Required	Default
metadata	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ů.	No

deleteMessageResponse

Name	Typ	Description	Required	Default
deleted	boolean		Yes
id	řetězec		Yes
objekt	řetězec		Yes

object Enum: DeleteMessageResponseObject

Value	Description
thread.message.deleted	Stav objektu odpovědi na odstranění zprávy

listMessagesResponse

Name	Typ	Description	Required	Default
data	pole		Yes
first_id	řetězec		Yes
has_more	boolean		Yes
last_id	řetězec		Yes
objekt	řetězec		Yes

messageContentImageFileObject

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

Name	Typ	Description	Required	Default
image_file	objekt		Yes
└ file_id	řetězec	ID souboru obrázku v obsahu zprávy.	No
typ	řetězec	Vždy image_file.	Yes

type Enum: Typ objektu souboru obrazů MessageContentImageFileObjectType

Value	Description
image_file	Typ souboru obrázku obsahu zprávy

messageContentTextObject

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

Name	Typ	Description	Required	Default
poslat SMS	objekt		Yes
└– poznámky	pole		No
└– hodnota	řetězec	Data, která tvoří text.	No
typ	řetězec	Vždy text.	Yes

type Enum: messageContentTextObjectType

Value	Description
poslat SMS	Typ textového objektu obsahu zprávy

messageContentTextAnnotationsFileCitationObject

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

Name	Typ	Description	Required	Default
end_index	integer		Yes
file_citation	objekt		Yes
└ file_id	řetězec	ID konkrétního souboru, ze které citace pochází.	No
start_index	integer		Yes
poslat SMS	řetězec	Text v obsahu zprávy, který je potřeba nahradit.	Yes
typ	řetězec	Vždy file_citation.	Yes

typ Enum: FileCitationObjectType

Value	Description
file_citation	Typ objektu citace souboru

messageContentTextAnnotationsFilePathObject

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

Name	Typ	Description	Required	Default
end_index	integer		Yes
file_path	objekt		Yes
└ file_id	řetězec	ID vygenerovaného souboru.	No
start_index	integer		Yes
poslat SMS	řetězec	Text v obsahu zprávy, který je potřeba nahradit.	Yes
typ	řetězec	Vždy file_path.	Yes

typ Enum: FilePathObjectType

Value	Description
file_path	Typ objektu cesty k souboru

messageDeltaContentImageFileObject

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

Name	Typ	Description	Required	Default
image_file	objekt		No
└ file_id	řetězec	ID souboru obrázku v obsahu zprávy.	No
index	integer	Index části obsahu ve zprávě.	Yes
typ	řetězec	Vždy image_file.	Yes

type Enum: MessageDeltaContentImageFileObjectType

Value	Description
image_file

messageDeltaContentTextObject

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

Name	Typ	Description	Required	Default
index	integer	Index části obsahu ve zprávě.	Yes
poslat SMS	objekt		No
└– poznámky	pole		No
└– hodnota	řetězec	Data, která tvoří text.	No
typ	řetězec	Vždy text.	Yes

type Enum: MessageDeltaContentTextObjectType

Value	Description
poslat SMS

messageDeltaContentTextAnnotationsFileCitationObject

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

Name	Typ	Description	Required	Default
end_index	integer		No
file_citation	objekt		No
└ file_id	řetězec	ID konkrétního souboru, ze které citace pochází.	No
└- citace	řetězec	Konkrétní citace v souboru.	No
index	integer	Index poznámky v textové části obsahu.	Yes
start_index	integer		No
poslat SMS	řetězec	Text v obsahu zprávy, který je potřeba nahradit.	No
typ	řetězec	Vždy file_citation.	Yes

type Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

Value	Description
file_citation

messageDeltaContentTextAnnotationsFilePathObject

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

Name	Typ	Description	Required	Default
end_index	integer		No
file_path	objekt		No
└ file_id	řetězec	ID vygenerovaného souboru.	No
index	integer	Index poznámky v textové části obsahu.	Yes
start_index	integer		No
poslat SMS	řetězec	Text v obsahu zprávy, který je potřeba nahradit.	No
typ	řetězec	Vždy file_path.	Yes

type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

Value	Description
file_path

runStepObject

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

Name	Typ	Description	Required	Default
assistant_id	řetězec	ID asistenta přidruženého ke kroku spuštění.	Yes
cancelled_at	integer	Časové razítko unixu (v sekundách) pro zrušení kroku spuštění.	Yes
completed_at	integer	Časové razítko unixu (v sekundách) pro dokončení kroku spuštění.	Yes
created_at	integer	Časové razítko unixu (v sekundách) pro vytvoření kroku spuštění.	Yes
expired_at	integer	Č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.	Yes
failed_at	integer	Časové razítko unixu (v sekundách) pro selhání kroku spuštění.	Yes
id	řetězec	Identifikátor kroku spuštění, na který lze odkazovat v koncových bodech rozhraní API.	Yes
last_error	objekt	Poslední chyba přidružená k tomuto kroku spuštění null Pokud nedojde k žádným chybám.	Yes
└ kód	řetězec	Jedna z možností: server_error nebo rate_limit_exceeded	No
└- zpráva	řetězec	Popis chyby čitelný člověkem.	No
metadata	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ů.	Yes
objekt	řetězec	Typ objektu, který je vždy assistant.run.step.	Yes
run_id	řetězec	ID spuštění, ve které je tento krok spuštění součástí.	Yes
stav	řetězec	Stav spuštění, který může být buď in_progress, cancelled, failed, completednebo expired.	Yes
step_details	runStepDetailsMessageCreationObject nebo runStepDetailsToolCallsObject	Podrobnosti o kroku spuštění	Yes
thread_id	řetězec	ID vláken, která byla spuštěna.	Yes
typ	řetězec	Typ kroku spuštění, který může být buď message_creation nebo tool_calls.	Yes

object Enum: RunStepObjectType

Value	Description
assistant.run.step	Typ objektu, který je vždy assistant.run.step

type Enum: RunStepObjectType

Value	Description
message_creation	Krok spuštění message_creation
tool_calls	Krok spuštění tool_calls

Status Enum: RunStepObjectStatus

Value	Description
in_progress	Stav spuštění in_progress
cancelled	Stav zrušeného spuštění
failed	Stav zrušeného spuštění
completed	Stav zrušeného spuštění
expired	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í.

Name	Typ	Description	Required	Default
delta	objekt	Rozdíl obsahující pole, která se změnila v kroku spuštění	Yes
└─ podrobnosti_kroku	runStepDeltaStepDetailsMessageCreationObject nebo runStepDeltaStepDetailsToolCallsObject	Podrobnosti o kroku spuštění	No
id	řetězec	Identifikátor kroku spuštění, na který lze odkazovat v koncových bodech rozhraní API.	Yes
objekt	řetězec	Typ objektu, který je vždy thread.run.step.delta.	Yes

object Enum: RunStepDeltaObjectType

Value	Description
thread.run.step.delta

listRunStepsResponse

Name	Typ	Description	Required	Default
data	pole		Yes
first_id	řetězec		Yes
has_more	boolean		Yes
last_id	řetězec		Yes
objekt	řetězec		Yes

runStepDetailsMessageCreationObject

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

Name	Typ	Description	Required	Default
message_creation	objekt		Yes
└message_id	řetězec	ID zprávy vytvořené tímto krokem spuštění.	No
typ	řetězec	Vždy message_creation.	Yes

type Enum: RunStepDetailsMessageCreationObjectType

Value	Description
message_creation

runStepDeltaStepDetailsMessageCreationObject

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

Name	Typ	Description	Required	Default
message_creation	objekt		No
└message_id	řetězec	ID zprávy vytvořené tímto krokem spuštění.	No
typ	řetězec	Vždy message_creation.	Yes

typ Enum: RunStepDeltaStepDetailsMessageCreationObjectType

Value	Description
message_creation

runStepDetailsToolCallsObject

Podrobnosti o volání nástroje

Name	Typ	Description	Required	Default
tool_calls	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.	Yes
typ	řetězec	Vždy tool_calls.	Yes

Typ Enum: Objektový typ RunStepDetailsToolCalls

Value	Description
tool_calls

runStepDeltaStepDetailsToolCallsObject

Podrobnosti o volání nástroje

Name	Typ	Description	Required	Default
tool_calls	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.	No
typ	řetězec	Vždy tool_calls.	Yes

type Enum: RunStepDeltaStepDetailsToolCallsObjectType

Value	Description
tool_calls

runStepDetailsToolCallsCodeObject

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

Name	Typ	Description	Required	Default
code_interpreter	objekt	Definice volání nástroje Interpret kódu.	Yes
└─ vstup	řetězec	Vstup do volání nástroje Interpret kódu.	No
└– 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.	No
id	řetězec	ID volání nástroje.	Yes
typ	řetězec	Typ volání nástroje. Toto bude code_interpreter vždy pro tento typ volání nástroje.	Yes

type Enum: RunStepDetailsToolCallsCodeObjectType

Value	Description
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

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

Name	Typ	Description	Required	Default
code_interpreter	objekt	Definice volání nástroje Interpret kódu.	No
└─ vstup	řetězec	Vstup do volání nástroje Interpret kódu.	No
└– 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.	No
id	řetězec	ID volání nástroje.	No
index	integer	Index volání nástroje v nástroji volá pole.	Yes
typ	řetězec	Typ volání nástroje. Toto bude code_interpreter vždy pro tento typ volání nástroje.	Yes

type Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

Value	Description
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

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

Name	Typ	Description	Required	Default
protokoly	řetězec	Textový výstup volání nástroje Interpret kódu.	Yes
typ	řetězec	Vždy logs.	Yes

type Enum: RunStepDetailsToolCallsCodeOutputLogsObjectType

Value	Description
protokoly

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

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

Name	Typ	Description	Required	Default
index	integer	Index výstupu v poli výstupů.	Yes
protokoly	řetězec	Textový výstup volání nástroje Interpret kódu.	No
typ	řetězec	Vždy logs.	Yes

typ Enum: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

Value	Description
protokoly

runStepDetailsToolCallsCodeOutputImageObject

Name	Typ	Description	Required	Default
bitová kopie	objekt		Yes
└ file_id	řetězec	ID souboru obrázku.	No
typ	řetězec	Vždy image.	Yes

type Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

Value	Description
bitová kopie

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Name	Typ	Description	Required	Default
bitová kopie	objekt		No
└ file_id	řetězec	ID souboru obrázku.	No
index	integer	Index výstupu v poli výstupů.	Yes
typ	řetězec	Vždy image.	Yes

typ Enum: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

Value	Description
bitová kopie

runStepDetailsToolCallsFileSearchObject

Name	Typ	Description	Required	Default
file_search	objekt	Prozatím to bude vždy prázdný objekt.	Yes
└─ výsledky	pole	Výsledky hledání souboru.	No
id	řetězec	ID objektu volání nástroje.	Yes
typ	řetězec	Typ volání nástroje. Toto bude file_search vždy pro tento typ volání nástroje.	Yes

type Enum: RunStepDetailsToolCallsFileSearchObjectType

Value	Description
file_search

runStepDetailsToolCallsFileSearchResultObject

Výsledná instance hledání souboru.

Name	Typ	Description	Required	Default
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.	No
file_id	řetězec	ID souboru, ve který byl výsledek nalezen.	Yes
file_name	řetězec	Název souboru, ve který byl výsledek nalezen.	Yes
skóre	number	Skóre výsledku Všechny hodnoty musí být číslo s plovoucí desetinou čárkou mezi 0 a 1.	Yes

runStepDeltaStepDetailsToolCallsFileSearchObject

Name	Typ	Description	Required	Default
file_search	objekt	Prozatím to bude vždy prázdný objekt.	Yes
id	řetězec	ID objektu volání nástroje.	No
index	integer	Index volání nástroje v nástroji volá pole.	Yes
typ	řetězec	Typ volání nástroje. Toto bude retrieval vždy pro tento typ volání nástroje.	Yes

type Enum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Value	Description
file_search

runStepDetailsToolCallsFunctionObject

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

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

Value	Description
funkce

runStepDeltaStepDetailsToolCallsFunctionObject

Name	Typ	Description	Required	Default
funkce	objekt	Definice funkce, která byla volána.	No
└argumenty	řetězec	Argumenty předané funkci.	No
└– název	řetězec	Název funkce.	No
└─ výstup	řetězec	Výstup funkce. To bude v null případě, že se výstupy ještě neodeslaly.	No
id	řetězec	ID objektu volání nástroje.	No
index	integer	Index volání nástroje v nástroji volá pole.	Yes
typ	řetězec	Typ volání nástroje. Toto bude function vždy pro tento typ volání nástroje.	Yes

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

Value	Description
funkce

vectorStoreExpirationAfter

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

Name	Typ	Description	Required	Default
kotva	řetězec	Ukotvení časového razítka, po kterém se zásada vypršení platnosti použije. Podporované kotvy: last_active_at.	Yes
days	integer	Počet dní po ukotvení, kdy platnost úložiště vektorů vyprší.	Yes

anchor Enum: VectorStoreExpirationAfterAnchor

Value	Description
last_active_at	Č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 .

Name	Typ	Description	Required	Default
created_at	integer	Časové razítko unixu (v sekundách) pro vytvoření vektorového úložiště.	Yes
expires_after	vectorStoreExpirationAfter	Zásady vypršení platnosti pro úložiště vektorů.	No
expires_at	integer	Časové razítko unixu (v sekundách) pro vypršení platnosti úložiště vektorů.	No
file_counts	objekt		Yes
└- zrušeno	integer	Počet zrušených souborů.	No
└- dokončeno	integer	Počet úspěšně zpracovaných souborů.	No
└– selhalo	integer	Počet souborů, které se nepodařilo zpracovat.	No
└─ probíhá	integer	Počet souborů, které se právě zpracovávají.	No
└- celkem	integer	Celkový počet souborů.	No
id	řetězec	Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.	Yes
last_active_at	integer	Časové razítko unixu (v sekundách) doby, kdy bylo úložiště vektorů naposledy aktivní.	Yes
metadata	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ů.	Yes
name	řetězec	Název úložiště vektorů.	Yes
objekt	výčet	Typ objektu, který je vždy vector_store. Možné hodnoty: vector_store	Yes
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í.	Yes
usage_bytes	integer	Celkový počet bajtů používaných soubory v úložišti vektorů.	Yes

status Enum: VectorStoreObjectStatus

Value	Description
expired
in_progress
completed

createVectorStoreRequest

Name	Typ	Description	Required	Default
chunking_strategy	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ý.	No
expires_after	vectorStoreExpirationAfter	Zásady vypršení platnosti pro úložiště vektorů.	No
file_ids	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.	No
metadata	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ů.	No
name	řetězec	Název úložiště vektorů.	No

updateVectorStoreRequest

Name	Typ	Description	Required	Default
expires_after	vectorStoreExpirationAfter	Zásady vypršení platnosti pro úložiště vektorů.	No
metadata	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ů.	No
name	řetězec	Název úložiště vektorů.	No

listVectorStoresResponse

Name	Typ	Description	Required	Default
data	pole		Yes
first_id	řetězec		Yes
has_more	boolean		Yes
last_id	řetězec		Yes
objekt	řetězec		Yes

deleteVectorStoreResponse

Name	Typ	Description	Required	Default
deleted	boolean		Yes
id	řetězec		Yes
objekt	řetězec		Yes

object Enum: DeleteVectorStoreResponseObject

Value	Description
vector_store.deleted	Stav objektu odpovědi pro odstranění vektorového úložiště

vectorStoreFileObject

Seznam souborů připojených k úložišti vektorů

Name	Typ	Description	Required	Default
chunking_strategy	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ý.	No
created_at	integer	Časové razítko unixu (v sekundách) pro vytvoření souboru úložiště vektorů.	Yes
id	řetězec	Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.	Yes
last_error	objekt	Poslední chyba přidružená k tomuto souboru úložiště vektorů. null Pokud nedojde k žádným chybám.	Yes
└ kód	řetězec	Jeden z server_error nebo invalid_file nebo unsupported_file.	No
└- zpráva	řetězec	Popis chyby čitelný člověkem.	No
objekt	řetězec	Typ objektu, který je vždy vector_store.file.	Yes
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í.	Yes
usage_bytes	integer	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.	Yes
vector_store_id	řetězec	ID vektorového úložiště, ke kterému je soubor připojen.	Yes

objekt Enum: Typ objektu souboru VectorStore

Value	Description
vector_store.file

status Enum: StavObjektuSouboruVeVektorovémUložení

Value	Description
in_progress
completed
cancelled
failed

otherChunkingStrategyResponseParam

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.

Name	Typ	Description	Required	Default
typ	řetězec	Vždy other.	Yes

typ Enum: OtherChunkingStrategyResponseParamType

Value	Description
other

staticChunkingStrategyResponseParam

Name	Typ	Description	Required	Default
statický	staticChunkingStrategy		Yes
typ	řetězec	Vždy static.	Yes

typ Enum: StaticChunkingStrategyResponseParamType

Value	Description
statický

staticChunkingStrategy

Name	Typ	Description	Required	Default
chunk_overlap_tokens	integer	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	Yes
max_chunk_size_tokens	integer	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.	Yes

autoChunkingStrategyRequestParam

Výchozí strategie. Tato strategie v současné době používá max_chunk_size_tokens800chunk_overlap_tokens400

Name	Typ	Description	Required	Default
typ	výčet	Vždy auto. Možné hodnoty: auto	Yes

staticChunkingStrategyRequestParam

Name	Typ	Description	Required	Default
statický	staticChunkingStrategy		Yes
typ	výčet	Vždy static. Možné hodnoty: static	Yes

chunkingStrategyRequestParam

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
• staticChunkingStrategyRequestParam

createVectorStoreFileRequest

Name	Typ	Description	Required	Default
chunking_strategy	chunkingStrategyRequestParam	Strategie vytváření bloků dat použitá k vytvoření bloků souborů. Pokud není nastavená, použije strategii auto .	No
file_id	ř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.	Yes

listVectorStoreFilesResponse

Name	Typ	Description	Required	Default
data	pole		Yes
first_id	řetězec		Yes
has_more	boolean		Yes
last_id	řetězec		Yes
objekt	řetězec		Yes

deleteVectorStoreFileResponse

Name	Typ	Description	Required	Default
deleted	boolean		Yes
id	řetězec		Yes
objekt	řetězec		Yes

object Enum: DeleteVectorStoreFileResponseObject

Value	Description
vector_store.file.deleted

vectorStoreFileBatchObject

Dávka souborů připojených k úložišti vektorů.

Name	Typ	Description	Required	Default
created_at	integer	Časové razítko unixu (v sekundách) pro vytvoření dávky souborů úložiště vektorů.	Yes
file_counts	objekt		Yes
└- zrušeno	integer	Počet zrušených souborů.	No
└- dokončeno	integer	Počet zpracovaných souborů.	No
└– selhalo	integer	Počet souborů, které se nepodařilo zpracovat.	No
└─ probíhá	integer	Počet souborů, které se právě zpracovávají.	No
└- celkem	integer	Celkový počet souborů.	No
id	řetězec	Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.	Yes
objekt	řetězec	Typ objektu, který je vždy vector_store.file_batch.	Yes
stav	řetězec	Stav dávky souborů úložiště vektorů, které mohou být buď in_progress, completednebo cancelledfailed.	Yes
vector_store_id	řetězec	ID vektorového úložiště, ke kterému je soubor připojen.	Yes

objekt Enum: VectorStoreFileBatchObjectType

Value	Description
vector_store.files_batch

status Enum: VectorStoreFileBatchObjectStatus

Value	Description
in_progress
completed
cancelled
failed

createVectorStoreFileBatchRequest

Name	Typ	Description	Required	Default
chunking_strategy	chunkingStrategyRequestParam	Strategie vytváření bloků dat použitá k vytvoření bloků souborů. Pokud není nastavená, použije strategii auto .	No
file_ids	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.	Yes

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:

thread.created

Nastane při vytvoření nového vlákna.

Name	Typ	Description	Required	Default
data	threadObject	Představuje vlákno, které obsahuje zprávy.	Yes
událost	řetězec		Yes

Data: threadObject

Výčet událostí: ThreadStreamEventEnum

Value	Description
thread.created	Událost vytvoření vlákna

---

runStreamEvent

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

thread.run.created

Nastane při vytvoření nového spuštění.

Name	Typ	Description	Required	Default
data	runObject	Představuje spuštění na vlákně.	Yes
událost	řetězec		Yes

Data: runObject

Výčet událostí: RunStreamEventCreated

Value	Description
thread.run.created

---

thread.run.queued

Nastane, když se spuštění přesune do queued stavu.

Name	Typ	Description	Required	Default
data	runObject	Představuje spuštění na vlákně.	Yes
událost	řetězec		Yes

Data: runObject

Výčet událostí: RunStreamEventQueued

Value	Description
thread.run.queued

---

thread.run.in_progress

Nastane, když se spuštění přesune do in_progress stavu.

Name	Typ	Description	Required	Default
data	runObject	Představuje spuštění na vlákně.	Yes
událost	řetězec		Yes

Data: runObject

Výčet událostí: RunStreamEventInProgress

Value	Description
thread.run.in_progress

---

thread.run.requires_action

Nastane, když se spuštění přesune do requires_action stavu.

Name	Typ	Description	Required	Default
data	runObject	Představuje spuštění na vlákně.	Yes
událost	řetězec		Yes

Data: runObject

Výčet událostí: RunStreamEventRequiresAction

Value	Description
thread.run.requires_action

---

thread.run.completed

Nastane při dokončení spuštění.

Name	Typ	Description	Required	Default
data	runObject	Představuje spuštění na vlákně.	Yes
událost	řetězec		Yes

Data: runObject

Výčet událostí: RunStreamEventCompleted

Value	Description
thread.run.completed

---

thread.run.failed

Nastane, když se spuštění nezdaří.

Name	Typ	Description	Required	Default
data	runObject	Představuje spuštění na vlákně.	Yes
událost	řetězec		Yes

Data: runObject

Výčet událostí: RunStreamEventFailed

Value	Description
thread.run.failed

---

thread.run.cancelling

Nastane, když se spuštění přesune do cancelling stavu.

Name	Typ	Description	Required	Default
data	runObject	Představuje spuštění na vlákně.	Yes
událost	řetězec		Yes

Data: runObject

Výčet událostí: RunStreamEventCancelling

Value	Description
thread.run.cancelling

---

thread.run.cancelled

Nastane při zrušení spuštění.

Name	Typ	Description	Required	Default
data	runObject	Představuje spuštění na vlákně.	Yes
událost	řetězec		Yes

Data: runObject

Výčet událostí: RunStreamEventCancelled

Value	Description
thread.run.cancelled

---

thread.run.expired

Nastane, když vyprší platnost spuštění.

Name	Typ	Description	Required	Default
data	runObject	Představuje spuštění na vlákně.	Yes
událost	řetězec		Yes

Data: runObject

Výčet událostí: RunStreamEventExpired

Value	Description
thread.run.expired

---

runStepStreamEvent

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

thread.run.step.created

Nastane při vytvoření kroku spuštění.

Name	Typ	Description	Required	Default
data	runStepObject	Představuje krok při spuštění spuštění.	Yes
událost	řetězec		Yes

Data: runStepObject

Výčet událostí: RunStepStreamEventCreated

Value	Description
thread.run.step.created

---

thread.run.step.in_progress

Nastane, když se krok spuštění přesune do in_progress stavu.

Name	Typ	Description	Required	Default
data	runStepObject	Představuje krok při spuštění spuštění.	Yes
událost	řetězec		Yes

Data: runStepObject

Výčet událostí: RunStepStreamEventInProgress

Value	Description
thread.run.step.in_progress

---

thread.run.step.delta

Nastane, když se streamují části kroku spuštění.

Name	Typ	Description	Required	Default
data	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í.	Yes
událost	řetězec		Yes

Data: runStepDeltaObject

Výčet událostí: RunStepStreamEventDelta

Value	Description
thread.run.step.delta

---

thread.run.step.completed

Nastane při dokončení kroku spuštění.

Name	Typ	Description	Required	Default
data	runStepObject	Představuje krok při spuštění spuštění.	Yes
událost	řetězec		Yes

Data: runStepObject

Výčet událostí: RunStepStreamEventCompleted

Value	Description
thread.run.step.completed

---

thread.run.step.failed

Nastane, když selže krok spuštění.

Name	Typ	Description	Required	Default
data	runStepObject	Představuje krok při spuštění spuštění.	Yes
událost	řetězec		Yes

Data: runStepObject

Výčet událostí: RunStepStreamEventFailed

Value	Description
thread.run.step.failed

---

thread.run.step.cancelled

Nastane při zrušení kroku spuštění.

Name	Typ	Description	Required	Default
data	runStepObject	Představuje krok při spuštění spuštění.	Yes
událost	řetězec		Yes

Data: runStepObject

Výčet událostí: RunStepStreamEventCancelled

Value	Description
thread.run.step.cancelled

---

thread.run.step.expired

Nastane, když vyprší platnost kroku spuštění.

Name	Typ	Description	Required	Default
data	runStepObject	Představuje krok při spuštění spuštění.	Yes
událost	řetězec		Yes

Data: runStepObject

Výčet událostí: RunStepStreamEventExpired

Value	Description
thread.run.step.expired

---

messageStreamEvent

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

thread.message.created

Nastane při vytvoření zprávy.

Name	Typ	Description	Required	Default
data	messageObject	Představuje zprávu v rámci vláken.	Yes
událost	řetězec		Yes

Data: messageObject

Výčet událostí: MessageStreamEventCreated

Value	Description
thread.message.created

---

thread.message.in_progress

Nastane, když se zpráva přesune do in_progress stavu.

Name	Typ	Description	Required	Default
data	messageObject	Představuje zprávu v rámci vláken.	Yes
událost	řetězec		Yes

Data: messageObject

Výčet událostí: MessageStreamEventInProgress

Value	Description
thread.message.in_progress

---

thread.message.delta

Nastane, když se streamují části zprávy.

Name	Typ	Description	Required	Default
data	messageDeltaObject	Představuje rozdíl zprávy, tj. všechna změněná pole zprávy během streamování.	Yes
událost	řetězec		Yes

Data: messageDeltaObject

Výčet událostí: MessageStreamEventDelta

Value	Description
thread.message.delta

---

thread.message.completed

Nastane při dokončení zprávy.

Name	Typ	Description	Required	Default
data	messageObject	Představuje zprávu v rámci vláken.	Yes
událost	řetězec		Yes

Data: messageObject

Výčet událostí: MessageStreamEventCompleted

Value	Description
thread.message.completed

---

thread.message.incomplete

Nastane, když zpráva skončí před dokončením.

Name	Typ	Description	Required	Default
data	messageObject	Představuje zprávu v rámci vláken.	Yes
událost	řetězec		Yes

Data: messageObject

Výčet událostí: MessageStreamEventIncomplete

Value	Description
thread.message.incomplete

---

Annotation

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

• FileCitation
• UrlCitation
• FilePath

Click

Kliknutí myší.

Name	Typ	Description	Required	Default
button	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	Yes
typ	výčet	Určuje typ události. U akce kliknutí je tato vlastnost vždy nastavena na clickhodnotu . Možné hodnoty: click	Yes
x	integer	Souřadnice x, kde došlo k kliknutí.	Yes
y	integer	Souřadnice y, kde došlo k kliknutí.	Yes

CodeInterpreterFileOutput

Výstup volání nástroje interpretu kódu, který je souborem.

Name	Typ	Description	Required	Default
files	pole		Yes
typ	výčet	Typ výstupu souboru interpretu kódu. Vždy files. Možné hodnoty: files	Yes

CodeInterpreterTextOutput

Výstup volání nástroje interpreta kódu, který je text.

Name	Typ	Description	Required	Default
protokoly	řetězec	Protokoly volání nástroje interpreta kódu.	Yes
typ	výčet	Typ textového výstupu interpreta kódu. Vždy logs. Možné hodnoty: logs	Yes

CodeInterpreterTool

Nástroj, který spouští kód.

Name	Typ	Description	Required	Default
file_ids	pole	ID souborů pro spuštění kódu.	Yes
typ	výčet	Typ nástroje pro interpret kódu. Vždy code_interpreter. Možné hodnoty: code_interpreter	Yes

CodeInterpreterToolCall

Volání nástroje ke spuštění kódu

Name	Typ	Description	Required	Default
kód	řetězec	Kód, který se má spustit.	Yes
id	řetězec	Jedinečné ID volání nástroje interpretu kódu.	Yes
results	pole	Výsledky volání nástroje interpreta kódu.	Yes
stav	výčet	Stav volání nástroje interpreta kódu. Možné hodnoty: in_progress, interpreting, completed	Yes
typ	výčet	Typ volání nástroje interpreta kódu. Vždy code_interpreter_call. Možné hodnoty: code_interpreter_call	Yes

CodeInterpreterToolOutput

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

• CodeInterpreterTextOutput
• CodeInterpreterFileOutput

ComparisonFilter

Filtr použitý k porovnání zadaného klíče atributu s danou hodnotou pomocí definované operace porovnání.

Name	Typ	Description	Required	Default
klíč	řetězec	Klíč k porovnání s hodnotou.	Yes
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	Yes
value	ř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.	Yes

CompoundFilter

Kombinování více filtrů pomocí and nebo or.

Name	Typ	Description	Required	Default
filters	pole	Pole filtrů k kombinování. Položky mohou být ComparisonFilter nebo CompoundFilter.	Yes
typ	výčet	Typ operace: and nebo or. Možné hodnoty: and, or	Yes

ComputerAction

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

• Click
• DoubleClick
• Drag
• KeyPress
• Move
• Screenshot
• Scroll
• Type
• Wait

ComputerScreenshotImage

Snímek obrazovky počítače použitý s nástrojem pro použití počítače

Name	Typ	Description	Required	Default
file_id	řetězec	Identifikátor nahraného souboru, který obsahuje snímek obrazovky.	No
image_url	řetězec	Adresa URL obrázku snímku obrazovky	No
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	Yes

ComputerTool

Nástroj, který řídí virtuální počítač.

Name	Typ	Description	Required	Default
display_height	number	Výška displeje počítače.	Yes
display_width	number	Šířka displeje počítače.	Yes
prostředí	výčet	Typ počítačového prostředí, které se má řídit. Možné hodnoty: mac, windows, ubuntu, browser	Yes
typ	výčet	Typ nástroje pro použití počítače. Vždy computer_use_preview. Možné hodnoty: computer-use-preview	Yes

ComputerToolCall

Zavolání nástroje k použití s počítačovým nástrojem.

Name	Typ	Description	Required	Default
akce	ComputerAction		Yes
call_id	řetězec	Identifikátor použitý při odpovídání na volání nástroje s výstupem.	Yes
id	řetězec	Jedinečné ID počítačového volání.	Yes
pending_safety_checks	pole	Čekající bezpečnostní kontroly volání počítače.	Yes
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	Yes
typ	výčet	Typ hovoru počítačem. Vždy computer_call. Možné hodnoty: computer_call	Yes

ComputerToolCallOutput

Výstup z volání počítačového nástroje.

Name	Typ	Description	Required	Default
acknowledged_safety_checks	pole	Bezpečnostní kontroly hlášené rozhraním API, které vývojář potvrdil.	No
call_id	řetězec	ID volání počítačového nástroje, které vytvořilo výstup.	Yes
id	řetězec	ID výstupu volání počítačového nástroje.	No
výstup	ComputerScreenshotImage	Snímek obrazovky počítače použitý s nástrojem pro použití počítače	Yes
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	No
typ	výčet	Typ výstupu volání počítačového nástroje. Vždy computer_call_output. Možné hodnoty: computer_call_output	Yes

ComputerToolCallOutputResource

Name	Typ	Description	Required	Default
acknowledged_safety_checks	pole	Bezpečnostní kontroly hlášené rozhraním API, které vývojář potvrdil.	No
call_id	řetězec	ID volání počítačového nástroje, které vytvořilo výstup.	Yes
id	řetězec	Jedinečné ID výstupu nástroje pro počítačový hovor.	Yes
výstup	ComputerScreenshotImage	Snímek obrazovky počítače použitý s nástrojem pro použití počítače	Yes
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	No
typ	výčet	Typ výstupu volání počítačového nástroje. Vždy computer_call_output. Možné hodnoty: computer_call_output	Yes

ComputerToolCallSafetyCheck

Čekající bezpečnostní kontrola pro počítačové volání.

Name	Typ	Description	Required	Default
kód	řetězec	Typ čekající bezpečnostní kontroly.	Yes
id	řetězec	ID čekající bezpečnostní kontroly.	Yes
zpráva	řetězec	Podrobnosti o čekající bezpečnostní kontrole	Yes

Content

Multimodální vstupní a výstupní obsah

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

• InputContent
• OutputContent

Coordinate

Dvojice souřadnic x/y, například { x: 100, y: 200 }.

Name	Typ	Description	Required	Default
x	integer	Souřadnice x.	Yes
y	integer	Souřadnice y.	Yes

CreateModelResponseProperties

Name	Typ	Description	Required	Default
metadata	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ů.	No
model	řetězec	Model použitý k vygenerování odpovědí	No
temperature	number	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	No	1
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	No	1
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct OpenAI monitorovat a zjišťovat zneužití. .	No

createResponse

Name	Typ	Description	Required	Default
include	pole	{"$ref": "#/components/schemas/includable/description"}	No
vstup	řetězec nebo pole	Textové, obrázkové nebo souborové vstupy do modelu, které se používají k vygenerování odpovědi.	Yes
instructions	ř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.	No
max_output_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a zdůvodnění tokenů.	No
parallel_tool_calls	boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	No	True
previous_response_id	ř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.	No
reasoning	Reasoning	Možnosti konfigurace pro zdůvodnění modelů	No
uložit	boolean	Zda se má vygenerovaná odpověď modelu uložit pro pozdější načtení prostřednictvím rozhraní API.	No	True
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.	No	False
poslat SMS	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	No
└─ Formát	TextResponseFormatConfiguration	Objekt určující formát, který musí model vypíše. Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, což zajišťuje, že model odpovídá 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í.	No
tool_choice	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.	No
tools	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	No
truncation	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	No

DoubleClick

Akce dvojkliku.

Name	Typ	Description	Required	Default
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	Yes
x	integer	Souřadnice x, kde došlo k dvojitému kliknutí.	Yes
y	integer	Souřadnice y, kde došlo k dvojitému kliknutí.	Yes

Drag

Akce přetažení

Name	Typ	Description	Required	Default
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 }]	Yes
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	Yes

EasyInputMessage

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.

Name	Typ	Description	Required	Default
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.	Yes
role	výčet	Role vstupu zprávy. Jeden z user, assistant, systemnebo developer. Možné hodnoty: user, assistant, system, developer	Yes
typ	výčet	Typ vstupu zprávy. Vždy message. Možné hodnoty: message	No

FileCitation

Citace souboru.

Name	Typ	Description	Required	Default
file_id	řetězec	ID souboru.	Yes
index	integer	Index souboru v seznamu souborů.	Yes
typ	výčet	Typ citace souboru. Vždy file_citation. Možné hodnoty: file_citation	Yes

FilePath

Cesta k souboru.

Name	Typ	Description	Required	Default
file_id	řetězec	ID souboru.	Yes
index	integer	Index souboru v seznamu souborů.	Yes
typ	výčet	Typ cesty k souboru. Vždy file_path. Možné hodnoty: file_path	Yes

FileSearchRanker

Ranker, který se má použít pro vyhledávání souborů. Pokud není specifikován, bude použit hodnotící systém auto.

Property	Value
Description	Ranker, který se má použít pro vyhledávání souborů. Pokud není specifikován, bude použit hodnotící systém auto.
Type	řetězec
Values	auto default_2024_08_21

FileSearchTool

Nástroj, který hledá relevantní obsah z nahraných souborů.

Name	Typ	Description	Required	Default
filters	ComparisonFilter nebo CompoundFilter	Filtr, který se použije na základě atributů souboru.	No
max_num_results	integer	Maximální počet výsledků, které se mají vrátit. Toto číslo by mělo být mezi 1 a 50 včetně.	No
ranking_options	objekt	Možnosti řazení pro hledání	No
└- ranker	výčet	Ranker, který se má použít pro vyhledávání souborů. Možné hodnoty: auto, default-2024-11-15	No
└ score_threshold	number	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ů.	No	0
typ	výčet	Typ nástroje pro vyhledávání souborů. Vždy file_search. Možné hodnoty: file_search	Yes
vector_store_ids	pole	ID vektorových úložišť, která se mají prohledávat.	Yes

FileSearchToolCall

Výsledky volání nástroje pro vyhledávání souborů.

Name	Typ	Description	Required	Default
id	řetězec	Jedinečné ID volání nástroje pro vyhledávání souborů.	Yes
queries	pole	Dotazy používané k hledání souborů.	Yes
results	pole	Výsledky volání nástroje pro vyhledávání souborů.	No
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	Yes
typ	výčet	Typ volání nástroje pro vyhledávání souborů. Vždy file_search_call. Možné hodnoty: file_search_call	Yes

FunctionTool

Ve vašem vlastním kódu definuje funkci, kterou může model volitelně volat.

Name	Typ	Description	Required	Default
description	řetězec	Popis funkce. Model se používá k rozhodnutí, zda má být funkce volána či nikoliv.	No
name	řetězec	Název funkce, která se má volat.	Yes
parameters	objekt	Objekt schématu JSON popisující parametry funkce.	Yes
strict	boolean	Určuje, jestli se má vynutit přísné ověřování parametrů. Výchozí true.	Yes
typ	výčet	Typ nástroje funkce. Vždy function. Možné hodnoty: function	Yes

FunctionToolCall

Volání nástroje ke spuštění funkce

Name	Typ	Description	Required	Default
arguments	řetězec	Řetězec JSON obsahující argumenty, které mají být předány funkci.	Yes
call_id	řetězec	Jedinečné ID volání nástroje funkcí vygenerované modelem.	Yes
id	řetězec	Jedinečné ID volání nástroje funkcí.	Yes
name	řetězec	Název funkce, která se má spustit.	Yes
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	No
typ	výčet	Typ volání funkčního nástroje. Vždy function_call. Možné hodnoty: function_call	Yes

FunctionToolCallOutput

Výstup z volání funkčního nástroje.

Name	Typ	Description	Required	Default
call_id	řetězec	Jedinečné ID volání nástroje funkcí vygenerované modelem.	Yes
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.	No
výstup	řetězec	Řetězec JSON výstupu volání nástroje funkcí.	Yes
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	No
typ	výčet	Typ výstupu volání nástroje funkce. Vždy function_call_output. Možné hodnoty: function_call_output	Yes

FunctionToolCallOutputResource

Name	Typ	Description	Required	Default
call_id	řetězec	Jedinečné ID volání nástroje funkcí vygenerované modelem.	Yes
id	řetězec	Jedinečné ID výstupu nástroje volání funkce.	Yes
výstup	řetězec	Řetězec JSON výstupu volání nástroje funkcí.	Yes
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	No
typ	výčet	Typ výstupu volání nástroje funkce. Vždy function_call_output. Možné hodnoty: function_call_output	Yes

includable

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

Property	Value
Description	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.
Type	řetězec
Values	file_search_call.results message.input_image.image_url computer_call_output.output.image_url

InputAudio

Zvukový vstup do modelu.

Name	Typ	Description	Required	Default
data	řetězec	Zvuková data s kódováním Base64	Yes
format	výčet	Formát zvukových dat. Aktuálně podporované formáty jsou mp3 a wav. Možné hodnoty: mp3, wav	Yes
typ	výčet	Typ vstupní položky. Vždy input_audio. Možné hodnoty: input_audio	Yes

InputContent

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

• InputText
• InputImage
• InputFile

InputFile

Vstup souboru do modelu.

Name	Typ	Description	Required	Default
file_data	řetězec	Obsah souboru, který se má odeslat do modelu.	No
file_id	řetězec	ID souboru, který se má odeslat do modelu.	No
filename	řetězec	Název souboru, který se má odeslat do modelu.	No
typ	výčet	Typ vstupní položky. Vždy input_file. Možné hodnoty: input_file	Yes

InputImage

Vstup obrázku do modelu.

Name	Typ	Description	Required	Default
detail	výčet	Úroveň podrobností obrázku, která se má odeslat do modelu. Jeden z high, lownebo auto. Výchozí hodnota je auto. Možné hodnoty: high, low, auto	Yes
file_id	řetězec	ID souboru, který se má odeslat do modelu.	No
image_url	ř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.	No
typ	výčet	Typ vstupní položky. Vždy input_image. Možné hodnoty: input_image	Yes

InputItem

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

• EasyInputMessage
• Item
• ItemReference

InputMessage

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.

Name	Typ	Description	Required	Default
obsah	InputMessageContentList	Seznam jedné nebo více vstupních položek modelu obsahující jiný obsah types.	Yes
role	výčet	Role vstupu zprávy. Jeden z user, systemnebo developer. Možné hodnoty: user, system, developer	Yes
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	No
typ	výčet	Typ vstupu zprávy. Vždy je nastavená na message. Možné hodnoty: message	No

InputMessageContentList

Seznam jedné nebo více vstupních položek modelu, který obsahuje různé typy obsahu.

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

InputMessageResource

Name	Typ	Description	Required	Default
obsah	InputMessageContentList	Seznam jedné nebo více vstupních položek modelu obsahující jiný obsah types.	Yes
id	řetězec	Jedinečné ID vstupu zprávy.	Yes
role	výčet	Role vstupu zprávy. Jeden z user, systemnebo developer. Možné hodnoty: user, system, developer	Yes
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	No
typ	výčet	Typ vstupu zprávy. Vždy je nastavená na message. Možné hodnoty: message	No

InputText

Textový vstup do modelu.

Name	Typ	Description	Required	Default
poslat SMS	řetězec	Textový vstup do modelu.	Yes
typ	výčet	Typ vstupní položky. Vždy input_text. Možné hodnoty: input_text	Yes

Item

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
• ReasoningItem

ItemReference

Interní identifikátor položky, na kterou se má odkazovat.

Name	Typ	Description	Required	Default
id	řetězec	ID položky, na kterou chcete odkazovat.	Yes
typ	výčet	Typ položky, na kterou chcete odkazovat. Vždy item_reference. Možné hodnoty: item_reference	Yes

ItemResource

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.

Name	Typ	Description	Required	Default
keys	pole	Kombinace kláves, které model žádá stisknout. Toto je pole řetězců, z nichž každý představuje klíč.	Yes
typ	výčet	Určuje typ události. U akce keypress je tato vlastnost vždy nastavena na keypress. Možné hodnoty: keypress	Yes

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

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

ModelResponseProperties

Name	Typ	Description	Required	Default
metadata	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ů.	No
model	řetězec	Model použitý k vygenerování odpovědí	No
temperature	number	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	No	1
top_p	number	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	No	1
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct OpenAI monitorovat a zjišťovat zneužití. .	No

Move

Akce přesunutí myší.

Name	Typ	Description	Required	Default
typ	výčet	Určuje typ události. U akce přesunutí je tato vlastnost vždy nastavena na movehodnotu . Možné hodnoty: move	Yes
x	integer	Souřadnice x, ke které se chcete přesunout.	Yes
y	integer	Souřadnice y, ke které se chcete přesunout.	Yes

OutputAudio

Zvukový výstup z modelu.

Name	Typ	Description	Required	Default
data	řetězec	Zvuková data s kódováním Base64 z modelu.	Yes
přepis	řetězec	Přepis zvukových dat z modelu.	Yes
typ	výčet	Typ výstupního zvuku. Vždy output_audio. Možné hodnoty: output_audio	Yes

OutputContent

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

• OutputText
• Refusal

OutputItem

Name	Typ	Description	Required	Default
akce	ComputerAction		Yes
arguments	řetězec	Řetězec JSON obsahující argumenty, které mají být předány funkci.	Yes
call_id	řetězec	Identifikátor použitý při odpovídání na volání nástroje s výstupem.	Yes
obsah	pole	Zdůvodnění obsahu textu	Yes
id	řetězec	Jedinečný identifikátor obsahu odůvodnění.	Yes
name	řetězec	Název funkce, která se má spustit.	Yes
pending_safety_checks	pole	Čekající bezpečnostní kontroly volání počítače.	Yes
queries	pole	Dotazy používané k hledání souborů.	Yes
results	pole	Výsledky volání nástroje pro vyhledávání souborů.	No
role	výčet	Role výstupní zprávy. Vždy assistant. Možné hodnoty: assistant	Yes
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	Yes
typ	výčet	Typ objektu. Vždy reasoning. Možné hodnoty: reasoning	Yes

OutputMessage

Výstupní zpráva z modelu

Name	Typ	Description	Required	Default
obsah	pole	Obsah výstupní zprávy.	Yes
id	řetězec	Jedinečné ID výstupní zprávy.	Yes
role	výčet	Role výstupní zprávy. Vždy assistant. Možné hodnoty: assistant	Yes
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	Yes
typ	výčet	Typ výstupní zprávy. Vždy message. Možné hodnoty: message	Yes

OutputText

Textový výstup z modelu.

Name	Typ	Description	Required	Default
annotations	pole	Poznámky textového výstupu.	Yes
poslat SMS	řetězec	Textový výstup z modelu.	Yes
typ	výčet	Typ výstupního textu. Vždy output_text. Možné hodnoty: output_text	Yes

RealtimeSessionCreateRequest

Konfigurace objektu relace v reálném čase.

Name	Typ	Description	Required	Default
input_audio_format	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	No
input_audio_noise_reduction	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.	No
└- 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	No
input_audio_transcription	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.	No
└jazyk	řetězec	Jazyk vstupního zvuku. Zadávání jazyka zadávání ve formátu ISO-639-1 (např. en) zlepšuje přesnost a latenci.	No
└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.	No
└─ 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í".	No
instructions	ř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.	No
max_response_output_tokens	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 je inf.	No
modalities		Sada způsobů, kterými může model reagovat. Pokud chcete zvuk zakázat, nastavte ho na ["text"].	No
model	řetězec	Název nasazení použitého pro tuto relaci.	No
output_audio_format	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	No
temperature	number	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.	No	0.8
tool_choice	řetězec	Jak model vybírá nástroje. Možnosti jsou auto, none, requirednebo zadat funkci.	No	auto
tools	pole	Nástroje (funkce) dostupné pro model	No
turn_detection	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.	No
└create_response	boolean	Jestli se má automaticky generovat odpověď, když dojde k události zastavení VAD.	No	True
└- 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	No
└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.	No	True
└- prefix_padding_ms	integer	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.	No
└─ trvání_ticha_ms	integer	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.	No
└- prahová hodnota	number	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.	No
└- typ	výčet	Typ detekce otáčení Možné hodnoty: server_vad, semantic_vad	No
voice	VoiceIdsShared		No

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.

Name	Typ	Description	Required	Default
client_secret	objekt	Dočasný klíč vrácený rozhraním API	Yes
└- vyprší_dne	integer	Časové razítko pro vypršení platnosti tokenu V současné době vyprší platnost všech tokenů po jedné minutě.	No
└– 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.	No
input_audio_format	řetězec	Formát vstupního zvuku. Možnosti jsou pcm16, g711_ulawnebo g711_alaw.	No
input_audio_transcription	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í.	No
└model	řetězec	Model, který se má použít pro přepis, whisper-1 je jediným aktuálně podporovaným modelem.	No
instructions	ř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.	No
max_response_output_tokens	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 je inf.	No
modalities		Sada způsobů, kterými může model reagovat. Pokud chcete zvuk zakázat, nastavte ho na ["text"].	No
output_audio_format	řetězec	Formát výstupního zvuku. Možnosti jsou pcm16, g711_ulawnebo g711_alaw.	No
temperature	number	Vzorkovací teplota pro model omezená na [0.6, 1.2]. Výchozí hodnota je 0,8.	No
tool_choice	řetězec	Jak model vybírá nástroje. Možnosti jsou auto, none, requirednebo zadat funkci.	No
tools	pole	Nástroje (funkce) dostupné pro model	No
turn_detection	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.	No
└- prefix_padding_ms	integer	Množství zvuku, které se má zahrnout před detekovanou řečí VAD (v milisekundách). Výchozí hodnota je 300 ms.	No
└─ trvání_ticha_ms	integer	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.	No
└- prahová hodnota	number	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.	No
└- typ	řetězec	Aktuálně je podporován pouze typ detekce otáčení server_vad.	No
voice	VoiceIdsShared		No

RealtimeTranscriptionSessionCreateRequest

Konfigurace objektu relace přepisu v reálném čase

Name	Typ	Description	Required	Default
include	pole	Sada položek, které se mají zahrnout do přepisu. Aktuální dostupné položky jsou: - item.input_audio_transcription.logprobs	No
input_audio_format	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	No
input_audio_noise_reduction	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.	No
└- 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	No
input_audio_transcription	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.	No
└jazyk	řetězec	Jazyk vstupního zvuku. Zadávání jazyka zadávání ve formátu ISO-639-1 (např. en) zlepšuje přesnost a latenci.	No
└model	výčet	Model, který se má použít pro přepis, aktuální možnosti jsou gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribea whisper-1. Možné hodnoty: gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, whisper-1	No
└─ 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í".	No
modalities		Sada způsobů, kterými může model reagovat. Pokud chcete zvuk zakázat, nastavte ho na ["text"].	No
turn_detection	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.	No
└create_response	boolean	Jestli se má automaticky generovat odpověď, když dojde k události zastavení VAD. Není k dispozici pro přepisovací relace.	No	True
└- 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	No
└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.	No	True
└- prefix_padding_ms	integer	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.	No
└─ trvání_ticha_ms	integer	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.	No
└- prahová hodnota	number	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.	No
└- typ	výčet	Typ detekce otáčení Možné hodnoty: server_vad, semantic_vad	No

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.

Name	Typ	Description	Required	Default
client_secret	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.	Yes
└- vyprší_dne	integer	Časové razítko pro vypršení platnosti tokenu V současné době vyprší platnost všech tokenů po jedné minutě.	No
└– 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.	No
input_audio_format	řetězec	Formát vstupního zvuku. Možnosti jsou pcm16, g711_ulawnebo g711_alaw.	No
input_audio_transcription	objekt	Konfigurace modelu přepisu	No
└jazyk	řetězec	Jazyk vstupního zvuku. Zadávání jazyka zadávání ve formátu ISO-639-1 (např. en) zlepšuje přesnost a latenci.	No
└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	No
└─ 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.	No
modalities		Sada způsobů, kterými může model reagovat. Pokud chcete zvuk zakázat, nastavte ho na ["text"].	No
turn_detection	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.	No
└- prefix_padding_ms	integer	Množství zvuku, které se má zahrnout před detekovanou řečí VAD (v milisekundách). Výchozí hodnota je 300 ms.	No
└─ trvání_ticha_ms	integer	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.	No
└- prahová hodnota	number	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.	No
└- typ	řetězec	Aktuálně je podporován pouze typ detekce otáčení server_vad.	No

Reasoning

Možnosti konfigurace pro zdůvodnění modelů

Name	Typ	Description	Required	Default
úsilí	ReasoningEffort	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.	Yes	médium
souhrn	výčet	Souhrn důvodů provedených modelem To může být užitečné pro ladění a pochopení procesu odůvodnění modelu. Jedna z možností: concise nebo detailed Možné hodnoty: concise, detailed	No

ReasoningItem

Popis řetězce myšlenky používaného modelem odůvodnění při generování odpovědi.

Name	Typ	Description	Required	Default
obsah	pole	Zdůvodnění obsahu textu	Yes
id	řetězec	Jedinečný identifikátor obsahu odůvodnění.	Yes
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	No
typ	výčet	Typ objektu. Vždy reasoning. Možné hodnoty: reasoning	Yes

Refusal

Odmítnutí modelu.

Name	Typ	Description	Required	Default
refusal	řetězec	Vysvětlení zamítnutí od modelu.	Yes
typ	výčet	Typ odmítnutí. Vždy refusal. Možné hodnoty: refusal	Yes

response

Name	Typ	Description	Required	Default
created_at	number	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Yes
chyba	ResponseError	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Yes
id	řetězec	Jedinečný identifikátor pro tuto odpověď.	Yes
incomplete_details	objekt	Podrobnosti o tom, proč je odpověď neúplná.	Yes
└důvod	výčet	Důvod, proč je odpověď neúplná. Možné hodnoty: max_output_tokens, content_filter	No
instructions	ř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.	Yes
max_output_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a stavu konverzace.	No
metadata	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ů.	Yes
model	řetězec	Model použitý k vygenerování odpovědí	Yes
objekt	výčet	Typ objektu tohoto prostředku – vždy nastaven na response. Možné hodnoty: response	Yes
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.	Yes
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.	No
parallel_tool_calls	boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Yes	True
previous_response_id	ř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.	No
reasoning	Reasoning	Možnosti konfigurace pro zdůvodnění modelů	No
stav	výčet	Stav generování odpovědi. Jeden z completed, failed, in_progressnebo incomplete. Možné hodnoty: completed, failed, in_progress, incomplete	No
temperature	number	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í.	Yes	1
poslat SMS	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	No
└─ Formát	TextResponseFormatConfiguration	Objekt určující formát, který musí model vypíše. Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, což zajišťuje, že model odpovídá 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í.	No
tool_choice	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.	Yes
tools	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	Yes
top_p	number	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í.	Yes	1
truncation	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	No
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ů.	No
uživatel	řetězec	Jedinečný identifikátor představující koncového uživatele, který může pomoct OpenAI monitorovat a zjišťovat zneužití. .	No

ResponseAudioDeltaEvent

Vygenerováno, pokud je k dispozici částečná zvuková odpověď.

Name	Typ	Description	Required	Default
delta	řetězec	Blok odeslaných zvukových bajtů zakódovaných pomocí Base64.	Yes
typ	výčet	Typ události. Vždy response.audio.delta. Možné hodnoty: response.audio.delta	Yes

ResponseAudioDoneEvent

Po dokončení zvukové odpovědi dojde k vysílání.

Name	Typ	Description	Required	Default
typ	výčet	Typ události. Vždy response.audio.done. Možné hodnoty: response.audio.done	Yes

ResponseAudioTranscriptDeltaEvent

Vygenerováno, pokud je k dispozici částečný přepis zvuku.

Name	Typ	Description	Required	Default
delta	řetězec	Částečný přepis zvukové odpovědi.	Yes
typ	výčet	Typ události. Vždy response.audio.transcript.delta. Možné hodnoty: response.audio.transcript.delta	Yes

ResponseAudioTranscriptDoneEvent

Emitování nastane po dokončení úplného přepisu zvuku.

Name	Typ	Description	Required	Default
typ	výčet	Typ události. Vždy response.audio.transcript.done. Možné hodnoty: response.audio.transcript.done	Yes

ResponseCodeInterpreterCallCodeDeltaEvent

Vygeneruje se při přidání částečného fragmentu kódu interpretem kódu.

Name	Typ	Description	Required	Default
delta	řetězec	Částečný fragment kódu přidaný interpretem kódu.	Yes
output_index	integer	Index výstupní položky, u níž právě probíhá volání interpreta kódu.	Yes
typ	výčet	Typ události. Vždy response.code_interpreter_call.code.delta. Možné hodnoty: response.code_interpreter_call.code.delta	Yes

ResponseCodeInterpreterCallCodeDoneEvent

Emitováno, když je výstup fragmentu kódu finalizován interpretem kódu.

Name	Typ	Description	Required	Default
kód	řetězec	Výstup konečného fragmentu kódu interpretem kódu.	Yes
output_index	integer	Index výstupní položky, u níž právě probíhá volání interpreta kódu.	Yes
typ	výčet	Typ události. Vždy response.code_interpreter_call.code.done. Možné hodnoty: response.code_interpreter_call.code.done	Yes

ResponseCodeInterpreterCallCompletedEvent

Po dokončení volání interpreta kódu se vysílá.

Name	Typ	Description	Required	Default
code_interpreter_call	CodeInterpreterToolCall	Volání nástroje ke spuštění kódu	Yes
output_index	integer	Index výstupní položky, u níž právě probíhá volání interpreta kódu.	Yes
typ	výčet	Typ události. Vždy response.code_interpreter_call.completed. Možné hodnoty: response.code_interpreter_call.completed	Yes

ResponseCodeInterpreterCallInProgressEvent

Vygenerováno, když probíhá volání interpreta kódu.

Name	Typ	Description	Required	Default
code_interpreter_call	CodeInterpreterToolCall	Volání nástroje ke spuštění kódu	Yes
output_index	integer	Index výstupní položky, u níž právě probíhá volání interpreta kódu.	Yes
typ	výčet	Typ události. Vždy response.code_interpreter_call.in_progress. Možné hodnoty: response.code_interpreter_call.in_progress	Yes

ResponseCodeInterpreterCallInterpretingEvent

Vygeneruje se, když interpret kódu aktivně interpretuje fragment kódu.

Name	Typ	Description	Required	Default
code_interpreter_call	CodeInterpreterToolCall	Volání nástroje ke spuštění kódu	Yes
output_index	integer	Index výstupní položky, u níž právě probíhá volání interpreta kódu.	Yes
typ	výčet	Typ události. Vždy response.code_interpreter_call.interpreting. Možné hodnoty: response.code_interpreter_call.interpreting	Yes

ResponseCompletedEvent

Po dokončení odpovědi modelu se aktivuje.

Name	Typ	Description	Required	Default
response	response		Yes
typ	výčet	Typ události. Vždy response.completed. Možné hodnoty: response.completed	Yes

ResponseContentPartAddedEvent

Vygeneruje se při přidání nové části obsahu.

Name	Typ	Description	Required	Default
content_index	integer	Index přidané části obsahu.	Yes
item_id	řetězec	ID výstupní položky, do které byla část obsahu přidána.	Yes
output_index	integer	Index výstupní položky, do které byla část obsahu přidána.	Yes
part	OutputContent		Yes
typ	výčet	Typ události. Vždy response.content_part.added. Možné hodnoty: response.content_part.added	Yes

ResponseContentPartDoneEvent

Vydává se, když je část obsahu hotová.

Name	Typ	Description	Required	Default
content_index	integer	Index části obsahu, která je dokončena.	Yes
item_id	řetězec	ID výstupní položky, do které byla část obsahu přidána.	Yes
output_index	integer	Index výstupní položky, do které byla část obsahu přidána.	Yes
part	OutputContent		Yes
typ	výčet	Typ události. Vždy response.content_part.done. Možné hodnoty: response.content_part.done	Yes

ResponseCreatedEvent

Událost, která se vygeneruje při vytvoření odpovědi.

Name	Typ	Description	Required	Default
response	response		Yes
typ	výčet	Typ události. Vždy response.created. Možné hodnoty: response.created	Yes

ResponseError

Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.

Name	Typ	Description	Required	Default
kód	ResponseErrorCode	Kód chyby pro odpověď.	Yes
zpráva	řetězec	Popis chyby čitelný člověkem.	Yes

ResponseErrorCode

Kód chyby pro odpověď.

Property	Value
Description	Kód chyby pro odpověď.
Type	řetězec
Values	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ě.

Name	Typ	Description	Required	Default
kód	řetězec	Kód chyby.	Yes
zpráva	řetězec	Chybová zpráva.	Yes
param	řetězec	Parametr chyby.	Yes
typ	výčet	Typ události. Vždy error. Možné hodnoty: error	Yes

ResponseFailedEvent

Událost, která se vygeneruje v případě selhání odpovědi.

Name	Typ	Description	Required	Default
response	response		Yes
typ	výčet	Typ události. Vždy response.failed. Možné hodnoty: response.failed	Yes

ResponseFileSearchCallCompletedEvent

Vygenerováno při dokončení volání hledání souborů (nalezeny výsledky).

Name	Typ	Description	Required	Default
item_id	řetězec	ID výstupní položky, kterou je inicializováno volání hledání souborů.	Yes
output_index	integer	Index výstupní položky, kterou je inicializováno volání hledání souborů.	Yes
typ	výčet	Typ události. Vždy response.file_search_call.completed. Možné hodnoty: response.file_search_call.completed	Yes

ResponseFileSearchCallInProgressEvent

Vygenerováno při zahájení volání hledání souboru.

Name	Typ	Description	Required	Default
item_id	řetězec	ID výstupní položky, kterou je inicializováno volání hledání souborů.	Yes
output_index	integer	Index výstupní položky, kterou je inicializováno volání hledání souborů.	Yes
typ	výčet	Typ události. Vždy response.file_search_call.in_progress. Možné hodnoty: response.file_search_call.in_progress	Yes

ResponseFileSearchCallSearchingEvent

Vygenerováno při hledání souborů, které právě hledáte.

Name	Typ	Description	Required	Default
item_id	řetězec	ID výstupní položky, kterou je inicializováno volání hledání souborů.	Yes
output_index	integer	Index výstupní položky, kterou hledá volání hledání souboru.	Yes
typ	výčet	Typ události. Vždy response.file_search_call.searching. Možné hodnoty: response.file_search_call.searching	Yes

ResponseFunctionCallArgumentsDeltaEvent

Vygenerováno v případě, že existuje rozdíl argumentů částečného volání funkce.

Name	Typ	Description	Required	Default
delta	řetězec	Argumenty volání funkce delta, které se přidají.	Yes
item_id	řetězec	ID konkrétní výstupní položky, ke které se přičítá delta argumentů volání funkce.	Yes
output_index	integer	Index výstupní položky, ke které je přidána delta argumentů volání funkce.	Yes
typ	výčet	Typ události. Vždy response.function_call_arguments.delta. Možné hodnoty: response.function_call_arguments.delta	Yes

ResponseFunctionCallArgumentsDoneEvent

Vygenerováno, když jsou argumenty volání funkce finalizovány.

Name	Typ	Description	Required	Default
arguments	řetězec	Argumenty volání funkce.	Yes
item_id	řetězec	ID položky.	Yes
output_index	integer	Index výstupní položky.	Yes
typ	výčet	Možné hodnoty: response.function_call_arguments.done	Yes

ResponseInProgressEvent

Vygenerováno, když probíhá odpověď.

Name	Typ	Description	Required	Default
response	response		Yes
typ	výčet	Typ události. Vždy response.in_progress. Možné hodnoty: response.in_progress	Yes

ResponseIncompleteEvent

Událost, která se vygeneruje, když se odpověď dokončí jako neúplná.

Name	Typ	Description	Required	Default
response	response		Yes
typ	výčet	Typ události. Vždy response.incomplete. Možné hodnoty: response.incomplete	Yes

responseItemList

Seznam položek odpovědi.

Name	Typ	Description	Required	Default
data	pole	Seznam položek použitých k vygenerování této odpovědi	Yes
first_id	řetězec	ID první položky v seznamu.	Yes
has_more	boolean	Jestli je k dispozici více položek.	Yes
last_id	řetězec	ID poslední položky v seznamu.	Yes
objekt	výčet	Typ vráceného objektu musí být list. Možné hodnoty: list	Yes

ResponseModalities

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.

ResponseModalitiesTextOnly

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.

ResponseOutputItemAddedEvent

Dojde k emisi, když je přidána nová výstupní položka.

Name	Typ	Description	Required	Default
položka	OutputItem		Yes
output_index	integer	Index přidané výstupní položky.	Yes
typ	výčet	Typ události. Vždy response.output_item.added. Možné hodnoty: response.output_item.added	Yes

ResponseOutputItemDoneEvent

Vygenerováno, když je výstupní položka označena jako dokončená.

Name	Typ	Description	Required	Default
položka	OutputItem		Yes
output_index	integer	Index výstupní položky, která byla označena jako dokončená.	Yes
typ	výčet	Typ události. Vždy response.output_item.done. Možné hodnoty: response.output_item.done	Yes

ResponseProperties

Name	Typ	Description	Required	Default
instructions	ř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.	No
max_output_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a stavu konverzace.	No
previous_response_id	ř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.	No
reasoning	Reasoning	Možnosti konfigurace pro zdůvodnění modelů	No
poslat SMS	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	No
└─ Formát	TextResponseFormatConfiguration	Objekt určující formát, který musí model vypíše. Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, což zajišťuje, že model odpovídá 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í.	No
tool_choice	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.	No
tools	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	No
truncation	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	No

ResponseRefusalDeltaEvent

Vygenerováno v případě částečného odmítnutí textu.

Name	Typ	Description	Required	Default
content_index	integer	Index části obsahu, do které se přidává text odmítnutí.	Yes
delta	řetězec	Text o odmítnutí, který je přidán.	Yes
item_id	řetězec	ID výstupní položky, do které je přidán text odmítnutí.	Yes
output_index	integer	Index výstupní položky, do které je přidán text zamítnutí.	Yes
typ	výčet	Typ události. Vždy response.refusal.delta. Možné hodnoty: response.refusal.delta	Yes

ResponseRefusalDoneEvent

Emitováno, když je dokončen text odmítnutí.

Name	Typ	Description	Required	Default
content_index	integer	Index části obsahu, ve které je text odmítnutí finalizován.	Yes
item_id	řetězec	ID výstupní položky, kterou je zamítnutý text finalizován.	Yes
output_index	integer	Index výstupní položky, kdy je zamítnutý text finalizován.	Yes
refusal	řetězec	Text odmítnutí, který je finalizován.	Yes
typ	výčet	Typ události. Vždy response.refusal.done. Možné hodnoty: response.refusal.done	Yes

responseStreamEvent

Name	Typ	Description	Required	Default
poznámka	Annotation		Yes
annotation_index	integer	Index přidané poznámky.	Yes
arguments	řetězec	Argumenty volání funkce.	Yes
kód	řetězec	Kód chyby.	Yes
code_interpreter_call	CodeInterpreterToolCall	Volání nástroje ke spuštění kódu	Yes
content_index	integer	Index té části obsahu, ve které je textový obsah finalizován.	Yes
delta	řetězec	Text delta, který byl přidán.	Yes
položka	OutputItem	Výstupní položka, která byla označena jako hotová.	Yes
item_id	řetězec	ID výstupní položky, kterou je textový obsah finalizován.	Yes
zpráva	řetězec	Chybová zpráva.	Yes
output_index	integer	Index výstupní položky, který finalizuje textový obsah.	Yes
param	řetězec	Parametr chyby.	Yes
part	OutputContent	Část obsahu, která je hotová.	Yes
refusal	řetězec	Text odmítnutí, který je finalizován.	Yes
response	response	Odpověď, která byla neúplná.	Yes
poslat SMS	řetězec	Textový obsah, který je finalizován.	Yes
typ	výčet	Typ události. Vždy response.output_text.done. Možné hodnoty: response.output_text.done	Yes

ResponseTextAnnotationDeltaEvent

Při přidání textové poznámky se vygeneruje.

Name	Typ	Description	Required	Default
poznámka	Annotation		Yes
annotation_index	integer	Index přidané poznámky.	Yes
content_index	integer	Index části obsahu, do které byla přidána textová poznámka.	Yes
item_id	řetězec	ID výstupní položky, do které byla přidána textová poznámka.	Yes
output_index	integer	Index výstupní položky, do které byla přidána textová poznámka.	Yes
typ	výčet	Typ události. Vždy response.output_text.annotation.added. Možné hodnoty: response.output_text.annotation.added	Yes

ResponseTextDeltaEvent

Emitováno, když je k dispozici dodatečný textový delta.

Name	Typ	Description	Required	Default
content_index	integer	Index části obsahu, do které byla přidána textová delta.	Yes
delta	řetězec	Text delta, který byl přidán.	Yes
item_id	řetězec	ID výstupní položky, ke které byla přidána textová delta.	Yes
output_index	integer	Index výstupní položky, do které byl přidán rozdíl textu.	Yes
typ	výčet	Typ události. Vždy response.output_text.delta. Možné hodnoty: response.output_text.delta	Yes

ResponseTextDoneEvent

Vygenerováno při finalizaci textového obsahu.

Name	Typ	Description	Required	Default
content_index	integer	Index té části obsahu, ve které je textový obsah finalizován.	Yes
item_id	řetězec	ID výstupní položky, kterou je textový obsah finalizován.	Yes
output_index	integer	Index výstupní položky, který finalizuje textový obsah.	Yes
poslat SMS	řetězec	Textový obsah, který je finalizován.	Yes
typ	výčet	Typ události. Vždy response.output_text.done. Možné hodnoty: response.output_text.done	Yes

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

Name	Typ	Description	Required	Default
input_tokens	integer	Počet vstupních tokenů.	Yes
output_tokens	integer	Počet výstupních tokenů	Yes
output_tokens_details	objekt	Podrobný rozpis výstupních tokenů	Yes
└─ "reasoning_tokens"	integer	Počet tokenů pro logické uvažování.	No
total_tokens	integer	Celkový počet použitých tokenů	Yes

Screenshot

Akce snímku obrazovky

Name	Typ	Description	Required	Default
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	Yes

Scroll

Akce scrollování

Name	Typ	Description	Required	Default
scroll_x	integer	Vodorovná vzdálenost posouvání.	Yes
scroll_y	integer	Svislá posuvná vzdálenost.	Yes
typ	výčet	Určuje typ události. U akce posouvání je tato vlastnost vždy nastavena na scrollhodnotu . Možné hodnoty: scroll	Yes
x	integer	Souřadnice x, kde došlo k posunu.	Yes
y	integer	Souřadnice y, kde došlo ke scrollování.	Yes

StopConfiguration

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:

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 odpovídá 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
• TextResponseFormatJsonSchema
• 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.

Name	Typ	Description	Required	Default
description	řetězec	Popis formátu odpovědi, který model používá k určení způsobu reakce v tomto formátu.	No
name	ř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.	No
schéma	ResponseFormatJsonSchemaSchema	Schéma pro formát odpovědi popsané jako objekt schématu JSON.	Yes
strict	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. Pokud je stricttrue, podporuje se pouze podmnožina schématu JSON.	No	False
typ	výčet	Typ formátu odpovědi, který se definuje. Vždy json_schema. Možné hodnoty: json_schema	Yes

Tool

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

• FileSearchTool
• FunctionTool
• ComputerTool

ToolChoiceFunction

Tuto možnost použijte k vynucení volání konkrétní funkce modelu.

Name	Typ	Description	Required	Default
name	řetězec	Název funkce, která se má volat.	Yes
typ	výčet	Pro volání funkce je typ vždy function. Možné hodnoty: function	Yes

ToolChoiceOptions

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

Property	Value
Description	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ů.
Type	řetězec
Values	none auto required

ToolChoiceTypes

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj.

Name	Typ	Description	Required	Default
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	Yes

Typ

Akce pro zadávání textu.

Name	Typ	Description	Required	Default
poslat SMS	řetězec	Text, který chcete zadat.	Yes
typ	výčet	Určuje typ události. U akce typu je tato vlastnost vždy nastavena na typehodnotu . Možné hodnoty: type	Yes

UpdateVectorStoreFileAttributesRequest

Name	Typ	Description	Required	Default
attributes	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.	Yes

UrlCitation

Citace webového prostředku použitého k vygenerování odpovědi modelu

Name	Typ	Description	Required	Default
end_index	integer	Index posledního znaku citace adresy URL ve zprávě.	Yes
start_index	integer	Index prvního znaku citace adresy URL ve zprávě.	Yes
title	řetězec	Název webového prostředku.	Yes
typ	výčet	Typ citace adresy URL. Vždy url_citation. Možné hodnoty: url_citation	Yes
url	řetězec	Adresa URL webového prostředku.	Yes

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.

VectorStoreFileContentResponse

Představuje analyzovaný obsah souboru vektorového úložiště.

Name	Typ	Description	Required	Default
data	pole	Parsovaný obsah souboru	Yes
has_more	boolean	Označuje, zda je třeba načíst více stránek obsahu.	Yes
next_page	řetězec	Token pro další stránku, pokud existuje.	Yes
objekt	výčet	Typ objektu, který je vždy vector_store.file_content.page Možné hodnoty: vector_store.file_content.page	Yes

VectorStoreSearchRequest

Name	Typ	Description	Required	Default
filters	ComparisonFilter nebo CompoundFilter	Filtr, který se použije na základě atributů souboru.	No
max_num_results	integer	Maximální počet výsledků, které se mají vrátit. Toto číslo by mělo být mezi 1 a 50 včetně.	No	10
dotaz	řetězec nebo pole	Řetězec dotazu pro hledání	Yes
ranking_options	objekt	Možnosti řazení pro hledání	No
└- ranker	výčet	Možné hodnoty: auto, default-2024-11-15	No
└ score_threshold	number		No	0
rewrite_query	boolean	Zda se má dotaz v přirozeném jazyce přepsat pro vektorové vyhledávání.	No	False

VectorStoreSearchResultContentObject

Name	Typ	Description	Required	Default
poslat SMS	řetězec	Textový obsah vrácený z hledání.	Yes
typ	výčet	Typ obsahu. Možné hodnoty: text	Yes

VectorStoreSearchResultItem

Name	Typ	Description	Required	Default
attributes	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.	Yes
obsah	pole	Bloky obsahu ze souboru.	Yes
file_id	řetězec	ID souboru úložiště vektorů.	Yes
filename	řetězec	Název souboru úložiště vektorů.	Yes
skóre	number	Skóre podobnosti výsledku	Yes

VectorStoreSearchResultsPage

Name	Typ	Description	Required	Default
data	pole	Seznam položek výsledků hledání	Yes
has_more	boolean	Označuje, zda existují další výsledky ke stažení.	Yes
next_page	řetězec	Token pro další stránku, pokud existuje.	Yes
objekt	výčet	Typ objektu, který je vždy vector_store.search_results.page Možné hodnoty: vector_store.search_results.page	Yes
search_query	pole		Yes

VoiceIdsShared

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

Wait

Akce čekání.

Name	Typ	Description	Required	Default
typ	výčet	Určuje typ události. U akce čekání je tato vlastnost vždy nastavena na waithodnotu . Možné hodnoty: wait	Yes

ReasoningEffort

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.

Property	Value
Description	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.
Type	řetězec
Default	médium
Values	low medium high

errorEvent

Nastane, když dojde k chybě. K tomu může dojít kvůli vnitřní chybě serveru nebo vypršení časového limitu.

Name	Typ	Description	Required	Default
data	error		Yes
událost	řetězec		Yes

event Enum: ErrorEventEnum

Value	Description
chyba

doneEvent

Nastane, když datový proud skončí.

Name	Typ	Description	Required	Default
data	řetězec		Yes
událost	řetězec		Yes

event Enum: DoneEventEnum

Value	Description
done

datový výčet: DoneEventDataEnum

Value	Description
[DONE]

Další kroky

Seznamte se s modely a vyladěním pomocí rozhraní REST API. Zjistěte více o základních modelech, které pohánějí Azure OpenAI.