Sdílet prostřednictvím

Referenční informace k rozhraní REST API služby Azure OpenAI Ve verzi Preview

  • Článek

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

Specifikace rozhraní API

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

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

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

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

Ověřování

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

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

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

Správa verzí rozhraní REST API

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

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

Odvození roviny dat

Zbytek článku popisuje nejnovější verzi Preview specifikace odvozování roviny dat Azure OpenAI. 2024-10-01-preview Tento článek obsahuje dokumentaci k nejnovějším funkcím ve verzi Preview, jako jsou asistenti, vlákna a úložiště vektorů.

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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
deployment-id path Ano string ID nasazení modelu, který byl nasazen.
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

Name Typ Popis Požaduje se Výchozí
pobídnout řetězec nebo pole Výzvy k vygenerování dokončení pro, zakódované jako řetězec, pole řetězců, pole tokenů nebo pole polí tokenů.

Všimněte si, že <|endoftext|> je oddělovač dokumentu, který model uvidí během trénování, takže pokud není zadána výzva, model se vygeneruje, jako by byl na začátku nového dokumentu.
 Ano
best_of integer Vygeneruje best_of dokončení na straně serveru a vrátí "nejlepší" (ten s nejvyšší pravděpodobností protokolu na token). Výsledky se nedají streamovat.

Pokud se používá s n, best_of řídí počet dokončení kandidáta a n určuje, kolik se má vrátit â € best_of " musí být větší než n.

Poznámka: Protože tento parametr generuje mnoho dokončení, může rychle spotřebovat kvótu tokenu. Pečlivě používejte a ujistěte se, že máte přiměřené nastavení a max_tokens stop.
 No 0
echo boolean Ozvěte výzvu kromě dokončení.
 No False
frequency_penalty Číslo Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.
 No 0
logit_bias objekt Upravte pravděpodobnost výskytu zadaných tokenů v dokončení.

Přijímá objekt JSON, který mapuje tokeny (určené jejich ID tokenu v tokenizátoru GPT) na přidruženou hodnotu předsudku od -100 do 100. Matematicky se před vzorkováním přidá do logitů vygenerovaných modelem. Přesný účinek se bude lišit podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu.

Můžete například předat {"50256": -100} , abyste zabránili generování tokenu <|endoftext|> .
 No Nic
protokoly integer Zahrňte pravděpodobnosti protokolu u nejpravděpodobnějších logprobs výstupních tokenů a vybraných tokenů. Pokud je například logprobs 5, rozhraní API vrátí seznam pěti nejpravděpodobnějších tokenů. Rozhraní API vždy vrátí logprob vzorkovaný token, takže v odpovědi může být až logprobs+1 elementy.

Maximální hodnota je logprobs 5.
 No Nic
max_tokens integer Maximální počet tokenů, které lze vygenerovat v dokončení.

Počet tokenů výzvy plus max_tokens nesmí překročit délku kontextu modelu.
No 16
n integer Kolik dokončení se má vygenerovat pro každou výzvu.

Poznámka: Protože tento parametr generuje mnoho dokončení, může rychle spotřebovat kvótu tokenu. Pečlivě používejte a ujistěte se, že máte přiměřené nastavení a max_tokens stop.
 No 0
presence_penalty Číslo Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.
 No 0
semeno integer Pokud je zadáno, náš systém se bude snažit vzorkovat deterministicky, aby opakované požadavky se stejnými seed parametry měly vrátit stejný výsledek.

Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.
 No
Zastavit řetězec nebo pole Až čtyři sekvence, ve kterých rozhraní API přestane generovat další tokeny. Vrácený text nebude obsahovat sekvenci zastavení.
 No
datový proud boolean Zda se má streamovat zpět částečný průběh. Pokud jsou nastavené, tokeny se posílají jako události odesílané jen pro data, jakmile budou k dispozici, a datový proud je ukončen zprávoudata: [DONE].
 No False
přípona string Přípona, která následuje po dokončení vloženého textu.

Tento parametr je podporován pouze pro gpt-3.5-turbo-instruct.
 No Nic
Teplota Číslo Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.

Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.
 No 0
top_p Číslo Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.
 No 0
user string Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.
 No

Odpovědi

Stavový kód: 200

Popis: OK

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

Stavový kód: výchozí

Popis: Služba není k dispozici

Typ obsahu Typ Popis
application/json errorResponse

Příklady

Příklad

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

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
deployment-id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

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

Odpovědi

Name Typ Popis Požaduje se Výchozí
objekt string Ano
model string Ano
data pole Ano
využití objekt Ano

Vlastnosti pro použití

prompt_tokens

Name Typ Popis Výchozí
prompt_tokens integer

total_tokens

Name Typ Popis Výchozí
total_tokens integer

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json objekt

Příklady

Příklad

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

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-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.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05,
          0.0032178196
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Dokončení chatu – Vytvoření

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

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
deployment-id path Ano string ID nasazení modelu, který byl nasazen.
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

Name Typ Popis Požaduje se Výchozí
Teplota Číslo Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.

Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.
 No 0
top_p Číslo Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.
 No 0
datový proud boolean Pokud je tato možnost nastavená, budou odeslány částečné rozdíly zpráv, například v ChatGPT. Tokeny se posílají jako události odesílané jen pro data, jakmile budou k dispozici, a datový proud je ukončen zprávoudata: [DONE].
 No False
Zastavit řetězec nebo pole Až čtyři sekvence, ve kterých rozhraní API přestane generovat další tokeny.
 No
max_tokens integer Maximální počet tokenů, které lze vygenerovat v dokončení chatu.

Celková délka vstupních tokenů a vygenerovaných tokenů je omezená délkou kontextu modelu.
No
max_completion_tokens integer Horní mez počtu tokenů, které lze vygenerovat pro dokončení, včetně viditelných výstupních tokenů a zdůvodnění tokenů. To je podporováno pouze v modelech řady o1. Rozšíří podporu dalších modelů v budoucí verzi rozhraní API. No
presence_penalty Číslo Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.
 No 0
frequency_penalty Číslo Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.
 No 0
logit_bias objekt Upravte pravděpodobnost výskytu zadaných tokenů v dokončení.

Přijímá objekt JSON, který mapuje tokeny (určené jejich ID tokenu v tokenizátoru) na přidruženou hodnotu předsudku od -100 do 100. Matematicky se před vzorkováním přidá do logitů vygenerovaných modelem. Přesný účinek se bude lišit podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu.
 No Nic
user string Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.
 No
zprávy pole Seznam zpráv, které tvoří dosud konverzaci. Ano
data_sources pole Položky konfigurace pro rozšíření chatu Azure OpenAI, které je používají.
Tato další specifikace je kompatibilní pouze s Azure OpenAI.		 No
protokoly boolean Zda se mají vrátit pravděpodobnosti protokolu výstupních tokenů, nebo ne. Pokud je pravda, vrátí pravděpodobnosti protokolu každého výstupního tokenu vráceného v hodnotě content message. No False
top_logprobs integer Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu. logprobs parametr musí být nastaven na true hodnotu, pokud je použit tento parametr. No
n integer Kolik možností dokončení chatu se má vygenerovat pro každou vstupní zprávu. Mějte na paměti, že se vám bude účtovat na základě počtu vygenerovaných tokenů napříč všemi možnostmi. Udržujte n si přehled o 1 minimalizaci nákladů. No 0
parallel_tool_calls ParallelToolCalls Zda se má povolit paralelní volání funkcí během použití nástroje. No True
response_format ResponseFormatText nebo ResponseFormatJsonObject nebo ResponseFormatJsonSchema Objekt určující formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4o mini, GPT-4 Turbo a všechny GPT-3.5 Turbo modely novější než gpt-3.5-turbo-1106.

Nastavení pro { "type": "json_schema", "json_schema": {...} } povolení strukturovaných výstupů, které zaručuje, že model bude odpovídat zadanému schématu JSON.

Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

Důležité: Pokud používáte režim JSON, musíte také dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.
 No
semeno integer Tato funkce je v beta verzi.
Pokud je zadáno, náš systém se bude snažit vzorkovat deterministicky, aby opakované požadavky se stejnými seed parametry měly vrátit stejný výsledek.
Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.
 No
stream_options chatCompletionStreamOptions Možnosti pro odpověď streamování Toto nastavení nastavíte pouze při nastavení stream: true.
 No Nic
tools pole Seznam nástrojů, které model může volat. V současné době se jako nástroj podporují jenom funkce. Pomocí tohoto příkazu můžete poskytnout seznam funkcí, pro které může model generovat vstupy JSON. Podporuje se maximálně 128 funkcí.
 No
tool_choice chatCompletionToolChoiceOption Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádný nástroj a místo toho vygeneruje zprávu. auto znamená, že model si může vybrat mezi generováním zprávy nebo voláním jednoho nebo více nástrojů. required znamená, že model musí volat jeden nebo více nástrojů. Zadáním konkrétního nástroje vynutíte {"type": "function", "function": {"name": "my_function"}} model, aby tento nástroj volal. none je výchozí, pokud nejsou k dispozici žádné nástroje. auto je výchozí, pokud jsou k dispozici nástroje. No
function_call string nebo chatCompletionFunctionCallOption Zastaralá ve prospěch tool_choice.

Určuje, která funkce (pokud existuje) volána modelem.
none znamená, že model nebude volat funkci a místo toho vygeneruje zprávu.
auto znamená, že model může vybrat mezi generováním zprávy nebo voláním funkce.
Zadáním konkrétní funkce vynutíte {"name": "my_function"} , aby model volal danou funkci.

none je výchozí, pokud nejsou k dispozici žádné funkce. auto je výchozí, pokud jsou k dispozici funkce.
 No
– funkce pole Zastaralá ve prospěch tools.

Seznam funkcí, pro které model může generovat vstupy JSON.
 No

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json createChatCompletionResponse nebo createChatCompletionStreamResponse

Stavový kód: výchozí

Popis: Služba není k dispozici

Typ obsahu Typ Popis
application/json errorResponse

Příklady

Příklad

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

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

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

Odpovědi: Stavový kód: 200

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

Příklad

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

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

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

Odpovědi: Stavový kód: 200

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

Příklad

Vytvoří dokončení na základě dat vektoru obrázků služby Azure Search.

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

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

Odpovědi: Stavový kód: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Příklad

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

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

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

Odpovědi: Stavový kód: 200

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

Příklad

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

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

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

Odpovědi: Stavový kód: 200

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

Příklad

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

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Odpovědi: Stavový kód: 200

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

Příklad

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

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

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

Odpovědi: Stavový kód: 200

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

Příklad

Vytvoří dokončení pro zadaný zdroj Pinecone.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-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=2024-10-01-preview

Přepisuje zvuk do vstupního jazyka.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
deployment-id path Ano string ID nasazení modelu šeptu
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: multipart/form-data

Name Typ Popis Požaduje se Výchozí
soubor string Objekt zvukového souboru, který se má přepisovat. Ano
pobídnout string Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla odpovídat jazyku zvuku. No
response_format audioResponseFormat Definuje formát výstupu. No
Teplota Číslo Teplota vzorkování mezi 0 a 1. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Pokud je nastavená hodnota 0, model použije pravděpodobnost protokolu k automatickému zvýšení teploty do dosažení určitých prahových hodnot. No 0
jazyk string Jazyk vstupního zvuku. Poskytnutí jazyka zadávání vstupu ve formátu ISO-639-1 zlepší přesnost a latenci. No
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: Pro časová razítka segmentů neexistuje žádná další latence, ale generování časových razítek slov způsobuje další latenci. No ['segment']

Odpovědi

Stavový kód: 200

Popis: OK

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

Příklady

Příklad

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

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

Odpovědi: Stavový kód: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Příklad

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
deployment-id path Ano string ID nasazení modelu šeptu, který byl nasazen.
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: multipart/form-data

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

Odpovědi

Stavový kód: 200

Popis: OK

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

Příklady

Příklad

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

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Odpovědi: Stavový kód: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Příklad

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-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=2024-10-01-preview

Generuje zvuk ze vstupního textu.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
deployment-id path Ano string ID nasazení modelu tts, který byl nasazen.
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: multipart/form-data

Name Typ Popis Požaduje se Výchozí
vstup string Text pro syntetizaci zvuku. Maximální délka je 4 096 znaků. Ano
voice enum Hlas, který se má použít pro syntézu řeči.
Možné hodnoty: slitina, echo, fable, onyx, nova, shimmer		 Ano
response_format enum Formát syntetizování zvuku v.
Možné hodnoty: mp3, opus, aac, flaši, wav, pcm		 No
rychlost Číslo Rychlost syntetizovaného zvuku. Vyberte hodnotu od 0.25 do 4.0. 1.0 je výchozí možnost. No 1.0

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/octet-stream string

Příklady

Příklad

Syntetizuje zvuk z poskytnutého textu.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
deployment-id path Ano string ID nasazení modelu dalle, který byl nasazen.
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

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

Odpovědi

Stavový kód: 200

Popis: Ok

Typ obsahu Typ Popis
application/json generateImagesResponse

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu Typ Popis
application/json dalleErrorResponse

Příklady

Příklad

Vytvoří obrázky s výzvou.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-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
          }
        }
      }
    ]
  }
}

Seznam – asistenti

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

Vrátí seznam asistentů.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
limit query No integer
order query No string
po query No string
před query No string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json listAssistantsResponse

Příklady

Příklad

Vrátí seznam asistentů.

GET https://{endpoint}/openai/assistants?api-version=2024-10-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=2024-10-01-preview

Vytvořte asistenta s modelem a pokyny.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

Name Typ Popis Požaduje se Výchozí
model Ano
jméno string Jméno asistenta. Maximální délka je 256 znaků.
 No
description string Popis asistenta. Maximální délka je 512 znaků.
 No
pokyny string Systémové pokyny, které asistent používá. Maximální délka je 256 000 znaků.
 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 []
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
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
Teplota Číslo Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.
 No 0
top_p Číslo Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.
 No 0
response_format asistentiApiResponseFormatOption Určuje formát, který musí model vypíše. Kompatibilní s GPT-4 Turbo a všemi modely GPT-3.5 Turbo od té doby gpt-3.5-turbo-1106.

Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

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

Vlastnosti pro tool_resources

code_interpreter

Name Typ Popis Výchozí
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ů.
 []
Name Typ Popis Výchozí
vector_store_ids pole Vektorové úložiště připojené k tomuto asistentovi. K asistentovi může být připojeno maximálně jedno úložiště vektorů.
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ě jedno úložiště vektorů.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json assistantObject Představuje model assistant , který může volat model a používat nástroje.

Příklady

Příklad

Vytvořte asistenta s modelem a pokyny.

POST https://{endpoint}/openai/assistants?api-version=2024-10-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=2024-10-01-preview

Načte asistenta.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
assistant_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json assistantObject Představuje model assistant , který může volat model a používat nástroje.

Příklady

Příklad

Načte asistenta.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-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=2024-10-01-preview

Upraví asistenta.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
assistant_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

Name Typ Popis Požaduje se Výchozí
model No
name string Jméno asistenta. Maximální délka je 256 znaků.
 No
description string Popis asistenta. Maximální délka je 512 znaků.
 No
pokyny string Systémové pokyny, které asistent používá. Maximální délka je 32 768 znaků.
 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 []
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
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
Teplota Číslo Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.
 No 0
top_p Číslo Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.
 No 0
response_format asistentiApiResponseFormatOption Určuje formát, který musí model vypíše. Kompatibilní s GPT-4 Turbo a všemi modely GPT-3.5 Turbo od té doby gpt-3.5-turbo-1106.

Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

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

Vlastnosti pro tool_resources

code_interpreter

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

file_search

Name Typ Popis Výchozí
vector_store_ids pole Přepíše vektorové úložiště připojené k tomuto asistentovi. K asistentovi může být připojeno maximálně jedno úložiště vektorů.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json assistantObject Představuje model assistant , který může volat model a používat nástroje.

Příklady

Příklad

Upraví asistenta.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-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=2024-10-01-preview

Odstraňte asistenta.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
assistant_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json deleteAssistantResponse

Příklady

Příklad

Odstraní asistenta.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-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=2024-10-01-preview

Vytvořte vlákno.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

Name Typ Popis Požaduje se Výchozí
zprávy pole Seznam zpráv, se kterými má vlákno začínat. 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
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

Vlastnosti pro tool_resources

code_interpreter

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

file_search

Name Typ Popis Výchozí
vector_store_ids 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ě.
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ě jedno vektorové úložiště.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json threadObject Představuje vlákno, které obsahuje zprávy.

Příklady

Příklad

Vytvoří vlákno.

POST https://{endpoint}/openai/threads?api-version=2024-10-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=2024-10-01-preview

Načte vlákno.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json threadObject Představuje vlákno, které obsahuje zprávy.

Příklady

Příklad

Načte vlákno.

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-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=2024-10-01-preview

Upraví vlákno.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

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

Vlastnosti pro tool_resources

code_interpreter

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

file_search

Name Typ Popis Výchozí
vector_store_ids pole Vektorové úložiště připojené k tomuto vláknu. K vláknu může být připojeno maximálně jedno vektorové úložiště.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json threadObject Představuje vlákno, které obsahuje zprávy.

Příklady

Příklad

Upraví vlákno.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-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=2024-10-01-preview

Odstraňte vlákno.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json deleteThreadResponse

Příklady

Příklad

Odstraní vlákno.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
limit query No integer
order query No string
po query No string
před query No string
run_id query No string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json listMessagesResponse

Příklady

Příklad

Výpis zpráv

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-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=2024-10-01-preview

Vytvořit zprávu.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

Name Typ Popis Požaduje se Výchozí
role string Role entity, která vytváří zprávu. Mezi povolené hodnoty patří:
- user: Označuje, že zpráva je odeslána skutečným uživatelem a měla by být použita ve většině případů k reprezentaci uživatelem generovaných zpráv.
- assistant: Označuje zprávu vygenerovanou asistentem. Tato hodnota slouží k vložení zpráv z asistenta do konverzace.
 Ano
content string Obsah zprávy. Ano
přílohy pole Seznam souborů připojených ke zprávě a nástroje, do které by se měly přidat. 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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json messageObject Představuje zprávu v rámci vlákna.

Příklady

Příklad

Vytvořit zprávu.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-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=2024-10-01-preview

Načtení zprávy

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
message_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json messageObject Představuje zprávu v rámci vlákna.

Příklady

Příklad

Načtení zprávy

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-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=2024-10-01-preview

Upraví zprávu.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
message_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json messageObject Představuje zprávu v rámci vlákna.

Příklady

Příklad

Umožňuje změnit zprávu.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

Name Typ Popis Požaduje se Výchozí
assistant_id string ID pomocníka, který se má použít ke spuštění tohoto spuštění. Ano
vlákno createThreadRequest No
model string Název nasazení 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
pokyny string 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
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
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
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
Teplota Číslo Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.
 No 0
top_p Číslo Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.
 No 0
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 Nic
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í bude maximálně usilovat o použití pouze počtu zadaných tokenů výzvy, a to napříč několikanásobným spuštěním. Pokud spuštění překročí zadaný počet zadaných tokenů výzvy, spuštění skončí se stavem incomplete. Další informace najdete incomplete_details .
 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í bude maximálně usilovat o použití pouze zadaného počtu tokenů dokončení, a to napříč několikanásobným otočením spuštění. Pokud spuštění překročí zadaný počet tokenů dokončení, spuštění skončí stavem incomplete. Další informace najdete incomplete_details .
 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í. No
tool_choice asistentiApiToolChoiceOption Určuje, který (pokud existuje) nástroj, který model volá.
none znamená, že model nebude volat žádné nástroje a místo toho vygeneruje zprávu.
auto je výchozí hodnota a znamená, že model může vybrat mezi generováním zprávy nebo voláním nástroje.
Určení konkrétního nástroje, například {"type": "file_search"} nebo {"type": "function", "function": {"name": "my_function"}} vynutí model, aby tento nástroj volal.
 No
parallel_tool_calls ParallelToolCalls Zda se má povolit paralelní volání funkcí během použití nástroje. No True
response_format asistentiApiResponseFormatOption Určuje formát, který musí model vypíše. Kompatibilní s GPT-4 Turbo a všemi modely GPT-3.5 Turbo od té doby gpt-3.5-turbo-1106.

Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

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

Vlastnosti pro tool_resources

code_interpreter

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

file_search

Name Typ Popis Výchozí
vector_store_ids pole ID vektorového úložiště připojeného k tomuto asistentovi. K asistentovi může být připojeno maximálně jedno úložiště vektorů.

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json runObject Představuje spuštění ve vlákně.

Příklady

Příklad

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

POST https://{endpoint}/openai/threads/runs?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
limit query No integer
order query No string
po query No string
před query No string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json listRunsResponse

Příklady

Příklad

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

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-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=2024-10-01-preview

Vytvořte spuštění.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

Name Typ Popis Požaduje se Výchozí
assistant_id string ID pomocníka, který se má použít ke spuštění tohoto spuštění. Ano
model string 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
pokyny string 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
additional_instructions string 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
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
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
Teplota Číslo Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.
 No 0
top_p Číslo Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.
 No 0
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
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í bude maximálně usilovat o použití pouze počtu zadaných tokenů výzvy, a to napříč několikanásobným spuštěním. Pokud spuštění překročí zadaný počet zadaných tokenů výzvy, spuštění skončí se stavem incomplete. Další informace najdete incomplete_details .
 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í bude maximálně usilovat o použití pouze zadaného počtu tokenů dokončení, a to napříč několikanásobným otočením spuštění. Pokud spuštění překročí zadaný počet tokenů dokončení, spuštění skončí stavem incomplete. Další informace najdete incomplete_details .
 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í. No
tool_choice asistentiApiToolChoiceOption Určuje, který (pokud existuje) nástroj, který model volá.
none znamená, že model nebude volat žádné nástroje a místo toho vygeneruje zprávu.
auto je výchozí hodnota a znamená, že model může vybrat mezi generováním zprávy nebo voláním nástroje.
Určení konkrétního nástroje, například {"type": "file_search"} nebo {"type": "function", "function": {"name": "my_function"}} vynutí model, aby tento nástroj volal.
 No
parallel_tool_calls ParallelToolCalls Zda se má povolit paralelní volání funkcí během použití nástroje. No True
response_format asistentiApiResponseFormatOption Určuje formát, který musí model vypíše. Kompatibilní s GPT-4 Turbo a všemi modely GPT-3.5 Turbo od té doby gpt-3.5-turbo-1106.

Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json runObject Představuje spuštění ve vlákně.

Příklady

Příklad

Vytvořte spuštění.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-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=2024-10-01-preview

Načte spuštění.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
run_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json runObject Představuje spuštění ve vlákně.

Příklady

Příklad

Získá spuštění.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-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=2024-10-01-preview

Upraví spuštění.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
run_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json runObject Představuje spuštění ve vlákně.

Příklady

Příklad

Upraví spuštění.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
run_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

Name Typ Popis Požaduje se Výchozí
tool_outputs pole Seznam nástrojů, pro které se odesílají výstupy. Ano
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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json runObject Představuje spuštění ve vlákně.

Příklady

Příklad

Po spuštění se status: "requires_action" required_action.type submit_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=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
run_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json runObject Představuje spuštění ve vlákně.

Příklady

Příklad

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

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
run_id path Ano string
limit query No integer
order query No string
po query No string
před query No string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json listRunStepsResponse

Příklady

Příklad

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

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-10-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=2024-10-01-preview

Načte krok spuštění.

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
thread_id path Ano string
run_id path Ano string
step_id path Ano string
verze-api query Ano string Verze rozhraní API

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json runStepObject Představuje krok při spuštění spuštění.

Příklady

Příklad

Načte krok spuštění.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
limit query No integer
order query No string
po query No string
před query No string
verze-api query Ano string

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json listVectorStoresResponse

Příklady

Příklad

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

GET https://{endpoint}/openai/vector_stores?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze-api query Ano string

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

Name Typ Popis Požaduje se Výchozí
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
name string Název úložiště vektorů. No
expires_after vectorStoreExpirationAfter Zásady vypršení platnosti pro úložiště vektorů. No
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 je neprázdný. 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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json vectorStoreObject Vektorové úložiště je kolekce zpracovaných souborů, kterou může nástroj použít file_search .

Příklady

Příklad

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

POST https://{endpoint}/openai/vector_stores?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
vector_store_id path Ano string
verze-api query Ano string

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json vectorStoreObject Vektorové úložiště je kolekce zpracovaných souborů, kterou může nástroj použít file_search .

Příklady

Příklad

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
vector_store_id path Ano string
verze-api query Ano string

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

Name Typ Popis Požaduje se Výchozí
name string Název úložiště vektorů. No
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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json vectorStoreObject Vektorové úložiště je kolekce zpracovaných souborů, kterou může nástroj použít file_search .

Příklady

Příklad

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
vector_store_id path Ano string
verze-api query Ano string

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json deleteVectorStoreResponse

Příklady

Příklad

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

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
vector_store_id path Ano string
limit query No integer
order query No string
po query No string
před query No string
filter query No string
verze-api query Ano string

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json listVectorStoreFilesResponse

Příklady

Příklad

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
vector_store_id path Ano string
verze-api query Ano string

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json vectorStoreFileObject Seznam souborů připojených k úložišti vektorů

Příklady

Příklad

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
vector_store_id path Ano string
file_id path Ano string
verze-api query Ano string

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json vectorStoreFileObject Seznam souborů připojených k úložišti vektorů

Příklady

Příklad

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
vector_store_id path Ano string
file_id path Ano string
verze-api query Ano string

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json deleteVectorStoreFileResponse

Příklady

Příklad

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

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

Odpovědi: Stavový kód: 200

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

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

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

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
vector_store_id path Ano string
verze-api query Ano string

Hlavička požadavku

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

Text požadavku

Content-Type: application/json

Name Typ Popis Požaduje se Výchozí
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. Ano
chunking_strategy chunkingStrategyRequestParam Strategie vytváření bloků dat použitá k vytvoření bloků souborů. Pokud není nastavená, použije strategii auto . No

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json vectorStoreFileBatchObject Dávka souborů připojených k úložišti vektorů.

Příklady

Příklad

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
vector_store_id path Ano string
batch_id path Ano string
verze-api query Ano string

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json vectorStoreFileBatchObject Dávka souborů připojených k úložišti vektorů.

Příklady

Příklad

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
vector_store_id path Ano string
batch_id path Ano string
verze-api query Ano string

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json vectorStoreFileBatchObject Dávka souborů připojených k úložišti vektorů.

Příklady

Příklad

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2024-10-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=2024-10-01-preview

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

Parametry identifikátoru URI

Název V Požaduje se Type Popis
endpoint path Ano string
url		 Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
vector_store_id path Ano string
batch_id path Ano string
limit query No integer
order query No string
po query No string
před query No string
filter query No string
verze-api query Ano string

Hlavička požadavku

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

Odpovědi

Stavový kód: 200

Popis: OK

Typ obsahu Typ Popis
application/json listVectorStoreFilesResponse

Příklady

Příklad

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2024-10-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
  }
}

Komponenty

errorResponse

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

errorBase

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

chyba

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

innerError

Vnitřní chyba s dalšími podrobnostmi

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

innerErrorCode

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

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

Typ: řetězec

Výchozí:

Název výčtu: InnerErrorCode

Hodnoty výčtu:

Hodnota Popis
ResponsibleAIPolicyViolation Výzva porušila jedno z více pravidel filtru obsahu.

dalleErrorResponse

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

dalleError

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

dalleInnerError

Vnitřní chyba s dalšími podrobnostmi

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

contentFilterCompletionTextSpan

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

Name Typ Popis Požaduje se Výchozí
completion_start_offset integer Posun bodu kódu UTF32, který začíná rozsahem. Ano
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 pro neprázdné rozsahy. Ano

contentFilterResultBase

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

contentFilterSeverityResult

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

contentFilterDetectedResult

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

contentFilterDetectedWithCitationResult

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

Vlastnosti citace

Adresa URL

Name Typ Popis Výchozí
URL string

license

Name Typ Popis Výchozí
license string

contentFilterDetectedWithCompletionTextSpansResult

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

contentFilterIdResult

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

contentFilterResultsBase

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

Name Typ Popis Požaduje se Výchozí
sexuální contentFilterSeverityResult No
násilí contentFilterSeverityResult No
nenávist contentFilterSeverityResult No
self_harm contentFilterSeverityResult No
rouhání contentFilterDetectedResult No
custom_blocklists contentFilterDetailedResults Výsledky filtrování obsahu s podrobnostmi o ID filtru obsahu pro filtrované segmenty No
chyba errorBase No

contentFilterPromptResults

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

Name Typ Popis Požaduje se Výchozí
sexuální contentFilterSeverityResult No
násilí contentFilterSeverityResult No
nenávist contentFilterSeverityResult No
self_harm contentFilterSeverityResult No
rouhání contentFilterDetectedResult No
custom_blocklists contentFilterDetailedResults Výsledky filtrování obsahu s podrobnostmi o ID filtru obsahu pro filtrované segmenty No
chyba errorBase No
útěk z vězení contentFilterDetectedResult No
indirect_attack contentFilterDetectedResult No

contentFilterChoiceResults

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

Name Typ Popis Požaduje se Výchozí
sexuální contentFilterSeverityResult No
násilí contentFilterSeverityResult No
nenávist contentFilterSeverityResult No
self_harm contentFilterSeverityResult No
rouhání contentFilterDetectedResult No
custom_blocklists contentFilterDetailedResults Výsledky filtrování obsahu s podrobnostmi o ID filtru obsahu pro filtrované segmenty No
chyba errorBase No
protected_material_text contentFilterDetectedResult No
protected_material_code contentFilterDetectedWithCitationResult No
ungrounded_material contentFilterDetectedWithCompletionTextSpansResult No

contentFilterDetailedResults

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

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

promptFilterResult

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

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

promptFilterResults

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

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

dalleContentFilterResults

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

Name Typ Popis Požaduje se Výchozí
sexuální contentFilterSeverityResult No
násilí contentFilterSeverityResult No
nenávist contentFilterSeverityResult No
self_harm 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 Popis Požaduje se Výchozí
sexuální contentFilterSeverityResult No
násilí contentFilterSeverityResult No
nenávist contentFilterSeverityResult No
self_harm contentFilterSeverityResult No
rouhání contentFilterDetectedResult No
útěk z vězení contentFilterDetectedResult No
custom_blocklists contentFilterDetailedResults Výsledky filtrování obsahu s podrobnostmi o ID filtru obsahu pro filtrované segmenty No

chatCompletionsRequestCommon

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

createCompletionRequest

Name Typ Popis Požaduje se Výchozí
pobídnout řetězec nebo pole Výzvy k vygenerování dokončení pro, zakódované jako řetězec, pole řetězců, pole tokenů nebo pole polí tokenů.

Všimněte si, že <|endoftext|> je oddělovač dokumentu, který model uvidí během trénování, takže pokud není zadána výzva, model se vygeneruje, jako by byl na začátku nového dokumentu.
 Ano
best_of integer Vygeneruje best_of dokončení na straně serveru a vrátí "nejlepší" (ten s nejvyšší pravděpodobností protokolu na token). Výsledky se nedají streamovat.

Pokud se používá s n, best_of řídí počet dokončení kandidáta a n určuje, kolik se má vrátit â € best_of " musí být větší než n.

Poznámka: Protože tento parametr generuje mnoho dokončení, může rychle spotřebovat kvótu tokenu. Pečlivě používejte a ujistěte se, že máte přiměřené nastavení a max_tokens stop.
 No 0
echo boolean Ozvěte výzvu kromě dokončení.
 No False
frequency_penalty Číslo Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.
 No 0
logit_bias objekt Upravte pravděpodobnost výskytu zadaných tokenů v dokončení.

Přijímá objekt JSON, který mapuje tokeny (určené jejich ID tokenu v tokenizátoru GPT) na přidruženou hodnotu předsudku od -100 do 100. Matematicky se před vzorkováním přidá do logitů vygenerovaných modelem. Přesný účinek se bude lišit podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu.

Můžete například předat {"50256": -100} , abyste zabránili generování tokenu <|endoftext|> .
 No Nic
protokoly integer Zahrňte pravděpodobnosti protokolu u nejpravděpodobnějších logprobs výstupních tokenů a vybraných tokenů. Pokud je například logprobs 5, rozhraní API vrátí seznam 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 Nic
max_tokens integer Maximální počet tokenů, které lze vygenerovat v dokončení.

Počet tokenů výzvy plus max_tokens nesmí překročit délku kontextu modelu.
No 16
n integer Kolik dokončení se má vygenerovat pro každou výzvu.

Poznámka: Protože tento parametr generuje mnoho dokončení, může rychle spotřebovat kvótu tokenu. Pečlivě používejte a ujistěte se, že máte přiměřené nastavení a max_tokens stop.
 No 0
presence_penalty Číslo Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.
 No 0
semeno integer Pokud je zadáno, náš systém se bude snažit vzorkovat deterministicky, aby opakované požadavky se stejnými seed parametry měly vrátit stejný výsledek.

Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.
 No
Zastavit řetězec nebo pole Až 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 jsou nastavené, tokeny se posílají jako události odesílané jen pro data, jakmile budou k dispozici, a datový proud je ukončen zprávoudata: [DONE].
No False
přípona string Přípona, která následuje po dokončení vloženého textu.

Tento parametr je podporován pouze pro gpt-3.5-turbo-instruct.
 No Nic
Teplota Číslo Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.

Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.
 No 0
top_p Číslo Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.
 No 0
user string Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.
 No

createCompletionResponse

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

Name Typ Popis Požaduje se Výchozí
ID řetězec Jedinečný identifikátor dokončení. Ano
volby pole Seznam voleb dokončení, které model vygeneroval pro vstupní výzvu. Ano
vytvořené integer Časové razítko unixu (v sekundách) doby vytvoření dokončení. Ano
model string Model použitý k dokončení. Ano
prompt_filter_results promptFilterResults Výsledky filtrování obsahu pro nulové nebo více výzev v požadavku V žádosti o streamování můžou výsledky různých výzev dorazit v různých časech nebo v různých objednávkách. No
system_fingerprint string Tento otisk prstu představuje konfiguraci back-endu, se kterou model běží.

Lze použít společně s parametrem seed požadavku, abyste pochopili, kdy byly provedeny změny back-endu, které by mohly ovlivnit determinismus.
 No
objekt enum Typ objektu, který je vždy "text_completion"
Možné hodnoty: text_completion		 Ano
využití completionUsage Statistiky využití žádosti o dokončení No

createChatCompletionRequest

Name Typ Popis Požaduje se Výchozí
Teplota Číslo Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.

Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.
 No 0
top_p Číslo Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.
 No 0
datový proud boolean Pokud je tato možnost nastavená, budou odeslány částečné rozdíly zpráv, například v ChatGPT. Tokeny se posílají jako události odesílané jen pro data, jakmile budou k dispozici, a datový proud je ukončen zprávoudata: [DONE].
 No False
Zastavit řetězec nebo pole Až 4 sekvence, ve kterých rozhraní API přestane generovat další tokeny.
 No
max_tokens integer Maximální počet tokenů, které lze vygenerovat v dokončení chatu.

Celková délka vstupních tokenů a vygenerovaných tokenů je omezená délkou kontextu modelu.
No
max_completion_tokens integer Horní mez počtu tokenů, které lze vygenerovat pro dokončení, včetně viditelných výstupních tokenů a zdůvodnění tokenů. To je podporováno pouze v modelech řady o1. Rozšíří podporu dalších modelů v budoucí verzi rozhraní API. No
presence_penalty Číslo Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.
 No 0
frequency_penalty Číslo Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.
 No 0
logit_bias objekt Upravte pravděpodobnost výskytu zadaných tokenů v dokončení.

Přijímá objekt JSON, který mapuje tokeny (určené jejich ID tokenu v tokenizátoru) na přidruženou hodnotu předsudku od -100 do 100. Matematicky se před vzorkováním přidá do logitů vygenerovaných modelem. Přesný účinek se bude lišit podle modelu, ale hodnoty mezi -1 a 1 by měly snížit nebo zvýšit pravděpodobnost výběru; hodnoty jako -100 nebo 100 by měly vést k zákazu nebo výhradnímu výběru příslušného tokenu.
 No Nic
user string Jedinečný identifikátor představující koncového uživatele, který může pomoct monitorovat a zjišťovat zneužití.
 No
zprávy pole Seznam zpráv, které tvoří dosud konverzaci. Ano
data_sources pole Položky konfigurace pro rozšíření chatu Azure OpenAI, které je používají.
Tato další specifikace je kompatibilní pouze s Azure OpenAI.		 No
protokoly boolean Zda se mají vrátit pravděpodobnosti protokolu výstupních tokenů, nebo ne. Pokud je pravda, vrátí pravděpodobnosti protokolu každého výstupního tokenu vráceného v hodnotě content message. No False
top_logprobs integer Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu. logprobs parametr musí být nastaven na true hodnotu, pokud je použit tento parametr. No
n integer Kolik možností dokončení chatu se má vygenerovat pro každou vstupní zprávu. Mějte na paměti, že se vám bude účtovat na základě počtu vygenerovaných tokenů napříč všemi možnostmi. Udržujte n si přehled o 1 minimalizaci nákladů. No 0
parallel_tool_calls ParallelToolCalls Zda se má povolit paralelní volání funkcí během použití nástroje. No True
response_format ResponseFormatText nebo ResponseFormatJsonObject nebo ResponseFormatJsonSchema Objekt určující formát, který musí model vypíše. Kompatibilní s GPT-4o, GPT-4o mini, GPT-4 Turbo a všechny GPT-3.5 Turbo modely novější než gpt-3.5-turbo-1106.

Nastavení pro { "type": "json_schema", "json_schema": {...} } povolení strukturovaných výstupů, které zaručuje, že model bude odpovídat zadanému schématu JSON.

Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

Důležité: Pokud používáte režim JSON, musíte také dát modelu pokyn, aby vygeneroval JSON sami prostřednictvím systémové nebo uživatelské zprávy. Bez toho může model vygenerovat neschválený datový proud prázdných znaků, dokud generace nedosáhne limitu tokenu, což vede k dlouhotrvajícímu a zdánlivě zablokovanému požadavku. Všimněte si také, že obsah zprávy může být částečně oříznut, pokud finish_reason="length", což znamená, že generování překročilo max_tokens nebo konverzace překročila maximální délku kontextu.
 No
semeno integer Tato funkce je v beta verzi.
Pokud je zadáno, náš systém se bude snažit vzorkovat deterministicky, aby opakované požadavky se stejnými seed parametry měly vrátit stejný výsledek.
Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.
 No
stream_options chatCompletionStreamOptions Možnosti pro odpověď streamování Toto nastavení nastavíte pouze při nastavení stream: true.
 No Nic
tools pole Seznam nástrojů, které model může volat. V současné době se jako nástroj podporují jenom funkce. Pomocí tohoto příkazu můžete poskytnout seznam funkcí, pro které může model generovat vstupy JSON. Podporuje se maximálně 128 funkcí.
 No
tool_choice chatCompletionToolChoiceOption Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádný nástroj a místo toho vygeneruje zprávu. auto znamená, že model si může vybrat mezi generováním zprávy nebo voláním jednoho nebo více nástrojů. required znamená, že model musí volat jeden nebo více nástrojů. Zadáním konkrétního nástroje vynutíte {"type": "function", "function": {"name": "my_function"}} model, aby tento nástroj volal. none je výchozí, pokud nejsou k dispozici žádné nástroje. auto je výchozí, pokud jsou k dispozici nástroje. No
function_call string nebo chatCompletionFunctionCallOption Zastaralá ve prospěch tool_choice.

Určuje, která funkce (pokud existuje) volána modelem.
none znamená, že model nebude volat funkci a místo toho vygeneruje zprávu.
auto znamená, že model může vybrat mezi generováním zprávy nebo voláním funkce.
Zadáním konkrétní funkce vynutíte {"name": "my_function"} , aby model volal danou funkci.

none je výchozí, pokud nejsou k dispozici žádné funkce. auto je výchozí, pokud jsou k dispozici funkce.
 No
– funkce pole Zastaralá ve prospěch tools.

Seznam funkcí, pro které model může generovat vstupy JSON.
 No

chatCompletionFunctions

Name Typ Popis Požaduje se Výchozí
description string Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat. No
name string Název funkce, která se má volat. Musí být a-z, A-Z, 0-9 nebo obsahovat podtržítka a pomlčky s maximální délkou 64. Ano
parametry FunctionParameters Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON. Příklady najdete v příručce](/azure/ai-services/openai/how-to/function-calling) a referenční informace ke schématu JSON pro dokumentaci k formátu.

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

chatCompletionFunctionCallOption

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

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

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:

chatCompletionRequestSystemMessage

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

chatCompletionRequestUserMessage

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

chatCompletionRequestAssistantMessage

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

Vlastnosti pro function_call

argumenty

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

name

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

chatCompletionRequestToolMessage

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

chatCompletionRequestFunctionMessage

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

chatCompletionRequestSystemMessageContentPart

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

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestAssistantMessageContentPart

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

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

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

chatCompletionRequestMessageContentPartImage

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

Vlastnosti pro image_url

url

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

detail

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

chatCompletionRequestMessageContentPartRefusal

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

azureChatExtensionConfiguration

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

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

azureChatExtensionType

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

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

Typ: řetězec

Výchozí:

Název výčtu: AzureChatExtensionType

Hodnoty výčtu:

Hodnota Popis
azure_search Představuje použití služby Azure Search jako rozšíření chatu Azure OpenAI.
azure_cosmos_db Představuje použití služby Azure Cosmos DB jako rozšíření chatu Azure OpenAI.
elasticsearch Představuje použití indexu Elasticsearch® jako rozšíření chatu Azure OpenAI.
mongo_db Představuje použití Mongo DB jako rozšíření chatu Azure OpenAI.
borová šiška Představuje použití indexu Pinecone jako rozšíření chatu Azure OpenAI.

azureSearchChatExtensionConfiguration

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

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

azureSearchChatExtensionParameters

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

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

azureSearchIndexFieldMappingOptions

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

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

azureSearchQueryType

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

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

Typ: řetězec

Výchozí:

Název výčtu: AzureSearchQueryType

Hodnoty výčtu:

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

azureCosmosDBChatExtensionConfiguration

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

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

azureCosmosDBChatExtensionParameters

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

Name Typ Popis Požaduje se Výchozí
ověřování onYourDataConnectionStringAuthenticationOptions Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití připojovací řetězec Ano
top_n_documents integer Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz. No
max_search_queries integer Maximální počet přepsaných dotazů, které by se měly odeslat poskytovateli vyhledávání pro jednu zprávu uživatele. Pokud není zadaný, systém rozhodne počet dotazů, které se mají odeslat. No
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
in_scope boolean Určuje, jestli se dotazy mají omezit na použití indexovaných dat. No
přísnost integer Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi. No
database_name string Název databáze MongoDB vCore, který se má použít se službou Azure Cosmos DB. Ano
container_name string Název kontejneru prostředků služby Azure Cosmos DB. Ano
index_name string Název indexu virtuálních jader MongoDB, který se má použít se službou Azure Cosmos DB. Ano
fields_mapping azureCosmosDBFieldMappingOptions Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Služby Azure Cosmos DB Ano
embedding_dependency onYourDataEndpointVectorizationSource nebo onYourDataDeploymentNameVectorizationSource Ano
include_contexts pole Zahrnuté vlastnosti výstupního kontextu. Pokud není zadána, výchozí hodnota je citations a intent. 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 Popis Požaduje se Výchozí
title_field string Název pole indexu, které se má použít jako název. No
url_field string Název pole indexu, které se má použít jako adresa URL. No
filepath_field string Název pole indexu, které se má použít jako cesta k souboru. No
content_fields pole Názvy polí indexu, která by se měla považovat za obsah. Ano
content_fields_separator string Vzor oddělovače, který mají pole obsahu používat. No
vector_fields pole Názvy polí, která představují vektorová data. Ano

elasticsearchChatExtensionConfiguration

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

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

elasticsearchChatExtensionParameters

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

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

elasticsearchIndexFieldMappingOptions

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

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

elasticsearchQueryType

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

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

Typ: řetězec

Výchozí:

Název výčtu: ElasticsearchQueryType

Hodnoty výčtu:

Hodnota Popis
jednoduchý Představuje výchozí jednoduchý analyzátor dotazů.
vektor Představuje vektorové vyhledávání vypočítaných dat.

MongoDBChatExtensionConfiguration

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

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

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 Popis Požaduje se Výchozí
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 Ano
top_n_documents integer Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz. No
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
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
in_scope boolean Určuje, jestli se dotazy mají omezit na použití indexovaných dat. No
přísnost integer Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi. No
endpoint string Název koncového bodu clusteru Mongo DB. Ano
database_name string Název databáze Mongo DB. Ano
collection_name string Název kolekce Mongo DB. Ano
app_name string Název aplikace Mongo DB. Ano
index_name string Název indexu Mongo DB. Ano
fields_mapping MongoDBFieldMappingOptions Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Mongo DB. Ano
embedding_dependency onYourDataEndpointVectorizationSource nebo onYourDataDeploymentNameVectorizationSource Ano
include_contexts pole Zahrnuté vlastnosti výstupního kontextu. Pokud není zadána, výchozí hodnota je citations a intent. No

MongoDBFieldMappingOptions

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

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

pineconeChatExtensionConfiguration

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

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

pineconeChatExtensionParameters

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

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

pineconeFieldMappingOptions

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

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

onYourDataAuthenticationOptions

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

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

onYourDataContextProperty

Kontextová vlastnost.

Popis: Kontextová vlastnost.

Typ: řetězec

Výchozí:

Název výčtu: OnYourDataContextProperty

Hodnoty výčtu:

Hodnota Popis
Citace Vlastnost citations .
Záměr Vlastnost intent .
all_retrieved_documents Vlastnost all_retrieved_documents .

onYourDataAuthenticationType

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

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

Typ: řetězec

Výchozí:

Název výčtu: OnYourDataAuthenticationType

Hodnoty výčtu:

Hodnota Popis
api_key Ověřování prostřednictvím klíče rozhraní API
connection_string Ověřování prostřednictvím připojovací řetězec.
key_and_key_id Ověřování pomocí páru klíč a ID klíče.
encoded_api_key Ověřování prostřednictvím zakódovaného klíče rozhraní API
access_token Ověřování prostřednictvím přístupového tokenu
system_assigned_managed_identity Ověřování prostřednictvím spravované identity přiřazené systémem
user_assigned_managed_identity Ověřování prostřednictvím spravované identity přiřazené uživatelem
username_and_password Ověřování pomocí uživatelského jména a hesla

onYourDataApiKeyAuthenticationOptions

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

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

onYourDataConnectionStringAuthenticationOptions

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

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

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 Popis Požaduje se Výchozí
type onYourDataAuthenticationType Typy ověřování podporované v Azure OpenAI ve vašich datech. Ano
klíč string Klíč Elasticsearch, který se má použít k ověřování. No
key_id string ID klíče Elasticsearch, které se má použít k ověřování. No

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 Popis Požaduje se Výchozí
type onYourDataAuthenticationType Typy ověřování podporované v Azure OpenAI ve vašich datech. Ano
encoded_api_key string Kódovaný klíč rozhraní API Elasticsearch, který se má použít k ověřování. No

onYourDataAccessTokenAuthenticationOptions

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

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

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

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

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 Popis Požaduje se Výchozí
type onYourDataAuthenticationType Typy ověřování podporované v Azure OpenAI ve vašich datech. Ano
username string Uživatelské jméno, které se má použít k ověřování. No
Heslo string Heslo. použít k ověřování. No

onYourDataVectorizationSource

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

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

onYourDataVectorizationSourceType

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

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

Typ: řetězec

Výchozí:

Název výčtu: OnYourDataVectorizationSourceType

Hodnoty výčtu:

Hodnota Popis
endpoint Představuje vektorizaci prováděnou voláními veřejné služby do modelu vkládání Azure OpenAI.
deployment_name Představuje název nasazení modelu Ada, který se má použít. Toto nasazení modelu musí být ve stejném prostředku Azure OpenAI, ale
Ve vašich datech bude toto nasazení modelu používat prostřednictvím interního volání, nikoli veřejného, což umožňuje vektor.
vyhledávání i v privátních sítích.
integrovaný Představuje integrovaný vektorizátor definovaný v rámci vyhledávacího prostředku.
model_id Představuje konkrétní ID modelu vložení definované ve vyhledávací službě.
V současné době podporuje pouze Elasticsearch®.

onYourDataEndpointVectorizationSource

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

Name Typ Popis Požaduje se Výchozí
type onYourDataVectorizationSourceType Představuje dostupné zdroje, které azure OpenAI ve vašich datech může použít ke konfiguraci vektorizace dat pro použití
vektorové vyhledávání.		 Ano
endpoint string 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
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

onYourDataDeploymentNameVectorizationSource

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

Name Typ Popis Požaduje se Výchozí
type onYourDataVectorizationSourceType Představuje dostupné zdroje, které azure OpenAI ve vašich datech může použít ke konfiguraci vektorizace dat pro použití
vektorové vyhledávání.		 Ano
deployment_name string Určuje název nasazení modelu, který se má použít pro vektorizaci. Toto nasazení modelu musí být ve stejném prostředku Azure OpenAI, ale ve vašich datech bude toto nasazení modelu používat prostřednictvím interního volání, nikoli veřejného, což umožňuje vektorové vyhledávání i v privátních sítích. No
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

onYourDataIntegratedVectorizationSource

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

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

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 Popis Požaduje se Výchozí
type onYourDataVectorizationSourceType Představuje dostupné zdroje, které azure OpenAI ve vašich datech může použít ke konfiguraci vektorizace dat pro použití
vektorové vyhledávání.		 Ano
model_id string 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

azureChatExtensionsMessageContext

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

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

citace

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

Name Typ Popis Požaduje se Výchozí
content string Obsah citace. Ano
title string Název citace. No
url string Adresa URL citace. No
cesta k souboru string Cesta k souboru citace. No
chunk_id string ID bloku citace. No
rerank_score Číslo Skóre opětovného pořadí načteného dokumentu. No

retrievedDocument

Načtený dokument.

Name Typ Popis Požaduje se Výchozí
content string Obsah citace. Ano
title string Název citace. No
url string Adresa URL citace. No
cesta k souboru string Cesta k souboru citace. No
chunk_id string ID bloku citace. No
rerank_score Číslo 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
data_source_index integer Index zdroje dat. No
original_search_score Číslo Původní skóre hledání načteného dokumentu. No
filter_reason filterReason Důvod filtrování načteného dokumentu. No

filterReason

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

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

Typ: řetězec

Výchozí:

Název výčtu: FilterReason

Hodnoty výčtu:

Hodnota Popis
score Dokument je filtrován podle původní prahové hodnoty skóre hledání definované konfigurací strictness .
změna pořadí Dokument není filtrován podle původní prahové hodnoty skóre hledání, ale filtruje se podle skóre pořadí a top_n_documents konfigurace.

chatCompletionMessageToolCall

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

Vlastnosti funkce

name

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

argumenty

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

toolCallType

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

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

Typ: řetězec

Výchozí:

Název výčtu: ToolCallType

Hodnoty výčtu:

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

chatCompletionRequestMessageTool

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

chatCompletionRequestMessageFunction

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

createChatCompletionResponse

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

Name Typ Popis Požaduje se Výchozí
ID řetězec Jedinečný identifikátor dokončení chatu. Ano
prompt_filter_results promptFilterResults Výsledky filtrování obsahu pro nulové nebo více výzev v požadavku V žádosti o streamování můžou výsledky různých výzev dorazit v různých časech nebo v různých objednávkách. No
volby pole Seznam možností dokončení chatu Pokud je větší než 1, může být více než jedna n . Ano
vytvořené integer Časové razítko unixu (v sekundách) doby vytvoření dokončení chatu. Ano
model string Model použitý k dokončení chatu. Ano
system_fingerprint string Tento otisk prstu představuje konfiguraci back-endu, se kterou model běží.

Lze použít společně s parametrem seed požadavku, abyste pochopili, kdy byly provedeny změny back-endu, které by mohly ovlivnit determinismus.
 No
objekt enum Typ objektu, který je vždy chat.completion.
Možné hodnoty: chat.completion		 Ano
využití completionUsage Statistiky využití žádosti o dokončení No

createChatCompletionStreamResponse

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

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

chatCompletionStreamResponseDelta

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

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

Vlastnosti pro function_call

argumenty

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

name

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

chatCompletionMessageToolCallChunk

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

Vlastnosti funkce

name

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

argumenty

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

chatCompletionStreamOptions

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

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

chatCompletionChoiceLogProbs

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

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

chatCompletionTokenLogprob

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

chatCompletionResponseMessage

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

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

chatCompletionResponseMessageRole

Role autora zprávy odpovědi

Popis: Role autora zprávy odpovědi.

Typ: řetězec

Výchozí:

Hodnoty výčtu:

  • asistent

chatCompletionToolChoiceOption

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

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

chatCompletionNamedToolChoice

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

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

Vlastnosti funkce

name

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

ParallelToolCalls

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

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

chatCompletionMessageToolCalls

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

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

chatCompletionFunctionCall

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

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

completionUsage

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

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

Vlastnosti pro prompt_tokens_details

cached_tokens

Name Typ Popis Výchozí
cached_tokens integer Počet tokenů výzvy uložených v mezipaměti.

Vlastnosti pro completion_tokens_details

reasoning_tokens

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

chatCompletionTool

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

FunctionParameters

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

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

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

FunctionObject

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

Vynechání parameters definuje funkci s prázdným seznamem parametrů.		 No
přísné boolean Zda povolit přísné dodržování schématu při generování volání funkce. Pokud je nastavená hodnota true, model bude dodržovat přesné schéma definované v parameters poli. Pouze podmnožina schématu JSON je podporována, pokud strict je true. No False

ResponseFormatText

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

ResponseFormatJsonObject

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

ResponseFormatJsonSchemaSchema

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

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

ResponseFormatJsonSchema

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

Vlastnosti pro json_schema

description

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

name

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

schema

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

přísné

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

chatCompletionChoiceCommon

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

createTranslationRequest

Žádost o překlad

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

audioResponse

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

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

audioVerboseResponse

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

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

audioResponseFormat

Definuje formát výstupu.

Popis: Definuje formát výstupu.

Typ: řetězec

Výchozí:

Hodnoty výčtu:

  • json
  • text
  • srt
  • verbose_json
  • vttt

createTranscriptionRequest

Žádost o přepis

Name Typ Popis Požaduje se Výchozí
soubor string Objekt zvukového souboru, který se má přepisovat. Ano
pobídnout string Volitelný text pro vodítko stylu modelu nebo pokračování v předchozím zvukovém segmentu. Výzva by měla odpovídat jazyku zvuku. No
response_format audioResponseFormat Definuje formát výstupu. No
Teplota Číslo Teplota vzorkování mezi 0 a 1. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Pokud je nastavená hodnota 0, model použije pravděpodobnost protokolu k automatickému zvýšení teploty do dosažení určitých prahových hodnot. No 0
jazyk string Jazyk vstupního zvuku. Poskytnutí jazyka zadávání vstupu ve formátu ISO-639-1 zlepší přesnost a latenci. No
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: Pro časová razítka segmentů neexistuje žádná další latence, ale generování časových razítek slov způsobuje další latenci. No ['segment']

audioSegment

Přepis nebo segment překladu

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

audioWord

Přepis nebo překlad slova

Name Typ Popis Požaduje se Výchozí
slovo string Word No
start Číslo Začátek wordového posunu No
end Číslo Odsazení konce wordu No

createSpeechRequest

Žádost o řeč

Name Typ Popis Požaduje se Výchozí
vstup string Text pro syntetizaci zvuku. Maximální délka je 4096 znaků. Ano
voice enum Hlas, který se má použít pro syntézu řeči.
Možné hodnoty: slitina, echo, fable, onyx, nova, shimmer		 Ano
response_format enum Formát syntetizování zvuku v.
Možné hodnoty: mp3, opus, aac, flaši, wav, pcm		 No
rychlost Číslo Rychlost syntetizovaného zvuku. Vyberte hodnotu od 0.25 do 4.0. 1.0 je výchozí možnost. No 1.0

imageQuality

Kvalita image, která se vygeneruje.

Popis: Kvalita image, která se vygeneruje.

Typ: řetězec

Výchozí: standardní

Název výčtu: Kvalita

Hodnoty výčtu:

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

imagesResponseFormat

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

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

Typ: řetězec

Výchozí: adresa URL

Název výčtu: ImagesResponseFormat

Hodnoty výčtu:

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

imageSize

Velikost vygenerovaných obrázků.

Popis: Velikost vygenerovaných obrázků.

Typ: řetězec

Výchozí: 1024x1024

Název výčtu: Velikost

Hodnoty výčtu:

Hodnota Popis
256x256 Požadovaná velikost vygenerovaného obrázku je 256 × 256 pixelů. Podporováno pouze pro dall-e-2.
512 × 512 Požadovaná velikost vygenerovaného obrázku je 512 × 512 pixelů. Podporováno pouze pro dall-e-2.
1792x1024 Požadovaná velikost vygenerovaného obrázku je 1792 × 1024 pixelů. Podporováno pouze pro dall-e-3.
1024x1792 Požadovaná velikost vygenerovaného obrázku je 1024 × 1792 pixelů. Podporováno pouze pro dall-e-3.
1024 × 1024 Požadovaná velikost vygenerovaného obrázku je 1024 × 1024 pixelů.

imageStyle

Styl vygenerovaných obrázků

Popis: Styl vygenerovaných obrázků.

Typ: řetězec

Výchozí: živé

Název výčtu: styl

Hodnoty výčtu:

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

imageGenerationsRequest

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

generateImagesResponse

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

imageResult

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

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

čára

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

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

rozpětí

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

Name Typ Popis Požaduje se Výchozí
text string Textový obsah rozsahu, který představuje zjištěný objekt. Ano
offset 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. Ano
length integer Délka rozsahu znaků měřená v bodech kódu Unicode. Ano
mnohoúhelník pole Pole objektů představujících body v mnohoúhelníku, které ohraničují rozpoznaný objekt. Ano

runCompletionUsage

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

Name Typ Popis Požaduje se Výchozí
completion_tokens integer Počet tokenů dokončení použitých v průběhu spuštění Ano
prompt_tokens integer Počet výzev tokenů použitých v průběhu spuštění Ano
total_tokens integer Celkový počet použitých tokenů (výzva + dokončení). Ano

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 Popis Požaduje se Výchozí
completion_tokens integer Počet tokenů dokončení použitých v průběhu kroku spuštění Ano
prompt_tokens integer Počet výzev tokenů použitých v průběhu kroku spuštění Ano
total_tokens integer Celkový počet použitých tokenů (výzva + dokončení). Ano

asistentiApiResponseFormatOption

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

Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

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

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

asistentiApiResponseFormat

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

Name Typ Popis Požaduje se Výchozí
type string Musí to být jedna z text nebo json_object. No text

type Enum: AssistantsApiResponseFormat

Hodnota Popis
text
json_object

assistantObject

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

Name Typ Popis Požaduje se Výchozí
ID řetězec Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API. Ano
objekt string Typ objektu, který je vždy assistant. Ano
created_at integer Časové razítko unixu (v sekundách) pro vytvoření asistenta. Ano
jméno string Jméno asistenta. Maximální délka je 256 znaků.
 Ano
popis string Popis asistenta. Maximální délka je 512 znaků.
 Ano
model string ID modelu, který se má použít. K zobrazení všech dostupných modelů můžete použít rozhraní API pro výpis modelů.
 Ano
pokyny string Systémové pokyny, které asistent používá. Maximální délka je 256 000 znaků.
 Ano
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.
 Ano []
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
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ů.
 Ano
Teplota Číslo Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.
 No 0
top_p Číslo Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.
 No 0
response_format asistentiApiResponseFormatOption Určuje formát, který musí model vypíše. Kompatibilní s GPT-4 Turbo a všemi modely GPT-3.5 Turbo od té doby gpt-3.5-turbo-1106.

Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

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

Vlastnosti pro tool_resources

code_interpreter

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

file_search

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

object Enum: AssistantObjectType

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

createAssistantRequest

Name Typ Popis Požaduje se Výchozí
model Ano
jméno string Jméno asistenta. Maximální délka je 256 znaků.
 No
description string Popis asistenta. Maximální délka je 512 znaků.
 No
pokyny string Systémové pokyny, které asistent používá. Maximální délka je 256 000 znaků.
 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 []
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
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
Teplota Číslo Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.
 No 0
top_p Číslo Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.
 No 0
response_format asistentiApiResponseFormatOption Určuje formát, který musí model vypíše. Kompatibilní s GPT-4 Turbo a všemi modely GPT-3.5 Turbo od té doby gpt-3.5-turbo-1106.

Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

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

Vlastnosti pro tool_resources

code_interpreter

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

file_search

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

modifyAssistantRequest

Name Typ Popis Požaduje se Výchozí
model No
name string Jméno asistenta. Maximální délka je 256 znaků.
 No
description string Popis asistenta. Maximální délka je 512 znaků.
 No
pokyny string Systémové pokyny, které asistent používá. Maximální délka je 32768 znaků.
 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 []
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
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
Teplota Číslo Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.
 No 0
top_p Číslo Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.
 No 0
response_format asistentiApiResponseFormatOption Určuje formát, který musí model vypíše. Kompatibilní s GPT-4 Turbo a všemi modely GPT-3.5 Turbo od té doby gpt-3.5-turbo-1106.

Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

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

Vlastnosti pro tool_resources

code_interpreter

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

file_search

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

deleteAssistantResponse

Name Typ Popis Požaduje se Výchozí
ID string Ano
odstraněný boolean Ano
objekt string Ano

object Enum: DeleteAssistantResponseState

Hodnota Popis
assistant.deleted

listAssistantsResponse

Name Typ Popis Požaduje se Výchozí
objekt string Ano
data pole Ano
first_id string Ano
last_id string Ano
has_more boolean Ano

assistantToolsCode

Name Typ Popis Požaduje se Výchozí
type string Typ definovaného nástroje: code_interpreter Ano

type Enum: assistantToolsCodeType

Hodnota Popis
code_interpreter

assistantToolsFileSearch

Name Typ Popis Požaduje se Výchozí
type string Typ definovaného nástroje: file_search Ano
file_search objekt Přepisy pro nástroj pro vyhledávání souborů. No

max_num_results

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

type Enum: assistantToolsFileSearchType

Hodnota Popis
file_search

assistantToolsFileSearchTypeOnly

Name Typ Popis Požaduje se Výchozí
type string Typ definovaného nástroje: file_search Ano

type Enum: assistantToolsFileSearchType

Hodnota Popis
file_search

assistantToolsFunction

Name Typ Popis Požaduje se Výchozí
type string Typ definovaného nástroje: function Ano
function objekt Definice funkce. Ano

Vlastnosti funkce

description

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

name

Name Typ Popis Výchozí
name string Název funkce, která se má volat. Musí být a-z, A-Z, 0-9 nebo obsahovat podtržítka a pomlčky s maximální délkou 64.

parametry

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

type Enum: assistantToolsFunction

Hodnota Popis
function

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 Popis Požaduje se Výchozí
type string Strategie zkrácení, která se má použít pro vlákno. Výchozí hodnota je auto. Pokud je nastavená hodnota last_messages, vlákno bude zkráceno na n nejnovější zprávy ve vlákně. Při nastavení na autohodnotu , zprávy uprostřed vlákna budou vynechán tak, aby odpovídaly kontextové délce modelu, max_prompt_tokens. Ano
last_messages integer Počet nejnovějších zpráv z vlákna při vytváření kontextu pro spuštění. No

type Enum: TruncationType

Hodnota Popis
auto
last_messages

asistentiApiToolChoiceOption

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

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

assistantsNamedToolChoice

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

Name Typ Popis Požaduje se Výchozí
type string Typ nástroje. Pokud je functiontyp, musí být nastaven název funkce. Ano
function objekt No

Vlastnosti funkce

name

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

type Enum: AssistantsNamedToolChoiceType

Hodnota Popis
function
code_interpreter
file_search

runObject

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

Name Typ Popis Požaduje se Výchozí
ID řetězec Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API. Ano
objekt string Typ objektu, který je vždy thread.run. Ano
created_at integer Časové razítko unixu (v sekundách) pro vytvoření spuštění. Ano
thread_id string ID vlákna, na které bylo spuštěno jako součást tohoto spuštění. Ano
assistant_id string ID asistenta použitého ke spuštění tohoto spuštění. Ano
stav string Stav spuštění, který může být buď , , , , , , failed, , , completednebo expired. cancelledcancellingrequires_actionin_progressqueued Ano
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á. Ano
last_error objekt Poslední chyba přidružená k tomuto spuštění. null Pokud nedojde k žádným chybám. Ano
expires_at integer Časové razítko unixu (v sekundách) pro vypršení platnosti spuštění. Ano
started_at integer Časové razítko unixu (v sekundách) pro spuštění spuštění. Ano
cancelled_at integer Časové razítko unixu (v sekundách) pro zrušení spuštění. Ano
failed_at integer Časové razítko unixu (v sekundách) pro dobu, kdy se spuštění nezdařilo. Ano
completed_at integer Časové razítko unixu (v sekundách) pro dokončení spuštění. Ano
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é. Ano
model string Model, který pomocník použil pro toto spuštění. Ano
pokyny string Pokyny, které pomocník použil pro toto spuštění. Ano
tools pole Seznam nástrojů, které pomocník použil pro toto spuštění. Ano []
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ů.
 Ano
využití runCompletionUsage Statistiky využití související se spuštěním Tato hodnota bude, null pokud spuštění není v terminálovém stavu (tj. in_progress, queuedatd.). Ano
Teplota Číslo Teplota vzorkování použitá pro toto spuštění. Pokud není nastavená, výchozí hodnota je 1. No
top_p Číslo Hodnota vzorkování jádra použitá pro toto spuštění. Pokud není nastavená, výchozí hodnota je 1. No
max_prompt_tokens integer Maximální počet výzev tokenů zadaných k použití v průběhu spuštění.
 Ano
max_completion_tokens integer Maximální počet tokenů dokončení určených k použití v průběhu spuštění.
 Ano
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í. Ano
tool_choice asistentiApiToolChoiceOption Určuje, který (pokud existuje) nástroj, který model volá.
none znamená, že model nebude volat žádné nástroje a místo toho vygeneruje zprávu.
auto je výchozí hodnota a znamená, že model může vybrat mezi generováním zprávy nebo voláním nástroje.
Určení konkrétního nástroje, například {"type": "file_search"} nebo {"type": "function", "function": {"name": "my_function"}} vynutí model, aby tento nástroj volal.
 Ano
parallel_tool_calls ParallelToolCalls Zda se má povolit paralelní volání funkcí během použití nástroje. No True
response_format asistentiApiResponseFormatOption Určuje formát, který musí model vypíše. Kompatibilní s GPT-4 Turbo a všemi modely GPT-3.5 Turbo od té doby gpt-3.5-turbo-1106.

Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

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

Vlastnosti pro required_action

type

Název Typ Popis Výchozí
type string Prozatím je to vždy submit_tool_outputs.

submit_tool_outputs

Name Typ Popis Výchozí
tool_calls pole Seznam příslušných volání nástrojů.

Vlastnosti pro last_error

code

Name Typ Popis Výchozí
code string Jeden z server_error nebo rate_limit_exceeded.

zpráva

Name Typ Popis Výchozí
zpráva string Popis chyby čitelný člověkem.

Vlastnosti pro incomplete_details

reason

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

object Enum: runObjectType

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

status Enum: RunObjectStatus

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

createRunRequest

Name Typ Popis Požaduje se Výchozí
assistant_id string ID pomocníka, který se má použít ke spuštění tohoto spuštění. Ano
model string ID nasazení 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
pokyny string 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
additional_instructions string 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
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
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
Teplota Číslo Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.
 No 0
top_p Číslo Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.
 No 0
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
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í bude maximálně usilovat o použití pouze počtu zadaných tokenů výzvy, a to napříč několikanásobným spuštěním. Pokud spuštění překročí zadaný počet zadaných tokenů výzvy, spuštění skončí se stavem incomplete. Další informace najdete incomplete_details .
 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í bude maximálně usilovat o použití pouze zadaného počtu tokenů dokončení, a to napříč několikanásobným otočením spuštění. Pokud spuštění překročí zadaný počet tokenů dokončení, spuštění skončí stavem incomplete. Další informace najdete incomplete_details .
 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í. No
tool_choice asistentiApiToolChoiceOption Určuje, který (pokud existuje) nástroj, který model volá.
none znamená, že model nebude volat žádné nástroje a místo toho vygeneruje zprávu.
auto je výchozí hodnota a znamená, že model může vybrat mezi generováním zprávy nebo voláním nástroje.
Určení konkrétního nástroje, například {"type": "file_search"} nebo {"type": "function", "function": {"name": "my_function"}} vynutí model, aby tento nástroj volal.
 No
parallel_tool_calls ParallelToolCalls Zda se má povolit paralelní volání funkcí během použití nástroje. No True
response_format asistentiApiResponseFormatOption Určuje formát, který musí model vypíše. Kompatibilní s GPT-4 Turbo a všemi modely GPT-3.5 Turbo od té doby gpt-3.5-turbo-1106.

Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

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

listRunsResponse

Name Typ Popis Požaduje se Výchozí
objekt string Ano
data pole Ano
first_id string Ano
last_id string Ano
has_more boolean Ano

modifyRunRequest

Name Typ Popis Požaduje se Výchozí
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 Popis Požaduje se Výchozí
tool_outputs pole Seznam nástrojů, pro které se odesílají výstupy. Ano
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

runToolCallObject

Objekty volání nástrojů

Name Typ Popis Požaduje se Výchozí
ID řetězec ID volání nástroje. Toto ID musí být odkazováno, když odešlete výstupy nástroje pomocí výstupů nástroje Odeslat ke spuštění koncového bodu. Ano
type string Typ volání nástroje vyžaduje výstup. Prozatím je to vždy function. Ano
function objekt Definice funkce. Ano

Vlastnosti funkce

name

Name Typ Popis Výchozí
name string Název funkce.

argumenty

Name Typ Popis Výchozí
argumenty string Argumenty, které model očekává, že funkci předáte.

type Enum: RunToolCallObjectType

Hodnota Popis
function

createThreadAndRunRequest

Name Typ Popis Požaduje se Výchozí
assistant_id string ID pomocníka, který se má použít ke spuštění tohoto spuštění. Ano
vlákno createThreadRequest No
model string Název nasazení 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
pokyny string 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
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
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
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
Teplota Číslo Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.
 No 0
top_p Číslo Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.
 No 0
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 Nic
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í bude maximálně usilovat o použití pouze počtu zadaných tokenů výzvy, a to napříč několikanásobným spuštěním. Pokud spuštění překročí zadaný počet zadaných tokenů výzvy, spuštění skončí se stavem incomplete. Další informace najdete incomplete_details .
 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í bude maximálně usilovat o použití pouze zadaného počtu tokenů dokončení, a to napříč několikanásobným otočením spuštění. Pokud spuštění překročí zadaný počet tokenů dokončení, spuštění skončí stavem incomplete. Další informace najdete incomplete_details .
 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í. No
tool_choice asistentiApiToolChoiceOption Určuje, který (pokud existuje) nástroj, který model volá.
none znamená, že model nebude volat žádné nástroje a místo toho vygeneruje zprávu.
auto je výchozí hodnota a znamená, že model může vybrat mezi generováním zprávy nebo voláním nástroje.
Určení konkrétního nástroje, například {"type": "file_search"} nebo {"type": "function", "function": {"name": "my_function"}} vynutí model, aby tento nástroj volal.
 No
parallel_tool_calls ParallelToolCalls Zda se má povolit paralelní volání funkcí během použití nástroje. No True
response_format asistentiApiResponseFormatOption Určuje formát, který musí model vypíše. Kompatibilní s GPT-4 Turbo a všemi modely GPT-3.5 Turbo od té doby gpt-3.5-turbo-1106.

Nastavení pro { "type": "json_object" } povolení režimu JSON, který zaručuje, že zpráva, kterou model vygeneruje, je platný JSON.

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

Vlastnosti pro tool_resources

code_interpreter

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

file_search

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

threadObject

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

Name Typ Popis Požaduje se Výchozí
ID řetězec Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API. Ano
objekt string Typ objektu, který je vždy thread. Ano
created_at integer Časové razítko unixu (v sekundách) pro vytvoření vlákna. Ano
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ů.
 Ano
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ů.
 Ano

Vlastnosti pro tool_resources

code_interpreter

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

file_search

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

object Enum: ThreadObjectType

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

createThreadRequest

Name Typ Popis Požaduje se Výchozí
zprávy pole Seznam zpráv, se kterými má vlákno začínat. 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
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

Vlastnosti pro tool_resources

code_interpreter

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

file_search

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

modifyThreadRequest

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

Vlastnosti pro tool_resources

code_interpreter

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

file_search

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

deleteThreadResponse

Name Typ Popis Požaduje se Výchozí
ID string Ano
odstraněný boolean Ano
objekt string Ano

object Enum: DeleteThreadResponseObjectState

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

listThreadsResponse

Name Typ Popis Požaduje se Výchozí
objekt string Ano
data pole Ano
first_id string Ano
last_id string Ano
has_more boolean Ano

messageObject

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

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

Vlastnosti pro incomplete_details

reason

Name Typ Popis Výchozí
reason string Důvod, proč je zpráva neúplná.

object Enum: MessageObjectType

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

status Enum: MessageObjectStatus

Hodnota Popis
in_progress
neúplný
dokončené

role Enum: MessageObjectRole

Hodnota Popis
user
asistent

messageDeltaObject

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

Name Typ Popis Požaduje se Výchozí
ID řetězec Identifikátor zprávy, na kterou lze odkazovat v koncových bodech rozhraní API. Ano
objekt string Typ objektu, který je vždy thread.message.delta. Ano
Delta objekt Rozdíl obsahující pole, která se změnila ve zprávě. Ano

Vlastnosti pro rozdíl

role

Name Typ Popis Výchozí
role string Entita, která zprávu vytvořila. Jeden z user nebo assistant.

content

Name Typ Popis Výchozí
content pole Obsah zprávy v poli textu nebo obrázků.

object Enum: MessageDeltaObjectType

Hodnota Popis
thread.message.delta

createMessageRequest

Name Typ Popis Požaduje se Výchozí
role string Role entity, která vytváří zprávu. Mezi povolené hodnoty patří:
- user: Označuje, že zpráva je odeslána skutečným uživatelem a měla by být použita ve většině případů k reprezentaci uživatelem generovaných zpráv.
- assistant: Označuje zprávu vygenerovanou asistentem. Tato hodnota slouží k vložení zpráv z asistenta do konverzace.
 Ano
content string Obsah zprávy. Ano
přílohy pole Seznam souborů připojených ke zprávě a nástroje, do které by se měly přidat. 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

role Enum: CreateMessageRequestRole

Hodnota Popis
user
asistent

modifyMessageRequest

Name Typ Popis Požaduje se Výchozí
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 Popis Požaduje se Výchozí
ID string Ano
odstraněný boolean Ano
objekt string Ano

object Enum: DeleteMessageResponseObject

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

listMessagesResponse

Name Typ Popis Požaduje se Výchozí
objekt string Ano
data pole Ano
first_id string Ano
last_id string Ano
has_more boolean Ano

messageContentImageFileObject

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

Name Typ Popis Požaduje se Výchozí
type string Vždy hodnota image_file. Ano
image_file objekt Ano

Vlastnosti pro image_file

file_id

Name Typ Popis Výchozí
file_id string ID souboru obrázku v obsahu zprávy.

type Enum: MessageContentImageFileObjectType

Hodnota Popis
image_file Typ souboru obrázku obsahu zprávy

messageContentTextObject

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

Name Typ Popis Požaduje se Výchozí
type string Vždy hodnota text. Ano
text objekt Ano

Vlastnosti textu

hodnota

Name Typ Popis Výchozí
hodnota string Data, která tvoří text.

anotace

Name Typ Popis Výchozí
anotace pole

type Enum: messageContentTextObjectType

Hodnota Popis
text 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 Popis Požaduje se Výchozí
type string Vždy hodnota file_citation. Ano
text string Text v obsahu zprávy, který je potřeba nahradit. Ano
file_citation objekt Ano
start_index integer Ano
end_index integer Ano

Vlastnosti pro file_citation

file_id

Name Typ Popis Výchozí
file_id string ID konkrétního souboru, ze které citace pochází.

type Enum: FileCitationObjectType

Hodnota Popis
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 Popis Požaduje se Výchozí
type string Vždy hodnota file_path. Ano
text string Text v obsahu zprávy, který je potřeba nahradit. Ano
file_path objekt Ano
start_index integer Ano
end_index integer Ano

Vlastnosti pro file_path

file_id

Name Typ Popis Výchozí
file_id string ID vygenerovaného souboru.

type Enum: FilePathObjectType

Hodnota Popis
file_path Typ objektu cesty k souboru

messageDeltaContentImageFileObject

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

Name Typ Popis Požaduje se Výchozí
index integer Index části obsahu ve zprávě. Ano
type string Vždy hodnota image_file. Ano
image_file objekt No

Vlastnosti pro image_file

file_id

Name Typ Popis Výchozí
file_id string ID souboru obrázku v obsahu zprávy.

type Enum: MessageDeltaContentImageFileObjectType

Hodnota Popis
image_file

messageDeltaContentTextObject

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

Name Typ Popis Požaduje se Výchozí
index integer Index části obsahu ve zprávě. Ano
type string Vždy hodnota text. Ano
text objekt No

Vlastnosti textu

hodnota

Name Typ Popis Výchozí
hodnota string Data, která tvoří text.

anotace

Name Typ Popis Výchozí
anotace pole

type Enum: MessageDeltaContentTextObjectType

Hodnota Popis
text

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 Popis Požaduje se Výchozí
index integer Index poznámky v textové části obsahu. Ano
type string Vždy hodnota file_citation. Ano
text string Text v obsahu zprávy, který je potřeba nahradit. No
file_citation objekt No
start_index integer No
end_index integer No

Vlastnosti pro file_citation

file_id

Name Typ Popis Výchozí
file_id string ID konkrétního souboru, ze které citace pochází.

citát

Name Typ Popis Výchozí
citát string Konkrétní citace v souboru.

type Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

Hodnota Popis
file_citation

messageDeltaContentTextAnnotationsFilePathObject

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

Name Typ Popis Požaduje se Výchozí
index integer Index poznámky v textové části obsahu. Ano
type string Vždy hodnota file_path. Ano
text string Text v obsahu zprávy, který je potřeba nahradit. No
file_path objekt No
start_index integer No
end_index integer No

Vlastnosti pro file_path

file_id

Name Typ Popis Výchozí
file_id string ID vygenerovaného souboru.

type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

Hodnota Popis
file_path

runStepObject

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

Name Typ Popis Požaduje se Výchozí
ID řetězec Identifikátor kroku spuštění, na který lze odkazovat v koncových bodech rozhraní API. Ano
objekt string Typ objektu, který je vždy assistant.run.step. Ano
created_at integer Časové razítko unixu (v sekundách) pro vytvoření kroku spuštění. Ano
assistant_id string ID asistenta přidruženého ke kroku spuštění. Ano
thread_id string ID vlákna, které bylo spuštěno. Ano
run_id string ID spuštění, ve které je tento krok spuštění součástí. Ano
type string Typ kroku spuštění, který může být buď message_creation nebo tool_calls. Ano
stav string Stav spuštění, který může být buď in_progress, cancelled, failed, completednebo expired. Ano
step_details runStepDetailsMessageCreationObject nebo runStepDetailsToolCallsObject Podrobnosti o kroku spuštění Ano
last_error objekt Poslední chyba přidružená k tomuto kroku spuštění null Pokud nedojde k žádným chybám. Ano
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. Ano
cancelled_at integer Časové razítko unixu (v sekundách) pro zrušení kroku spuštění. Ano
failed_at integer Časové razítko unixu (v sekundách) pro selhání kroku spuštění. Ano
completed_at integer Časové razítko unixu (v sekundách) pro dokončení kroku spuštění. Ano
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ů.
 Ano

Vlastnosti pro last_error

code

Name Typ Popis Výchozí
code string Jeden z server_error nebo rate_limit_exceeded.

zpráva

Name Typ Popis Výchozí
zpráva string Popis chyby čitelný člověkem.

object Enum: RunStepObjectType

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

type Enum: RunStepObjectType

Hodnota Popis
message_creation Krok spuštění message_creation
tool_calls Krok spuštění tool_calls

status Enum: RunStepObjectStatus

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

runStepDeltaObject

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

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

Vlastnosti pro rozdíl

step_details

Name Typ Popis Výchozí
step_details runStepDeltaStepDetailsMessageCreationObject nebo runStepDeltaStepDetailsToolCallsObject Podrobnosti o kroku spuštění

object Enum: RunStepDeltaObjectType

Hodnota Popis
thread.run.step.delta

listRunStepsResponse

Name Typ Popis Požaduje se Výchozí
objekt string Ano
data pole Ano
first_id string Ano
last_id string Ano
has_more boolean Ano

runStepDetailsMessageCreationObject

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

Name Typ Popis Požaduje se Výchozí
type string Vždy hodnota message_creation. Ano
message_creation objekt Ano

Vlastnosti pro message_creation

message_id

Name Typ Popis Výchozí
message_id string ID zprávy vytvořené tímto krokem spuštění.

type Enum: RunStepDetailsMessageCreationObjectType

Hodnota Popis
message_creation

runStepDeltaStepDetailsMessageCreationObject

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

Name Typ Popis Požaduje se Výchozí
type string Vždy hodnota message_creation. Ano
message_creation objekt No

Vlastnosti pro message_creation

message_id

Name Typ Popis Výchozí
message_id string ID zprávy vytvořené tímto krokem spuštění.

type Enum: RunStepDeltaStepDetailsMessageCreationObjectType

Hodnota Popis
message_creation

runStepDetailsToolCallsObject

Podrobnosti o volání nástroje

Name Typ Popis Požaduje se Výchozí
type string Vždy hodnota tool_calls. Ano
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 retrieval function.
 Ano

type Enum: RunStepDetailsToolCallsObjectType

Hodnota Popis
tool_calls

runStepDeltaStepDetailsToolCallsObject

Podrobnosti o volání nástroje

Name Typ Popis Požaduje se Výchozí
type string Vždy hodnota tool_calls. Ano
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_search function.
 No

type Enum: RunStepDeltaStepDetailsToolCallsObjectType

Hodnota Popis
tool_calls

runStepDetailsToolCallsCodeObject

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

Name Typ Popis Požaduje se Výchozí
ID řetězec ID volání nástroje. Ano
type string Typ volání nástroje. Toto bude code_interpreter vždy pro tento typ volání nástroje. Ano
code_interpreter objekt Definice volání nástroje Interpret kódu. Ano

Vlastnosti pro code_interpreter

input

Name Typ Popis Výchozí
vstup string Vstup do volání nástroje Interpret kódu.

výstupy

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

type Enum: RunStepDetailsToolCallsCodeObjectType

Hodnota Popis
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

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

Name Typ Popis Požaduje se Výchozí
index integer Index volání nástroje v nástroji volá pole. Ano
ID řetězec ID volání nástroje. No
type string Typ volání nástroje. Toto bude code_interpreter vždy pro tento typ volání nástroje. Ano
code_interpreter objekt Definice volání nástroje Interpret kódu. No

Vlastnosti pro code_interpreter

input

Name Typ Popis Výchozí
vstup string Vstup do volání nástroje Interpret kódu.

výstupy

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

type Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

Hodnota Popis
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

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

Name Typ Popis Požaduje se Výchozí
type string Vždy hodnota logs. Ano
Protokoly string Textový výstup volání nástroje Interpret kódu. Ano

type Enum: RunStepDetailsToolCallsCodeOutputLogsObjectType

Hodnota Popis
Protokoly

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

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

Name Typ Popis Požaduje se Výchozí
index integer Index výstupu v poli výstupů. Ano
type string Vždy hodnota logs. Ano
Protokoly string Textový výstup volání nástroje Interpret kódu. No

type Enum: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

Hodnota Popis
Protokoly

runStepDetailsToolCallsCodeOutputImageObject

Name Typ Popis Požaduje se Výchozí
type string Vždy hodnota image. Ano
image objekt Ano

Vlastnosti obrázku

file_id

Name Typ Popis Výchozí
file_id string ID souboru obrázku.

type Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

Hodnota Popis
image

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Name Typ Popis Požaduje se Výchozí
index integer Index výstupu v poli výstupů. Ano
type string Vždy hodnota image. Ano
image objekt No

Vlastnosti obrázku

file_id

Name Typ Popis Výchozí
file_id string ID souboru obrázku.

type Enum: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

Hodnota Popis
image

runStepDetailsToolCallsFileSearchObject

Name Typ Popis Požaduje se Výchozí
ID řetězec ID objektu volání nástroje. Ano
type string Typ volání nástroje. Toto bude file_search vždy pro tento typ volání nástroje. Ano
file_search objekt Prozatím to bude vždy prázdný objekt. Ano

type Enum: RunStepDetailsToolCallsFileSearchObjectType

Hodnota Popis
file_search

runStepDeltaStepDetailsToolCallsFileSearchObject

Name Typ Popis Požaduje se Výchozí
index integer Index volání nástroje v nástroji volá pole. Ano
ID řetězec ID objektu volání nástroje. No
type string Typ volání nástroje. Toto bude retrieval vždy pro tento typ volání nástroje. Ano
file_search objekt Prozatím to bude vždy prázdný objekt. Ano

type Enum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Hodnota Popis
file_search

runStepDetailsToolCallsFunctionObject

Name Typ Popis Požaduje se Výchozí
ID řetězec ID objektu volání nástroje. Ano
type string Typ volání nástroje. Toto bude function vždy pro tento typ volání nástroje. Ano
function objekt Definice funkce, která byla volána. Ano

Vlastnosti funkce

name

Name Typ Popis Výchozí
name string Název funkce.

argumenty

Name Typ Popis Výchozí
argumenty string Argumenty předané funkci.

output

Jméno Typ Popis Výchozí
output string Výstup funkce. To bude v null případě, že se výstupy ještě neodeslaly.

type Enum: RunStepDetailsToolCallsFunctionObjectType

Hodnota Popis
function

runStepDeltaStepDetailsToolCallsFunctionObject

Name Typ Popis Požaduje se Výchozí
index integer Index volání nástroje v nástroji volá pole. Ano
ID řetězec ID objektu volání nástroje. No
type string Typ volání nástroje. Toto bude function vždy pro tento typ volání nástroje. Ano
function objekt Definice funkce, která byla volána. No

Vlastnosti funkce

name

Name Typ Popis Výchozí
name string Název funkce.

argumenty

Name Typ Popis Výchozí
argumenty string Argumenty předané funkci.

output

Jméno Typ Popis Výchozí
output string Výstup funkce. To bude v null případě, že se výstupy ještě neodeslaly.

type Enum: RunStepDetailsToolCallsFunctionObjectType

Hodnota Popis
function

vectorStoreExpirationAfter

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

Name Typ Popis Požaduje se Výchozí
ukotvení string Ukotvení časového razítka, po kterém se zásada vypršení platnosti použije. Podporované kotvy: last_active_at. Ano
dny (dní) integer Počet dní po ukotvení, kdy platnost úložiště vektorů vyprší. Ano

anchor Enum: VectorStoreExpirationAfterAnchor

Hodnota Popis
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 Popis Požaduje se Výchozí
ID řetězec Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API. Ano
objekt enum Typ objektu, který je vždy vector_store.
Možné hodnoty: vector_store		 Ano
created_at integer Časové razítko unixu (v sekundách) pro vytvoření vektorového úložiště. Ano
jméno string Název úložiště vektorů. Ano
usage_bytes integer Celkový počet bajtů používaných soubory v úložišti vektorů. Ano
file_counts objekt Ano
stav string Stav úložiště vektorů, který může být buď expired, in_progressnebo completed. Stav indikuje, že úložiště vektorů completed je připravené k použití. Ano
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
last_active_at integer Časové razítko unixu (v sekundách) doby, kdy bylo úložiště vektorů naposledy aktivní. Ano
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ů.
 Ano

Vlastnosti pro file_counts

in_progress

Name Typ Popis Výchozí
in_progress integer Počet souborů, které se právě zpracovávají.

dokončené

Name Typ Popis Výchozí
dokončené integer Počet úspěšně zpracovaných souborů.

selhalo

Name Typ Popis Výchozí
selhalo integer Počet souborů, které se nepodařilo zpracovat.

odvolaný

Name Typ Popis Výchozí
odvolaný integer Počet zrušených souborů.

total

Name Typ Popis Výchozí
total integer Celkový počet souborů.

status Enum: VectorStoreObjectStatus

Hodnota Popis
prošlý
in_progress
dokončené

createVectorStoreRequest

Name Typ Popis Požaduje se Výchozí
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
name string Název úložiště vektorů. No
expires_after vectorStoreExpirationAfter Zásady vypršení platnosti pro úložiště vektorů. No
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 je neprázdný. 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

updateVectorStoreRequest

Name Typ Popis Požaduje se Výchozí
name string Název úložiště vektorů. No
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

listVectorStoresResponse

Name Typ Popis Požaduje se Výchozí
objekt string Ano
data pole Ano
first_id string Ano
last_id string Ano
has_more boolean Ano

deleteVectorStoreResponse

Name Typ Popis Požaduje se Výchozí
ID string Ano
odstraněný boolean Ano
objekt string Ano

object Enum: DeleteVectorStoreResponseObject

Hodnota Popis
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 Popis Požaduje se Výchozí
ID řetězec Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API. Ano
objekt string Typ objektu, který je vždy vector_store.file. Ano
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. Ano
created_at integer Časové razítko unixu (v sekundách) pro vytvoření souboru úložiště vektorů. Ano
vector_store_id string ID vektorového úložiště, ke kterému je soubor připojen. Ano
stav string Stav souboru úložiště vektorů, který může být buď in_progress, completed, cancellednebo failed. Stav completed označuje, že soubor úložiště vektorů je připravený k použití. Ano
last_error objekt Poslední chyba přidružená k tomuto souboru úložiště vektorů. null Pokud nedojde k žádným chybám. Ano
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 je neprázdný. No

Vlastnosti pro last_error

code

Name Typ Popis Výchozí
code string Jeden z server_error nebo rate_limit_exceeded.

zpráva

Name Typ Popis Výchozí
zpráva string Popis chyby čitelný člověkem.

object Enum: VectorStoreFileObjectType

Hodnota Popis
vector_store.file

status Enum: VectorStoreFileObjectStatus

Hodnota Popis
in_progress
dokončené
odvolaný
selhalo

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 Popis Požaduje se Výchozí
type string Vždy hodnota other. Ano

type Enum: OtherChunkingStrategyResponseParamType

Hodnota Popis
other

staticChunkingStrategyResponseParam

Name Typ Popis Požaduje se Výchozí
type string Vždy hodnota static. Ano
static staticChunkingStrategy Ano

type Enum: StaticChunkingStrategyResponseParamType

Hodnota Popis
static

staticChunkingStrategy

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

autoChunkingStrategyRequestParam

Výchozí strategie. Tato strategie v současné době používá max_chunk_size_tokens 800 chunk_overlap_tokens 400

Name Typ Popis Požaduje se Výchozí
type enum Vždy hodnota auto.
Možné hodnoty: auto		 Ano

staticChunkingStrategyRequestParam

Name Typ Popis Požaduje se Výchozí
type enum Vždy hodnota static.
Možné hodnoty: statické		 Ano
static staticChunkingStrategy Ano

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:

createVectorStoreFileRequest

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

listVectorStoreFilesResponse

Name Typ Popis Požaduje se Výchozí
objekt string Ano
data pole Ano
first_id string Ano
last_id string Ano
has_more boolean Ano

deleteVectorStoreFileResponse

Name Typ Popis Požaduje se Výchozí
ID string Ano
odstraněný boolean Ano
objekt string Ano

object Enum: DeleteVectorStoreFileResponseObject

Hodnota Popis
vector_store.file.deleted

vectorStoreFileBatchObject

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

Name Typ Popis Požaduje se Výchozí
ID řetězec Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API. Ano
objekt string Typ objektu, který je vždy vector_store.file_batch. Ano
created_at integer Časové razítko unixu (v sekundách) pro vytvoření dávky souborů úložiště vektorů. Ano
vector_store_id string ID vektorového úložiště, ke kterému je soubor připojen. Ano
stav string Stav dávky souborů úložiště vektorů, které mohou být buď in_progress, completednebo cancelled failed. Ano
file_counts objekt Ano

Vlastnosti pro file_counts

in_progress

Name Typ Popis Výchozí
in_progress integer Počet souborů, které se právě zpracovávají.

dokončené

Name Typ Popis Výchozí
dokončené integer Počet zpracovaných souborů.

selhalo

Name Typ Popis Výchozí
selhalo integer Počet souborů, které se nepodařilo zpracovat.

odvolaný

Name Typ Popis Výchozí
odvolaný integer Počet souborů, které byly zrušeny.

total

Name Typ Popis Výchozí
total integer Celkový počet souborů.

object Enum: VectorStoreFileBatchObjectType

Hodnota Popis
vector_store.files_batch

status Enum: VectorStoreFileBatchObjectStatus

Hodnota Popis
in_progress
dokončené
odvolaný
selhalo

createVectorStoreFileBatchRequest

Name Typ Popis Požaduje se Výchozí
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. Ano
chunking_strategy chunkingStrategyRequestParam Strategie vytváření bloků dat použitá k vytvoření bloků souborů. Pokud není nastavená, použije strategii auto . No

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

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 Popis Požaduje se Výchozí
event string Ano
data threadObject Představuje vlákno, které obsahuje zprávy. Ano

Data: threadObject

Výčet událostí: ThreadStreamEventEnum

Hodnota Popis
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 Popis Požaduje se Výchozí
event string Ano
data runObject Představuje spuštění ve vlákně. Ano

Data: runObject

Výčet událostí: RunStreamEventCreated

Hodnota Popis
thread.run.created

thread.run.queued

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data runObject Představuje spuštění ve vlákně. Ano

Data: runObject

Výčet událostí: RunStreamEventQueued

Hodnota Popis
thread.run.queued

thread.run.in_progress

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data runObject Představuje spuštění ve vlákně. Ano

Data: runObject

Výčet událostí: RunStreamEventInProgress

Hodnota Popis
thread.run.in_progress

thread.run.requires_action

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data runObject Představuje spuštění ve vlákně. Ano

Data: runObject

Výčet událostí: RunStreamEventRequiresAction

Hodnota Popis
thread.run.requires_action

thread.run.completed

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data runObject Představuje spuštění ve vlákně. Ano

Data: runObject

Výčet událostí: RunStreamEventCompleted

Hodnota Popis
thread.run.completed

thread.run.failed

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data runObject Představuje spuštění ve vlákně. Ano

Data: runObject

Výčet událostí: RunStreamEventFailed

Hodnota Popis
thread.run.failed

thread.run.cancelling

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data runObject Představuje spuštění ve vlákně. Ano

Data: runObject

Výčet událostí: RunStreamEventCancelling

Hodnota Popis
thread.run.cancelling

thread.run.cancelled

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data runObject Představuje spuštění ve vlákně. Ano

Data: runObject

Výčet událostí: RunStreamEventCancelled

Hodnota Popis
thread.run.cancelled

thread.run.expired

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data runObject Představuje spuštění ve vlákně. Ano

Data: runObject

Výčet událostí: RunStreamEventExpired

Hodnota Popis
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 Popis Požaduje se Výchozí
event string Ano
data runStepObject Představuje krok při spuštění spuštění.
 Ano

Data: runStepObject

Výčet událostí: RunStepStreamEventCreated

Hodnota Popis
thread.run.step.created

thread.run.step.in_progress

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data runStepObject Představuje krok při spuštění spuštění.
 Ano

Data: runStepObject

Výčet událostí: RunStepStreamEventInProgress

Hodnota Popis
thread.run.step.in_progress

thread.run.step.delta

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

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

Data: runStepDeltaObject

Výčet událostí: RunStepStreamEventDelta

Hodnota Popis
thread.run.step.delta

thread.run.step.completed

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data runStepObject Představuje krok při spuštění spuštění.
 Ano

Data: runStepObject

Výčet událostí: RunStepStreamEventCompleted

Hodnota Popis
thread.run.step.completed

thread.run.step.failed

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data runStepObject Představuje krok při spuštění spuštění.
 Ano

Data: runStepObject

Výčet událostí: RunStepStreamEventFailed

Hodnota Popis
thread.run.step.failed

thread.run.step.cancelled

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data runStepObject Představuje krok při spuštění spuštění.
 Ano

Data: runStepObject

Výčet událostí: RunStepStreamEventCancelled

Hodnota Popis
thread.run.step.cancelled

thread.run.step.expired

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data runStepObject Představuje krok při spuštění spuštění.
 Ano

Data: runStepObject

Výčet událostí: RunStepStreamEventExpired

Hodnota Popis
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 Popis Požaduje se Výchozí
event string Ano
data messageObject Představuje zprávu v rámci vlákna. Ano

Data: messageObject

Výčet událostí: MessageStreamEventCreated

Hodnota Popis
thread.message.created

thread.message.in_progress

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data messageObject Představuje zprávu v rámci vlákna. Ano

Data: messageObject

Výčet událostí: MessageStreamEventInProgress

Hodnota Popis
thread.message.in_progress

thread.message.delta

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data messageDeltaObject Představuje rozdíl zprávy, tj. všechna změněná pole zprávy během streamování.
 Ano

Data: messageDeltaObject

Výčet událostí: MessageStreamEventDelta

Hodnota Popis
thread.message.delta

thread.message.completed

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data messageObject Představuje zprávu v rámci vlákna. Ano

Data: messageObject

Výčet událostí: MessageStreamEventCompleted

Hodnota Popis
thread.message.completed

thread.message.incomplete

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

Name Typ Popis Požaduje se Výchozí
event string Ano
data messageObject Představuje zprávu v rámci vlákna. Ano

Data: messageObject

Výčet událostí: MessageStreamEventIncomplete

Hodnota Popis
thread.message.incomplete

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 Popis Požaduje se Výchozí
event string Ano
data chyba Ano

event Enum: ErrorEventEnum

Hodnota Popis
chyba

doneEvent

Nastane, když datový proud skončí.

Name Typ Popis Požaduje se Výchozí
event string Ano
data string Ano

event Enum: DoneEventEnum

Hodnota Popis
Hotovo

datový výčet: DoneEventDataEnum

Hodnota Popis
[HOTOVO]

Další kroky

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