Az Azure OpenAI Service REST API előzetes verziójának referenciája

Cikk
01/29/2025

Ez a cikk részletesen ismerteti az Azure OpenAI-hoz készült REST API-végpontok következtetését.

API-specifikációk

Az Azure OpenAI-modellek és -erőforrások kezelése és kezelése három elsődleges API-felületre oszlik:

Vezérlősík
Adatsík – létrehozás
Adatsík – következtetés

Minden API-felület/specifikáció más Azure OpenAI-képességeket foglal magában. Mindegyik API saját egyedi előzetes verziójú és stabil/általánosan elérhető (GA) API-kiadásokkal rendelkezik. Az előzetes verziók jelenleg általában havi rendszerességet követnek.

API	Legújabb előzetes kiadás	Legújabb GA-kiadás	Specifikációk	Leírás
Vezérlősík	`2024-06-01-preview`	`2024-10-01`	Spec fájlok	Az Azure OpenAI közös vezérlősíkot oszt meg az összes többi Azure AI-szolgáltatással. A vezérlősík API-t olyan dolgokhoz használják, mint az Azure OpenAI-erőforrások létrehozása, a modell üzembe helyezése és más magasabb szintű erőforrás-kezelési feladatok. A vezérlősík azt is szabályozza, hogy mit lehet tenni olyan képességekkel, mint az Azure Resource Manager, a Bicep, a Terraform és az Azure CLI.
Adatsík – létrehozás	`2025-01-01-preview`	`2024-10-21`	Spec fájlok	Az adatsík-létrehozó API szabályozza a finomhangolást, a fájlfeltöltést, a betöltési feladatokat, a kötegeket és bizonyos modellszintű lekérdezéseket
Adatsík – következtetés	`2025-01-01-preview`	`2024-10-21`	Spec fájlok	Az adatsík-következtetési API olyan funkciók következtetési képességeit/végpontjait biztosítja, mint a befejezés, a csevegés befejezése, a beágyazások, a beszéd/suttogás, az adatokon, a Dall-e, az asszisztensek stb.

Hitelesítés

Az Azure OpenAI két módszert biztosít a hitelesítéshez. Az API-kulcsokat vagy a Microsoft Entra-azonosítót is használhatja.

API-kulcs hitelesítése: Az ilyen típusú hitelesítéshez minden API-kérésnek tartalmaznia kell az API-kulcsot a api-key HTTP-fejlécben. A rövid útmutató útmutatást nyújt az ilyen típusú hitelesítéssel történő hívásokhoz.
Microsoft Entra ID-hitelesítés: Az API-hívásokat Microsoft Entra-jogkivonat használatával hitelesítheti. A hitelesítési jogkivonatok fejlécként szerepelnek a Authorization kérésekben. A megadott jogkivonatot például Bearer YOUR_AUTH_TOKENmeg kell előznieBearer. A Microsoft Entra ID-val történő hitelesítéssel kapcsolatos útmutatónkban olvashat.

REST API-verziószámozás

A szolgáltatási API-k verziószámozása az api-version lekérdezési paraméterrel történik. Minden verzió az ÉÉÉÉ-HH-NN adatstruktúrát követi. Példa:

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

Adatsík-következtetés

A cikk további része az Azure OpenAI adatsík következtetési specifikációjának 2025-01-01-previewlegújabb előzetes kiadását ismerteti. Ez a cikk dokumentációt tartalmaz a legújabb előzetes verziójú képességekről, például asszisztensekről, szálakról és vektortárolókról.

Ha a legújabb GA API-kiadás dokumentációját keresi, tekintse meg a legújabb GA adatsík-következtetési API-t

Befejezések – Létrehozás

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

Létrehoz egy befejezést a megadott parancssorhoz, paraméterekhez és kiválasztott modellhez.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
deployment-id	ösvény	Igen	húr	Az üzembe helyezett modell üzembehelyezési azonosítója.
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező	Alapértelmezett
haladéktalan	sztring vagy tömb	A befejezések létrehozására szolgáló kérések sztringként, sztringek tömbjeként, jogkivonatok tömbjeként vagy tokentömbként kódolva. Vegye figyelembe, hogy <a(z) \|endoftext\|> az a dokumentumelválasztó, amelyet a modell a betanítás során lát, így ha nincs megadva egy kérés, a modell úgy fog létrejönni, mintha egy új dokumentum elejéről származna.	Igen
best_of	egész szám	A befejezéseket `best_of` kiszolgálóoldalon hozza létre, és a "legjobb" értéket adja vissza (az, amelynek a legnagyobb a naplók valószínűsége jogkivonatonként). Az eredmények nem streamelhetők. A használat során `n`a jelölt befejezések számát szabályozza, `best_of` és `n` meghatározza, hogy hánynak kell visszaadnia a â € " `best_of` -nál `n`nagyobbnak kell lennie. Megjegyzés: Mivel ez a paraméter sok befejezést generál, gyorsan felhasználhatja a jogkivonatkvótát. Gondosan használja, és győződjön meg arról, hogy megfelelő beállításokat `max_tokensstop`és .	Nem	0
echo	Logikai	A befejezés mellett a kérést is vissza kell adni	Nem	Hamis
frequency_penalty	szám	-2,0 és 2,0 közötti szám. A pozitív értékek a szövegben meglévő gyakoriságuk alapján büntetik az új jogkivonatokat, így csökken annak a valószínűsége, hogy a modell ugyanazt a sort szó szerint megismételi.	Nem	0
logit_bias	object	Módosítsa annak valószínűségét, hogy a megadott jogkivonatok megjelenjenek a befejezéskor. Elfogad egy JSON-objektumot, amely -100-ról 100-ra képez le jogkivonatokat (a GPT-jogkivonat-kezelőben megadott jogkivonat-azonosítójuk alapján) egy társított elfogultsági értékre. Matematikailag a rendszer hozzáadja a torzításokat a modell által a mintavételezés előtt létrehozott logitokhoz. A pontos hatás modellenként eltérő lesz, de a -1 és az 1 közötti értékeknek csökkentenie vagy növelnie kell a kiválasztás valószínűségét; a -100 vagy a 100 értékhez hasonló értékek esetén a megfelelő jogkivonat kitiltása vagy kizárólagos kiválasztása szükséges. Átadhatja `{"50256": -100}` például a(z) \|endoftext\|> jogkivonat létrehozásának megakadályozását<.	Nem	Egyik sem
logprobs	egész szám	Adja meg a napló valószínűségét a `logprobs` legvalószínűbb kimeneti jogkivonatokon, valamint a kiválasztott jogkivonatokon. Ha például `logprobs` 5, az API az 5 legvalószínűbb token listáját adja vissza. Az API mindig a `logprob` mintául szolgáló jogkivonatot adja vissza, így a válaszban `logprobs+1` akár elemek is lehetnek. A maximális érték `logprobs` 5.	Nem	Egyik sem
max_tokens	egész szám	A befejezés során létrehozható jogkivonatok maximális száma. A parancssor jogkivonatszáma plusz `max_tokens` nem haladhatja meg a modell környezethosszát.	Nem	16
n	egész szám	Hány befejezést kell létrehozni az egyes kérésekhez. Megjegyzés: Mivel ez a paraméter sok befejezést generál, gyorsan felhasználhatja a jogkivonatkvótát. Gondosan használja, és győződjön meg arról, hogy megfelelő beállításokat `max_tokensstop`és .	Nem	0
presence_penalty	szám	-2,0 és 2,0 közötti szám. A pozitív értékek büntetik az új jogkivonatokat attól függően, hogy az eddig megjelennek-e a szövegben, növelve a modell valószínűségét, hogy új témakörökről beszéljenek.	Nem	0
mag	egész szám	Ha meg van adva, a rendszerünk mindent megtesz annak érdekében, hogy determinisztikus mintát hozzon létre, így az azonos `seed` és paraméterekkel rendelkező ismétlődő kérelmeknek ugyanazt az eredményt kell visszaadnia. A determinizmus nem garantált, és a háttérrendszer változásainak figyeléséhez tekintse meg a `system_fingerprint` válaszparamétert.	Nem
állj	sztring vagy tömb	Legfeljebb négy sorozat, amelyekben az API leállítja a további jogkivonatok generálását. A visszaadott szöveg nem tartalmazza a leállítási sorrendet.	Nem
patak	Logikai	Azt határozza meg, hogy vissza szeretné-e streamelni a részleges előrehaladást. Ha be van állítva, a jogkivonatok csak a kiszolgáló által küldött eseményekként lesznek elküldve, amint elérhetővé válnak, és a streamet egy `data: [DONE]` üzenet leállítja.	Nem	Hamis
toldalék	húr	A beszúrt szöveg befejezése után megjelenő utótag. Ez a paraméter csak a következőhöz `gpt-3.5-turbo-instruct`támogatott: .	Nem	Egyik sem
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet. Általában azt javasoljuk, hogy módosítsa ezt vagy `top_p` mindkettőt, de nem mindkettőt.	Nem	0
top_p	szám	A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti. Általában azt javasoljuk, hogy módosítsa ezt vagy `temperature` mindkettőt, de nem mindkettőt.	Nem	0
user	húr	A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében.	Nem

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	createCompletionResponse	Az API befejezési válaszát jelöli. Megjegyzés: a streamelt és a nem streamelt válaszobjektumok is ugyanazt az alakzatot adják meg (a csevegési végponttól eltérően).

Állapotkód: alapértelmezett

Leírás: A szolgáltatás nem érhető el

Tartalomtípus	Típus	Leírás
application/json	errorResponse

Példák

Példa

Létrehoz egy befejezést a megadott parancssorhoz, paraméterekhez és kiválasztott modellhez.

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

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

Válaszok: Állapotkó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
    }
  }
}

Beágyazások – Létrehozás

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

A gépi tanulási modellek és algoritmusok által könnyen felhasználható adott bemenet vektoros ábrázolását kaphatja meg.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
deployment-id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező
bemenet	sztring vagy tömb	Bemeneti szöveg beágyazásához, sztringként vagy tokentömbként kódolva. Ha több bemenetet szeretne beágyazni egyetlen kérelembe, adjon át sztringek vagy tokentömbök tömbjének tömböt. A bemenet nem haladhatja meg a modell maximális bemeneti jogkivonatait (8 192 token esetén `text-embedding-ada-002`), nem lehet üres sztring, és egy tömbnek legalább 2048 dimenziónak kell lennie.	Igen
user	húr	A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében.	Nem
input_type	húr	a használni kívánt beágyazási keresés bemeneti típusa	Nem
encoding_format	húr	A beágyazások visszaadásának formátuma. Lehet vagy `floatbase64`. Alapértelmezett érték: `float`.	Nem
Méretek	egész szám	Az eredményként kapott kimeneti beágyazások dimenzióinak száma. Csak a későbbi és a későbbi modellekben `text-embedding-3` támogatott.	Nem

Válaszok

Név	Típus	Kötelező
object	sztring	Igen
modell	sztring	Igen
adatok	array	Igen
használat	object	Igen

Használati tulajdonságok

prompt_tokens

Név	Típus	Leírás	Alapértelmezett
prompt_tokens	egész szám

total_tokens

Név	Típus	Leírás	Alapértelmezett
total_tokens	egész szám

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	object

Példák

Példa

Adja vissza a beágyazásokat egy adott kéréshez.

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

{
 "input": [
  "this is a test"
 ]
}

Válaszok: Állapotkó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
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Csevegés befejezése – Létrehozás

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

Befejező üzenet létrehozása a csevegőüzenethez

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
deployment-id	ösvény	Igen	húr	Az üzembe helyezett modell üzembehelyezési azonosítója.
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező	Alapértelmezett
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet. Általában azt javasoljuk, hogy módosítsa ezt vagy `top_p` mindkettőt, de nem mindkettőt.	Nem	0
top_p	szám	A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti. Általában azt javasoljuk, hogy módosítsa ezt vagy `temperature` mindkettőt, de nem mindkettőt.	Nem	0
patak	Logikai	Ha be van állítva, a rendszer részleges üzenet-különbözeteket küld, például a ChatGPT-ben. A jogkivonatok csak a kiszolgáló által küldött eseményekként lesznek elküldve, amint elérhetővé válnak, és a streamet egy `data: [DONE]` üzenet leállítja.	Nem	Hamis
állj	sztring vagy tömb	Legfeljebb négy sorozat, amelyekben az API leállítja a további jogkivonatok generálását.	Nem
max_tokens	egész szám	A csevegés befejezésekor létrehozható jogkivonatok maximális száma. A bemeneti jogkivonatok és a létrehozott jogkivonatok teljes hosszát a modell környezethossza korlátozza.	Nem
max_completion_tokens	egész szám	A befejezéshez létrehozható tokenek számának felső határa, beleértve a látható kimeneti jogkivonatokat és az érvelési jogkivonatokat. Ez csak o1 sorozatú modellekben támogatott. A jövőbeni API-kiadásban kiterjeszti a támogatást más modellekre.	Nem
presence_penalty	szám	-2,0 és 2,0 közötti szám. A pozitív értékek büntetik az új jogkivonatokat attól függően, hogy az eddig megjelennek-e a szövegben, növelve a modell valószínűségét, hogy új témakörökről beszéljenek.	Nem	0
frequency_penalty	szám	-2,0 és 2,0 közötti szám. A pozitív értékek a szövegben meglévő gyakoriságuk alapján büntetik az új jogkivonatokat, így csökken annak a valószínűsége, hogy a modell ugyanazt a sort szó szerint megismételi.	Nem	0
logit_bias	object	Módosítsa annak valószínűségét, hogy a megadott jogkivonatok megjelenjenek a befejezéskor. Elfogad egy JSON-objektumot, amely a tokeneket (a jogkivonat-azonosítójuk által megadott) -100-ról 100-ra képez le egy társított elfogultsági értékre. Matematikailag a rendszer hozzáadja a torzításokat a modell által a mintavételezés előtt létrehozott logitokhoz. A pontos hatás modellenként eltérő lesz, de a -1 és az 1 közötti értékeknek csökkentenie vagy növelnie kell a kiválasztás valószínűségét; a -100 vagy a 100 értékhez hasonló értékek esetén a megfelelő jogkivonat kitiltása vagy kizárólagos kiválasztása szükséges.	Nem	Egyik sem
hozzáadásához	Logikai	Függetlenül attól, hogy tárolja-e a csevegés befejezésére vonatkozó kérés kimenetét a modelllepárlási vagy kiértékelési termékeinkben való használatra.	Nem
metaadatok	object	A tárolt befejezési irányítópulton a befejezések szűréséhez használt fejlesztő által definiált címkék és értékek.	Nem
user	húr	A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében.	Nem
üzenet	array	Az eddig a beszélgetésből álló üzenetek listája.	Igen
data_sources	array	Az őket használó Azure OpenAI-csevegőbővítmények konfigurációs bejegyzései. Ez a további specifikáció csak az Azure OpenAI-val kompatibilis.	Nem
reasoning_effort	Enum	csak o1 modellek Korlátozza az érvelési modellek érvelését. Jelenleg a támogatott értékek a következők`low`: és `highmedium`. Az érvelési erőfeszítések csökkentése gyorsabb válaszokat és kevesebb jogkivonatot eredményezhet a válaszokban való érveléshez. Lehetséges értékek: alacsony, közepes, magas	Nem
logprobs	Logikai	A kimeneti jogkivonatok naplós valószínűségének visszaadása vagy sem. Ha igaz, akkor az egyes kimeneti jogkivonatok napló valószínűségét adja vissza a `content` következőben `message`: .	Nem	Hamis
top_logprobs	egész szám	Egy 0 és 20 közötti egész szám, amely megadja, hogy az egyes tokenpozíciókban a legvalószínűbb tokenek hányan térnek vissza, és mindegyikhez tartozik napló valószínűsége. `logprobs` ezt a paramétert `true` kell beállítani.	Nem
n	egész szám	Hány csevegés-befejezési lehetőséget kell létrehozni az egyes bemeneti üzenetekhez. Vegye figyelembe, hogy a díjakat a létrehozott jogkivonatok száma alapján számítjuk fel az összes lehetőség közül. Tartsa meg `n` a `1` költségek minimalizálását.	Nem	0
parallel_tool_calls	ParallelToolCalls	Engedélyezi-e a párhuzamos függvényhívást az eszköz használata során.	Nem	Igaz
response_format	ResponseFormatText vagy ResponseFormatJsonObject vagy ResponseFormatJsonSchema	Egy objektum, amely megadja a modell által kiadandó formátumot. Kompatibilis a GPT-4o, GPT-4o mini, GPT-4 Turbo és az összes GPT-3.5 Turbo modellek újabb, mint `gpt-3.5-turbo-1106`. A strukturált kimeneteket engedélyező `{ "type": "json_schema", "json_schema": {...} }` beállítás, amely garantálja, hogy a modell megfelel a megadott JSON-sémának. A JSON mód engedélyezése, `{ "type": "json_object" }` amely garantálja, hogy a modell által generált üzenet érvényes JSON. Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha `finish_reason="length"`az azt jelzi, hogy a létrehozás túllépte `max_tokens` vagy a beszélgetés túllépte a környezet maximális hosszát.	Nem
mag	egész szám	Ez a funkció bétaverzióban érhető el. Ha meg van adva, a rendszerünk mindent megtesz annak érdekében, hogy determinisztikus mintát hozzon létre, így az azonos `seed` és paraméterekkel rendelkező ismétlődő kérelmeknek ugyanazt az eredményt kell visszaadnia. A determinizmus nem garantált, és a háttérrendszer változásainak figyeléséhez tekintse meg a `system_fingerprint` válaszparamétert.	Nem
stream_options	chatCompletionStreamOptions	A streamelési válasz beállításai. Ezt csak akkor állítsa be, ha be van állítva `stream: true`.	Nem	Egyik sem
eszközök	array	A modell által meghívható eszközök listája. Jelenleg csak a függvények támogatottak eszközként. Ezzel megadhatja azon függvények listáját, amelyekhez a modell JSON-bemeneteket hozhat létre. Legfeljebb 128 függvény támogatott.	Nem
tool_choice	chatCompletionToolChoiceOption	Azt szabályozza, hogy a modell melyik eszközt hívja meg (ha van ilyen). `none` azt jelenti, hogy a modell nem hív meg egyetlen eszközt sem, és ehelyett létrehoz egy üzenetet. `auto` azt jelenti, hogy a modell választhat egy üzenet létrehozása vagy egy vagy több eszköz meghívása között. `required` azt jelenti, hogy a modellnek egy vagy több eszközt kell meghívnia. Egy adott eszköz megadása az `{"type": "function", "function": {"name": "my_function"}}` eszköz meghívására kényszeríti a modellt. `none` az alapértelmezett, ha nincsenek eszközök. `auto` az alapértelmezett, ha az eszközök vannak jelen.	Nem
function_call	sztring vagy csevegésCompletionFunctionCallOption	Elavult a javára `tool_choice`. Azt szabályozza, hogy a modell melyik függvényt hívja meg (ha van ilyen). `none` azt jelenti, hogy a modell nem hív meg függvényt, hanem létrehoz egy üzenetet. `auto` azt jelenti, hogy a modell választhat az üzenet létrehozása vagy egy függvény meghívása között. Egy adott függvény megadása a modell meghívására kényszeríti `{"name": "my_function"}` a modellt. `none` az alapértelmezett, ha nincsenek függvények. `auto` az alapértelmezett, ha függvények vannak jelen.	Nem
functions	array	Elavult a javára `tools`. Azon függvények listája, amelyekhez a modell JSON-bemeneteket hozhat létre.	Nem
user_security_context	userSecurityContext	A felhasználói biztonsági környezet számos paramétert tartalmaz, amelyek maguk az AI-alkalmazást, valamint az AI-alkalmazást kezelő végfelhasználót írják le. Ezek a mezők segítenek a biztonsági üzemeltetési csapatoknak a biztonsági incidensek kivizsgálásában és enyhítésében azáltal, hogy átfogó megközelítést nyújtanak az AI-alkalmazások védelméhez. További információ az AI-alkalmazások Felhőhöz készült Microsoft Defender használatával történő védelméről.	Nem
Módozatok	ChatCompletionModalities	Olyan kimeneti típusok, amelyeket a modellnek létre szeretne hozni ehhez a kéréshez. A legtöbb modell képes szöveg létrehozására, ami az alapértelmezett: `["text"]` A `gpt-4o-audio-preview` modell hang létrehozására is használható. Művelet kérvényezi, hogy ez a modell szöveges és hangválaszokat is hozzon létre, használat: `["text", "audio"]`	Nem
jóslás	PredictionContent	Előrejelzett kimenet konfigurációja, amely jelentősen javíthatja a válaszidőt, ha a modell válaszának nagy része előre ismert. Ez a leggyakoribb, ha olyan fájlt hoz létre, amely csak kisebb módosításokat tartalmaz a tartalom nagy részén.	Nem
hanganyag	object	A hangkimenet paraméterei. A hangkimenet kérése esetén kötelező `modalities: ["audio"]`.	Nem

Hangtulajdonságok

voice

Név	Típus	Leírás	Alapértelmezett
voice	húr	Megadja a hangtípust. A támogatott hangok a következők`alloy`: , `echo` `fable`, `onyx`, `nova` és `shimmer`.

format

Név	Típus	Leírás	Alapértelmezett
format	húr	Megadja a kimeneti hangformátumot. Az egyiknek `wav`, `mp3`, , `flac` `opus` `pcm16`vagy .

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	createChatCompletionResponse vagy createChatCompletionStreamResponse

Állapotkód: alapértelmezett

Leírás: A szolgáltatás nem érhető el

Tartalomtípus	Típus	Leírás
application/json	errorResponse

Példák

Példa

Létrehoz egy befejezést a megadott parancssorhoz, paraméterekhez és kiválasztott modellhez.

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

Válaszok: Állapotkó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élda

Befejezést hoz létre az Azure Search adatai és a rendszer által hozzárendelt felügyelt identitás alapján.

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

Válaszok: Állapotkó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élda

Befejezést hoz létre az Azure Search képvektoradatai alapján.

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

Válaszok: Állapotkó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élda

Befejezést hoz létre az Azure Search vektoradatai, a korábbi asszisztensi üzenet és a felhasználó által hozzárendelt felügyelt identitás alapján.

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

Válaszok: Állapotkó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élda

Létrehoz egy befejezést a megadott Azure Cosmos DB-hez.

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

Válaszok: Állapotkó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élda

Létrehoz egy befejezést a megadott Mongo DB-hez.

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

Válaszok: Állapotkó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élda

Befejezést hoz létre a megadott Elasticsearch számára.

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

Válaszok: Állapotkó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élda

Létrehoz egy befejezést a megadott Pinecone-erőforráshoz.

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

Válaszok: Állapotkó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
    }
  }
}

Átiratok – Létrehozás

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

A hang átírása a bemeneti nyelvre.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
deployment-id	ösvény	Igen	húr	A suttogó modell üzembehelyezési azonosítója.
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: többrészes/űrlapadatok

Név	Típus	Leírás	Kötelező	Alapértelmezett
fájl	húr	Az átírandó hangfájl-objektum.	Igen
haladéktalan	húr	Választható szöveg a modell stílusának irányításához vagy egy korábbi hangszegmens folytatásához. A kérésnek meg kell egyeznie a hangnyelvvel.	Nem
response_format	audioResponseFormat	Meghatározza a kimenet formátumát.	Nem
hőmérséklet	szám	A mintavételi hőmérséklet 0 és 1 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet. Ha 0 értékre van állítva, a modell naplók valószínűségével automatikusan növeli a hőmérsékletet, amíg bizonyos küszöbértékeket nem ér el.	Nem	0
language	húr	A bemeneti hang nyelve. Ha ISO-639-1 formátumban adja meg a bemeneti nyelvet, az növeli a pontosságot és a késést.	Nem
timestamp_granularities[]	array	Az átíráshoz feltöltendő időbélyeg részletesség. `response_format` időbélyeg részletesség használatára kell beállítani `verbose_json` . Mindkét lehetőség támogatott: `word`vagy `segment`. Megjegyzés: A szegmensek időbélyegei nem járnak további késéssel, de a szóidőbélyegek generálása további késéssel jár.	Nem	[szegmens]

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	audioResponse vagy audioVerboseResponse
text/plain	húr	Átírt szöveg kimeneti formátumban (amikor response_format szöveg, vtt vagy srt volt).

Példák

Példa

Lekéri az átírt szöveget és a kapcsolódó metaadatokat a megadott beszélt hangadatokból.

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

Válaszok: Állapotkód: 200

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

Példa

Lekéri az átírt szöveget és a kapcsolódó metaadatokat a megadott beszélt hangadatokból.

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

Válaszok: Állapotkód: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Fordítások – Létrehozás

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

Átírja és lefordítja a bemeneti hangokat angol szöveggé.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
deployment-id	ösvény	Igen	húr	Az üzembe helyezett suttogómodell üzembehelyezési azonosítója.
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: többrészes/űrlapadatok

Név	Típus	Leírás	Kötelező	Alapértelmezett
fájl	húr	A lefordítandó hangfájl.	Igen
haladéktalan	húr	Választható szöveg a modell stílusának irányításához vagy egy korábbi hangszegmens folytatásához. A kérésnek angolul kell lennie.	Nem
response_format	audioResponseFormat	Meghatározza a kimenet formátumát.	Nem
hőmérséklet	szám	A mintavételi hőmérséklet 0 és 1 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet. Ha 0 értékre van állítva, a modell naplók valószínűségével automatikusan növeli a hőmérsékletet, amíg bizonyos küszöbértékeket nem ér el.	Nem	0

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	audioResponse vagy audioVerboseResponse
text/plain	húr	Átírt szöveg kimeneti formátumban (amikor response_format szöveg, vtt vagy srt volt).

Példák

Példa

Lekéri az angol nyelvű átírt szöveget és a kapcsolódó metaadatokat a megadott beszélt hangadatokból.

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

Válaszok: Állapotkód: 200

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

Példa

Lekéri az angol nyelvű átírt szöveget és a kapcsolódó metaadatokat a megadott beszélt hangadatokból.

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

Válaszok: Állapotkód: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Beszéd – Létrehozás

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

Hang létrehozása a bemeneti szövegből.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
deployment-id	ösvény	Igen	húr	Az üzembe helyezett tts-modell üzembehelyezési azonosítója.
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: többrészes/űrlapadatok

Név	Típus	Leírás	Kötelező	Alapértelmezett
bemenet	húr	A hangszintézishez használt szöveg. A maximális hossz 4096 karakter.	Igen
voice	Enum	A beszédszintézishez használandó hang. Lehetséges értékek: ötvözet, echo, medális, onyx, nova, csillám	Igen
response_format	Enum	A hangszintézis formátuma. Lehetséges értékek: mp3, opus, aac, flac, wav, pcm	Nem
sebesség	szám	A szintetizált hang sebessége. Válasszon ki egy értéket a kívánt érték közül `0.254.0`. A `1.0` az alapértelmezett formátum.	Nem	1.0

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/octet-stream	húr

Példák

Példa

A megadott szövegből származó hangszintézis.

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

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

Válaszok: Állapotkód: 200

{
  "body": "101010101"
}

Képgenerációk – Létrehozás

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

Képköteg létrehozása szövegfeliratból egy adott DALLE-modell üzembe helyezéséhez

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
deployment-id	ösvény	Igen	húr	Az üzembe helyezett dalle-modell üzembehelyezési azonosítója.
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező	Alapértelmezett
haladéktalan	húr	A kívánt kép(ek) szöveges leírása. A maximális hossz 4000 karakter.	Igen
n	egész szám	A létrehozandó képek száma.	Nem	0
Méret	imageSize	A létrehozott képek mérete.	Nem	1024 x 1024
response_format	imagesResponseFormat	A létrehozott képek visszaadott formátuma.	Nem	url
user	húr	A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében.	Nem
minőség	imageQuality	A létrehozandó kép minősége.	Nem	normál
style	imageStyle	A létrehozott képek stílusa.	Nem	élénk

Válaszok

Állapotkód: 200

Leírás: Ok

Tartalomtípus	Típus	Leírás
application/json	generateImagesResponse

Állapotkód: alapértelmezett

Leírás: Hiba történt.

Tartalomtípus	Típus	Leírás
application/json	dalleErrorResponse

Példák

Példa

A rendszerképeket a rendszer kéri.

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

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

Válaszok: Állapotkó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
          }
        }
      }
    ]
  }
}

Lista – Asszisztensek

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

Az asszisztensek listáját adja vissza.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
korlát	Lekérdezés	Nem	egész szám
megrendelés	Lekérdezés	Nem	húr
ennyi idő múlva	Lekérdezés	Nem	húr
előtt	Lekérdezés	Nem	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	listAssistantsResponse

Példák

Példa

Az asszisztensek listáját adja vissza.

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

Válaszok: Állapotkó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
  }
}

Létrehozás – Asszisztens

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

Hozzon létre egy asszisztenst egy modellel és útmutatással.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező	Alapértelmezett
modell			Igen
név	húr	Az asszisztens neve. A maximális hossz 256 karakter.	Nem
leírás	húr	Az asszisztens leírása. A maximális hossz 512 karakter.	Nem
útmutató	húr	Az asszisztens által használt rendszerutasítások. A maximális hossz 256 000 karakter.	Nem
eszközök	array	Az asszisztensen engedélyezett eszközlista. Asszisztensenként legfeljebb 128 eszköz lehet. Az eszközök lehetnek típusok `code_interpreter`, `retrieval`vagy `function`.	Nem	[]
tool_resources	object	Az asszisztens eszközei által használt erőforrások készlete. Az erőforrások az eszköz típusára vonatkoznak. Az eszköznek például `code_interpreter` a fájlazonosítók listájára van szüksége, míg az `file_search` eszköznek a vektortároló azonosítóinak listájára van szüksége.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet.	Nem	0
top_p	szám	A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti. Általában azt javasoljuk, hogy módosítsa ezt vagy a hőmérsékletet, de mindkettőt nem.	Nem	0
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4o, a GPT-4 Turbo és az összes GPT-3.5 Turbo modellel.`gpt-3.5-turbo-1106` A strukturált kimeneteket engedélyező `{ "type": "json_schema", "json_schema": {...} }` beállítás, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. További információ a Strukturált kimenetek útmutatóban. A JSON mód engedélyezése beállítás `{ "type": "json_object" }` , amely biztosítja, hogy a modell által generált üzenet érvényes JSON legyen. Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha `finish_reason="length"`az azt jelzi, hogy a létrehozás túllépte `max_tokens` vagy a beszélgetés túllépte a környezet maximális hosszát.	Nem

A tool_resources tulajdonságai

code_interpreter

Név	Típus	Leírás	Alapértelmezett
file_ids	array	Az eszköz számára `code_interpreter` elérhetővé tett fájlazonosítók listája. Az eszközhöz legfeljebb 20 fájl társítható.	[]

file_search

Név	Típus	Leírás	Alapértelmezett
vector_store_ids	array	Az asszisztenshez csatolt vektortároló. Legfeljebb egy vektortároló csatolható az asszisztenshez.
vector_stores	array	Segéd egy vektortároló létrehozásához file_ids és csatolja az asszisztenshez. Legfeljebb egy vektortároló csatolható az asszisztenshez.

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	assistantObject	Olyan modellt `assistant` jelöl, amely meghívhatja a modellt, és eszközöket használhat.

Példák

Példa

Hozzon létre egy asszisztenst egy modellel és útmutatással.

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

Válaszok: Állapotkó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"
  }
}

Get - Assistant

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

Lekéri az asszisztenst.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
assistant_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	assistantObject	Olyan modellt `assistant` jelöl, amely meghívhatja a modellt, és eszközöket használhat.

Példák

Példa

Lekéri az asszisztenst.

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

Válaszok: Állapotkó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"
  }
}

Módosítás – Asszisztens

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

Módosítja az asszisztenst.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
assistant_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező	Alapértelmezett
modell			Nem
név	húr	Az asszisztens neve. A maximális hossz 256 karakter.	Nem
leírás	húr	Az asszisztens leírása. A maximális hossz 512 karakter.	Nem
útmutató	húr	Az asszisztens által használt rendszerutasítások. A maximális hossz 32 768 karakter.	Nem
eszközök	array	Az asszisztensen engedélyezett eszközlista. Asszisztensenként legfeljebb 128 eszköz lehet. Az eszközök lehetnek típusok `code_interpreter`, `retrieval`vagy `function`.	Nem	[]
tool_resources	object	Az asszisztens eszközei által használt erőforrások készlete. Az erőforrások az eszköz típusára vonatkoznak. Az eszköznek például `code_interpreter` a fájlazonosítók listájára van szüksége, míg az `file_search` eszköznek a vektortároló azonosítóinak listájára van szüksége.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet.	Nem	0
top_p	szám	A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti. Általában azt javasoljuk, hogy módosítsa ezt vagy a hőmérsékletet, de mindkettőt nem.	Nem	0
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4o, a GPT-4 Turbo és az összes GPT-3.5 Turbo modellel.`gpt-3.5-turbo-1106` A strukturált kimeneteket engedélyező `{ "type": "json_schema", "json_schema": {...} }` beállítás, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. További információ a Strukturált kimenetek útmutatóban. A JSON mód engedélyezése beállítás `{ "type": "json_object" }` , amely biztosítja, hogy a modell által generált üzenet érvényes JSON legyen. Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha `finish_reason="length"`az azt jelzi, hogy a létrehozás túllépte `max_tokens` vagy a beszélgetés túllépte a környezet maximális hosszát.	Nem

A tool_resources tulajdonságai

code_interpreter

Név	Típus	Leírás	Alapértelmezett
file_ids	array	Felülbírálja az eszköz számára `code_interpreter` elérhetővé tett fájlazonosítók listáját. Az eszközhöz legfeljebb 20 fájl társítható.	[]

file_search

Név	Típus	Leírás	Alapértelmezett
vector_store_ids	array	Felülbírálja az asszisztenshez csatolt vektortárolót. Legfeljebb egy vektortároló csatolható az asszisztenshez.

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	assistantObject	Olyan modellt `assistant` jelöl, amely meghívhatja a modellt, és eszközöket használhat.

Példák

Példa

Módosítja az asszisztenst.

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

Válaszok: Állapotkó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"
  }
}

Törlés – Asszisztens

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

Segéd törlése.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
assistant_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	deleteAssistantResponse

Példák

Példa

Egy asszisztens törlése.

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

Válaszok: Állapotkód: 200

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

Létrehozás – Szál

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

Hozzon létre egy szálat.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező
üzenet	array	Azoknak az üzeneteknek a listája, amellyel elindíthatja a szálat.	Nem
tool_resources	object	Az ebben a szálban az asszisztens eszközei számára elérhetővé tett erőforrások készlete. Az erőforrások az eszköz típusára vonatkoznak. Az eszköznek például `code_interpreter` a fájlazonosítók listájára van szüksége, míg az `file_search` eszköznek a vektortároló azonosítóinak listájára van szüksége.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem

A tool_resources tulajdonságai

code_interpreter

Név	Típus	Leírás	Alapértelmezett
file_ids	array	Az eszköz számára `code_interpreter` elérhetővé tett fájlazonosítók listája. Az eszközhöz legfeljebb 20 fájl társítható.	[]

file_search

Név	Típus	Leírás	Alapértelmezett
vector_store_ids	array	A szálhoz csatolt vektortároló. A szálhoz legfeljebb egy vektortároló csatolható.
vector_stores	array	Segéd egy vektortároló létrehozásához file_ids és csatolja ehhez a szálhoz. A szálhoz legfeljebb egy vektortároló csatolható.

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	threadObject	Üzeneteket tartalmazó szálat jelöl.

Példák

Példa

Létrehoz egy szálat.

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

Válaszok: Állapotkód: 200

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

Lekérés – Szál

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

Lekéri a szálat.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	threadObject	Üzeneteket tartalmazó szálat jelöl.

Példák

Példa

Lekéri a szálat.

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

Válaszok: Állapotkód: 200

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

Módosítás – Szál

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

Módosítja a szálat.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező	Alapértelmezett
tool_resources	object	Az ebben a szálban az asszisztens eszközei számára elérhetővé tett erőforrások készlete. Az erőforrások az eszköz típusára vonatkoznak. Az eszköznek például `code_interpreter` a fájlazonosítók listájára van szüksége, míg az `file_search` eszköznek a vektortároló azonosítóinak listájára van szüksége.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem

A tool_resources tulajdonságai

code_interpreter

Név	Típus	Leírás	Alapértelmezett
file_ids	array	Az eszköz számára `code_interpreter` elérhetővé tett fájlazonosítók listája. Az eszközhöz legfeljebb 20 fájl társítható.	[]

file_search

Név	Típus	Leírás	Alapértelmezett
vector_store_ids	array	A szálhoz csatolt vektortároló. A szálhoz legfeljebb egy vektortároló csatolható.

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	threadObject	Üzeneteket tartalmazó szálat jelöl.

Példák

Példa

Módosítja a szálat.

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

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

Válaszok: Állapotkód: 200

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

Törlés – Szál

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

Szál törlése.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	deleteThreadResponse

Példák

Példa

Töröl egy szálat.

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

Válaszok: Állapotkód: 200

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

Lista – Üzenetek

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

Egy adott szál üzenetlistáját adja vissza.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
korlát	Lekérdezés	Nem	egész szám
megrendelés	Lekérdezés	Nem	húr
ennyi idő múlva	Lekérdezés	Nem	húr
előtt	Lekérdezés	Nem	húr
run_id	Lekérdezés	Nem	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	listMessagesResponse

Példák

Példa

Üzenetek listázása

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

Válaszok: Állapotkó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
  }
}

Létrehozás – Üzenet

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

Hozzon létre egy üzenetet.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező
szerepkör	húr	Az üzenetet létrehozó entitás szerepe. Az engedélyezett értékek a következők: - `user`: Azt jelzi, hogy az üzenetet egy tényleges felhasználó küldi el, és a legtöbb esetben a felhasználó által generált üzenetek megjelenítésére kell használni. - `assistant`: Azt jelzi, hogy az üzenetet az asszisztens hozza létre. Ezzel az értékkel beszúrhat üzeneteket az asszisztensből a beszélgetésbe.	Igen
content	húr	Az üzenet tartalma.	Igen
Mellékletek	array	Az üzenethez csatolt fájlok listája, valamint az eszközök, amelyhez hozzá kell adni őket.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	messageObject	Egy szálon belüli üzenetet jelöl.

Példák

Példa

Hozzon létre egy üzenetet.

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

Válaszok: Állapotkó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": {}
  }
}

Lekérés – Üzenet

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

Üzenet lekérése.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
message_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	messageObject	Egy szálon belüli üzenetet jelöl.

Példák

Példa

Üzenet lekérése.

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

Válaszok: Állapotkó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": {}
  }
}

Módosítás – Üzenet

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

Módosítja az üzenetet.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
message_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező	Alapértelmezett
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	messageObject	Egy szálon belüli üzenetet jelöl.

Példák

Példa

Üzenet módosítása.

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

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

Válaszok: Állapotkó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"
    }
  }
}

Létrehozás – Szál és futtatás

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

Hozzon létre egy szálat, és futtassa egy kérelemben.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező	Alapértelmezett
assistant_id	húr	A futtatás végrehajtásához használni kívánt asszisztens azonosítója.	Igen
szál	createThreadRequest		Nem
modell	húr	A futtatás végrehajtásához használandó modell azonosítója. Ha itt egy érték van megadva, az felülírja az asszisztenshez társított modellt. Ha nem, akkor a rendszer az asszisztenshez társított modellt használja.	Nem
útmutató	húr	Felülbírálja az asszisztens alapértelmezett rendszerüzenetét. Ez a viselkedés futásonkénti módosításához hasznos.	Nem
eszközök	array	Felülbírálja az asszisztens által a futtatáshoz használható eszközöket. Ez a viselkedés futásonkénti módosításához hasznos.	Nem
tool_resources	object	Az asszisztens eszközei által használt erőforrások készlete. Az erőforrások az eszköz típusára vonatkoznak. Az eszköznek például `code_interpreter` a fájlazonosítók listájára van szüksége, míg az `file_search` eszköznek a vektortároló azonosítóinak listájára van szüksége.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet.	Nem	0
top_p	szám	A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti. Általában azt javasoljuk, hogy módosítsa ezt vagy a hőmérsékletet, de mindkettőt nem.	Nem	0
patak	Logikai	Ha `true`, a futtatás kiszolgáló által küldött események során bekövetkező események adatfolyamát adja vissza, amely akkor végződik, amikor a Futtatás terminálállapotba lép egy `data: [DONE]` üzenettel.	Nem
stream_options	chatCompletionStreamOptions	A streamelési válasz beállításai. Ezt csak akkor állítsa be, ha be van állítva `stream: true`.	Nem	Egyik sem
max_prompt_tokens	egész szám	A futtatás során használható parancssori jogkivonatok maximális száma. A futtatás mindent megtesz annak érdekében, hogy csak a megadott számú parancssori jogkivonatot használja a futtatás több fordulója során. Ha a futtatás meghaladja a megadott parancssori jogkivonatok számát, a futtatás állapottal `incomplete`fejeződik be. További információt itt talál `incomplete_details` .	Nem
max_completion_tokens	egész szám	A futtatás során használható befejezési jogkivonatok maximális száma. A futtatás mindent megtesz annak érdekében, hogy csak a megadott számú befejezési jogkivonatot használja a futtatás több fordulója során. Ha a futtatás meghaladja a megadott befejezési jogkivonatok számát, a futtatás állapottal `incomplete`fejeződik be. További információt itt talál `incomplete_details` .	Nem
truncation_strategy	truncationObject	Azt szabályozza, hogy a futtatás előtt hogyan csonkolja a szálat. Ezzel szabályozhatja a futtatás kezdeti környezeti ablakát.	Nem
tool_choice	assistantsApiToolChoiceOption	Azt szabályozza, hogy a modell melyik eszközt hívja meg (ha van ilyen). `none` azt jelenti, hogy a modell nem hív meg eszközöket, hanem üzenetet hoz létre. `auto` az alapértelmezett érték, és azt jelenti, hogy a modell választhat az üzenet létrehozása vagy az eszköz meghívása között. Egy adott eszköz megadása, például `{"type": "file_search"}{"type": "function", "function": {"name": "my_function"}}` a modell meghívására kényszeríti a modellt.	Nem
parallel_tool_calls	ParallelToolCalls	Engedélyezi-e a párhuzamos függvényhívást az eszköz használata során.	Nem	Igaz
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4o, a GPT-4 Turbo és az összes GPT-3.5 Turbo modellel.`gpt-3.5-turbo-1106` A strukturált kimeneteket engedélyező `{ "type": "json_schema", "json_schema": {...} }` beállítás, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. További információ a Strukturált kimenetek útmutatóban. A JSON mód engedélyezése beállítás `{ "type": "json_object" }` , amely biztosítja, hogy a modell által generált üzenet érvényes JSON legyen. Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha `finish_reason="length"`az azt jelzi, hogy a létrehozás túllépte `max_tokens` vagy a beszélgetés túllépte a környezet maximális hosszát.	Nem

A tool_resources tulajdonságai

code_interpreter

Név	Típus	Leírás	Alapértelmezett
file_ids	array	Az eszköz számára `code_interpreter` elérhetővé tett fájlazonosítók listája. Az eszközhöz legfeljebb 20 fájl társítható.	[]

file_search

Név	Típus	Leírás	Alapértelmezett
vector_store_ids	array	Az asszisztenshez csatolt vektortároló azonosítója. Legfeljebb egy vektortároló csatolható az asszisztenshez.

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	runObject	Egy szálon futtatott végrehajtást jelöl.

Példák

Példa

Hozzon létre egy szálat, és futtassa egy kérelemben.

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

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

Válaszok: Állapotkó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"
  }
}

Lista – Futtatások

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

Egy szálhoz tartozó futtatások listáját adja vissza.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
korlát	Lekérdezés	Nem	egész szám
megrendelés	Lekérdezés	Nem	húr
ennyi idő múlva	Lekérdezés	Nem	húr
előtt	Lekérdezés	Nem	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	listRunsResponse

Példák

Példa

Egy szálhoz tartozó futtatások listáját adja vissza.

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

Válaszok: Állapotkó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
  }
}

Létrehozás – Futtatás

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

Futtatás létrehozása.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
include[]	Lekérdezés	Nem	array
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező	Alapértelmezett
assistant_id	húr	A futtatás végrehajtásához használni kívánt asszisztens azonosítója.	Igen
modell	húr	A futtatás végrehajtásához használandó modell azonosítója. Ha itt egy érték van megadva, az felülírja az asszisztenshez társított modellt. Ha nem, akkor a rendszer az asszisztenshez társított modellt használja.	Nem
útmutató	húr	Felülbírálja az asszisztens alapértelmezett rendszerüzenetét. Ez a viselkedés futásonkénti módosításához hasznos.	Nem
additional_instructions	húr	A futtatásra vonatkozó utasítások végén további utasításokat fűz hozzá. Ez akkor hasznos, ha futtatásonként módosítja a viselkedést anélkül, hogy felülírna más utasításokat.	Nem
additional_messages	array	A futtatás létrehozása előtt további üzeneteket ad hozzá a szálhoz.	Nem
eszközök	array	Felülbírálja az asszisztens által a futtatáshoz használható eszközöket. Ez a viselkedés futásonkénti módosításához hasznos.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet.	Nem	0
top_p	szám	A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti. Általában azt javasoljuk, hogy módosítsa ezt vagy a hőmérsékletet, de mindkettőt nem.	Nem	0
patak	Logikai	Ha `true`, a futtatás kiszolgáló által küldött események során bekövetkező események adatfolyamát adja vissza, amely akkor végződik, amikor a Futtatás terminálállapotba lép egy `data: [DONE]` üzenettel.	Nem
max_prompt_tokens	egész szám	A futtatás során használható parancssori jogkivonatok maximális száma. A futtatás mindent megtesz annak érdekében, hogy csak a megadott számú parancssori jogkivonatot használja a futtatás több fordulója során. Ha a futtatás meghaladja a megadott parancssori jogkivonatok számát, a futtatás állapottal `incomplete`fejeződik be. További információt itt talál `incomplete_details` .	Nem
max_completion_tokens	egész szám	A futtatás során használható befejezési jogkivonatok maximális száma. A futtatás mindent megtesz annak érdekében, hogy csak a megadott számú befejezési jogkivonatot használja a futtatás több fordulója során. Ha a futtatás meghaladja a megadott befejezési jogkivonatok számát, a futtatás állapottal `incomplete`fejeződik be. További információt itt talál `incomplete_details` .	Nem
truncation_strategy	truncationObject	Azt szabályozza, hogy a futtatás előtt hogyan csonkolja a szálat. Ezzel szabályozhatja a futtatás kezdeti környezeti ablakát.	Nem
tool_choice	assistantsApiToolChoiceOption	Azt szabályozza, hogy a modell melyik eszközt hívja meg (ha van ilyen). `none` azt jelenti, hogy a modell nem hív meg eszközöket, hanem üzenetet hoz létre. `auto` az alapértelmezett érték, és azt jelenti, hogy a modell választhat az üzenet létrehozása vagy az eszköz meghívása között. Egy adott eszköz megadása, például `{"type": "file_search"}{"type": "function", "function": {"name": "my_function"}}` a modell meghívására kényszeríti a modellt.	Nem
parallel_tool_calls	ParallelToolCalls	Engedélyezi-e a párhuzamos függvényhívást az eszköz használata során.	Nem	Igaz
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4o, a GPT-4 Turbo és az összes GPT-3.5 Turbo modellel.`gpt-3.5-turbo-1106` A strukturált kimeneteket engedélyező `{ "type": "json_schema", "json_schema": {...} }` beállítás, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. További információ a Strukturált kimenetek útmutatóban. A JSON mód engedélyezése beállítás `{ "type": "json_object" }` , amely biztosítja, hogy a modell által generált üzenet érvényes JSON legyen. Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha `finish_reason="length"`az azt jelzi, hogy a létrehozás túllépte `max_tokens` vagy a beszélgetés túllépte a környezet maximális hosszát.	Nem

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	runObject	Egy szálon futtatott végrehajtást jelöl.

Példák

Példa

Futtatás létrehozása.

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

{
 "assistant_id": "asst_abc123"
}

Válaszok: Állapotkó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"
  }
}

Lekérés – Futtatás

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

Lekéri a futtatásokat.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
run_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	runObject	Egy szálon futtatott végrehajtást jelöl.

Példák

Példa

Lefut.

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

Válaszok: Állapotkó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": {}
  }
}

Módosítás – Futtatás

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

Módosítja a futtatásokat.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
run_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező	Alapértelmezett
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	runObject	Egy szálon futtatott végrehajtást jelöl.

Példák

Példa

Módosítja a futtatásokat.

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

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

Válaszok: Állapotkó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"
  }
}

Küldés – Futtatandó eszközkimenetek

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

Ha egy futtatás rendelkezik a status: "requires_action" következővel, required_action.typesubmit_tool_outputsez a végpont használható az eszközhívások kimeneteinek elküldésére, miután az összes befejeződött. Minden kimenetet egyetlen kérelemben kell elküldeni.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
run_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező	Alapértelmezett
tool_outputs	array	Azoknak az eszközöknek a listája, amelyekhez a kimenetek elküldése folyamatban van.	Igen
patak	Logikai	Ha `true`, a futtatás kiszolgáló által küldött események során bekövetkező események adatfolyamát adja vissza, amely akkor végződik, amikor a Futtatás terminálállapotba lép egy `data: [DONE]` üzenettel.	Nem

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	runObject	Egy szálon futtatott végrehajtást jelöl.

Példák

Példa

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

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

Válaszok: Állapotkó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"
  }
}

Mégse – Futtatás

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

Megszakítja a futtatásokat in_progress.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
run_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	runObject	Egy szálon futtatott végrehajtást jelöl.

Példák

Példa

Megszakítja a futtatásokat in_progress.

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

Válaszok: Állapotkó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"
  }
}

Lista – Futtatási lépések

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

Egy futtatáshoz tartozó futtatási lépések listáját adja vissza.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
run_id	ösvény	Igen	húr
korlát	Lekérdezés	Nem	egész szám
megrendelés	Lekérdezés	Nem	húr
ennyi idő múlva	Lekérdezés	Nem	húr
előtt	Lekérdezés	Nem	húr
api-verzió	Lekérdezés	Igen	húr	API-verzió
include[]	Lekérdezés	Nem	array

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	listRunStepsResponse

Példák

Példa

Egy futtatáshoz tartozó futtatási lépések listáját adja vissza.

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

Válaszok: Állapotkó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
  }
}

Lekérés – Futtatási lépés

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

Lekéri a futtatási lépést.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
thread_id	ösvény	Igen	húr
run_id	ösvény	Igen	húr
step_id	ösvény	Igen	húr
include[]	Lekérdezés	Nem	array
api-verzió	Lekérdezés	Igen	húr	API-verzió

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	runStepObject	Egy futtatás végrehajtásának lépését jelöli.

Példák

Példa

Lekéri a futtatási lépést.

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

Válaszok: Állapotkó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
    }
  }
}

Lista – Vektortárolók

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

A vektortárolók listáját adja vissza.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
korlát	Lekérdezés	Nem	egész szám
megrendelés	Lekérdezés	Nem	húr
ennyi idő múlva	Lekérdezés	Nem	húr
előtt	Lekérdezés	Nem	húr
api-verzió	Lekérdezés	Igen	húr

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	listVectorStoresResponse

Példák

Példa

A vektortárolók listáját adja vissza.

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

Válaszok: Állapotkó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
  }
}

Létrehozás – Vektortároló

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

Hozzon létre egy vektortárolót.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
api-verzió	Lekérdezés	Igen	húr

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező
file_ids	array	A vektortároló által használandó fájlazonosítók listája. Olyan eszközök esetén hasznos, amelyek `file_search` hozzáférhetnek a fájlokhoz.	Nem
név	húr	A vektortároló neve.	Nem
expires_after	vectorStoreExpirationAfter	A vektortároló lejárati szabályzata.	Nem
chunking_strategy	autoChunkingStrategyRequestParam vagy staticChunkingStrategyRequestParam	A fájl(ok) darabolásához használt adattömb-stratégia. Ha nincs beállítva, használja a `auto` stratégiát. Csak akkor alkalmazható, ha `file_ids` nincs lehetőség.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	vectorStoreObject	A vektortár az eszköz által `file_search` használható feldolgozott fájlok gyűjteménye.

Példák

Példa

Vektortárolót hoz létre.

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

Válaszok: Állapotkód: 200

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

Get – Vector Store

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

Egy vektortárolót kér le.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
vector_store_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	vectorStoreObject	A vektortár az eszköz által `file_search` használható feldolgozott fájlok gyűjteménye.

Példák

Példa

Egy vektortárolót kér le.

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

Válaszok: Állapotkód: 200

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

Módosítás – Vektortároló

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

Módosítja a vektortárolót.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
vector_store_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező
név	húr	A vektortároló neve.	Nem
expires_after	vectorStoreExpirationAfter	A vektortároló lejárati szabályzata.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	vectorStoreObject	A vektortár az eszköz által `file_search` használható feldolgozott fájlok gyűjteménye.

Példák

Példa

Módosítja a vektortárolót.

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

{
 "name": "Support FAQ"
}

Válaszok: Állapotkó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
    }
  }
}

Törlés – Vektortároló

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

Vektortároló törlése.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
vector_store_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	deleteVectorStoreResponse

Példák

Példa

Vektortároló törlése.

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

Válaszok: Állapotkód: 200

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

Lista – Vektortár fájljai

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

A vektortárfájlok listáját adja vissza.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
vector_store_id	ösvény	Igen	húr
korlát	Lekérdezés	Nem	egész szám
megrendelés	Lekérdezés	Nem	húr
ennyi idő múlva	Lekérdezés	Nem	húr
előtt	Lekérdezés	Nem	húr
szűrő	Lekérdezés	Nem	húr
api-verzió	Lekérdezés	Igen	húr

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	listVectorStoreFilesResponse

Példák

Példa

A vektortárfájlok listáját adja vissza.

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

Válaszok: Állapotkó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
  }
}

Létrehozás – Vektortárfájl

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

Vektortárfájl létrehozása egy fájl vektortárolóhoz csatolásával.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
vector_store_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező	Alapértelmezett
file_id	húr	Egy fájlazonosító, amelyet a vektortárolónak használnia kell. Olyan eszközök esetén hasznos, amelyek `file_search` hozzáférhetnek a fájlokhoz.	Igen
chunking_strategy	chunkingStrategyRequestParam	A fájl(ok) darabolásához használt adattömb-stratégia. Ha nincs beállítva, használja a `auto` stratégiát.	Nem

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	vectorStoreFileObject	Vektortárolóhoz csatolt fájlok listája.

Példák

Példa

Vektortárfájl létrehozása egy fájl vektortárolóhoz csatolásával.

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

{
 "file_id": "file-abc123"
}

Válaszok: Állapotkó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 – Vector Store-fájl

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

Egy vektortárfájl lekérése.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
vector_store_id	ösvény	Igen	húr
file_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	vectorStoreFileObject	Vektortárolóhoz csatolt fájlok listája.

Példák

Példa

Egy vektortárfájl lekérése.

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

Válaszok: Állapotkód: 200

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

Törlés – Vektortárfájl

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

Vektortárfájl törlése. Ezzel eltávolítja a fájlt a vektortárolóból, de magát a fájlt nem törli. A fájl törléséhez használja a törlési fájlvégpontot.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
vector_store_id	ösvény	Igen	húr
file_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	deleteVectorStoreFileResponse

Példák

Példa

Vektortárfájl törlése. Ezzel eltávolítja a fájlt a vektortárolóból, de magát a fájlt nem törli. A fájl törléséhez használja a törlési fájlvégpontot.

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

Válaszok: Állapotkód: 200

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

Létrehozás – Vektortároló fájlköteg

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

Hozzon létre egy vektortároló fájlköteget.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
vector_store_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név	Típus	Leírás	Kötelező	Alapértelmezett
file_ids	array	A vektortároló által használandó fájlazonosítók listája. Olyan eszközök esetén hasznos, amelyek `file_search` hozzáférhetnek a fájlokhoz.	Igen
chunking_strategy	chunkingStrategyRequestParam	A fájl(ok) darabolásához használt adattömb-stratégia. Ha nincs beállítva, használja a `auto` stratégiát.	Nem

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	vectorStoreFileBatchObject	Egy vektortárolóhoz csatolt fájlköteg.

Példák

Példa

Hozzon létre egy vektortároló fájlköteget.

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

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

Válaszok: Állapotkó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
  }
}

Lekérés – Vektortároló fájlköteg

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

Egy vektortárfájl kötegét kéri le.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
vector_store_id	ösvény	Igen	húr
batch_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	vectorStoreFileBatchObject	Egy vektortárolóhoz csatolt fájlköteg.

Példák

Példa

Egy vektortárfájl kötegét kéri le.

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

Válaszok: Állapotkó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
    }
  }
}

Mégse – Vektortároló fájlköteg

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

Vektortároló fájl kötegének megszakítása. Ez a művelet a lehető leghamarabb megkísérli megszakítani a kötegben lévő fájlok feldolgozását.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
vector_store_id	ösvény	Igen	húr
batch_id	ösvény	Igen	húr
api-verzió	Lekérdezés	Igen	húr

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	vectorStoreFileBatchObject	Egy vektortárolóhoz csatolt fájlköteg.

Példák

Példa

Vektortároló fájl kötegének megszakítása. Ez a művelet a lehető leghamarabb megkísérli megszakítani a kötegben lévő fájlok feldolgozását.

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

Válaszok: Állapotkó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
    }
  }
}

Lista – Vektortároló fájl kötegfájljai

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

Egy kötegben lévő vektortároló-fájlok listáját adja vissza.

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
endpoint	ösvény	Igen	húr url	Támogatott Azure OpenAI-végpontok (protokoll és állomásnév, például: `https://aoairesource.openai.azure.com`. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-erőforrás nevére. https://{your-resource-name}.openai.azure.com
vector_store_id	ösvény	Igen	húr
batch_id	ösvény	Igen	húr
korlát	Lekérdezés	Nem	egész szám
megrendelés	Lekérdezés	Nem	húr
ennyi idő múlva	Lekérdezés	Nem	húr
előtt	Lekérdezés	Nem	húr
szűrő	Lekérdezés	Nem	húr
api-verzió	Lekérdezés	Igen	húr

Kérelem fejléce

Név	Kötelező	Típus	Leírás
api-key	Igaz	húr	Itt adja meg az Azure OpenAI API-kulcsot

Válaszok

Állapotkód: 200

Leírás: OK

Tartalomtípus	Típus	Leírás
application/json	listVectorStoreFilesResponse

Példák

Példa

A vektortárfájlok listáját adja vissza.

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

Válaszok: Állapotkó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
  }
}

Összetevők

errorResponse

Név	Típus	Leírás	Kötelező	Alapértelmezett
hiba	hiba		Nem

errorBase

Név	Típus	Leírás	Kötelező	Alapértelmezett
code	húr		Nem
üzenet	húr		Nem

hiba

Név	Típus	Leírás	Kötelező
Param	húr		Nem
típus	húr		Nem
inner_error	innerError	Belső hiba további részletekkel.	Nem

innerError

Belső hiba további részletekkel.

Név	Típus	Leírás	Kötelező	Alapértelmezett
code	innerErrorCode	A belső hibaobjektum hibakódjai.	Nem
content_filter_results	contentFilterPromptResults	Információ a tartalomszűrési kategóriáról (gyűlölet, szexuális, erőszak, self_harm), ha észlelték, valamint a súlyossági szintről (very_low, alacsony, közepes, nagy léptékű, amely meghatározza a káros tartalmak intenzitását és kockázati szintjét), és hogy szűrték-e vagy sem. Információk a jailbreak tartalomról és a trágárságról, ha észlelték, és hogy szűrték-e vagy sem. És az ügyfél-tiltólistával kapcsolatos információk, ha szűrték, és annak azonosítója.	Nem

innerErrorCode

A belső hibaobjektum hibakódjai.

Leírás: A belső hibaobjektum hibakódjai.

Típus: sztring

Alapértelmezett:

Szám neve: InnerErrorCode

Enumerálási értékek:

Érték	Leírás
ResponsibleAIPolicyViolation	A kérés megsértette az egyik további tartalomszűrő szabályt.

dalleErrorResponse

Név	Típus	Leírás	Kötelező	Alapértelmezett
hiba	dalleError		Nem

dalleError

Név	Típus	Leírás	Kötelező
Param	húr		Nem
típus	húr		Nem
inner_error	dalleInnerError	Belső hiba további részletekkel.	Nem

dalleInnerError

Belső hiba további részletekkel.

Név	Típus	Leírás	Kötelező
code	innerErrorCode	A belső hibaobjektum hibakódjai.	Nem
content_filter_results	dalleFilterResults	Információ a tartalomszűrési kategóriáról (gyűlölet, szexuális, erőszak, self_harm), ha észlelték, valamint a súlyossági szintről (very_low, alacsony, közepes, nagy léptékű, amely meghatározza a káros tartalmak intenzitását és kockázati szintjét), és hogy szűrték-e vagy sem. Információk a jailbreak tartalomról és a trágárságról, ha észlelték, és hogy szűrték-e vagy sem. És az ügyfél-tiltólistával kapcsolatos információk, ha szűrték, és annak azonosítója.	Nem
revised_prompt	húr	A rendszerkép létrehozásához használt kérés, ha a kérésnek volt valamilyen változata.	Nem

contentFilterCompletionTextSpan

A létrehozott befejezési szövegen belüli időtartamot ismerteti. A 0 eltolás a befejezési szöveg első UTF32 kódpontja.

Név	Típus	Leírás	Kötelező	Alapértelmezett
completion_start_offset	egész szám	Az UTF32 kódpont eltolása, amely a span kezdetét veszi.	Igen
completion_end_offset	egész szám	Az első UTF32 kódpont eltolása, amely nincs kizárva a spanból. Ez a mező mindig egyenlő az üres tartományok completion_start_offset. Ez a mező mindig nagyobb, mint completion_start_offset a nem megengedett időtartamok esetében.	Igen

contentFilterResultBase

Név	Típus	Leírás	Kötelező	Alapértelmezett
Szűrt	Logikai		Igen

contentFilterSeverityResult

Név	Típus	Leírás	Kötelező	Alapértelmezett
Szűrt	Logikai		Igen
súlyosság	húr		Nem

contentFilterDetectedResult

Név	Típus	Leírás	Kötelező	Alapértelmezett
Szűrt	Logikai		Igen
Észlelt	Logikai		Nem

contentFilterDetectedWithCitationResult

Név	Típus	Leírás	Kötelező	Alapértelmezett
idézet	object		Nem

Az idézet tulajdonságai

URL-cím

Név	Típus	Leírás	Alapértelmezett
URL-cím	húr

licenc

Név	Típus	Leírás	Alapértelmezett
licenc	húr

contentFilterDetectedWithCompletionTextSpansResult

Név	Típus	Leírás	Kötelező	Alapértelmezett
részletek	array		Nem

contentFilterIdResult

Név	Típus	Leírás	Kötelező	Alapértelmezett
Szűrt	Logikai		Igen
id	húr		Nem

contentFilterResultsBase

Információ a tartalomszűrési eredményekről.

Név	Típus	Leírás	Kötelező
szexuális	contentFilterSeverityResult		Nem
erőszak	contentFilterSeverityResult		Nem
gyűlölet	contentFilterSeverityResult		Nem
self_harm	contentFilterSeverityResult		Nem
szentségtörés	contentFilterDetectedResult		Nem
custom_blocklists	contentFilterDetailedResults	A tartalomszűrés eredménye a szűrt szegmensek tartalomszűrő-azonosítóinak részleteivel.	Nem
hiba	errorBase		Nem

contentFilterPromptResults

Információ a tartalomszűrési kategóriáról (gyűlölet, szexuális, erőszak, self_harm), ha észlelték, valamint a súlyossági szintről (very_low, alacsony, közepes, nagy léptékű, amely meghatározza a káros tartalmak intenzitását és kockázati szintjét), és hogy szűrték-e vagy sem. Információk a jailbreak tartalomról és a trágárságról, ha észlelték, és hogy szűrték-e vagy sem. És az ügyfél-tiltólistával kapcsolatos információk, ha szűrték, és annak azonosítója.

Név	Típus	Leírás	Kötelező
szexuális	contentFilterSeverityResult		Nem
erőszak	contentFilterSeverityResult		Nem
gyűlölet	contentFilterSeverityResult		Nem
self_harm	contentFilterSeverityResult		Nem
szentségtörés	contentFilterDetectedResult		Nem
custom_blocklists	contentFilterDetailedResults	A tartalomszűrés eredménye a szűrt szegmensek tartalomszűrő-azonosítóinak részleteivel.	Nem
hiba	errorBase		Nem
Szökik	contentFilterDetectedResult		Nem
indirect_attack	contentFilterDetectedResult		Nem

contentFilterChoiceResults

Információ a tartalomszűrési kategóriáról (gyűlölet, szexuális, erőszak, self_harm), ha észlelték, valamint a súlyossági szintről (very_low, alacsony, közepes, nagy léptékű, amely meghatározza a káros tartalmak intenzitását és kockázati szintjét), és hogy szűrték-e vagy sem. Harmadik féltől származó szövegre és trágárságra vonatkozó információk, ha észlelték, és szűrték vagy sem. És az ügyfél-tiltólistával kapcsolatos információk, ha szűrték, és annak azonosítója.

Név	Típus	Leírás	Kötelező
szexuális	contentFilterSeverityResult		Nem
erőszak	contentFilterSeverityResult		Nem
gyűlölet	contentFilterSeverityResult		Nem
self_harm	contentFilterSeverityResult		Nem
szentségtörés	contentFilterDetectedResult		Nem
custom_blocklists	contentFilterDetailedResults	A tartalomszűrés eredménye a szűrt szegmensek tartalomszűrő-azonosítóinak részleteivel.	Nem
hiba	errorBase		Nem
protected_material_text	contentFilterDetectedResult		Nem
protected_material_code	contentFilterDetectedWithCitationResult		Nem
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		Nem

contentFilterDetailedResults

A tartalomszűrés eredménye a szűrt szegmensek tartalomszűrő-azonosítóinak részleteivel.

Név	Típus	Leírás	Kötelező	Alapértelmezett
Szűrt	Logikai		Igen
részletek	array		Nem

promptFilterResult

A tartalomszűrési eredmények egyetlen kérésre jelennek meg a kérelemben.

Név	Típus	Leírás	Kötelező	Alapértelmezett
prompt_index	egész szám		Nem
content_filter_results	contentFilterPromptResults	Információ a tartalomszűrési kategóriáról (gyűlölet, szexuális, erőszak, self_harm), ha észlelték, valamint a súlyossági szintről (very_low, alacsony, közepes, nagy léptékű, amely meghatározza a káros tartalmak intenzitását és kockázati szintjét), és hogy szűrték-e vagy sem. Információk a jailbreak tartalomról és a trágárságról, ha észlelték, és hogy szűrték-e vagy sem. És az ügyfél-tiltólistával kapcsolatos információk, ha szűrték, és annak azonosítója.	Nem

promptFilterResults

A tartalomszűrés eredménye nulla vagy több kérés esetén jelenik meg a kérelemben. Streamelési kérés esetén a különböző kérések eredményei eltérő időpontokban vagy különböző megrendelésekben érkezhetnek.

Ehhez az összetevőhöz nincs definiálva tulajdonság.

dalleContentFilterResults

Információ a tartalomszűrési eredményekről.

Név	Típus	Kötelező
szexuális	contentFilterSeverityResult	Nem
erőszak	contentFilterSeverityResult	Nem
gyűlölet	contentFilterSeverityResult	Nem
self_harm	contentFilterSeverityResult	Nem

dalleFilterResults

Név	Típus	Leírás	Kötelező
szexuális	contentFilterSeverityResult		Nem
erőszak	contentFilterSeverityResult		Nem
gyűlölet	contentFilterSeverityResult		Nem
self_harm	contentFilterSeverityResult		Nem
szentségtörés	contentFilterDetectedResult		Nem
Szökik	contentFilterDetectedResult		Nem
custom_blocklists	contentFilterDetailedResults	A tartalomszűrés eredménye a szűrt szegmensek tartalomszűrő-azonosítóinak részleteivel.	Nem

chatCompletionsRequestCommon

Név	Típus	Leírás	Kötelező	Alapértelmezett
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet. Általában azt javasoljuk, hogy módosítsa ezt vagy `top_p` mindkettőt, de nem mindkettőt.	Nem	0
top_p	szám	A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti. Általában azt javasoljuk, hogy módosítsa ezt vagy `temperature` mindkettőt, de nem mindkettőt.	Nem	0
patak	Logikai	Ha be van állítva, a rendszer részleges üzenet-különbözeteket küld, például a ChatGPT-ben. A jogkivonatok csak a kiszolgáló által küldött eseményekként lesznek elküldve, amint elérhetővé válnak, és a streamet egy `data: [DONE]` üzenet leállítja.	Nem	Hamis
állj	sztring vagy tömb	Legfeljebb négy sorozat, amelyekben az API leállítja a további jogkivonatok generálását.	Nem
max_tokens	egész szám	A létrehozott válaszhoz engedélyezett jogkivonatok maximális száma. Alapértelmezés szerint a modell által visszaadható tokenek száma (4096 – prompt tokens) lesz. Ez nem kompatibilis az o1 sorozatú modellekkel.	Nem	4,096
max_completion_tokens	egész szám	A befejezéshez létrehozható tokenek számának felső határa, beleértve a látható kimeneti jogkivonatokat és az érvelési jogkivonatokat. Ez csak o1 sorozatú modellekben támogatott. A jövőbeni API-kiadásban kiterjeszti a támogatást más modellekre.	Nem
presence_penalty	szám	-2,0 és 2,0 közötti szám. A pozitív értékek büntetik az új jogkivonatokat attól függően, hogy az eddig megjelennek-e a szövegben, növelve a modell valószínűségét, hogy új témakörökről beszéljenek.	Nem	0
frequency_penalty	szám	-2,0 és 2,0 közötti szám. A pozitív értékek a szövegben meglévő gyakoriságuk alapján büntetik az új jogkivonatokat, így csökken annak a valószínűsége, hogy a modell ugyanazt a sort szó szerint megismételi.	Nem	0
logit_bias	object	Módosítsa annak valószínűségét, hogy a megadott jogkivonatok megjelenjenek a befejezéskor. Elfogad egy json-objektumot, amely -100-ról 100-ra képez le jogkivonatokat (a jogkivonat-azonosítójuk által megadott) egy társított elfogultsági értékre. Matematikailag a rendszer hozzáadja a torzításokat a modell által a mintavételezés előtt létrehozott logitokhoz. A pontos hatás modellenként eltérő lesz, de a -1 és az 1 közötti értékeknek csökkentenie vagy növelnie kell a kiválasztás valószínűségét; a -100 vagy a 100 értékhez hasonló értékek esetén a megfelelő jogkivonat kitiltása vagy kizárólagos kiválasztása szükséges.	Nem
hozzáadásához	Logikai	Függetlenül attól, hogy tárolja-e a csevegés befejezésére vonatkozó kérés kimenetét a modelllepárlási vagy kiértékelési termékeinkben való használatra.	Nem
metaadatok	object	A tárolt befejezési irányítópulton a befejezések szűréséhez használt fejlesztő által definiált címkék és értékek.	Nem
user	húr	A végfelhasználót jelképező egyedi azonosító, amely segíthet az Azure OpenAI-nak a visszaélések monitorozásában és észlelésében.	Nem

createCompletionRequest

Név	Típus	Leírás	Kötelező	Alapértelmezett
haladéktalan	sztring vagy tömb	A befejezések létrehozására szolgáló kérések sztringként, sztringek tömbjeként, jogkivonatok tömbjeként vagy tokentömbként kódolva. Vegye figyelembe, hogy <a(z) \|endoftext\|> az a dokumentumelválasztó, amelyet a modell a betanítás során lát, így ha nincs megadva egy kérés, a modell úgy fog létrejönni, mintha egy új dokumentum elejéről származna.	Igen
best_of	egész szám	A befejezéseket `best_of` kiszolgálóoldalon hozza létre, és a "legjobb" értéket adja vissza (az, amelynek a legnagyobb a naplók valószínűsége jogkivonatonként). Az eredmények nem streamelhetők. A használat során `n`a jelölt befejezések számát szabályozza, `best_of` és `n` meghatározza, hogy hánynak kell visszaadnia a â € " `best_of` -nál `n`nagyobbnak kell lennie. Megjegyzés: Mivel ez a paraméter sok befejezést generál, gyorsan felhasználhatja a jogkivonatkvótát. Gondosan használja, és győződjön meg arról, hogy megfelelő beállításokat `max_tokensstop`és .	Nem	0
echo	Logikai	A befejezés mellett a kérést is vissza kell adni	Nem	Hamis
frequency_penalty	szám	-2,0 és 2,0 közötti szám. A pozitív értékek a szövegben meglévő gyakoriságuk alapján büntetik az új jogkivonatokat, így csökken annak a valószínűsége, hogy a modell ugyanazt a sort szó szerint megismételi.	Nem	0
logit_bias	object	Módosítsa annak valószínűségét, hogy a megadott jogkivonatok megjelenjenek a befejezéskor. Elfogad egy JSON-objektumot, amely -100-ról 100-ra képez le jogkivonatokat (a GPT-jogkivonat-kezelőben megadott jogkivonat-azonosítójuk alapján) egy társított elfogultsági értékre. Matematikailag a rendszer hozzáadja a torzításokat a modell által a mintavételezés előtt létrehozott logitokhoz. A pontos hatás modellenként eltérő lesz, de a -1 és az 1 közötti értékeknek csökkentenie vagy növelnie kell a kiválasztás valószínűségét; a -100 vagy a 100 értékhez hasonló értékek esetén a megfelelő jogkivonat kitiltása vagy kizárólagos kiválasztása szükséges. Átadhatja `{"50256": -100}` például a(z) \|endoftext\|> jogkivonat létrehozásának megakadályozását<.	Nem	Egyik sem
logprobs	egész szám	Adja meg a napló valószínűségét a `logprobs` legvalószínűbb kimeneti jogkivonatokon, valamint a kiválasztott jogkivonatokon. Ha például `logprobs` 5, az API az 5 legvalószínűbb token listáját adja vissza. Az API mindig a `logprob` mintául szolgáló jogkivonatot adja vissza, így a válaszban `logprobs+1` akár elemek is lehetnek. A maximális érték `logprobs` 5.	Nem	Egyik sem
max_tokens	egész szám	A befejezés során létrehozható jogkivonatok maximális száma. A parancssor jogkivonatszáma plusz `max_tokens` nem haladhatja meg a modell környezethosszát.	Nem	16
n	egész szám	Hány befejezést kell létrehozni az egyes kérésekhez. Megjegyzés: Mivel ez a paraméter sok befejezést generál, gyorsan felhasználhatja a jogkivonatkvótát. Gondosan használja, és győződjön meg arról, hogy megfelelő beállításokat `max_tokensstop`és .	Nem	0
presence_penalty	szám	-2,0 és 2,0 közötti szám. A pozitív értékek büntetik az új jogkivonatokat attól függően, hogy az eddig megjelennek-e a szövegben, növelve a modell valószínűségét, hogy új témakörökről beszéljenek.	Nem	0
mag	egész szám	Ha meg van adva, a rendszerünk mindent megtesz annak érdekében, hogy determinisztikus mintát hozzon létre, így az azonos `seed` és paraméterekkel rendelkező ismétlődő kérelmeknek ugyanazt az eredményt kell visszaadnia. A determinizmus nem garantált, és a háttérrendszer változásainak figyeléséhez tekintse meg a `system_fingerprint` válaszparamétert.	Nem
állj	sztring vagy tömb	Legfeljebb négy sorozat, amelyekben az API leállítja a további jogkivonatok generálását. A visszaadott szöveg nem tartalmazza a leállítási sorrendet.	Nem
patak	Logikai	Azt határozza meg, hogy vissza szeretné-e streamelni a részleges előrehaladást. Ha be van állítva, a jogkivonatok csak a kiszolgáló által küldött eseményekként lesznek elküldve, amint elérhetővé válnak, és a streamet egy `data: [DONE]` üzenet leállítja.	Nem	Hamis
toldalék	húr	A beszúrt szöveg befejezése után megjelenő utótag. Ez a paraméter csak a következőhöz `gpt-3.5-turbo-instruct`támogatott: .	Nem	Egyik sem
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet. Általában azt javasoljuk, hogy módosítsa ezt vagy `top_p` mindkettőt, de nem mindkettőt.	Nem	0
top_p	szám	A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti. Általában azt javasoljuk, hogy módosítsa ezt vagy `temperature` mindkettőt, de nem mindkettőt.	Nem	0
user	húr	A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében.	Nem

createCompletionResponse

Az API befejezési válaszát jelöli. Megjegyzés: a streamelt és a nem streamelt válaszobjektumok is ugyanazt az alakzatot adják meg (a csevegési végponttól eltérően).

Név	Típus	Leírás	Kötelező
id	húr	A befejezés egyedi azonosítója.	Igen
Választás	array	A bemeneti kéréshez létrehozott modell által létrehozott befejezési lehetőségek listája.	Igen
létrehozva	egész szám	A befejezés létrehozásának unix-időbélyege (másodpercben).	Igen
modell	húr	A befejezéshez használt modell.	Igen
prompt_filter_results	promptFilterResults	A tartalomszűrés eredménye nulla vagy több kérés esetén jelenik meg a kérelemben. Streamelési kérés esetén a különböző kérések eredményei eltérő időpontokban vagy különböző megrendelésekben érkezhetnek.	Nem
system_fingerprint	húr	Ez az ujjlenyomat azt a háttérkonfigurációt jelöli, amellyel a modell fut. A kérelemparaméterrel `seed` együtt használható annak megértéséhez, hogy mikor történtek olyan háttérbeli módosítások, amelyek hatással lehetnek a determinizmusra.	Nem
object	Enum	Az objektum típusa, amely mindig "text_completion" Lehetséges értékek: text_completion	Igen
használat	completionUsage	A befejezési kérelem használati statisztikái.	Nem

createChatCompletionRequest

Név	Típus	Leírás	Kötelező	Alapértelmezett
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet. Általában azt javasoljuk, hogy módosítsa ezt vagy `top_p` mindkettőt, de nem mindkettőt.	Nem	0
top_p	szám	A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti. Általában azt javasoljuk, hogy módosítsa ezt vagy `temperature` mindkettőt, de nem mindkettőt.	Nem	0
patak	Logikai	Ha be van állítva, a rendszer részleges üzenet-különbözeteket küld, például a ChatGPT-ben. A jogkivonatok csak a kiszolgáló által küldött eseményekként lesznek elküldve, amint elérhetővé válnak, és a streamet egy `data: [DONE]` üzenet leállítja.	Nem	Hamis
állj	sztring vagy tömb	Legfeljebb négy sorozat, amelyekben az API leállítja a további jogkivonatok generálását.	Nem
max_tokens	egész szám	A csevegés befejezésekor létrehozható jogkivonatok maximális száma. A bemeneti jogkivonatok és a létrehozott jogkivonatok teljes hosszát a modell környezethossza korlátozza.	Nem
max_completion_tokens	egész szám	A befejezéshez létrehozható tokenek számának felső határa, beleértve a látható kimeneti jogkivonatokat és az érvelési jogkivonatokat. Ez csak o1 sorozatú modellekben támogatott. A jövőbeni API-kiadásban kiterjeszti a támogatást más modellekre.	Nem
presence_penalty	szám	-2,0 és 2,0 közötti szám. A pozitív értékek büntetik az új jogkivonatokat attól függően, hogy az eddig megjelennek-e a szövegben, növelve a modell valószínűségét, hogy új témakörökről beszéljenek.	Nem	0
frequency_penalty	szám	-2,0 és 2,0 közötti szám. A pozitív értékek a szövegben meglévő gyakoriságuk alapján büntetik az új jogkivonatokat, így csökken annak a valószínűsége, hogy a modell ugyanazt a sort szó szerint megismételi.	Nem	0
logit_bias	object	Módosítsa annak valószínűségét, hogy a megadott jogkivonatok megjelenjenek a befejezéskor. Elfogad egy JSON-objektumot, amely a tokeneket (a jogkivonat-azonosítójuk által megadott) -100-ról 100-ra képez le egy társított elfogultsági értékre. Matematikailag a rendszer hozzáadja a torzításokat a modell által a mintavételezés előtt létrehozott logitokhoz. A pontos hatás modellenként eltérő lesz, de a -1 és az 1 közötti értékeknek csökkentenie vagy növelnie kell a kiválasztás valószínűségét; a -100 vagy a 100 értékhez hasonló értékek esetén a megfelelő jogkivonat kitiltása vagy kizárólagos kiválasztása szükséges.	Nem	Egyik sem
hozzáadásához	Logikai	Függetlenül attól, hogy tárolja-e a csevegés befejezésére vonatkozó kérés kimenetét a modelllepárlási vagy kiértékelési termékeinkben való használatra.	Nem
metaadatok	object	A tárolt befejezési irányítópulton a befejezések szűréséhez használt fejlesztő által definiált címkék és értékek.	Nem
user	húr	A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében.	Nem
üzenet	array	Az eddig a beszélgetésből álló üzenetek listája.	Igen
data_sources	array	Az őket használó Azure OpenAI-csevegőbővítmények konfigurációs bejegyzései. Ez a további specifikáció csak az Azure OpenAI-val kompatibilis.	Nem
reasoning_effort	Enum	csak o1 modellek Korlátozza az érveléssel kapcsolatos erőfeszítéseket érvelési modelleket. Jelenleg a támogatott értékek a következők`low`: és `highmedium`. Az érvelési erőfeszítések csökkentése gyorsabb válaszokat és kevesebb jogkivonatot eredményezhet a válaszokban való érveléshez. Lehetséges értékek: alacsony, közepes, magas	Nem
logprobs	Logikai	A kimeneti jogkivonatok naplós valószínűségének visszaadása vagy sem. Ha igaz, akkor az egyes kimeneti jogkivonatok napló valószínűségét adja vissza a `content` következőben `message`: .	Nem	Hamis
top_logprobs	egész szám	Egy 0 és 20 közötti egész szám, amely megadja, hogy az egyes tokenpozíciókban a legvalószínűbb tokenek hányan térnek vissza, és mindegyikhez tartozik napló valószínűsége. `logprobs` ezt a paramétert `true` kell beállítani.	Nem
n	egész szám	Hány csevegés-befejezési lehetőséget kell létrehozni az egyes bemeneti üzenetekhez. Vegye figyelembe, hogy a díjakat a létrehozott jogkivonatok száma alapján számítjuk fel az összes lehetőség közül. Tartsa meg `n` a `1` költségek minimalizálását.	Nem	0
parallel_tool_calls	ParallelToolCalls	Engedélyezi-e a párhuzamos függvényhívást az eszköz használata során.	Nem	Igaz
response_format	ResponseFormatText vagy ResponseFormatJsonObject vagy ResponseFormatJsonSchema	Egy objektum, amely megadja a modell által kiadandó formátumot. Kompatibilis a GPT-4o, GPT-4o mini, GPT-4 Turbo és az összes GPT-3.5 Turbo modellek újabb, mint `gpt-3.5-turbo-1106`. A strukturált kimeneteket engedélyező `{ "type": "json_schema", "json_schema": {...} }` beállítás, amely garantálja, hogy a modell megfelel a megadott JSON-sémának. A JSON mód engedélyezése, `{ "type": "json_object" }` amely garantálja, hogy a modell által generált üzenet érvényes JSON. Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha `finish_reason="length"`az azt jelzi, hogy a létrehozás túllépte `max_tokens` vagy a beszélgetés túllépte a környezet maximális hosszát.	Nem
mag	egész szám	Ez a funkció bétaverzióban érhető el. Ha meg van adva, a rendszerünk mindent megtesz annak érdekében, hogy determinisztikus mintát hozzon létre, így az azonos `seed` és paraméterekkel rendelkező ismétlődő kérelmeknek ugyanazt az eredményt kell visszaadnia. A determinizmus nem garantált, és a háttérrendszer változásainak figyeléséhez tekintse meg a `system_fingerprint` válaszparamétert.	Nem
stream_options	chatCompletionStreamOptions	A streamelési válasz beállításai. Ezt csak akkor állítsa be, ha be van állítva `stream: true`.	Nem	Egyik sem
eszközök	array	A modell által meghívható eszközök listája. Jelenleg csak a függvények támogatottak eszközként. Ezzel megadhatja azon függvények listáját, amelyekhez a modell JSON-bemeneteket hozhat létre. Legfeljebb 128 függvény támogatott.	Nem
tool_choice	chatCompletionToolChoiceOption	Azt szabályozza, hogy a modell melyik eszközt hívja meg (ha van ilyen). `none` azt jelenti, hogy a modell nem hív meg egyetlen eszközt sem, és ehelyett létrehoz egy üzenetet. `auto` azt jelenti, hogy a modell választhat egy üzenet létrehozása vagy egy vagy több eszköz meghívása között. `required` azt jelenti, hogy a modellnek egy vagy több eszközt kell meghívnia. Egy adott eszköz megadása az `{"type": "function", "function": {"name": "my_function"}}` eszköz meghívására kényszeríti a modellt. `none` az alapértelmezett, ha nincsenek eszközök. `auto` az alapértelmezett, ha az eszközök vannak jelen.	Nem
function_call	sztring vagy csevegésCompletionFunctionCallOption	Elavult a javára `tool_choice`. Azt szabályozza, hogy a modell melyik függvényt hívja meg (ha van ilyen). `none` azt jelenti, hogy a modell nem hív meg függvényt, hanem létrehoz egy üzenetet. `auto` azt jelenti, hogy a modell választhat az üzenet létrehozása vagy egy függvény meghívása között. Egy adott függvény megadása a modell meghívására kényszeríti `{"name": "my_function"}` a modellt. `none` az alapértelmezett, ha nincsenek függvények. `auto` az alapértelmezett, ha függvények vannak jelen.	Nem
functions	array	Elavult a javára `tools`. Azon függvények listája, amelyekhez a modell JSON-bemeneteket hozhat létre.	Nem
user_security_context	userSecurityContext	A felhasználói biztonsági környezet számos paramétert tartalmaz, amelyek maguk az AI-alkalmazást, valamint az AI-alkalmazást kezelő végfelhasználót írják le. Ezek a mezők segítenek a biztonsági üzemeltetési csapatoknak a biztonsági incidensek kivizsgálásában és enyhítésében azáltal, hogy átfogó megközelítést nyújtanak az AI-alkalmazások védelméhez. További információ az AI-alkalmazások Felhőhöz készült Microsoft Defender használatával történő védelméről.	Nem		és észleli a visszaéléseket.	Nem
Módozatok	ChatCompletionModalities	Olyan kimeneti típusok, amelyeket a modellnek létre szeretne hozni ehhez a kéréshez. A legtöbb modell képes szöveg létrehozására, ami az alapértelmezett: `["text"]` A `gpt-4o-audio-preview` modell hang létrehozására is használható. Művelet kérvényezi, hogy ez a modell szöveges és hangválaszokat is hozzon létre, használat: `["text", "audio"]`	Nem
jóslás	PredictionContent	Előrejelzett kimenet konfigurációja, amely jelentősen javíthatja a válaszidőt, ha a modell válaszának nagy része előre ismert. Ez a leggyakoribb, ha olyan fájlt hoz létre, amely csak kisebb módosításokat tartalmaz a tartalom nagy részén.	Nem
hanganyag	object	A hangkimenet paraméterei. A hangkimenet kérése esetén kötelező `modalities: ["audio"]`. További információ.	Nem

Hangtulajdonságok

voice

Név	Típus	Leírás	Alapértelmezett
voice	húr	Megadja a hangtípust. A támogatott hangok a következők`alloy`: , `echo` `fable`, `onyx`, `nova` és `shimmer`.

format

Név	Típus	Leírás	Alapértelmezett
format	húr	Megadja a kimeneti hangformátumot. Az egyiknek `wav`, `mp3`, , `flac` `opus` `pcm16`vagy .

userSecurityContext

A felhasználói biztonsági környezet számos paramétert tartalmaz, amelyek maguk az AI-alkalmazást, valamint az AI-alkalmazást kezelő végfelhasználót írják le. Ezek a mezők segítenek a biztonsági üzemeltetési csapatoknak a biztonsági incidensek kivizsgálásában és enyhítésében azáltal, hogy átfogó megközelítést nyújtanak az AI-alkalmazások védelméhez. További információ az AI-alkalmazások Felhőhöz készült Microsoft Defender használatával történő védelméről.

Név	Típus	Leírás	Kötelező
application_name	húr	Az alkalmazás neve. Ebben a mezőben nem szerepelhetnek bizalmas személyes adatok.	Nem
end_user_id	húr	Ez az azonosító a Microsoft Entra-azonosító (korábbi nevén Azure Active Directory) felhasználói objektumazonosítója, amellyel a végfelhasználók hitelesíthetők a generatív AI-alkalmazásban. Ebben a mezőben nem szerepelhetnek bizalmas személyes adatok.	Nem
end_user_tenant_id	húr	Az a Microsoft 365-bérlőazonosító, amelyhez a végfelhasználó tartozik. Ez akkor szükséges, ha a generatív AI-alkalmazás több bérlős.	Nem
source_ip	húr	Rögzíti az eredeti ügyfél IP-címét, és IPv4- és IPv6-formátumokat is elfogad.	Nem

chatCompletionFunctions

Név	Típus	Leírás	Kötelező
leírás	húr	A függvény működésének leírása, amelyet a modell használ annak kiválasztásához, hogy mikor és hogyan hívja meg a függvényt.	Nem
név	húr	A meghívandó függvény neve. A-z, A-Z, 0-9, vagy aláhúzásjeleket és kötőjeleket kell tartalmaznia, legfeljebb 64 hosszúságúak.	Igen
parameters	Függvényparaméterek	A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva. Példákért tekintse meg az útmutatót és a formátum dokumentációját ismertető JSON-sémahivatkozást . Az kihagyás `parameters` üres paraméterlistával rendelkező függvényt határoz meg.	Nem

chatCompletionFunctionCallOption

Egy adott függvény megadása a modell meghívására kényszeríti {"name": "my_function"} a modellt.

Név	Típus	Leírás	Kötelező	Alapértelmezett
név	húr	A meghívandó függvény neve.	Igen

chatCompletionFunctionParameters

A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva. A formátum dokumentációját lásd az útmutatóban/ példákban, valamint a JSON-séma referenciájában .

Ehhez az összetevőhöz nincs definiálva tulajdonság.

chatCompletionRequestMessage

Ez az összetevő a következők egyike lehet:

ChatCompletionRequestDeveloperMessage

A fejlesztő által megadott utasítások, amelyeket a modellnek követnie kell, függetlenül a felhasználó által küldött üzenetektől. Az o1 modellek és újabbak developer esetén az üzenetek felülírják az előző system üzeneteket.

Név	Típus	Leírás	Kötelező
content	sztring vagy tömb	A fejlesztői üzenet tartalma.	Igen
szerepkör	Enum	Ebben az esetben `developer`az üzenetek szerzőjének szerepe. Lehetséges értékek: fejlesztő	Igen
név	húr	A résztvevő opcionális neve. Megadja a modellinformációkat, hogy különbséget tegyen az azonos szerepkörű résztvevők között.	Nem

chatCompletionRequestSystemMessage

Név	Típus	Leírás	Kötelező
content	sztring vagy tömb	A rendszerüzenet tartalma.	Igen
szerepkör	Enum	Ebben az esetben `system`az üzenetek szerzőjének szerepe. Lehetséges értékek: rendszer	Igen
név	húr	A résztvevő opcionális neve. Megadja a modellinformációkat, hogy különbséget tegyen az azonos szerepkörű résztvevők között.	Nem

chatCompletionRequestUserMessage

Név	Típus	Leírás	Kötelező
content	sztring vagy tömb	A felhasználói üzenet tartalma.	Igen
szerepkör	Enum	Ebben az esetben `user`az üzenetek szerzőjének szerepe. Lehetséges értékek: felhasználó	Igen
név	húr	A résztvevő opcionális neve. Megadja a modellinformációkat, hogy különbséget tegyen az azonos szerepkörű résztvevők között.	Nem

chatCompletionRequestAssistantMessage

Név	Típus	Leírás	Kötelező
content	sztring vagy tömb	Az asszisztens üzenetének tartalma. Kötelező, kivéve, ha `tool_callsfunction_call` meg van adva vagy meg van adva.	Nem
visszautasítás	húr	Az asszisztens elutasító üzenete.	Nem
szerepkör	Enum	Ebben az esetben `assistant`az üzenetek szerzőjének szerepe. Lehetséges értékek: asszisztens	Igen
név	húr	A résztvevő opcionális neve. Megadja a modellinformációkat, hogy különbséget tegyen az azonos szerepkörű résztvevők között.	Nem
tool_calls	chatCompletionMessageToolCalls	A modell által generált eszközhívások, például függvényhívások.	Nem
function_call	object	Elavult, és helyébe a következő lép `tool_calls`: . Egy meghívandó függvény neve és argumentumai a modell által generált módon.	Nem

A function_call tulajdonságai

Érvek

Név	Típus	Leírás	Alapértelmezett
Érvek	húr	A függvény meghívására használható argumentumok, amelyeket a modell JSON formátumban hoz létre. Vegye figyelembe, hogy a modell nem mindig hoz létre érvényes JSON-t, és olyan paramétereket is létrehozhat, amelyeket a függvényséma nem határoz meg. A függvény meghívása előtt ellenőrizze a kód argumentumait.

név

Név	Típus	Leírás	Alapértelmezett
név	húr	A meghívandó függvény neve.

chatCompletionRequestToolMessage

Név	Típus	Leírás	Kötelező
szerepkör	Enum	Ebben az esetben `tool`az üzenetek szerzőjének szerepe. Lehetséges értékek: eszköz	Igen
content	sztring vagy tömb	Az eszközüzenet tartalma.	Igen
tool_call_id	húr	Eszközhívás, amelyre az üzenet válaszol.	Igen

chatCompletionRequestFunctionMessage

Név	Típus	Leírás	Kötelező
szerepkör	Enum	Ebben az esetben `function`az üzenetek szerzőjének szerepe. Lehetséges értékek: függvény	Igen
content	húr	A függvényüzenet tartalma.	Igen
név	húr	A meghívandó függvény neve.	Igen

chatCompletionRequestDeveloperMessageContentPart

Ez az összetevő a következők egyike lehet:

chatCompletionRequestSystemMessageContentPart

Ez az összetevő a következők egyike lehet:

chatCompletionRequestUserMessageContentPart

Ez az összetevő a következők egyike lehet:

chatCompletionRequestAssistantMessageContentPart

Ez az összetevő a következők egyike lehet:

chatCompletionRequestToolMessageContentPart

Ez az összetevő a következők egyike lehet:

chatCompletionRequestMessageContentPartText

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	Enum	A tartalomrész típusa. Lehetséges értékek: szöveg	Igen
text	húr	A szöveges tartalom.	Igen

chatCompletionRequestMessageContentPartAudio

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	Enum	A tartalomrész típusa. Mindig `input_audio`. Lehetséges értékek: input_audio	Igen
input_audio	object		Igen

A input_audio tulajdonságai

adatok

Név	Típus	Leírás	Alapértelmezett
adatok	húr	Base64 kódolású hangadatok.

format

Név	Típus	Leírás	Alapértelmezett
format	húr	A kódolt hangadatok formátuma. Jelenleg a "wav" és az "mp3" elemet támogatja.

chatCompletionRequestMessageContentPartImage

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	Enum	A tartalomrész típusa. Lehetséges értékek: image_url	Igen
image_url	object		Igen

A image_url tulajdonságai

url

Név	Típus	Leírás	Alapértelmezett
url	húr	A rendszerkép URL-címe vagy a base64 kódolású képadatok.

részlet

Név	Típus	Leírás	Alapértelmezett
részlet	húr	A kép részletességi szintjét adja meg. További információ a Vision útmutatójában.	auto

chatCompletionRequestMessageContentPartRefusal

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	Enum	A tartalomrész típusa. Lehetséges értékek: elutasítás	Igen
visszautasítás	húr	A modell által generált elutasítási üzenet.	Igen

azureChatExtensionConfiguration

Konfigurációs adatok megjelenítése egyetlen Azure OpenAI-csevegőbővítményhez. Ezt egy olyan csevegés-befejezési kérés fogja használni, amely az Azure OpenAI csevegőbővítményekkel bővíti a válasz viselkedését. Ennek a konfigurációnak a használata csak az Azure OpenAI-val kompatibilis.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	azureChatExtensionType	Konfigurációs adatok megjelenítése egyetlen Azure OpenAI-csevegőbővítményhez. Ezt egy csevegés fogja használni befejező kérés, amely az Azure OpenAI-csevegőbővítményekkel bővíti a válasz viselkedését. Ennek a konfigurációnak a használata csak az Azure OpenAI-val kompatibilis.	Igen

azureChatExtensionType

Leírás: Konfigurációs adatok ábrázolása egyetlen Azure OpenAI-csevegőbővítményhez. Ezt egy csevegés fogja használni
befejező kérés, amely az Azure OpenAI-csevegőbővítményekkel bővíti a válasz viselkedését.
Ennek a konfigurációnak a használata csak az Azure OpenAI-val kompatibilis.

Típus: sztring

Alapértelmezett:

Enum Name: AzureChatExtensionType

Enumerálási értékek:

Érték	Leírás
azure_search	Az Azure Search Azure OpenAI-csevegőbővítményként való használatát jelöli.
azure_cosmos_db	Az Azure Cosmos DB Azure OpenAI-csevegőbővítményként való használatát jelöli.
elasticsearch	Az Elasticsearch® index Azure OpenAI-csevegőbővítményként való használatát jelöli.
mongo_db	A Mongo DB Azure OpenAI-csevegőbővítményként való használatát jelöli.
Pinecone	A Pinecone index Azure OpenAI-csevegőbővítményként való használatát jelöli.

azureSearchChatExtensionConfiguration

Az Azure Search konfigurálható beállításainak konkrét ábrázolása Azure OpenAI-csevegőbővítményként való használatakor.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	azureChatExtensionType	Konfigurációs adatok megjelenítése egyetlen Azure OpenAI-csevegőbővítményhez. Ezt egy csevegés fogja használni befejező kérés, amely az Azure OpenAI-csevegőbővítményekkel bővíti a válasz viselkedését. Ennek a konfigurációnak a használata csak az Azure OpenAI-val kompatibilis.	Igen
parameters	azureSearchChatExtensionParameters	Az Azure Search paraméterei, ha Azure OpenAI-csevegőbővítményként használják.	Nem

azureSearchChatExtensionParameters

Az Azure Search paraméterei, ha Azure OpenAI-csevegőbővítményként használják.

Név	Típus	Leírás	Kötelező	Alapértelmezett
hitelesítés	onYourDataApiKeyAuthenticationOptions vagy onYourDataSystemAssignedManagedIdentityAuthenticationOptions vagy onYourDataUserAssignedManagedIdentityAuthenticationOptions vagy onYourDataAccessTokenAuthenticationOptions		Igen
top_n_documents	egész szám	A konfigurált lekérdezéshez használható dokumentumok maximális száma.	Nem
max_search_queries	egész szám	Az egy felhasználói üzenet keresési szolgáltatójának küldendő újraírt lekérdezések maximális száma. Ha nincs megadva, a rendszer dönti el a küldendő lekérdezések számát.	Nem
allow_partial_result	Logikai	Ha igazként van megadva, a rendszer lehetővé teszi a részleges keresési eredmények használatát, és a kérés meghiúsul, ha az összes lekérdezés sikertelen. Ha nincs megadva, vagy hamisként van megadva, a kérés sikertelen lesz, ha bármilyen keresési lekérdezés meghiúsul.	Nem	Hamis
in_scope	Logikai	Azt határozza meg, hogy a lekérdezések az indexelt adatok használatára legyenek-e korlátozva.	Nem
szigorúság	egész szám	A keresési relevancia szűrésének konfigurált szigorúsága. Minél magasabb a szigorúság, annál nagyobb a pontosság, de annál kisebb a válasz visszahívása.	Nem
endpoint	húr	A használni kívánt Azure Search-erőforrás abszolút végponti elérési útja.	Igen
index_name	húr	A hivatkozott Azure Search-erőforrásban elérhetőként használni kívánt index neve.	Igen
fields_mapping	azureSearchIndexFieldMappingOptions	Nem kötelező beállítások a mezők feldolgozásának szabályozásához konfigurált Azure Search-erőforrás használatakor.	Nem
query_type	azureSearchQueryType	Az Azure Search lekéréses lekérdezésének típusa, amelyet Azure OpenAI-csevegőbővítményként való használatakor végre kell hajtani.	Nem
semantic_configuration	húr	A lekérdezés további szemantikai konfigurációja.	Nem
szűrő	húr	Keresési szűrő.	Nem
embedding_dependency	onYourDataEndpointVectorizationSource vagy onYourDataDeploymentNameVectorizationSource vagy onYourDataIntegratedVectorizationSource		Nem
include_contexts	array	A kimeneti környezet belefoglalt tulajdonságai. Ha nincs megadva, az alapértelmezett érték és `intent`a `citations` .	Nem

azureSearchIndexFieldMappingOptions

Nem kötelező beállítások a mezők feldolgozásának szabályozásához konfigurált Azure Search-erőforrás használatakor.

Név	Típus	Leírás	Kötelező
title_field	húr	A címként használni kívánt indexmező neve.	Nem
url_field	húr	Az URL-címként használni kívánt indexmező neve.	Nem
filepath_field	húr	A fájlútvonalként használandó indexmező neve.	Nem
content_fields	array	A tartalomként kezelendő indexmezők nevei.	Nem
content_fields_separator	húr	Az elválasztó minta, amelyet a tartalommezőknek használniuk kell.	Nem
vector_fields	array	A vektoradatokat ábrázoló mezők nevei.	Nem
image_vector_fields	array	A képvektoradatokat ábrázoló mezők nevei.	Nem

azureSearchQueryType

Az Azure Search lekéréses lekérdezésének típusa, amelyet Azure OpenAI-csevegőbővítményként való használatakor végre kell hajtani.

Leírás: Az Azure Search lekéréses lekérdezésének típusa, amelyet Azure OpenAI-csevegőbővítményként való használatakor végre kell hajtani.

Típus: sztring

Alapértelmezett:

Enum Name: AzureSearchQueryType

Enumerálási értékek:

Érték	Leírás
egyszerű	Az alapértelmezett, egyszerű lekérdezéselemzőt jelöli.
szemantikai	A speciális szemantikai modellezés szemantikai lekérdezéselemzője.
vektor	Vektorkeresést jelöl a számított adatokon keresztül.
vector_simple_hybrid	Az egyszerű lekérdezési stratégia és a vektoradatok kombinációját jelöli.
vector_semantic_hybrid	A szemantikai keresés és a vektoradatok lekérdezésének kombinációját jelöli.

azureCosmosDBChatExtensionConfiguration

Az Azure Cosmos DB konfigurálható beállításainak konkrét ábrázolása Azure OpenAI-csevegőbővítményként való használatakor.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	azureChatExtensionType	Konfigurációs adatok megjelenítése egyetlen Azure OpenAI-csevegőbővítményhez. Ezt egy csevegés fogja használni befejező kérés, amely az Azure OpenAI-csevegőbővítményekkel bővíti a válasz viselkedését. Ennek a konfigurációnak a használata csak az Azure OpenAI-val kompatibilis.	Igen
parameters	azureCosmosDBChatExtensionParameters	Az Azure Cosmos DB-hez készült Azure Cosmos DB használatakor az Azure OpenAI On Your Data csevegési bővítményeinek konfigurálásakor használandó paraméterek MongoDB virtuális mag.	Nem

azureCosmosDBChatExtensionParameters

Az Azure Cosmos DB mongoDB virtuális maghoz való használatakor az Azure OpenAI On Your Data csevegési bővítményeinek konfigurálásakor használandó paraméterek.

Név	Típus	Leírás	Kötelező	Alapértelmezett
hitelesítés	onYourDataConnectionStringAuthenticationOptions	Az Azure OpenAI on Your Data hitelesítési lehetőségei kapcsolati sztring használatakor.	Igen
top_n_documents	egész szám	A konfigurált lekérdezéshez használható dokumentumok maximális száma.	Nem
max_search_queries	egész szám	Az újraírt lekérdezések maximális számát egy felhasználói üzenet keresésszolgáltatójának kell elküldeni. Ha nincs megadva, a rendszer dönti el a küldendő lekérdezések számát.	Nem
allow_partial_result	Logikai	Ha igazként van megadva, a rendszer lehetővé teszi a részleges keresési eredmények használatát, és a kérés meghiúsul, ha az összes lekérdezés sikertelen. Ha nincs megadva, vagy hamisként van megadva, a kérés sikertelen lesz, ha bármilyen keresési lekérdezés meghiúsul.	Nem	Hamis
in_scope	Logikai	Azt határozza meg, hogy a lekérdezések az indexelt adatok használatára legyenek-e korlátozva.	Nem
szigorúság	egész szám	A keresési relevancia szűrésének konfigurált szigorúsága. Minél magasabb a szigorúság, annál nagyobb a pontosság, de annál kisebb a válasz visszahívása.	Nem
database_name	húr	Az Azure Cosmos DB-hez használandó MongoDB virtuálismag-adatbázis neve.	Igen
container_name	húr	Az Azure Cosmos DB-erőforrástároló neve.	Igen
index_name	húr	Az Azure Cosmos DB-vel használandó MongoDB virtuálismag-index neve.	Igen
fields_mapping	azureCosmosDBFieldMappingOptions	Nem kötelező beállítások a mezők feldolgozásának szabályozásához konfigurált Azure Cosmos DB-erőforrás használatakor.	Igen
embedding_dependency	onYourDataEndpointVectorizationSource vagy onYourDataDeploymentNameVectorizationSource		Igen
include_contexts	array	A kimeneti környezet belefoglalt tulajdonságai. Ha nincs megadva, az alapértelmezett érték és `intent`a `citations` .	Nem

azureCosmosDBFieldMappingOptions

Nem kötelező beállítások a mezők feldolgozásának szabályozásához konfigurált Azure Cosmos DB-erőforrás használatakor.

Név	Típus	Leírás	Kötelező
title_field	húr	A címként használni kívánt indexmező neve.	Nem
url_field	húr	Az URL-címként használni kívánt indexmező neve.	Nem
filepath_field	húr	A fájlútvonalként használandó indexmező neve.	Nem
content_fields	array	A tartalomként kezelendő indexmezők nevei.	Igen
content_fields_separator	húr	Az elválasztó minta, amelyet a tartalommezőknek használniuk kell.	Nem
vector_fields	array	A vektoradatokat ábrázoló mezők nevei.	Igen

elasticsearchChatExtensionConfiguration

Az Elasticsearch konfigurálható beállításainak konkrét ábrázolása Azure OpenAI-csevegőbővítményként való használatakor.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	azureChatExtensionType	Konfigurációs adatok megjelenítése egyetlen Azure OpenAI-csevegőbővítményhez. Ezt egy csevegés fogja használni befejező kérés, amely az Azure OpenAI-csevegőbővítményekkel bővíti a válasz viselkedését. Ennek a konfigurációnak a használata csak az Azure OpenAI-val kompatibilis.	Igen
parameters	elasticsearchChatExtensionParameters	Az Elasticsearch® Azure OpenAI-csevegőbővítményként való konfigurálásakor használandó paraméterek.	Nem

elasticsearchChatExtensionParameters

Az Elasticsearch® Azure OpenAI-csevegőbővítményként való konfigurálásakor használandó paraméterek.

Név	Típus	Leírás	Kötelező	Alapértelmezett
hitelesítés	onYourDataKeyAndKeyIdAuthenticationOptions vagy onYourDataEncodedApiKeyAuthenticationOptions		Igen
top_n_documents	egész szám	A konfigurált lekérdezéshez használható dokumentumok maximális száma.	Nem
max_search_queries	egész szám	Az egy felhasználói üzenet keresési szolgáltatójának küldendő újraírt lekérdezések maximális száma. Ha nincs megadva, a rendszer dönti el a küldendő lekérdezések számát.	Nem
allow_partial_result	Logikai	Ha igazként van megadva, a rendszer lehetővé teszi a részleges keresési eredmények használatát, és a kérés meghiúsul, ha az összes lekérdezés sikertelen. Ha nincs megadva, vagy hamisként van megadva, a kérés sikertelen lesz, ha bármilyen keresési lekérdezés meghiúsul.	Nem	Hamis
in_scope	Logikai	Azt határozza meg, hogy a lekérdezések az indexelt adatok használatára legyenek-e korlátozva.	Nem
szigorúság	egész szám	A keresési relevancia szűrésének konfigurált szigorúsága. Minél magasabb a szigorúság, annál nagyobb a pontosság, de annál kisebb a válasz visszahívása.	Nem
endpoint	húr	Az Elasticsearch® végpontja.	Igen
index_name	húr	Az Elasticsearch® indexneve.	Igen
fields_mapping	elasticsearchIndexFieldMappingOptions	Nem kötelező beállítások a mezők feldolgozásának szabályozásához konfigurált Elasticsearch-erőforrás® használatakor.	Nem
query_type	elasticsearchQueryType	Az Elasticsearch® lekéréses lekérdezésének típusa, amelyet Azure OpenAI-csevegőbővítményként való használatakor végre kell hajtani.	Nem
embedding_dependency	onYourDataEndpointVectorizationSource vagy onYourDataDeploymentNameVectorizationSource vagy onYourDataModelIdVectorizationSource		Nem
include_contexts	array	A kimeneti környezet belefoglalt tulajdonságai. Ha nincs megadva, az alapértelmezett érték és `intent`a `citations` .	Nem

elasticsearchIndexFieldMappingOptions

Nem kötelező beállítások a mezők feldolgozásának szabályozásához konfigurált Elasticsearch-erőforrás® használatakor.

Név	Típus	Leírás	Kötelező
title_field	húr	A címként használni kívánt indexmező neve.	Nem
url_field	húr	Az URL-címként használni kívánt indexmező neve.	Nem
filepath_field	húr	A fájlútvonalként használandó indexmező neve.	Nem
content_fields	array	A tartalomként kezelendő indexmezők nevei.	Nem
content_fields_separator	húr	Az elválasztó minta, amelyet a tartalommezőknek használniuk kell.	Nem
vector_fields	array	A vektoradatokat ábrázoló mezők nevei.	Nem

elasticsearchQueryType

Az Elasticsearch® lekéréses lekérdezésének típusa, amelyet Azure OpenAI-csevegőbővítményként való használatakor végre kell hajtani.

Leírás: Az Elasticsearch® lekéréses lekérdezésének típusa, amelyet Azure OpenAI-csevegőbővítményként való használatakor végre kell hajtani.

Típus: sztring

Alapértelmezett:

Enum Name: ElasticsearchQueryType

Enumerálási értékek:

Érték	Leírás
egyszerű	Az alapértelmezett, egyszerű lekérdezéselemzőt jelöli.
vektor	Vektorkeresést jelöl a számított adatokon keresztül.

mongoDBChatExtensionConfiguration

A Mongo DB konfigurálható beállításainak konkrét ábrázolása Azure OpenAI-csevegőbővítményként való használatakor.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	azureChatExtensionType	Konfigurációs adatok megjelenítése egyetlen Azure OpenAI-csevegőbővítményhez. Ezt egy csevegés fogja használni befejező kérés, amely az Azure OpenAI-csevegőbővítményekkel bővíti a válasz viselkedését. Ennek a konfigurációnak a használata csak az Azure OpenAI-val kompatibilis.	Igen
parameters	mongoDBChatExtensionParameters	A Mongo DB használatakor az Azure OpenAI On Your Data csevegési bővítményeinek konfigurálásakor használandó paraméterek.	Nem

mongoDBChatExtensionParameters

A Mongo DB használatakor az Azure OpenAI On Your Data csevegési bővítményeinek konfigurálásakor használandó paraméterek.

Név	Típus	Leírás	Kötelező	Alapértelmezett
hitelesítés	onYourDataUsernameAndPasswordAuthenticationOptions	Az Azure OpenAI on Your Data hitelesítési lehetőségei felhasználónév és jelszó használata esetén.	Igen
top_n_documents	egész szám	A konfigurált lekérdezéshez használható dokumentumok maximális száma.	Nem
max_search_queries	egész szám	Az egy felhasználói üzenet keresési szolgáltatójának küldendő újraírt lekérdezések maximális száma. Ha nincs megadva, a rendszer dönti el a küldendő lekérdezések számát.	Nem
allow_partial_result	Logikai	Ha igazként van megadva, a rendszer lehetővé teszi a részleges keresési eredmények használatát, és a kérés meghiúsul, ha az összes lekérdezés sikertelen. Ha nincs megadva, vagy hamisként van megadva, a kérés sikertelen lesz, ha bármilyen keresési lekérdezés meghiúsul.	Nem	Hamis
in_scope	Logikai	Azt határozza meg, hogy a lekérdezések az indexelt adatok használatára legyenek-e korlátozva.	Nem
szigorúság	egész szám	A keresési relevancia szűrésének konfigurált szigorúsága. Minél magasabb a szigorúság, annál nagyobb a pontosság, de annál kisebb a válasz visszahívása.	Nem
endpoint	húr	A Mongo DB-fürtvégpont neve.	Igen
database_name	húr	A Mongo DB-adatbázis neve.	Igen
collection_name	húr	A Mongo DB-gyűjtemény neve.	Igen
app_name	húr	A Mongo DB-alkalmazás neve.	Igen
index_name	húr	A Mongo DB-index neve.	Igen
fields_mapping	mongoDBFieldMappingOptions	Nem kötelező beállítások a mezők feldolgozásának szabályozásához konfigurált Mongo DB-erőforrás használatakor.	Igen
embedding_dependency	onYourDataEndpointVectorizationSource vagy onYourDataDeploymentNameVectorizationSource		Igen
include_contexts	array	A kimeneti környezet belefoglalt tulajdonságai. Ha nincs megadva, az alapértelmezett érték és `intent`a `citations` .	Nem

mongoDBFieldMappingOptions

Nem kötelező beállítások a mezők feldolgozásának szabályozásához konfigurált Mongo DB-erőforrás használatakor.

Név	Típus	Leírás	Kötelező
title_field	húr	A címként használni kívánt indexmező neve.	Nem
url_field	húr	Az URL-címként használni kívánt indexmező neve.	Nem
filepath_field	húr	A fájlútvonalként használandó indexmező neve.	Nem
content_fields	array	A tartalomként kezelendő indexmezők nevei.	Igen
content_fields_separator	húr	Az elválasztó minta, amelyet a tartalommezőknek használniuk kell.	Nem
vector_fields	array	A vektoradatokat ábrázoló mezők nevei.	Igen

pineconeChatExtensionConfiguration

A Pinecone konfigurálható beállításainak konkrét ábrázolása Azure OpenAI-csevegőbővítményként való használatakor.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	azureChatExtensionType	Konfigurációs adatok megjelenítése egyetlen Azure OpenAI-csevegőbővítményhez. Ezt egy csevegés fogja használni befejező kérés, amely az Azure OpenAI-csevegőbővítményekkel bővíti a válasz viselkedését. Ennek a konfigurációnak a használata csak az Azure OpenAI-val kompatibilis.	Igen
parameters	pineconeChatExtensionParameters	Az Azure OpenAI Pinecone csevegőbővítmények konfigurálásának paraméterei.	Nem

pineconeChatExtensionParameters

Az Azure OpenAI Pinecone csevegőbővítmények konfigurálásának paraméterei.

Név	Típus	Leírás	Kötelező	Alapértelmezett
hitelesítés	onYourDataApiKeyAuthenticationOptions	Az Azure OpenAI on Your Data hitelesítési lehetőségei API-kulcs használata esetén.	Igen
top_n_documents	egész szám	A konfigurált lekérdezéshez használható dokumentumok maximális száma.	Nem
max_search_queries	egész szám	Az egy felhasználói üzenet keresési szolgáltatójának küldendő újraírt lekérdezések maximális száma. Ha nincs megadva, a rendszer dönti el a küldendő lekérdezések számát.	Nem
allow_partial_result	Logikai	Ha igazként van megadva, a rendszer lehetővé teszi a részleges keresési eredmények használatát, és a kérés meghiúsul, ha az összes lekérdezés sikertelen. Ha nincs megadva, vagy hamisként van megadva, a kérés sikertelen lesz, ha bármilyen keresési lekérdezés meghiúsul.	Nem	Hamis
in_scope	Logikai	Azt határozza meg, hogy a lekérdezések az indexelt adatok használatára legyenek-e korlátozva.	Nem
szigorúság	egész szám	A keresési relevancia szűrésének konfigurált szigorúsága. Minél magasabb a szigorúság, annál nagyobb a pontosság, de annál kisebb a válasz visszahívása.	Nem
környezet	húr	A Pinecone környezetneve.	Igen
index_name	húr	A Pinecone-adatbázisindex neve.	Igen
fields_mapping	pineconeFieldMappingOptions	Nem kötelező beállítások a mezők feldolgozásának szabályozásához konfigurált Pinecone-erőforrás használatakor.	Igen
embedding_dependency	onYourDataDeploymentNameVectorizationSource	A vektorizációs forrás részletei, amelyeket az Azure OpenAI használ az Adatokon vektorkeresés alkalmazásakor, amely az egy belső beágyazási modell üzembehelyezési nevére ugyanabban az Azure OpenAI-erőforrásban.	Igen
include_contexts	array	A kimeneti környezet belefoglalt tulajdonságai. Ha nincs megadva, az alapértelmezett érték és `intent`a `citations` .	Nem

pineconeFieldMappingOptions

Nem kötelező beállítások a mezők feldolgozásának szabályozásához konfigurált Pinecone-erőforrás használatakor.

Név	Típus	Leírás	Kötelező
title_field	húr	A címként használni kívánt indexmező neve.	Nem
url_field	húr	Az URL-címként használni kívánt indexmező neve.	Nem
filepath_field	húr	A fájlútvonalként használandó indexmező neve.	Nem
content_fields	array	A tartalomként kezelendő indexmezők nevei.	Igen
content_fields_separator	húr	Az elválasztó minta, amelyet a tartalommezőknek használniuk kell.	Nem

onYourDataAuthenticationOptions

Az Azure OpenAI on Your Data hitelesítési beállításai.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	onYourDataAuthenticationType	Az Azure OpenAI on Your Data által támogatott hitelesítési típusok.	Igen

onYourDataContextProperty

A környezeti tulajdonság.

Leírás: A környezeti tulajdonság.

Típus: sztring

Alapértelmezett:

Szám neve: OnYourDataContextProperty

Enumerálási értékek:

Érték	Leírás
Idézetek	A `citations` tulajdonság.
szándék	A `intent` tulajdonság.
all_retrieved_documents	A `all_retrieved_documents` tulajdonság.

onYourDataAuthenticationType

Az Azure OpenAI on Your Data által támogatott hitelesítési típusok.

Leírás: Az Azure OpenAI által az Adatokon támogatott hitelesítési típusok.

Típus: sztring

Alapértelmezett:

Szám neve: OnYourDataAuthenticationType

Enumerálási értékek:

Érték	Leírás
api_key	Hitelesítés API-kulccsal.
connection_string	Hitelesítés kapcsolati sztring keresztül.
key_and_key_id	Hitelesítés kulcs- és kulcsazonosító-páron keresztül.
encoded_api_key	Hitelesítés kódolt API-kulccsal.
access_token	Hitelesítés hozzáférési jogkivonaton keresztül.
system_assigned_managed_identity	Hitelesítés rendszer által hozzárendelt felügyelt identitáson keresztül.
user_assigned_managed_identity	Hitelesítés felhasználó által hozzárendelt felügyelt identitáson keresztül.
username_and_password	Hitelesítés felhasználónévvel és jelszóval.

onYourDataApiKeyAuthenticationOptions

Az Azure OpenAI on Your Data hitelesítési lehetőségei API-kulcs használata esetén.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	onYourDataAuthenticationType	Az Azure OpenAI on Your Data által támogatott hitelesítési típusok.	Igen
kulcs	húr	A hitelesítéshez használandó API-kulcs.	Nem

onYourDataConnectionStringAuthenticationOptions

Az Azure OpenAI on Your Data hitelesítési lehetőségei kapcsolati sztring használatakor.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	onYourDataAuthenticationType	Az Azure OpenAI on Your Data által támogatott hitelesítési típusok.	Igen
connection_string	húr	A hitelesítéshez használni kívánt kapcsolati sztring.	Nem

onYourDataKeyAndKeyIdAuthenticationOptions

Az Azure OpenAI on Your Data hitelesítési lehetőségei Elasticsearch-kulcs és kulcsazonosító pár használata esetén.

Név	Típus	Leírás	Kötelező
típus	onYourDataAuthenticationType	Az Azure OpenAI on Your Data által támogatott hitelesítési típusok.	Igen
kulcs	húr	A hitelesítéshez használandó Elasticsearch kulcs.	Nem
key_id	húr	A hitelesítéshez használandó Elasticsearch kulcsazonosító.	Nem

onYourDataEncodedApiKeyAuthenticationOptions

Az Azure OpenAI on Your Data hitelesítési lehetőségei Elasticsearch kódolt API-kulcs használatakor.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	onYourDataAuthenticationType	Az Azure OpenAI on Your Data által támogatott hitelesítési típusok.	Igen
encoded_api_key	húr	Az Elasticsearch kódolt API-kulcsa a hitelesítéshez.	Nem

onYourDataAccessTokenAuthenticationOptions

Az Azure OpenAI on Your Data hitelesítési lehetőségei hozzáférési jogkivonat használata esetén.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	onYourDataAuthenticationType	Az Azure OpenAI on Your Data által támogatott hitelesítési típusok.	Igen
access_token	húr	A hitelesítéshez használandó hozzáférési jogkivonat.	Nem

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

Az Azure OpenAI on Your Data hitelesítési lehetőségei rendszer által hozzárendelt felügyelt identitás használatakor.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	onYourDataAuthenticationType	Az Azure OpenAI on Your Data által támogatott hitelesítési típusok.	Igen

onYourDataUserAssignedManagedIdentityAuthenticationOptions

Az Azure OpenAI on Your Data hitelesítési lehetőségei felhasználó által hozzárendelt felügyelt identitás használatakor.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	onYourDataAuthenticationType	Az Azure OpenAI on Your Data által támogatott hitelesítési típusok.	Igen
managed_identity_resource_id	húr	A hitelesítéshez használandó, felhasználó által hozzárendelt felügyelt identitás erőforrás-azonosítója.	Nem

onYourDataUsernameAndPasswordAuthenticationOptions

Az Azure OpenAI on Your Data hitelesítési lehetőségei felhasználónév és jelszó használata esetén.

Név	Típus	Leírás	Kötelező
típus	onYourDataAuthenticationType	Az Azure OpenAI on Your Data által támogatott hitelesítési típusok.	Igen
username	húr	A hitelesítéshez használandó felhasználónév.	Nem
jelszó	húr	A jelszó. hitelesítéshez.	Nem

onYourDataVectorizationSource

Az Azure OpenAI On Your Data vektorkereséssel rendelkező vektorizációs forrásának absztrakt ábrázolása.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	onYourDataVectorizationSourceType	Az Azure OpenAI On Your Data által az adatok vektorizálásának konfigurálásához használható rendelkezésre álló forrásokat jelöli vektorkeresés.	Igen

onYourDataVectorizationSourceType

Az Azure OpenAI On Your Data által az adatok vektorizálásának konfigurálásához használható rendelkezésre álló forrásokat jelöli a vektorkereséshez.

Leírás: Az Azure OpenAI On Your Data által az adatok vektorizálásának konfigurálásához használható rendelkezésre álló forrásokat jelöli
vektorkeresés.

Típus: sztring

Alapértelmezett:

Szám neve: OnYourDataVectorizationSourceType

Enumerálási értékek:

Érték	Leírás
endpoint	Az Azure OpenAI beágyazási modellbe irányuló nyilvános hívások által végrehajtott vektorizálást jelöli.
deployment_name	A használni kívánt Ada-modell üzembehelyezési nevét jelöli. Ennek a modellnek ugyanabban az Azure OpenAI-erőforrásban kell lennie, de Az Adatokon ezt a modelltelepítést egy belső hívással fogja használni, nem pedig egy nyilvános hívással, amely lehetővé teszi a vektorok privát hálózatokban is kereshet.
integrált	A keresési erőforráson belül definiált integrált vektorizálót jelöli.
model_id	A keresési szolgáltatásban meghatározott beágyazási modell azonosítóját jelöli. Jelenleg csak az Elasticsearch® támogatja.

onYourDataEndpointVectorizationSource

Az Azure OpenAI on Your Data által a vektorkeresés alkalmazásakor használt vektorizációs forrás részletei, amely egy nyilvános Azure OpenAI-végpont beágyazási hívásán alapul.

Név	Típus	Leírás	Kötelező
típus	onYourDataVectorizationSourceType	Az Azure OpenAI On Your Data által az adatok vektorizálásának konfigurálásához használható rendelkezésre álló forrásokat jelöli vektorkeresés.	Igen
endpoint	húr	Megadja az erőforrásvégpont URL-címét, amelyből le kell kérni a beágyazásokat. A formátumnak `https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings`a következőnek kell lennie: . Az API-verziójú lekérdezési paraméter nem engedélyezett.	Nem
hitelesítés	onYourDataApiKeyAuthenticationOptions vagy onYourDataAccessTokenAuthenticationOptions		Nem
Méretek	egész szám	A beágyazások dimenzióinak száma. Csak a későbbi és a későbbi modellekben `text-embedding-3` támogatott.	Nem

onYourDataDeploymentNameVectorizationSource

Az Azure OpenAI On Your Data által a vektorkeresés alkalmazásakor használt vektorizációs forrás részletei, amely egy belső beágyazási modell üzembehelyezési nevén alapul ugyanabban az Azure OpenAI-erőforrásban.

Név	Típus	Leírás	Kötelező
típus	onYourDataVectorizationSourceType	Az Azure OpenAI On Your Data által az adatok vektorizálásának konfigurálásához használható rendelkezésre álló forrásokat jelöli vektorkeresés.	Igen
deployment_name	húr	Megadja a vektorizáláshoz használni kívánt modelltelepítés nevét. A modell központi telepítésének ugyanabban az Azure OpenAI-erőforrásban kell lennie, de az Adatokon ezt a modelltelepítést egy belső hívással, nem nyilvános hívással fogja használni, amely lehetővé teszi a vektorkeresést még a privát hálózatokban is.	Nem
Méretek	egész szám	A beágyazások dimenzióinak száma. Csak a későbbi és a későbbi modellekben `text-embedding-3` támogatott.	Nem

onYourDataIntegratedVectorizationSource

A keresési erőforráson belül definiált integrált vektorizálót jelöli.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	onYourDataVectorizationSourceType	Az Azure OpenAI On Your Data által az adatok vektorizálásának konfigurálásához használható rendelkezésre álló forrásokat jelöli vektorkeresés.	Igen

onYourDataModelIdVectorizationSource

A vektorizációs forrás részletei, amelyeket az Azure OpenAI használ az Adatokon vektoros keresés alkalmazásakor, amely egy keresési szolgáltatásmodell-azonosítón alapul. Jelenleg csak az Elasticsearch® támogatja.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	onYourDataVectorizationSourceType	Az Azure OpenAI On Your Data által az adatok vektorizálásának konfigurálásához használható rendelkezésre álló forrásokat jelöli vektorkeresés.	Igen
model_id	húr	Megadja a vektorizáláshoz használandó modellazonosítót. Ezt a modellazonosítót a keresési szolgáltatásban kell meghatározni.	Nem

azureChatExtensionsMessageContext

Az Azure OpenAI-csevegőbővítmények létrehozásakor rendelkezésre álló további környezeti információk megjelenítése a megfelelő csevegéskizárási válasz létrehozásában. Ez a környezeti információ csak akkor lesz feltöltve, ha egy megfelelő bővítmény használatára konfigurált Azure OpenAI-kérést használ.

Név	Típus	Leírás	Kötelező
Idézetek	array	Az adatforrás lekérési eredménye, amely az asszisztens üzenetének a válaszban való létrehozásához használatos.	Nem
szándék	húr	A csevegési előzményekből észlelt szándék, amely a következő fordulóra való továbbításra szolgál a környezet átviteléhez.	Nem
all_retrieved_documents	array	Az összes lekért dokumentum.	Nem

idézet

a csevegés befejezésére vonatkozó válaszüzenetre vonatkozó idézetadatok.

Név	Típus	Leírás	Kötelező
content	húr	Az idézet tartalma.	Igen
cím	húr	Az idézet címe.	Nem
url	húr	Az idézet URL-címe.	Nem
filepath	húr	Az idézet fájl elérési útja.	Nem
chunk_id	húr	Az idézet adattömb-azonosítója.	Nem
rerank_score	szám	A lekért dokumentum rerank-pontszáma.	Nem

retrievedDocument

A lekért dokumentum.

Név	Típus	Leírás	Kötelező
content	húr	Az idézet tartalma.	Igen
cím	húr	Az idézet címe.	Nem
url	húr	Az idézet URL-címe.	Nem
filepath	húr	Az idézet fájl elérési útja.	Nem
chunk_id	húr	Az idézet adattömb-azonosítója.	Nem
rerank_score	szám	A lekért dokumentum rerank-pontszáma.	Nem
search_queries	array	A dokumentum lekéréséhez használt keresési lekérdezések.	Nem
data_source_index	egész szám	Az adatforrás indexe.	Nem
original_search_score	szám	A lekért dokumentum eredeti keresési pontszáma.	Nem
filter_reason	filterReason	A lekért dokumentum szűrési oka.	Nem

filterReason

A lekért dokumentum szűrési oka.

Leírás: A lekért dokumentum szűrési oka.

Típus: sztring

Alapértelmezett:

Enum Name: FilterReason

Enumerálási értékek:

Érték	Leírás
pontszám	A dokumentum szűrése a konfigurálás által meghatározott eredeti keresési pontszám küszöbértéke alapján `strictness` történik.
rerank	A dokumentumot nem az eredeti keresési pontszám küszöbértéke szűri, hanem a rerank pontszám és `top_n_documents` konfigurálás alapján szűri.

chatCompletionMessageToolCall

Név	Típus	Leírás	Kötelező
id	húr	Az eszközhívás azonosítója.	Igen
típus	toolCallType	Ebben az esetben `function`az eszközhívás típusa.	Igen
függvény	object	A modell által hívott függvény.	Igen

Függvény tulajdonságai

név

Név	Típus	Leírás	Alapértelmezett
név	húr	A meghívandó függvény neve.

Érvek

Név	Típus	Leírás	Alapértelmezett
Érvek	húr	A függvény meghívására használható argumentumok, amelyeket a modell JSON formátumban hoz létre. Vegye figyelembe, hogy a modell nem mindig hoz létre érvényes JSON-t, és olyan paramétereket is létrehozhat, amelyeket a függvényséma nem határoz meg. A függvény meghívása előtt ellenőrizze a kód argumentumait.

toolCallType

Ebben az esetben functionaz eszközhívás típusa.

Leírás: Az eszközhívás típusa, ebben az esetben function.

Típus: sztring

Alapértelmezett:

Szám neve: ToolCallType

Enumerálási értékek:

Érték	Leírás
függvény	Az eszközhívás típusa függvény.

chatCompletionRequestMessageTool

Név	Típus	Leírás	Kötelező	Alapértelmezett
tool_call_id	húr	Eszközhívás, amelyre az üzenet válaszol.	Nem
content	húr	Az üzenet tartalma.	Nem

chatCompletionRequestMessageFunction

Név	Típus	Leírás	Kötelező
szerepkör	Enum	Ebben az esetben `function`az üzenetek szerzőjének szerepe. Lehetséges értékek: függvény	Nem
név	húr	Az üzenet tartalma.	Nem
content	húr	Az üzenet tartalma.	Nem

createChatCompletionResponse

A megadott bemenet alapján a modell által visszaadott csevegés-befejezési választ jelöli.

Név	Típus	Leírás	Kötelező
id	húr	A csevegés befejezésének egyedi azonosítója.	Igen
prompt_filter_results	promptFilterResults	A tartalomszűrés eredménye nulla vagy több kérés esetén jelenik meg a kérelemben. Streamelési kérés esetén a különböző kérések eredményei eltérő időpontokban vagy különböző megrendelésekben érkezhetnek.	Nem
Választás	array	A csevegés befejezésének lehetőségeinek listája. Egynél több is lehet, ha `n` nagyobb, mint 1.	Igen
létrehozva	egész szám	A csevegés befejezésének unix időbélyege (másodpercben).	Igen
modell	húr	A csevegés befejezéséhez használt modell.	Igen
system_fingerprint	húr	Ez az ujjlenyomat azt a háttérkonfigurációt jelöli, amellyel a modell fut. A kérelemparaméterrel `seed` együtt használható annak megértéséhez, hogy mikor történtek olyan háttérbeli módosítások, amelyek hatással lehetnek a determinizmusra.	Nem
object	Enum	Az objektum típusa, amely mindig `chat.completion`. Lehetséges értékek: chat.completion	Igen
használat	completionUsage	A befejezési kérelem használati statisztikái.	Nem

createChatCompletionStreamResponse

A modell által visszaadott csevegés-befejezési válasz streamelt adattömbje a megadott bemenet alapján.

Név	Típus	Leírás	Kötelező
id	húr	A csevegés befejezésének egyedi azonosítója. Minden adattömb ugyanazzal az azonosítóval rendelkezik.	Igen
Választás	array	A csevegés befejezésének lehetőségeinek listája. Több elemet is tartalmazhat, ha `n` nagyobb, mint 1.	Igen
létrehozva	egész szám	A csevegés befejezésének unix időbélyege (másodpercben). Minden adattömbnek ugyanaz az időbélyege.	Igen
modell	húr	A befejezést generáló modell.	Igen
system_fingerprint	húr	Ez az ujjlenyomat azt a háttérkonfigurációt jelöli, amellyel a modell fut. A kérelemparaméterrel `seed` együtt használható annak megértéséhez, hogy mikor történtek olyan háttérbeli módosítások, amelyek hatással lehetnek a determinizmusra.	Nem
object	Enum	Az objektum típusa, amely mindig `chat.completion.chunk`. Lehetséges értékek: chat.completion.chunk	Igen

chatCompletionStreamResponseDelta

A streamelt modellválaszok által generált csevegés-befejezési változás.

Név	Típus	Leírás	Kötelező
content	húr	Az adattömbüzenet tartalma.	Nem
function_call	object	Elavult, és helyébe a következő lép `tool_calls`: . Egy meghívandó függvény neve és argumentumai a modell által generált módon.	Nem
tool_calls	array		Nem
szerepkör	Enum	Az üzenet szerzőjének szerepe. Lehetséges értékek: rendszer, felhasználó, asszisztens, eszköz	Nem
visszautasítás	húr	A modell által generált elutasítási üzenet.	Nem

A function_call tulajdonságai

Érvek

Név	Típus	Leírás	Alapértelmezett
Érvek	húr	A függvény meghívására használható argumentumok, amelyeket a modell JSON formátumban hoz létre. Vegye figyelembe, hogy a modell nem mindig hoz létre érvényes JSON-t, és olyan paramétereket is létrehozhat, amelyeket a függvényséma nem határoz meg. A függvény meghívása előtt ellenőrizze a kód argumentumait.

név

Név	Típus	Leírás	Alapértelmezett
név	húr	A meghívandó függvény neve.

chatCompletionMessageToolCallChunk

Név	Típus	Leírás	Kötelező
index	egész szám		Igen
id	húr	Az eszközhívás azonosítója.	Nem
típus	Enum	Az eszköz típusa. Jelenleg csak `function` a támogatottak. Lehetséges értékek: függvény	Nem
függvény	object		Nem

Függvény tulajdonságai

név

Név	Típus	Leírás	Alapértelmezett
név	húr	A meghívandó függvény neve.

Érvek

Név	Típus	Leírás	Alapértelmezett
Érvek	húr	A függvény meghívására használható argumentumok, amelyeket a modell JSON formátumban hoz létre. Vegye figyelembe, hogy a modell nem mindig hoz létre érvényes JSON-t, és olyan paramétereket is létrehozhat, amelyeket a függvényséma nem határoz meg. A függvény meghívása előtt ellenőrizze a kód argumentumait.

chatCompletionStreamOptions

A streamelési válasz beállításai. Ezt csak akkor állítsa be, ha be van állítva stream: true.

Név	Típus	Leírás	Kötelező	Alapértelmezett
include_usage	Logikai	Ha be van állítva, egy további adattömb lesz streamelve az `data: [DONE]` üzenet előtt. Az `usage` adattömb mezője a teljes kérelem jogkivonat-használati statisztikáit jeleníti meg, és a `choices` mező mindig üres tömb lesz. Az összes többi adattömb tartalmaz egy `usage` mezőt is, de null értékkel.	Nem

chatCompletionChoiceLogProbs

A választási lehetőség valószínűségi adatainak naplózása.

Név	Típus	Leírás	Kötelező	Alapértelmezett
content	array	Az üzenettartalom-jogkivonatok listája naplók valószínűségi adataival.	Igen
visszautasítás	array	Az üzenetmegtagadási jogkivonatok listája a napló valószínűségi adataival.	Nem

chatCompletionTokenLogprob

Név	Típus	Leírás	Kötelező
jogkivonat	húr	A jogkivonat.	Igen
logprob	szám	A jogkivonat naplójának valószínűsége.	Igen
bájt	array	A token UTF-8 bájtos ábrázolását képviselő egész számok listája. Olyan esetekben hasznos, amikor a karaktereket több jogkivonat jelöli, és a megfelelő szövegábrázolás létrehozásához kombinálni kell a bájtos ábrázolásukat. Ez akkor lehet `null` , ha nincs bájtos ábrázolás a jogkivonathoz.	Igen
top_logprobs	array	A legvalószínűbb jogkivonatok és a naplók valószínűségének listája ezen a jogkivonat-pozíción. Ritkán előfordulhat, hogy kevesebb a kért visszaadott `top_logprobs` számnál.	Igen

chatCompletionResponseMessage

A modell által létrehozott csevegőüzenet.

Név	Típus	Leírás	Kötelező
szerepkör	chatCompletionResponseMessageRole	A válaszüzenet szerzőjének szerepe.	Igen
visszautasítás	húr	A modell által generált elutasítási üzenet.	Igen
content	húr	Az üzenet tartalma.	Igen
tool_calls	array	A modell által generált eszközhívások, például függvényhívások.	Nem
function_call	chatCompletionFunctionCall	Elavult, és helyébe a következő lép `tool_calls`: . Egy meghívandó függvény neve és argumentumai a modell által generált módon.	Nem
hanganyag	object	Ha a hangkimeneti modalitást kéri, ez az objektum adatokat tartalmaz a modell hangválaszáról.	Nem
kontextus	azureChatExtensionsMessageContext	Az Azure OpenAI-csevegőbővítmények használatakor elérhető további környezeti információk megjelenítése a megfelelő csevegés-befejezési válasz létrehozásakor. Ez a környezeti információ csak akkor van kitöltve, ha egy egyező bővítmény használatára konfigurált Azure OpenAI-kérés használatával.	Nem

Hangtulajdonságok

id

Név	Típus	Leírás	Alapértelmezett
id	húr	A hangválasz egyedi azonosítója.

expires_at

Név	Típus	Leírás	Alapértelmezett
expires_at	egész szám	A Unix időbélyege (másodpercben) arra az időre, amikor a hangválasz többé nem lesz elérhető a kiszolgálón többfordulós használatra Beszélgetések.

adatok

Név	Típus	Leírás	Alapértelmezett
adatok	húr	A modell által létrehozott Base64 kódolású hang bájtok formátuma a kérelemben megadottak szerint.

átirat

Név	Típus	Leírás	Alapértelmezett
átirat	húr	A modell által létrehozott hang átirata.

chatCompletionResponseMessageRole

A válaszüzenet szerzőjének szerepe.

Leírás: A válaszüzenet szerzőjének szerepe.

Típus: sztring

Alapértelmezett:

Enumerálási értékek:

asszisztens

chatCompletionToolChoiceOption

Azt szabályozza, hogy a modell melyik eszközt hívja meg (ha van ilyen). none azt jelenti, hogy a modell nem hív meg egyetlen eszközt sem, és ehelyett létrehoz egy üzenetet. auto azt jelenti, hogy a modell választhat egy üzenet létrehozása vagy egy vagy több eszköz meghívása között. required azt jelenti, hogy a modellnek egy vagy több eszközt kell meghívnia. Egy adott eszköz megadása az {"type": "function", "function": {"name": "my_function"}} eszköz meghívására kényszeríti a modellt. none az alapértelmezett, ha nincsenek eszközök. auto az alapértelmezett, ha az eszközök vannak jelen.

Ez az összetevő a következők egyike lehet:

chatCompletionNamedToolChoice

Megadja, hogy a modellnek mely eszközt kell használnia. Egy adott függvény meghívására kényszeríti a modellt.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	Enum	Az eszköz típusa. Jelenleg csak `function` a támogatottak. Lehetséges értékek: függvény	Igen
függvény	object		Igen

Függvény tulajdonságai

név

Név	Típus	Leírás	Alapértelmezett
név	húr	A meghívandó függvény neve.

ParallelToolCalls

Engedélyezi-e a párhuzamos függvényhívást az eszköz használata során.

Ehhez az összetevőhöz nincs definiálva tulajdonság.

PredictionContent

Statikus előrejelzett kimeneti tartalom, például egy újragenerált szövegfájl tartalma.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	Enum	A megadni kívánt előrejelzett tartalom típusa. Ez a típus jelenleg mindig `content`jelen van. Lehetséges értékek: tartalom	Igen
content	sztring vagy tömb	A modellválasz létrehozásakor egyeztetendő tartalom. Ha a létrehozott jogkivonatok megfelelnek ennek a tartalomnak, a teljes modellválasz sokkal gyorsabban visszaadható.	Igen

chatCompletionMessageToolCalls

A modell által generált eszközhívások, például függvényhívások.

Ehhez az összetevőhöz nincs definiálva tulajdonság.

ChatCompletionModalities

Olyan kimeneti típusok, amelyeket a modellnek létre szeretne hozni ehhez a kéréshez. A legtöbb modell képes szöveg létrehozására, ami az alapértelmezett:

["text"]

A gpt-4o-audio-preview modell hang létrehozására is használható. Ha azt szeretné, hogy ez a modell szöveges és hangválaszokat is generáljon, a következőt használhatja:

["text", "audio"]

Ehhez az összetevőhöz nincs definiálva tulajdonság.

chatCompletionFunctionCall

Elavult, és helyébe a következő lép tool_calls: . Egy meghívandó függvény neve és argumentumai a modell által generált módon.

Név	Típus	Leírás	Kötelező	Alapértelmezett
név	húr	A meghívandó függvény neve.	Igen
Érvek	húr	A függvény meghívására használható argumentumok, amelyeket a modell JSON formátumban hoz létre. Vegye figyelembe, hogy a modell nem mindig hoz létre érvényes JSON-t, és olyan paramétereket is létrehozhat, amelyeket a függvényséma nem határoz meg. A függvény meghívása előtt ellenőrizze a kód argumentumait.	Igen

completionUsage

A befejezési kérelem használati statisztikái.

Név	Típus	Leírás	Kötelező
prompt_tokens	egész szám	A jogkivonatok száma a parancssorban.	Igen
completion_tokens	egész szám	A létrehozott befejezésben lévő tokenek száma.	Igen
total_tokens	egész szám	A kérelemben használt tokenek teljes száma (parancssor + befejezés).	Igen
prompt_tokens_details	object	A parancssori jogkivonatok részletei.	Nem
completion_tokens_details	object	A befejezéskor használt jogkivonatok lebontása.	Nem

A prompt_tokens_details tulajdonságai

audio_tokens

Név	Típus	Leírás	Alapértelmezett
audio_tokens	egész szám	A parancssorban található hangbemeneti jogkivonatok.

cached_tokens

Név	Típus	Leírás	Alapértelmezett
cached_tokens	egész szám	A gyorsítótárazott parancssori jogkivonatok száma.

A completion_tokens_details tulajdonságai

accepted_prediction_tokens

Név	Típus	Leírás	Alapértelmezett
accepted_prediction_tokens	egész szám	Előrejelzett kimenetek használatakor az előrejelzésben szereplő tokenek száma, amelyek a befejezéskor jelentek meg.

audio_tokens

Név	Típus	Leírás	Alapértelmezett
audio_tokens	egész szám	A modell által létrehozott hangbemeneti jogkivonatok.

reasoning_tokens

Név	Típus	Leírás	Alapértelmezett
reasoning_tokens	egész szám	A modell által az érveléshez létrehozott jogkivonatok.

rejected_prediction_tokens

Név	Típus	Leírás	Alapértelmezett
rejected_prediction_tokens	egész szám	Előrejelzett kimenetek használatakor az előrejelzésben szereplő tokenek száma, amelyek nem jelentek meg a befejezésben. Az érvelési jogkivonatokhoz hasonlóan azonban ezek a jogkivonatok továbbra is beleszámítanak a teljes befejezési jogkivonatba a számlázás, a kimenet és a környezeti ablak korlátai szempontjából.

chatCompletionTool

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	Enum	Az eszköz típusa. Jelenleg csak `function` a támogatottak. Lehetséges értékek: függvény	Igen
függvény	FunctionObject		Igen

Függvényparaméterek

A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva. Példákért tekintse meg az útmutatót és a formátum dokumentációját ismertető JSON-sémahivatkozást .

Az kihagyás parameters üres paraméterlistával rendelkező függvényt határoz meg.

Ehhez az összetevőhöz nincs definiálva tulajdonság.

FunctionObject

Név	Típus	Leírás	Kötelező	Alapértelmezett
leírás	húr	A függvény működésének leírása, amelyet a modell használ annak kiválasztásához, hogy mikor és hogyan hívja meg a függvényt.	Nem
név	húr	A meghívandó függvény neve. A-z, A-Z, 0-9, vagy aláhúzásjeleket és kötőjeleket kell tartalmaznia, legfeljebb 64 hosszúságúak.	Igen
parameters	Függvényparaméterek	A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva. Példákért tekintse meg az útmutatót és a formátum dokumentációját ismertető JSON-sémahivatkozást . Az kihagyás `parameters` üres paraméterlistával rendelkező függvényt határoz meg.	Nem
szigorú	Logikai	A függvényhívás létrehozásakor engedélyezze-e a szigorú sémabetartást. Ha igaz értékre van állítva, a modell a mezőben meghatározott sémát `parameters` követi. Csak a JSON-séma egy részhalmaza támogatott, ha `strict` az .`true`	Nem	Hamis

ResponseFormatText

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	Enum	A definiált válaszformátum típusa: `text` Lehetséges értékek: szöveg	Igen

ResponseFormatJsonObject

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	Enum	A definiált válaszformátum típusa: `json_object` Lehetséges értékek: json_object	Igen

ResponseFormatJsonSchemaSchema

A válaszformátum sémája, amely JSON-sémaobjektumként van leírva.

Ehhez az összetevőhöz nincs definiálva tulajdonság.

ResponseFormatJsonSchema

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	Enum	A definiált válaszformátum típusa: `json_schema` Lehetséges értékek: json_schema	Igen
json_schema	object		Igen

A json_schema tulajdonságai

leírás

Név	Típus	Leírás	Alapértelmezett
leírás	húr	A modell a válaszformátum leírásával határozza meg, hogyan válaszoljon a formátumra.

név

Név	Típus	Leírás	Alapértelmezett
név	húr	A válaszformátum neve. A-z, A-Z, 0-9, vagy aláhúzásjeleket és kötőjeleket kell tartalmaznia, legfeljebb 64 hosszúságúak.

schema

Név	Típus	Leírás	Alapértelmezett
schema	ResponseFormatJsonSchemaSchema	A válaszformátum sémája, amely JSON-sémaobjektumként van leírva.

szigorú

Név	Típus	Leírás	Alapértelmezett
szigorú	Logikai	A kimenet létrehozásakor engedélyezze-e a szigorú sémabetartást. Ha igaz értékre van állítva, a modell mindig a mezőben meghatározott sémát `schema` követi. Csak a JSON-séma egy részhalmaza támogatott, ha `strict` az .`true`	Hamis

chatCompletionChoiceCommon

Név	Típus	Leírás	Kötelező	Alapértelmezett
index	egész szám		Nem
finish_reason	húr		Nem

createTranslationRequest

Fordítási kérelem.

Név	Típus	Leírás	Kötelező	Alapértelmezett
fájl	húr	A lefordítandó hangfájl.	Igen
haladéktalan	húr	Választható szöveg a modell stílusának irányításához vagy egy korábbi hangszegmens folytatásához. A kérésnek angolul kell lennie.	Nem
response_format	audioResponseFormat	Meghatározza a kimenet formátumát.	Nem
hőmérséklet	szám	A mintavételi hőmérséklet 0 és 1 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet. Ha 0 értékre van állítva, a modell naplók valószínűségével automatikusan növeli a hőmérsékletet, amíg bizonyos küszöbértékeket nem ér el.	Nem	0

audioResponse

Fordítási vagy átírási válasz, amikor response_format json volt

Név	Típus	Leírás	Kötelező	Alapértelmezett
text	húr	Lefordított vagy átírt szöveg.	Igen

audioVerboseResponse

Fordítási vagy átírási válasz response_format verbose_json

Név	Típus	Leírás	Kötelező
text	húr	Lefordított vagy átírt szöveg.	Igen
feladat	húr	A hangfeladat típusa.	Nem
language	húr	Nyelv.	Nem
időtartam	szám	Időtartam.	Nem
Szegmensek	array		Nem
szöveg	array		Nem

audioResponseFormat

Meghatározza a kimenet formátumát.

Leírás: Meghatározza a kimenet formátumát.

Típus: sztring

Alapértelmezett:

Enumerálási értékek:

json
text
srt
verbose_json
vtt

createTranscriptionRequest

Átírási kérelem.

Név	Típus	Leírás	Kötelező	Alapértelmezett
fájl	húr	Az átírandó hangfájl-objektum.	Igen
haladéktalan	húr	Választható szöveg a modell stílusának irányításához vagy egy korábbi hangszegmens folytatásához. A kérésnek meg kell egyeznie a hangnyelvvel.	Nem
response_format	audioResponseFormat	Meghatározza a kimenet formátumát.	Nem
hőmérséklet	szám	A mintavételi hőmérséklet 0 és 1 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet. Ha 0 értékre van állítva, a modell naplók valószínűségével automatikusan növeli a hőmérsékletet, amíg bizonyos küszöbértékeket nem ér el.	Nem	0
language	húr	A bemeneti hang nyelve. Ha ISO-639-1 formátumban adja meg a bemeneti nyelvet, az növeli a pontosságot és a késést.	Nem
timestamp_granularities[]	array	Az átíráshoz feltöltendő időbélyeg részletesség. `response_format` időbélyeg részletesség használatára kell beállítani `verbose_json` . Mindkét lehetőség támogatott: `word`vagy `segment`. Megjegyzés: A szegmensek időbélyegei nem járnak további késéssel, de a szóidőbélyegek generálása további késéssel jár.	Nem	[szegmens]

audioSegment

Átirat vagy fordítási szegmens.

Név	Típus	Leírás	Kötelező
id	egész szám	Szegmensazonosító.	Nem
keres	szám	A szegmens eltolása.	Nem
start	szám	Szegmens kezdő eltolása.	Nem
vége	szám	Szegmens vége eltolása.	Nem
text	húr	Szegmentált szöveg.	Nem
Tokenek	array	A szöveg jogkivonatai.	Nem
hőmérséklet	szám	Hőmérséklet.	Nem
avg_logprob	szám	Átlagos napló valószínűsége.	Nem
compression_ratio	szám	Tömörítési arány.	Nem
no_speech_prob	szám	A "nincs beszéd" valószínűsége.	Nem

audioWord

Átirat vagy fordítási szó.

Név	Típus	Leírás	Kötelező
szó	húr	Word	Nem
start	szám	A Word eltolása.	Nem
vége	szám	Word vég eltolása.	Nem

createSpeechRequest

Beszédkérelem.

Név	Típus	Leírás	Kötelező	Alapértelmezett
bemenet	húr	A hangszintézishez használt szöveg. A maximális hossz 4096 karakter.	Igen
voice	Enum	A beszédszintézishez használandó hang. Lehetséges értékek: ötvözet, echo, medális, onyx, nova, csillám	Igen
response_format	Enum	A hangszintézis formátuma. Lehetséges értékek: mp3, opus, aac, flac, wav, pcm	Nem
sebesség	szám	A szintetizált hang sebessége. Válasszon ki egy értéket a kívánt érték közül `0.254.0`. A `1.0` az alapértelmezett formátum.	Nem	1.0

imageQuality

A létrehozandó kép minősége.

Leírás: A létrehozandó kép minősége.

Típus: sztring

Alapértelmezett: standard

Enum name: Quality

Enumerálási értékek:

Érték	Leírás
normál	A standard minőség szabványos minőségű képeket hoz létre.
merevlemez	A HD minőség finomabb részleteket és nagyobb konzisztenciát biztosít a képeken.

imagesResponseFormat

A létrehozott képek visszaadott formátuma.

Leírás: A létrehozott képek visszaadott formátuma.

Típus: sztring

Alapértelmezett: URL-cím

Enum Name: ImagesResponseFormat

Enumerálási értékek:

Érték	Leírás
url	A létrehozott képek letöltéséhez ideiglenes hozzáférést biztosító URL-cím.
b64_json	A létrehozott képek base64 kódolású sztringként lesznek visszaadva.

imageSize

A létrehozott képek mérete.

Leírás: A létrehozott képek mérete.

Típus: sztring

Alapértelmezett: 1024x1024

Szám neve: Méret

Enumerálási értékek:

Érték	Leírás
256x256	A létrehozott kép kívánt mérete 256x256 képpont. Csak dall-e-2 esetén támogatott.
512 x 512	A létrehozott kép kívánt mérete 512x512 képpont. Csak dall-e-2 esetén támogatott.
1792x1024	A létrehozott kép kívánt mérete 1792x1024 képpont. Csak dall-e-3 esetén támogatott.
1024x1792	A létrehozott kép kívánt mérete 1024x1792 képpont. Csak dall-e-3 esetén támogatott.
1024 x 1024	A létrehozott kép kívánt mérete 1024x1024 képpont.

imageStyle

A létrehozott képek stílusa.

Leírás: A létrehozott képek stílusa.

Típus: sztring

Alapértelmezett: élénk

Szám neve: Stílus

Enumerálási értékek:

Érték	Leírás
élénk	Az Élénk hiperreális és drámai képeket hoz létre.
természetes	A Natural természetesebb és kevésbé hiperreális képeket hoz létre.

imageGenerationsRequest

Név	Típus	Leírás	Kötelező	Alapértelmezett
haladéktalan	húr	A kívánt kép(ek) szöveges leírása. A maximális hossz 4000 karakter.	Igen
n	egész szám	A létrehozandó képek száma.	Nem	0
Méret	imageSize	A létrehozott képek mérete.	Nem	1024 x 1024
response_format	imagesResponseFormat	A létrehozott képek visszaadott formátuma.	Nem	url
user	húr	A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében.	Nem
minőség	imageQuality	A létrehozandó kép minősége.	Nem	normál
style	imageStyle	A létrehozott képek stílusa.	Nem	élénk

generateImagesResponse

Név	Típus	Leírás	Kötelező	Alapértelmezett
létrehozva	egész szám	A unix időbélyeg a művelet létrehozásakor.	Igen
adatok	array	A művelet eredményadatai, ha sikeresek	Igen

imageResult

Ha a rendszerkép URL-címe vagy kódolt képe sikeres, és egyéb hiba.

Név	Típus	Leírás	Kötelező
url	húr	A kép URL-címe.	Nem
b64_json	húr	A base64 kódolású rendszerkép	Nem
content_filter_results	dalleContentFilterResults	Információ a tartalomszűrési eredményekről.	Nem
revised_prompt	húr	A rendszerkép létrehozásához használt kérés, ha a kérésnek volt valamilyen változata.	Nem
prompt_filter_results	dalleFilterResults	Információ a tartalomszűrési kategóriáról (gyűlölet, szexuális, erőszak, self_harm), ha észlelték, valamint a súlyossági szintről (very_low, alacsony, közepes, nagy léptékű, amely meghatározza a káros tartalmak intenzitását és kockázati szintjét), és hogy szűrték-e vagy sem. Információk a jailbreak tartalomról és a trágárságról, ha észlelték, és hogy szűrték-e vagy sem. És az ügyfél-tiltólistával kapcsolatos információk, ha szűrték, és annak azonosítója.	Nem

vonal

Tartalomvonal-objektum, amely tartalomelemek, például szavak és kijelölési jelek szomszédos sorozatából áll.

Név	Típus	Leírás	Kötelező	Alapértelmezett
text	sztring		Igen
Ível	array	Az észlelt objektumokat és a határolókeret adatait ábrázoló spanok tömbje.	Igen

átível

Az észlelt objektumot és a határolókeret adatait ábrázoló span objektum.

Név	Típus	Leírás	Kötelező
text	húr	Az észlelt objektumot jelképező span szöveges tartalma.	Igen
ellensúlyoz	egész szám	A karakter eltolása azon a szövegen belül, amelyben a span kezdődik. Ez az eltolás a span első karakterének pozíciójaként van definiálva, a szöveg elejétől számítva Unicode-kódpontokként.	Igen
length (hossz)	egész szám	A hossz karakterben, Unicode-kódpontokban mérve.	Igen
sokszög	array	Az észlelt objektumot tartalmazó sokszögben lévő pontokat képviselő objektumok tömbje.	Igen

runCompletionUsage

A futtatáshoz kapcsolódó használati statisztikák. Ez az érték akkor lesz, null ha a futtatás nem terminálállapotban van (pl. in_progress, queuedstb.).

Név	Típus	Leírás	Kötelező
completion_tokens	egész szám	A futtatás során használt befejezési jogkivonatok száma.	Igen
prompt_tokens	egész szám	A futtatás során használt parancssori jogkivonatok száma.	Igen
total_tokens	egész szám	A használt tokenek teljes száma (prompt + completion).	Igen

runStepCompletionUsage

A futtatási lépéshez kapcsolódó használati statisztikák. Ez az érték a futtatási lépés állapota in_progressalatt lesznull.

Név	Típus	Leírás	Kötelező
completion_tokens	egész szám	A futtatási lépés során használt befejezési jogkivonatok száma.	Igen
prompt_tokens	egész szám	A futtatási lépés során használt parancssori jogkivonatok száma.	Igen
total_tokens	egész szám	A használt tokenek teljes száma (prompt + completion).	Igen

assistantsApiResponseFormatOption

Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4o, a GPT-4 Turbo és az összes GPT-3.5 Turbo modellel.gpt-3.5-turbo-1106

A strukturált kimeneteket engedélyező { "type": "json_schema", "json_schema": {...} } beállítás, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. További információ a Strukturált kimenetek útmutatóban.

A JSON mód engedélyezése beállítás { "type": "json_object" } , amely biztosítja, hogy a modell által generált üzenet érvényes JSON legyen.

Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha finish_reason="length"az azt jelzi, hogy a létrehozás túllépte max_tokens vagy a beszélgetés túllépte a környezet maximális hosszát.

Ez az összetevő a következők egyike lehet:

assistantsApiResponseFormat

A modell várható kimenetét leíró objektum. Ha json_object csak function a típus tools adható át a futtatásnak. Ha text a modell szöveget vagy bármilyen szükséges értéket tud visszaadni.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	Az egyiknek `text` vagy `json_object`a másiknak kell lennie.	Nem	text

típus: AssistantsApiResponseFormat

Érték	Leírás
text
json_object

assistantObject

Olyan modellt assistant jelöl, amely meghívhatja a modellt, és eszközöket használhat.

Név	Típus	Leírás	Kötelező	Alapértelmezett
id	húr	Az API-végpontokban hivatkozható azonosító.	Igen
object	húr	Az objektum típusa, amely mindig `assistant`.	Igen
created_at	egész szám	A Unix időbélyege (másodpercben) az asszisztens létrehozásakor.	Igen
név	húr	Az asszisztens neve. A maximális hossz 256 karakter.	Igen
leírás	húr	Az asszisztens leírása. A maximális hossz 512 karakter.	Igen
modell	húr	A használni kívánt modell azonosítója. A Modellek listázása API-val megtekintheti az összes elérhető modellt, vagy megtekintheti a modell áttekintését is.	Igen
útmutató	húr	Az asszisztens által használt rendszerutasítások. A maximális hossz 256 000 karakter.	Igen
eszközök	array	Az asszisztensen engedélyezett eszközlista. Asszisztensenként legfeljebb 128 eszköz lehet. Az eszközök lehetnek típusok `code_interpreter`, `file_search`vagy `function`.	Igen	[]
tool_resources	object	Az asszisztens eszközei által használt erőforrások készlete. Az erőforrások az eszköz típusára vonatkoznak. Az eszköznek például `code_interpreter` a fájlazonosítók listájára van szüksége, míg az `file_search` eszköznek a vektortároló azonosítóinak listájára van szüksége.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Igen
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet.	Nem	0
top_p	szám	A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti. Általában azt javasoljuk, hogy módosítsa ezt vagy a hőmérsékletet, de mindkettőt nem.	Nem	0
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4o, a GPT-4 Turbo és az összes GPT-3.5 Turbo modellel.`gpt-3.5-turbo-1106` A strukturált kimeneteket engedélyező `{ "type": "json_schema", "json_schema": {...} }` beállítás, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. További információ a Strukturált kimenetek útmutatóban. A JSON mód engedélyezése beállítás `{ "type": "json_object" }` , amely biztosítja, hogy a modell által generált üzenet érvényes JSON legyen. Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha `finish_reason="length"`az azt jelzi, hogy a létrehozás túllépte `max_tokens` vagy a beszélgetés túllépte a környezet maximális hosszát.	Nem

A tool_resources tulajdonságai

code_interpreter

Név	Típus	Leírás	Alapértelmezett
file_ids	array	Az "code_interpreter" eszköz számára elérhetővé tett fájlazonosítók listája. Az eszközhöz legfeljebb 20 fájl társítható.	[]

file_search

Név	Típus	Leírás	Alapértelmezett
vector_store_ids	array	Az asszisztenshez csatolt vektortároló azonosítója. Legfeljebb egy vektortároló csatolható az asszisztenshez.

object Enum: AssistantObjectType

Érték	Leírás
asszisztens	Az objektum típusa, amely mindig asszisztens

createAssistantRequest

Név	Típus	Leírás	Kötelező	Alapértelmezett
modell			Igen
név	húr	Az asszisztens neve. A maximális hossz 256 karakter.	Nem
leírás	húr	Az asszisztens leírása. A maximális hossz 512 karakter.	Nem
útmutató	húr	Az asszisztens által használt rendszerutasítások. A maximális hossz 256 000 karakter.	Nem
eszközök	array	Az asszisztensen engedélyezett eszközlista. Asszisztensenként legfeljebb 128 eszköz lehet. Az eszközök lehetnek típusok `code_interpreter`, `retrieval`vagy `function`.	Nem	[]
tool_resources	object	Az asszisztens eszközei által használt erőforrások készlete. Az erőforrások az eszköz típusára vonatkoznak. Az eszköznek például `code_interpreter` a fájlazonosítók listájára van szüksége, míg az `file_search` eszköznek a vektortároló azonosítóinak listájára van szüksége.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet.	Nem	0
top_p	szám	A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti. Általában azt javasoljuk, hogy módosítsa ezt vagy a hőmérsékletet, de mindkettőt nem.	Nem	0
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4o, a GPT-4 Turbo és az összes GPT-3.5 Turbo modellel.`gpt-3.5-turbo-1106` A strukturált kimeneteket engedélyező `{ "type": "json_schema", "json_schema": {...} }` beállítás, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. További információ a Strukturált kimenetek útmutatóban. A JSON mód engedélyezése beállítás `{ "type": "json_object" }` , amely biztosítja, hogy a modell által generált üzenet érvényes JSON legyen. Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha `finish_reason="length"`az azt jelzi, hogy a létrehozás túllépte `max_tokens` vagy a beszélgetés túllépte a környezet maximális hosszát.	Nem

A tool_resources tulajdonságai

code_interpreter

Név	Típus	Leírás	Alapértelmezett
file_ids	array	Az eszköz számára `code_interpreter` elérhetővé tett fájlazonosítók listája. Az eszközhöz legfeljebb 20 fájl társítható.	[]

file_search

Név	Típus	Leírás	Alapértelmezett
vector_store_ids	array	Az asszisztenshez csatolt vektortároló. Legfeljebb egy vektortároló csatolható az asszisztenshez.
vector_stores	array	Segéd egy vektortároló létrehozásához file_ids és csatolja az asszisztenshez. Legfeljebb egy vektortároló csatolható az asszisztenshez.

modifyAssistantRequest

Név	Típus	Leírás	Kötelező	Alapértelmezett
modell			Nem
név	húr	Az asszisztens neve. A maximális hossz 256 karakter.	Nem
leírás	húr	Az asszisztens leírása. A maximális hossz 512 karakter.	Nem
útmutató	húr	Az asszisztens által használt rendszerutasítások. A maximális hossz 32 768 karakter.	Nem
eszközök	array	Az asszisztensen engedélyezett eszközlista. Asszisztensenként legfeljebb 128 eszköz lehet. Az eszközök lehetnek típusok `code_interpreter`, `retrieval`vagy `function`.	Nem	[]
tool_resources	object	Az asszisztens eszközei által használt erőforrások készlete. Az erőforrások az eszköz típusára vonatkoznak. Az eszköznek például `code_interpreter` a fájlazonosítók listájára van szüksége, míg az `file_search` eszköznek a vektortároló azonosítóinak listájára van szüksége.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet.	Nem	0
top_p	szám	A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti. Általában azt javasoljuk, hogy módosítsa ezt vagy a hőmérsékletet, de mindkettőt nem.	Nem	0
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4o, a GPT-4 Turbo és az összes GPT-3.5 Turbo modellel.`gpt-3.5-turbo-1106` A strukturált kimeneteket engedélyező `{ "type": "json_schema", "json_schema": {...} }` beállítás, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. További információ a Strukturált kimenetek útmutatóban. A JSON mód engedélyezése beállítás `{ "type": "json_object" }` , amely biztosítja, hogy a modell által generált üzenet érvényes JSON legyen. Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha `finish_reason="length"`az azt jelzi, hogy a létrehozás túllépte `max_tokens` vagy a beszélgetés túllépte a környezet maximális hosszát.	Nem

A tool_resources tulajdonságai

code_interpreter

Név	Típus	Leírás	Alapértelmezett
file_ids	array	Felülbírálja az eszköz számára `code_interpreter` elérhetővé tett fájlazonosítók listáját. Az eszközhöz legfeljebb 20 fájl társítható.	[]

file_search

Név	Típus	Leírás	Alapértelmezett
vector_store_ids	array	Felülbírálja az asszisztenshez csatolt vektortárolót. Legfeljebb egy vektortároló csatolható az asszisztenshez.

deleteAssistantResponse

Név	Típus	Kötelező
id	sztring	Igen
törölt	Logikai	Igen
object	sztring	Igen

object Enum: DeleteAssistantResponseState

Érték	Leírás
assistant.deleted

listAssistantsResponse

Név	Típus	Kötelező
object	sztring	Igen
adatok	array	Igen
first_id	sztring	Igen
last_id	sztring	Igen
has_more	Logikai	Igen

assistantToolsCode

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	A definiált eszköz típusa: `code_interpreter`	Igen

típus Enum: assistantToolsCodeType

Érték	Leírás
code_interpreter

assistantToolsFileSearch

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	A definiált eszköz típusa: `file_search`	Igen
file_search	object	Felülbírálások a fájlkereső eszközhöz.	Nem

A file_search tulajdonságai

max_num_results

Név	Típus	Leírás	Alapértelmezett
max_num_results	egész szám	A fájlkeresési eszköz által megjelenítendő találatok maximális száma. Az alapértelmezett érték a gpt-4* modelleknél 20, a gpt-3.5 turbónál pedig 5. Ennek a számnak 1 és 50 közöttinek kell lennie. Vegye figyelembe, hogy a fájlkereső eszköz a találatoknál `max_num_results` kevesebb kimenetet adhat ki.

típus Enum: assistantToolsFileSearchType

Érték	Leírás
file_search

assistantToolsFileSearchTypeOnly

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	A definiált eszköz típusa: `file_search`	Igen

típus Enum: assistantToolsFileSearchType

Érték	Leírás
file_search

assistantToolsFunction

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	A definiált eszköz típusa: `function`	Igen
függvény	object	A függvénydefiníció.	Igen

Függvény tulajdonságai

leírás

Név	Típus	Leírás	Alapértelmezett
leírás	húr	A függvény működésének leírása, amelyet a modell használ annak kiválasztásához, hogy mikor és hogyan hívja meg a függvényt.

név

Név	Típus	Leírás	Alapértelmezett
név	húr	A meghívandó függvény neve. A-z, A-Z, 0-9, vagy aláhúzásjeleket és kötőjeleket kell tartalmaznia, legfeljebb 64 hosszúságúak.

parameters

Név	Típus	Leírás	Alapértelmezett
parameters	chatCompletionFunctionParameters	A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva. Példákért tekintse meg az útmutatót és a formátum dokumentációját ismertető JSON-sémahivatkozást .

típus Enum: assistantToolsFunction

Érték	Leírás
függvény

truncationObject

Azt szabályozza, hogy a futtatás előtt hogyan csonkolja a szálat. Ezzel szabályozhatja a futtatás kezdeti környezeti ablakát.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	A szálhoz használandó csonkítási stratégia. Az alapértelmezett érték `auto`. Ha be van `last_messages`állítva, a rendszer csonkolja a szálat a szál legutóbbi üzeneteihez. Ha be van `auto`állítva, a rendszer a szál közepén lévő üzeneteket elveti a modell környezeti hosszának megfelelően. `max_prompt_tokens`	Igen
last_messages	egész szám	A futtatás környezetének létrehozásakor a szál legutóbbi üzeneteinek száma.	Nem

típus Enum: TruncationType

Érték	Leírás
auto
last_messages

assistantsApiToolChoiceOption

Azt szabályozza, hogy a modell melyik eszközt hívja meg (ha van ilyen). none azt jelenti, hogy a modell nem hív meg eszközöket, hanem üzenetet hoz létre. auto az alapértelmezett érték, és azt jelenti, hogy a modell választhat az üzenet létrehozása vagy az eszköz meghívása között. Egy adott eszköz megadása, például {"type": "file_search"}{"type": "function", "function": {"name": "my_function"}} a modell meghívására kényszeríti a modellt.

Ez az összetevő a következők egyike lehet:

assistantsNamedToolChoice

Megadja, hogy a modellnek mely eszközt kell használnia. Ezzel kényszeríti a modellt egy adott eszköz meghívására.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	Az eszköz típusa. Ha a típus az `function`, a függvény nevét be kell állítani	Igen
függvény	object		Nem

Függvény tulajdonságai

név

Név	Típus	Leírás	Alapértelmezett
név	húr	A meghívandó függvény neve.

típus Enum: AssistantsNamedToolChoiceType

Érték	Leírás
függvény
code_interpreter
file_search

runObject

Egy szálon futtatott végrehajtást jelöl.

Név	Típus	Leírás	Kötelező	Alapértelmezett
id	húr	Az API-végpontokban hivatkozható azonosító.	Igen
object	húr	Az objektum típusa, amely mindig `thread.run`.	Igen
created_at	egész szám	A Unix időbélyege (másodpercben) a futtatás létrehozásakor.	Igen
thread_id	húr	A futtatás részeként végrehajtott szál azonosítója.	Igen
assistant_id	húr	A futtatás végrehajtásához használt asszisztens azonosítója.	Igen
status	húr	A futtatás állapota, amely lehet `queued`, , `in_progress`, `requires_actioncancelling`, `cancelled`, , `failed`, `completed`vagy `expired`.	Igen
required_action	object	A futtatás folytatásához szükséges művelet részletei. Akkor lesz, `null` ha nincs szükség műveletre.	Igen
last_error	object	A futtatáshoz tartozó utolsó hiba. Az lesz, `null` ha nincsenek hibák.	Igen
expires_at	egész szám	A Unix időbélyege (másodpercben) arra az időre, amikor a futtatás lejár.	Igen
started_at	egész szám	A Unix időbélyege (másodpercben) a futtatás indításakor.	Igen
cancelled_at	egész szám	A Unix időbélyege (másodpercben) arra az időre, amikor a futtatás megszakadt.	Igen
failed_at	egész szám	A Unix időbélyege (másodpercben), amikor a futtatás sikertelen volt.	Igen
completed_at	egész szám	A Futtatás befejezésének Unix-időbélyege (másodpercben).	Igen
incomplete_details	object	Részletek a futtatás sikertelenségéről. Akkor lesz, `null` ha a futtatás nem teljes.	Igen
modell	húr	Az asszisztens által a futtatáshoz használt modell.	Igen
útmutató	húr	Az asszisztens által a futtatáshoz használt utasítások.	Igen
eszközök	array	Az asszisztens által a futtatáshoz használt eszközök listája.	Igen	[]
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Igen
használat	runCompletionUsage	A futtatáshoz kapcsolódó használati statisztikák. Ez az érték akkor lesz, `null` ha a futtatás nem terminálállapotban van (pl. `in_progress`, `queued`stb.).	Igen
hőmérséklet	szám	A futtatáshoz használt mintavételi hőmérséklet. Ha nincs beállítva, az alapértelmezett érték 1.	Nem
top_p	szám	A futtatáshoz használt magmintavételi érték. Ha nincs beállítva, az alapértelmezett érték 1.	Nem
max_prompt_tokens	egész szám	A futtatás során használt parancssori jogkivonatok maximális száma.	Igen
max_completion_tokens	egész szám	A futtatás során használt befejezési jogkivonatok maximális száma.	Igen
truncation_strategy	truncationObject	Azt szabályozza, hogy a futtatás előtt hogyan csonkolja a szálat. Ezzel szabályozhatja a futtatás kezdeti környezeti ablakát.	Igen
tool_choice	assistantsApiToolChoiceOption	Azt szabályozza, hogy a modell melyik eszközt hívja meg (ha van ilyen). `none` azt jelenti, hogy a modell nem hív meg eszközöket, hanem üzenetet hoz létre. `auto` az alapértelmezett érték, és azt jelenti, hogy a modell választhat az üzenet létrehozása vagy az eszköz meghívása között. Egy adott eszköz megadása, például `{"type": "file_search"}{"type": "function", "function": {"name": "my_function"}}` a modell meghívására kényszeríti a modellt.	Igen
parallel_tool_calls	ParallelToolCalls	Engedélyezi-e a párhuzamos függvényhívást az eszköz használata során.	Nem	Igaz
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4o, a GPT-4 Turbo és az összes GPT-3.5 Turbo modellel.`gpt-3.5-turbo-1106` A strukturált kimeneteket engedélyező `{ "type": "json_schema", "json_schema": {...} }` beállítás, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. További információ a Strukturált kimenetek útmutatóban. A JSON mód engedélyezése beállítás `{ "type": "json_object" }` , amely biztosítja, hogy a modell által generált üzenet érvényes JSON legyen. Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha `finish_reason="length"`az azt jelzi, hogy a létrehozás túllépte `max_tokens` vagy a beszélgetés túllépte a környezet maximális hosszát.	Igen

A required_action tulajdonságai

típus

Név	Típus	Leírás	Alapértelmezett
típus	húr	Egyelőre ez mindig `submit_tool_outputs`így van.

submit_tool_outputs

Név	Típus	Leírás	Alapértelmezett
tool_calls	array	A megfelelő eszközhívások listája.

A last_error tulajdonságai

code

Név	Típus	Leírás	Alapértelmezett
code	húr	Az egyik vagy `server_errorrate_limit_exceeded`a másik.

üzenet

Név	Típus	Leírás	Alapértelmezett
üzenet	húr	A hiba ember által olvasható leírása.

A incomplete_details tulajdonságai

reason

Név	Típus	Leírás	Alapértelmezett
reason	húr	A futtatás oka nem teljes. Ez arra mutat, hogy a futtatás során melyik jogkivonat-korlát lett elérve.

object Enum: runObjectType

Érték	Leírás
thread.run	Az always thread.run objektumtípus

status Enum: RunObjectStatus

Érték	Leírás
Várólistára	Az üzenetsorba helyezett állapot
in_progress	A in_progress állapota
requires_action	A required_action állapota
Érvénytelenítés	A lemondási állapot
Törölt	A megszakított állapot
sikertelen	A sikertelen állapot
kész	A befejezett állapot
Lejárt	A lejárt állapot

createRunRequest

Név	Típus	Leírás	Kötelező	Alapértelmezett
assistant_id	húr	A futtatás végrehajtásához használni kívánt asszisztens azonosítója.	Igen
modell	húr	A futtatás végrehajtásához használandó modell azonosítója. Ha itt egy érték van megadva, az felülírja az asszisztenshez társított modellt. Ha nem, akkor a rendszer az asszisztenshez társított modellt használja.	Nem
útmutató	húr	Felülbírálja az asszisztens alapértelmezett rendszerüzenetét. Ez a viselkedés futásonkénti módosításához hasznos.	Nem
additional_instructions	húr	A futtatásra vonatkozó utasítások végén további utasításokat fűz hozzá. Ez akkor hasznos, ha futtatásonként módosítja a viselkedést anélkül, hogy felülírna más utasításokat.	Nem
additional_messages	array	A futtatás létrehozása előtt további üzeneteket ad hozzá a szálhoz.	Nem
eszközök	array	Felülbírálja az asszisztens által a futtatáshoz használható eszközöket. Ez a viselkedés futásonkénti módosításához hasznos.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet.	Nem	0
top_p	szám	A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti. Általában azt javasoljuk, hogy módosítsa ezt vagy a hőmérsékletet, de mindkettőt nem.	Nem	0
patak	Logikai	Ha `true`, a futtatás kiszolgáló által küldött események során bekövetkező események adatfolyamát adja vissza, amely akkor végződik, amikor a Futtatás terminálállapotba lép egy `data: [DONE]` üzenettel.	Nem
max_prompt_tokens	egész szám	A futtatás során használható parancssori jogkivonatok maximális száma. A futtatás mindent megtesz annak érdekében, hogy csak a megadott számú parancssori jogkivonatot használja a futtatás több fordulója során. Ha a futtatás meghaladja a megadott parancssori jogkivonatok számát, a futtatás állapottal `incomplete`fejeződik be. További információt itt talál `incomplete_details` .	Nem
max_completion_tokens	egész szám	A futtatás során használható befejezési jogkivonatok maximális száma. A futtatás mindent megtesz annak érdekében, hogy csak a megadott számú befejezési jogkivonatot használja a futtatás több fordulója során. Ha a futtatás meghaladja a megadott befejezési jogkivonatok számát, a futtatás állapottal `incomplete`fejeződik be. További információt itt talál `incomplete_details` .	Nem
truncation_strategy	truncationObject	Azt szabályozza, hogy a futtatás előtt hogyan csonkolja a szálat. Ezzel szabályozhatja a futtatás kezdeti környezeti ablakát.	Nem
tool_choice	assistantsApiToolChoiceOption	Azt szabályozza, hogy a modell melyik eszközt hívja meg (ha van ilyen). `none` azt jelenti, hogy a modell nem hív meg eszközöket, hanem üzenetet hoz létre. `auto` az alapértelmezett érték, és azt jelenti, hogy a modell választhat az üzenet létrehozása vagy az eszköz meghívása között. Egy adott eszköz megadása, például `{"type": "file_search"}{"type": "function", "function": {"name": "my_function"}}` a modell meghívására kényszeríti a modellt.	Nem
parallel_tool_calls	ParallelToolCalls	Engedélyezi-e a párhuzamos függvényhívást az eszköz használata során.	Nem	Igaz
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4o, a GPT-4 Turbo és az összes GPT-3.5 Turbo modellel.`gpt-3.5-turbo-1106` A strukturált kimeneteket engedélyező `{ "type": "json_schema", "json_schema": {...} }` beállítás, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. További információ a Strukturált kimenetek útmutatóban. A JSON mód engedélyezése beállítás `{ "type": "json_object" }` , amely biztosítja, hogy a modell által generált üzenet érvényes JSON legyen. Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha `finish_reason="length"`az azt jelzi, hogy a létrehozás túllépte `max_tokens` vagy a beszélgetés túllépte a környezet maximális hosszát.	Nem

listRunsResponse

Név	Típus	Kötelező
object	sztring	Igen
adatok	array	Igen
first_id	sztring	Igen
last_id	sztring	Igen
has_more	Logikai	Igen

modifyRunRequest

Név	Típus	Leírás	Kötelező	Alapértelmezett
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem

submitToolOutputsRunRequest

Név	Típus	Leírás	Kötelező	Alapértelmezett
tool_outputs	array	Azoknak az eszközöknek a listája, amelyekhez a kimenetek elküldése folyamatban van.	Igen
patak	Logikai	Ha `true`, a futtatás kiszolgáló által küldött események során bekövetkező események adatfolyamát adja vissza, amely akkor végződik, amikor a Futtatás terminálállapotba lép egy `data: [DONE]` üzenettel.	Nem

runToolCallObject

Eszközhívási objektumok

Név	Típus	Leírás	Kötelező
id	húr	Az eszközhívás azonosítója. Erre az azonosítóra akkor kell hivatkozni, amikor az eszköz kimeneteit a Submit eszköz kimeneteinek használatával küldi el a végpont futtatásához.	Igen
típus	húr	A kimenetet meghívó eszköz típusa szükséges. Egyelőre ez mindig `function`így van.	Igen
függvény	object	A függvénydefiníció.	Igen

Függvény tulajdonságai

név

Név	Típus	Leírás	Alapértelmezett
név	húr	A függvény neve.

Érvek

Név	Típus	Leírás	Alapértelmezett
Érvek	húr	Azok az argumentumok, amelyeket a modell elvár, hogy átadjon a függvénynek.

típus Enum: RunToolCallObjectType

Érték	Leírás
függvény

createThreadAndRunRequest

Név	Típus	Leírás	Kötelező	Alapértelmezett
assistant_id	húr	A futtatás végrehajtásához használni kívánt asszisztens azonosítója.	Igen
szál	createThreadRequest		Nem
modell	húr	A futtatás végrehajtásához használandó modell azonosítója. Ha itt egy érték van megadva, az felülírja az asszisztenshez társított modellt. Ha nem, akkor a rendszer az asszisztenshez társított modellt használja.	Nem
útmutató	húr	Felülbírálja az asszisztens alapértelmezett rendszerüzenetét. Ez a viselkedés futásonkénti módosításához hasznos.	Nem
eszközök	array	Felülbírálja az asszisztens által a futtatáshoz használható eszközöket. Ez a viselkedés futásonkénti módosításához hasznos.	Nem
tool_resources	object	Az asszisztens eszközei által használt erőforrások készlete. Az erőforrások az eszköz típusára vonatkoznak. Az eszköznek például `code_interpreter` a fájlazonosítók listájára van szüksége, míg az `file_search` eszköznek a vektortároló azonosítóinak listájára van szüksége.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet.	Nem	0
top_p	szám	A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti. Általában azt javasoljuk, hogy módosítsa ezt vagy a hőmérsékletet, de mindkettőt nem.	Nem	0
patak	Logikai	Ha `true`, a futtatás kiszolgáló által küldött események során bekövetkező események adatfolyamát adja vissza, amely akkor végződik, amikor a Futtatás terminálállapotba lép egy `data: [DONE]` üzenettel.	Nem
stream_options	chatCompletionStreamOptions	A streamelési válasz beállításai. Ezt csak akkor állítsa be, ha be van állítva `stream: true`.	Nem	Egyik sem
max_prompt_tokens	egész szám	A futtatás során használható parancssori jogkivonatok maximális száma. A futtatás mindent megtesz annak érdekében, hogy csak a megadott számú parancssori jogkivonatot használja a futtatás több fordulója során. Ha a futtatás meghaladja a megadott parancssori jogkivonatok számát, a futtatás állapottal `incomplete`fejeződik be. További információt itt talál `incomplete_details` .	Nem
max_completion_tokens	egész szám	A futtatás során használható befejezési jogkivonatok maximális száma. A futtatás mindent megtesz annak érdekében, hogy csak a megadott számú befejezési jogkivonatot használja a futtatás több fordulója során. Ha a futtatás meghaladja a megadott befejezési jogkivonatok számát, a futtatás állapottal `incomplete`fejeződik be. További információt itt talál `incomplete_details` .	Nem
truncation_strategy	truncationObject	Azt szabályozza, hogy a futtatás előtt hogyan csonkolja a szálat. Ezzel szabályozhatja a futtatás kezdeti környezeti ablakát.	Nem
tool_choice	assistantsApiToolChoiceOption	Azt szabályozza, hogy a modell melyik eszközt hívja meg (ha van ilyen). `none` azt jelenti, hogy a modell nem hív meg eszközöket, hanem üzenetet hoz létre. `auto` az alapértelmezett érték, és azt jelenti, hogy a modell választhat az üzenet létrehozása vagy az eszköz meghívása között. Egy adott eszköz megadása, például `{"type": "file_search"}{"type": "function", "function": {"name": "my_function"}}` a modell meghívására kényszeríti a modellt.	Nem
parallel_tool_calls	ParallelToolCalls	Engedélyezi-e a párhuzamos függvényhívást az eszköz használata során.	Nem	Igaz
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4o, a GPT-4 Turbo és az összes GPT-3.5 Turbo modellel.`gpt-3.5-turbo-1106` A strukturált kimeneteket engedélyező `{ "type": "json_schema", "json_schema": {...} }` beállítás, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. További információ a Strukturált kimenetek útmutatóban. A JSON mód engedélyezése beállítás `{ "type": "json_object" }` , amely biztosítja, hogy a modell által generált üzenet érvényes JSON legyen. Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha `finish_reason="length"`az azt jelzi, hogy a létrehozás túllépte `max_tokens` vagy a beszélgetés túllépte a környezet maximális hosszát.	Nem

A tool_resources tulajdonságai

code_interpreter

Név	Típus	Leírás	Alapértelmezett
file_ids	array	Az eszköz számára `code_interpreter` elérhetővé tett fájlazonosítók listája. Az eszközhöz legfeljebb 20 fájl társítható.	[]

file_search

Név	Típus	Leírás	Alapértelmezett
vector_store_ids	array	Az asszisztenshez csatolt vektortároló azonosítója. Legfeljebb egy vektortároló csatolható az asszisztenshez.

threadObject

Üzeneteket tartalmazó szálat jelöl.

Név	Típus	Leírás	Kötelező
id	húr	Az API-végpontokban hivatkozható azonosító.	Igen
object	húr	Az objektum típusa, amely mindig `thread`.	Igen
created_at	egész szám	A Unix időbélyege (másodpercben) a szál létrehozásakor.	Igen
tool_resources	object	Az ebben a szálban az asszisztens eszközei számára elérhetővé tett erőforrások készlete. Az erőforrások az eszköz típusára vonatkoznak. Az eszköznek például `code_interpreter` a fájlazonosítók listájára van szüksége, míg az `file_search` eszköznek a vektortároló azonosítóinak listájára van szüksége.	Igen
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Igen

A tool_resources tulajdonságai

code_interpreter

Név	Típus	Leírás	Alapértelmezett
file_ids	array	Az eszköz számára `code_interpreter` elérhetővé tett fájlazonosítók listája. Az eszközhöz legfeljebb 20 fájl társítható.	[]

file_search

Név	Típus	Leírás	Alapértelmezett
vector_store_ids	array	A szálhoz csatolt vektortároló. A szálhoz legfeljebb egy vektortároló csatolható.

object Enum: ThreadObjectType

Érték	Leírás
szál	A szálobjektum típusa, amely mindig `thread`

createThreadRequest

Név	Típus	Leírás	Kötelező
üzenet	array	Azoknak az üzeneteknek a listája, amellyel elindíthatja a szálat.	Nem
tool_resources	object	Az ebben a szálban az asszisztens eszközei számára elérhetővé tett erőforrások készlete. Az erőforrások az eszköz típusára vonatkoznak. Az eszköznek például `code_interpreter` a fájlazonosítók listájára van szüksége, míg az `file_search` eszköznek a vektortároló azonosítóinak listájára van szüksége.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem

A tool_resources tulajdonságai

code_interpreter

Név	Típus	Leírás	Alapértelmezett
file_ids	array	Az eszköz számára `code_interpreter` elérhetővé tett fájlazonosítók listája. Az eszközhöz legfeljebb 20 fájl társítható.	[]

file_search

Név	Típus	Leírás	Alapértelmezett
vector_store_ids	array	A szálhoz csatolt vektortároló. A szálhoz legfeljebb egy vektortároló csatolható.
vector_stores	array	Segéd egy vektortároló létrehozásához file_ids és csatolja ehhez a szálhoz. A szálhoz legfeljebb egy vektortároló csatolható.

modifyThreadRequest

Név	Típus	Leírás	Kötelező	Alapértelmezett
tool_resources	object	Az ebben a szálban az asszisztens eszközei számára elérhetővé tett erőforrások készlete. Az erőforrások az eszköz típusára vonatkoznak. Az eszköznek például `code_interpreter` a fájlazonosítók listájára van szüksége, míg az `file_search` eszköznek a vektortároló azonosítóinak listájára van szüksége.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem

A tool_resources tulajdonságai

code_interpreter

Név	Típus	Leírás	Alapértelmezett
file_ids	array	Az eszköz számára `code_interpreter` elérhetővé tett fájlazonosítók listája. Az eszközhöz legfeljebb 20 fájl társítható.	[]

file_search

Név	Típus	Leírás	Alapértelmezett
vector_store_ids	array	A szálhoz csatolt vektortároló. A szálhoz legfeljebb egy vektortároló csatolható.

deleteThreadResponse

Név	Típus	Kötelező
id	sztring	Igen
törölt	Logikai	Igen
object	sztring	Igen

object Enum: DeleteThreadResponseObjectState

Érték	Leírás
thread.deleted	A törlési szál válaszobjektumának állapota, amely `thread.deleted`

listThreadsResponse

Név	Típus	Kötelező
object	sztring	Igen
adatok	array	Igen
first_id	sztring	Igen
last_id	sztring	Igen
has_more	Logikai	Igen

messageObject

Egy szálon belüli üzenetet jelöl.

Név	Típus	Leírás	Kötelező
id	húr	Az API-végpontokban hivatkozható azonosító.	Igen
object	húr	Az objektum típusa, amely mindig `thread.message`.	Igen
created_at	egész szám	A Unix időbélyege (másodpercben) az üzenet létrehozásakor.	Igen
thread_id	húr	Az üzenet szálazonosítója.	Igen
status	húr	Az üzenet állapota, amely lehet `in_progress`, `incomplete`vagy `completed`.	Igen
incomplete_details	object	Hiányos üzenet esetén az üzenet hiányának részletei.	Igen
completed_at	egész szám	Az üzenet befejezésének Unix-időbélyege (másodpercben).	Igen
incomplete_at	egész szám	A Unix időbélyege (másodpercben), amikor az üzenet hiányosként lett megjelölve.	Igen
szerepkör	húr	Az üzenetet előállító entitás. Az egyik vagy `userassistant`a másik.	Igen
content	array	Az üzenet tartalma szöveges és/vagy képtömbben.	Igen
assistant_id	húr	Ha lehetséges, az üzenetet létrehozó asszisztens azonosítója.	Igen
run_id	húr	Adott esetben az üzenet létrehozásához társított futtatás azonosítója.	Igen
Mellékletek	array	Az üzenethez csatolt fájlok listája és azok eszközei.	Igen
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Igen

A incomplete_details tulajdonságai

reason

Név	Típus	Leírás	Alapértelmezett
reason	húr	Az üzenet nem teljes.

object Enum: MessageObjectType

Érték	Leírás
thread.message	Az üzenetobjektum típusa, amely `thread.message`

status Enum: MessageObjectStatus

Érték	Leírás
in_progress
hiányos
kész

role Enum: MessageObjectRole

Érték	Leírás
user
asszisztens

messageDeltaObject

Üzenetváltozást jelöl, azaz az üzenet módosított mezőit a streamelés során.

Név	Típus	Leírás	Kötelező
id	húr	Az üzenet azonosítója, amelyre az API-végpontokban lehet hivatkozni.	Igen
object	húr	Az objektum típusa, amely mindig `thread.message.delta`.	Igen
delta	object	Az üzenetben módosult mezőket tartalmazó változás.	Igen

A delta tulajdonságai

szerepkör

Név	Típus	Leírás	Alapértelmezett
szerepkör	húr	Az üzenetet előállító entitás. Az egyik vagy `userassistant`a másik.

content

Név	Típus	Leírás	Alapértelmezett
content	array	Az üzenet tartalma szöveges és/vagy képtömbben.

object Enum: MessageDeltaObjectType

Érték	Leírás
thread.message.delta

createMessageRequest

Név	Típus	Leírás	Kötelező
szerepkör	húr	Az üzenetet létrehozó entitás szerepe. Az engedélyezett értékek a következők: - `user`: Azt jelzi, hogy az üzenetet egy tényleges felhasználó küldi el, és a legtöbb esetben a felhasználó által generált üzenetek megjelenítésére kell használni. - `assistant`: Azt jelzi, hogy az üzenetet az asszisztens hozza létre. Ezzel az értékkel beszúrhat üzeneteket az asszisztensből a beszélgetésbe.	Igen
content	húr	Az üzenet tartalma.	Igen
Mellékletek	array	Az üzenethez csatolt fájlok listája, valamint az eszközök, amelyhez hozzá kell adni őket.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem

role Enum: CreateMessageRequestRole

Érték	Leírás
user
asszisztens

modifyMessageRequest

Név	Típus	Leírás	Kötelező	Alapértelmezett
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem

deleteMessageResponse

Név	Típus	Kötelező
id	sztring	Igen
törölt	Logikai	Igen
object	sztring	Igen

object Enum: DeleteMessageResponseObject

Érték	Leírás
thread.message.deleted	A törlési üzenet válaszobjektumának állapota

listMessagesResponse

Név	Típus	Kötelező
object	sztring	Igen
adatok	array	Igen
first_id	sztring	Igen
last_id	sztring	Igen
has_more	Logikai	Igen

messageContentImageFileObject

Egy képfájlra hivatkozik egy üzenet tartalmában.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	Mindig `image_file`.	Igen
image_file	object		Igen

A image_file tulajdonságai

file_id

Név	Típus	Leírás	Alapértelmezett
file_id	húr	A kép fájlazonosítója az üzenet tartalmában.

típus Enum: MessageContentImageFileObjectType

Érték	Leírás
image_file	Az üzenet tartalom képfájljának típusa

messageContentTextObject

Az üzenet részét képező szöveges tartalom.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	Mindig `text`.	Igen
text	object		Igen

Szöveg tulajdonságai

Érték

Név	Típus	Leírás	Alapértelmezett
Érték	húr	A szöveget alkotó adatok.

Széljegyzetek

Név	Típus	Leírás	Alapértelmezett
Széljegyzetek	array

típus Enum: messageContentTextObjectType

Érték	Leírás
text	Az üzenet tartalomszövegének objektumtípusa

messageContentTextAnnotationsFileCitationObject

Az üzeneten belüli idézet, amely egy adott, az asszisztenshez vagy az üzenethez társított fájlból származó idézetre mutat. Akkor jön létre, amikor az asszisztens a "lekérés" eszközzel keres fájlokat.

Név	Típus	Leírás	Kötelező
típus	húr	Mindig `file_citation`.	Igen
text	húr	Az üzenet tartalmának lecserélendő szövege.	Igen
file_citation	object		Igen
start_index	egész szám		Igen
end_index	egész szám		Igen

A file_citation tulajdonságai

file_id

Név	Típus	Leírás	Alapértelmezett
file_id	húr	Annak a fájlnak az azonosítója, amelyből az idézet származik.

típus Enum: FileCitationObjectType

Érték	Leírás
file_citation	A fájl idézet objektumtípusa

messageContentTextAnnotationsFilePathObject

A fájl URL-címe, amely akkor jön létre, amikor az asszisztens az code_interpreter eszközt használta a fájl létrehozásához.

Név	Típus	Leírás	Kötelező
típus	húr	Mindig `file_path`.	Igen
text	húr	Az üzenet tartalmának lecserélendő szövege.	Igen
file_path	object		Igen
start_index	egész szám		Igen
end_index	egész szám		Igen

A file_path tulajdonságai

file_id

Név	Típus	Leírás	Alapértelmezett
file_id	húr	A létrehozott fájl azonosítója.

típus Enum: FilePathObjectType

Érték	Leírás
file_path	A fájl elérési útjának objektumtípusa

messageDeltaContentImageFileObject

Egy képfájlra hivatkozik egy üzenet tartalmában.

Név	Típus	Leírás	Kötelező
index	egész szám	Az üzenet tartalomrészének indexe.	Igen
típus	húr	Mindig `image_file`.	Igen
image_file	object		Nem

A image_file tulajdonságai

file_id

Név	Típus	Leírás	Alapértelmezett
file_id	húr	A kép fájlazonosítója az üzenet tartalmában.

típus Enum: MessageDeltaContentImageFileObjectType

Érték	Leírás
image_file

messageDeltaContentTextObject

Az üzenet részét képező szöveges tartalom.

Név	Típus	Leírás	Kötelező
index	egész szám	Az üzenet tartalomrészének indexe.	Igen
típus	húr	Mindig `text`.	Igen
text	object		Nem

Szöveg tulajdonságai

Érték

Név	Típus	Leírás	Alapértelmezett
Érték	húr	A szöveget alkotó adatok.

Széljegyzetek

Név	Típus	Leírás	Alapértelmezett
Széljegyzetek	array

típus Enum: MessageDeltaContentTextObjectType

Érték	Leírás
text

messageDeltaContentTextAnnotationsFileCitationObject

Az üzeneten belüli idézet, amely egy adott, az asszisztenshez vagy az üzenethez társított fájlból származó idézetre mutat. Akkor jön létre, amikor az asszisztens a "file_search" eszközzel keres fájlokat.

Név	Típus	Leírás	Kötelező
index	egész szám	A jegyzet indexe a szöveges tartalomrészben.	Igen
típus	húr	Mindig `file_citation`.	Igen
text	húr	Az üzenet tartalmának lecserélendő szövege.	Nem
file_citation	object		Nem
start_index	egész szám		Nem
end_index	egész szám		Nem

A file_citation tulajdonságai

file_id

Név	Típus	Leírás	Alapértelmezett
file_id	húr	Annak a fájlnak az azonosítója, amelyből az idézet származik.

idéz

Név	Típus	Leírás	Alapértelmezett
idéz	húr	Az adott idézet a fájlban.

típus Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

Érték	Leírás
file_citation

messageDeltaContentTextAnnotationsFilePathObject

A fájl URL-címe, amely akkor jön létre, amikor az asszisztens az code_interpreter eszközt használta a fájl létrehozásához.

Név	Típus	Leírás	Kötelező
index	egész szám	A jegyzet indexe a szöveges tartalomrészben.	Igen
típus	húr	Mindig `file_path`.	Igen
text	húr	Az üzenet tartalmának lecserélendő szövege.	Nem
file_path	object		Nem
start_index	egész szám		Nem
end_index	egész szám		Nem

A file_path tulajdonságai

file_id

Név	Típus	Leírás	Alapértelmezett
file_id	húr	A létrehozott fájl azonosítója.

típus Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

Érték	Leírás
file_path

runStepObject

Egy futtatás végrehajtásának lépését jelöli.

Név	Típus	Leírás	Kötelező
id	húr	A futtatási lépés azonosítója, amelyre az API-végpontokban lehet hivatkozni.	Igen
object	húr	Az objektum típusa, amely mindig `assistant.run.step`.	Igen
created_at	egész szám	A Unix időbélyege (másodpercben) a futtatási lépés létrehozásakor.	Igen
assistant_id	húr	A futtatási lépéshez társított asszisztens azonosítója.	Igen
thread_id	húr	A futtatott szál azonosítója.	Igen
run_id	húr	Annak a futtatásnak az azonosítója, amelybe ez a futtatási lépés tartozik.	Igen
típus	húr	A futtatási lépés típusa, amely lehet vagy `message_creationtool_calls`.	Igen
status	húr	A futtatás állapota, amely lehet `in_progress`, `cancelled`, `failed`, `completed`vagy `expired`.	Igen
step_details	runStepDetailsMessageCreationObject vagy runStepDetailsToolCallsObject	A futtatási lépés részletei.	Igen
last_error	object	A futtatási lépéshez tartozó utolsó hiba. Az lesz, `null` ha nincsenek hibák.	Igen
expired_at	egész szám	A Unix időbélyege (másodpercben) arra az időre, amikor a futtatási lépés lejárt. A rendszer lejártnak tekint egy lépést, ha a szülőfuttatás lejárt.	Igen
cancelled_at	egész szám	A Unix időbélyege (másodpercben) arra az időre, amikor a futtatási lépést megszakították.	Igen
failed_at	egész szám	A Unix időbélyege (másodpercben) arra az időre, amikor a futtatási lépés sikertelen volt.	Igen
completed_at	egész szám	A Unix időbélyege (másodpercben) arra az időre, amikor a futtatási lépés befejeződött.	Igen
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Igen

A last_error tulajdonságai

code

Név	Típus	Leírás	Alapértelmezett
code	húr	Az egyik vagy `server_errorrate_limit_exceeded`a másik.

üzenet

Név	Típus	Leírás	Alapértelmezett
üzenet	húr	A hiba ember által olvasható leírása.

object Enum: RunStepObjectType

Érték	Leírás
assistant.run.step	Az objektum típusa, amely mindig `assistant.run.step`

típus Enum: RunStepObjectType

Érték	Leírás
message_creation	A message_creation futtatási lépés
tool_calls	A tool_calls futtatási lépés

status Enum: RunStepObjectStatus

Érték	Leírás
in_progress	A in_progress futtatási állapota
Törölt	A megszakított futtatás állapota
sikertelen	A megszakított futtatás állapota
kész	A megszakított futtatás állapota
Lejárt	A megszakított futtatás állapota

runStepDeltaObject

Egy futtatási lépés változását jelöli, azaz a futtatási lépésben a streamelés során módosított mezőket.

Név	Típus	Leírás	Kötelező
id	húr	A futtatási lépés azonosítója, amelyre az API-végpontokban lehet hivatkozni.	Igen
object	húr	Az objektum típusa, amely mindig `thread.run.step.delta`.	Igen
delta	object	A futtatási lépésben módosult mezőket tartalmazó változás.	Igen

A delta tulajdonságai

step_details

Név	Típus	Leírás	Alapértelmezett
step_details	runStepDeltaStepDetailsMessageCreationObject vagy runStepDeltaStepDetailsToolCallsObject	A futtatási lépés részletei.

object Enum: RunStepDeltaObjectType

Érték	Leírás
thread.run.step.delta

listRunStepsResponse

Név	Típus	Kötelező
object	sztring	Igen
adatok	array	Igen
first_id	sztring	Igen
last_id	sztring	Igen
has_more	Logikai	Igen

runStepDetailsMessageCreationObject

Az üzenet futási lépéssel történő létrehozásának részletei.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	Mindig `message_creation`.	Igen
message_creation	object		Igen

A message_creation tulajdonságai

message_id

Név	Típus	Leírás	Alapértelmezett
message_id	húr	A futtatási lépés által létrehozott üzenet azonosítója.

típus Enum: RunStepDetailsMessageCreationObjectType

Érték	Leírás
message_creation

runStepDeltaStepDetailsMessageCreationObject

Az üzenet futási lépéssel történő létrehozásának részletei.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	Mindig `message_creation`.	Igen
message_creation	object		Nem

A message_creation tulajdonságai

message_id

Név	Típus	Leírás	Alapértelmezett
message_id	húr	A futtatási lépés által létrehozott üzenet azonosítója.

típus Enum: RunStepDeltaStepDetailsMessageCreationObjectType

Érték	Leírás
message_creation

runStepDetailsToolCallsObject

Az eszközhívás részletei.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	Mindig `tool_calls`.	Igen
tool_calls	array	A futtatási lépésben egy eszközhívási tömb vett részt. Ezek a három eszköztípus egyikéhez társíthatók: `code_interpreter`vagy `retrievalfunction`.	Igen

típus Enum: RunStepDetailsToolCallsObjectType

Érték	Leírás
tool_calls

runStepDeltaStepDetailsToolCallsObject

Az eszközhívás részletei.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	Mindig `tool_calls`.	Igen
tool_calls	array	A futtatási lépésben egy eszközhívási tömb vett részt. Ezek a három eszköztípus egyikéhez társíthatók: `code_interpreter`vagy `file_searchfunction`.	Nem

típus Enum: RunStepDeltaStepDetailsToolCallsObjectType

Érték	Leírás
tool_calls

runStepDetailsToolCallsCodeObject

A kódértelmező eszköz a futtatási lépés meghívásával kapcsolatos részletekkel foglalkozott.

Név	Típus	Leírás	Kötelező
id	húr	Az eszközhívás azonosítója.	Igen
típus	húr	Az eszközhívás típusa. Ez mindig az ilyen típusú eszközhívásokhoz lesz `code_interpreter` .	Igen
code_interpreter	object	A Kódértelmező eszköz hívásdefiníciója.	Igen

A code_interpreter tulajdonságai

bemenet

Név	Típus	Leírás	Alapértelmezett
bemenet	húr	A Kódértelmező eszköz hívásának bemenete.

Kimenetek

Név	Típus	Leírás	Alapértelmezett
Kimenetek	array	A Kódértelmező eszköz hívásának kimenetei. A Kódértelmező egy vagy több elemet is képes kiírni, beleértve a szöveget (`logs`) vagy a képeket (`image`). Ezek mindegyikét egy másik objektumtípus jelöli.

típus Enum: RunStepDetailsToolCallsCodeObjectType

Érték	Leírás
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

A kódértelmező eszköz a futtatási lépés meghívásával kapcsolatos részletekkel foglalkozott.

Név	Típus	Leírás	Kötelező
index	egész szám	Az eszközhívás indexe az eszközhívási tömbben.	Igen
id	húr	Az eszközhívás azonosítója.	Nem
típus	húr	Az eszközhívás típusa. Ez mindig az ilyen típusú eszközhívásokhoz lesz `code_interpreter` .	Igen
code_interpreter	object	A Kódértelmező eszköz hívásdefiníciója.	Nem

A code_interpreter tulajdonságai

bemenet

Név	Típus	Leírás	Alapértelmezett
bemenet	húr	A Kódértelmező eszköz hívásának bemenete.

Kimenetek

Név	Típus	Leírás	Alapértelmezett
Kimenetek	array	A Kódértelmező eszköz hívásának kimenetei. A Kódértelmező egy vagy több elemet is képes kiírni, beleértve a szöveget (`logs`) vagy a képeket (`image`). Ezek mindegyikét egy másik objektumtípus jelöli.

típus Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

Érték	Leírás
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

A Kódértelmezési eszköz szöveges kimenete egy futtatási lépés részeként hívható meg.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	Mindig `logs`.	Igen
naplók	húr	A Kódértelmező eszköz hívásának szöveges kimenete.	Igen

típus Enum: RunStepDetailsToolCallsCodeOutputLogsObjectType

Érték	Leírás
naplók

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

A Kódértelmezési eszköz szöveges kimenete egy futtatási lépés részeként hívható meg.

Név	Típus	Leírás	Kötelező
index	egész szám	A kimenet indexe a kimeneti tömbben.	Igen
típus	húr	Mindig `logs`.	Igen
naplók	húr	A Kódértelmező eszköz hívásának szöveges kimenete.	Nem

típus Enum: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

Érték	Leírás
naplók

runStepDetailsToolCallsCodeOutputImageObject

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	Mindig `image`.	Igen
rendszerkép	object		Igen

A kép tulajdonságai

file_id

Név	Típus	Leírás	Alapértelmezett
file_id	húr	A kép fájlazonosítója.

típus Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

Érték	Leírás
rendszerkép

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Név	Típus	Leírás	Kötelező
index	egész szám	A kimenet indexe a kimeneti tömbben.	Igen
típus	húr	Mindig `image`.	Igen
rendszerkép	object		Nem

A kép tulajdonságai

file_id

Név	Típus	Leírás	Alapértelmezett
file_id	húr	A kép fájlazonosítója.

típus Enum: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

Érték	Leírás
rendszerkép

runStepDetailsToolCallsFileSearchObject

Név	Típus	Leírás	Kötelező
id	húr	Az eszköz hívási objektumának azonosítója.	Igen
típus	húr	Az eszközhívás típusa. Ez mindig az ilyen típusú eszközhívásokhoz lesz `file_search` .	Igen
file_search	object	Egyelőre ez mindig üres objektum lesz.	Igen

A file_search tulajdonságai

eredmények

Név	Típus	Leírás	Alapértelmezett
eredmények	array	A fájlkeresés eredményei.

típus Enum: RunStepDetailsToolCallsFileSearchObjectType

Érték	Leírás
file_search

runStepDetailsToolCallsFileSearchResultObject

A fájlkeresés eredménypéldánya.

Név	Típus	Leírás	Kötelező
file_id	húr	Az eredményként kapott fájl azonosítója.	Igen
file_name	húr	Az eredményként kapott fájl neve.	Igen
pontszám	szám	Az eredmény pontszáma. Minden értéknek 0 és 1 közötti lebegőpontos számnak kell lennie.	Igen
content	array	A talált eredmény tartalma. A tartalom csak akkor lesz belefoglalva, ha a belefoglalási lekérdezési paraméteren keresztül kérik.	Nem

runStepDeltaStepDetailsToolCallsFileSearchObject

Név	Típus	Leírás	Kötelező
index	egész szám	Az eszközhívás indexe az eszközhívási tömbben.	Igen
id	húr	Az eszköz hívási objektumának azonosítója.	Nem
típus	húr	Az eszközhívás típusa. Ez mindig az ilyen típusú eszközhívásokhoz lesz `retrieval` .	Igen
file_search	object	Egyelőre ez mindig üres objektum lesz.	Igen

típus Enum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Érték	Leírás
file_search

runStepDetailsToolCallsFunctionObject

Név	Típus	Leírás	Kötelező
id	húr	Az eszköz hívási objektumának azonosítója.	Igen
típus	húr	Az eszközhívás típusa. Ez mindig az ilyen típusú eszközhívásokhoz lesz `function` .	Igen
függvény	object	A meghívott függvény definíciója.	Igen

Függvény tulajdonságai

név

Név	Típus	Leírás	Alapértelmezett
név	húr	A függvény neve.

Érvek

Név	Típus	Leírás	Alapértelmezett
Érvek	húr	A függvénynek átadott argumentumok.

output

Név	Típus	Leírás	Alapértelmezett
output	húr	A függvény kimenete. Ez akkor lesz, `null` ha a kimenetek még nem lettek elküldve.

típus Enum: RunStepDetailsToolCallsFunctionObjectType

Érték	Leírás
függvény

runStepDeltaStepDetailsToolCallsFunctionObject

Név	Típus	Leírás	Kötelező
index	egész szám	Az eszközhívás indexe az eszközhívási tömbben.	Igen
id	húr	Az eszköz hívási objektumának azonosítója.	Nem
típus	húr	Az eszközhívás típusa. Ez mindig az ilyen típusú eszközhívásokhoz lesz `function` .	Igen
függvény	object	A meghívott függvény definíciója.	Nem

Függvény tulajdonságai

név

Név	Típus	Leírás	Alapértelmezett
név	húr	A függvény neve.

Érvek

Név	Típus	Leírás	Alapértelmezett
Érvek	húr	A függvénynek átadott argumentumok.

output

Név	Típus	Leírás	Alapértelmezett
output	húr	A függvény kimenete. Ez akkor lesz, `null` ha a kimenetek még nem lettek elküldve.

típus Enum: RunStepDetailsToolCallsFunctionObjectType

Érték	Leírás
függvény

vectorStoreExpirationAfter

A vektortároló lejárati szabályzata.

Név	Típus	Leírás	Kötelező	Alapértelmezett
horgony	húr	Horgony időbélyege, amely után a lejárati szabályzat érvényes. Támogatott horgonyok: `last_active_at`.	Igen
nap	egész szám	A vektortároló lejárati idejét követő napok száma.	Igen

horgony Enum: VectorStoreExpirationAfterAnchor

Érték	Leírás
last_active_at	A horgony időbélyege, amely után a lejárati szabályzat érvényes.

vectorStoreObject

A vektortár az eszköz által file_search használható feldolgozott fájlok gyűjteménye.

Név	Típus	Leírás	Kötelező
id	húr	Az API-végpontokban hivatkozható azonosító.	Igen
object	Enum	Az objektum típusa, amely mindig `vector_store`. Lehetséges értékek: vector_store	Igen
created_at	egész szám	A Unix időbélyege (másodpercben) a vektortároló létrehozásakor.	Igen
név	húr	A vektortároló neve.	Igen
usage_bytes	egész szám	A vektortárolóban lévő fájlok által használt bájtok teljes száma.	Igen
file_counts	object		Igen
status	húr	A vektortároló állapota, amely lehet `expired`, `in_progress`vagy `completed`. Az állapot `completed` azt jelzi, hogy a vektortároló használatra kész.	Igen
expires_after	vectorStoreExpirationAfter	A vektortároló lejárati szabályzata.	Nem
expires_at	egész szám	A Unix időbélyege (másodpercben) arra az időre, amikor a vektortároló lejár.	Nem
last_active_at	egész szám	A Unix időbélyege (másodpercben) arra az időre, amikor a vektortároló utoljára aktív volt.	Igen
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Igen

A file_counts tulajdonságai

in_progress

Név	Típus	Leírás	Alapértelmezett
in_progress	egész szám	A jelenleg feldolgozott fájlok száma.

kész

Név	Típus	Leírás	Alapértelmezett
kész	egész szám	A sikeresen feldolgozott fájlok száma.

sikertelen

Név	Típus	Leírás	Alapértelmezett
sikertelen	egész szám	A feldolgozni nem sikerült fájlok száma.

Törölt

Név	Típus	Leírás	Alapértelmezett
Törölt	egész szám	A törölt fájlok száma.

teljes

Név	Típus	Leírás	Alapértelmezett
teljes	egész szám	A fájlok teljes száma.

status Enum: VectorStoreObjectStatus

Érték	Leírás
Lejárt
in_progress
kész

createVectorStoreRequest

Név	Típus	Leírás	Kötelező
file_ids	array	A vektortároló által használandó fájlazonosítók listája. Olyan eszközök esetén hasznos, amelyek `file_search` hozzáférhetnek a fájlokhoz.	Nem
név	húr	A vektortároló neve.	Nem
expires_after	vectorStoreExpirationAfter	A vektortároló lejárati szabályzata.	Nem
chunking_strategy	autoChunkingStrategyRequestParam vagy staticChunkingStrategyRequestParam	A fájl(ok) darabolásához használt adattömb-stratégia. Ha nincs beállítva, használja a `auto` stratégiát. Csak akkor alkalmazható, ha `file_ids` nincs lehetőség.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem

updateVectorStoreRequest

Név	Típus	Leírás	Kötelező
név	húr	A vektortároló neve.	Nem
expires_after	vectorStoreExpirationAfter	A vektortároló lejárati szabályzata.	Nem
metaadatok	object	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektumra vonatkozó további információk strukturált formátumban történő tárolásához. A kulcsok legfeljebb 64 karakter hosszúak lehetnek, az értékek pedig legfeljebb 512 karakter hosszúak lehetnek.	Nem

listVectorStoresResponse

Név	Típus	Kötelező
object	sztring	Igen
adatok	array	Igen
first_id	sztring	Igen
last_id	sztring	Igen
has_more	Logikai	Igen

deleteVectorStoreResponse

Név	Típus	Kötelező
id	sztring	Igen
törölt	Logikai	Igen
object	sztring	Igen

object Enum: DeleteVectorStoreResponseObject

Érték	Leírás
vector_store.deleted	A törlési vektortároló válaszobjektumának állapota

vectorStoreFileObject

Vektortárolóhoz csatolt fájlok listája.

Név	Típus	Leírás	Kötelező
id	húr	Az API-végpontokban hivatkozható azonosító.	Igen
object	húr	Az objektum típusa, amely mindig `vector_store.file`.	Igen
usage_bytes	egész szám	A vektortárolók teljes kihasználtsága bájtban. Vegye figyelembe, hogy ez eltérhet az eredeti fájlmérettől.	Igen
created_at	egész szám	A Unix időbélyege (másodpercben) a vektortárfájl létrehozásakor.	Igen
vector_store_id	húr	Annak a vektortárolónak az azonosítója, amelyhez a fájl csatolva van.	Igen
status	húr	A vektortárfájl állapota, amely lehet `in_progress`, `completed`vagy `cancelledfailed`. Az állapot `completed` azt jelzi, hogy a vektortároló fájl használatra kész.	Igen
last_error	object	A vektortároló-fájlhoz társított utolsó hiba. Az lesz, `null` ha nincsenek hibák.	Igen
chunking_strategy	autoChunkingStrategyRequestParam vagy staticChunkingStrategyRequestParam	A fájl(ok) darabolásához használt adattömb-stratégia. Ha nincs beállítva, használja a `auto` stratégiát. Csak akkor alkalmazható, ha `file_ids` nincs lehetőség.	Nem

A last_error tulajdonságai

code

Név	Típus	Leírás	Alapértelmezett
code	húr	Az egyik `server_error` vagy `invalid_fileunsupported_file`a másik.

üzenet

Név	Típus	Leírás	Alapértelmezett
üzenet	húr	A hiba ember által olvasható leírása.

object Enum: VectorStoreFileObjectType

Érték	Leírás
vector_store.file

status Enum: VectorStoreFileObjectStatus

Érték	Leírás
in_progress
kész
Törölt
sikertelen

otherChunkingStrategyResponseParam

Ezt akkor adja vissza a rendszer, ha az adattömb-készítési stratégia ismeretlen. Ennek általában az az oka, hogy a fájlt indexelték, mielőtt bevezették a chunking_strategy koncepciót az API-ban.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	Mindig `other`.	Igen

típus Enum: OtherChunkingStrategyResponseParamType

Érték	Leírás
egyéb

staticChunkingStrategyResponseParam

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	húr	Mindig `static`.	Igen
static	staticChunkingStrategy		Igen

típus Enum: StaticChunkingStrategyResponseParamType

Érték	Leírás
static

staticChunkingStrategy

Név	Típus	Leírás	Kötelező	Alapértelmezett
max_chunk_size_tokens	egész szám	Az egyes adattömbökben lévő tokenek maximális száma. Az alapértelmezett érték `800`. A minimális érték és `100` a maximális érték `4,096`.	Igen
chunk_overlap_tokens	egész szám	Az adattömbök között átfedésben lévő tokenek száma. Az alapértelmezett érték `400`. Vegye figyelembe, hogy az átfedés nem haladhatja meg a `max_chunk_size_tokens`felét.	Igen

autoChunkingStrategyRequestParam

Az alapértelmezett stratégia. Ez a stratégia jelenleg egy max_chunk_size_tokens és 800chunk_overlap_tokens több elemet 400használ.

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	Enum	Mindig `auto`. Lehetséges értékek: automatikus	Igen

staticChunkingStrategyRequestParam

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	Enum	Mindig `static`. Lehetséges értékek: statikus	Igen
static	staticChunkingStrategy		Igen

chunkingStrategyRequestParam

A fájl(ok) darabolásához használt adattömb-stratégia. Ha nincs beállítva, használja a auto stratégiát.

Ez az összetevő a következők egyike lehet:

createVectorStoreFileRequest

Név	Típus	Leírás	Kötelező	Alapértelmezett
file_id	húr	Egy fájlazonosító, amelyet a vektortárolónak használnia kell. Olyan eszközök esetén hasznos, amelyek `file_search` hozzáférhetnek a fájlokhoz.	Igen
chunking_strategy	chunkingStrategyRequestParam	A fájl(ok) darabolásához használt adattömb-stratégia. Ha nincs beállítva, használja a `auto` stratégiát.	Nem

listVectorStoreFilesResponse

Név	Típus	Kötelező
object	sztring	Igen
adatok	array	Igen
first_id	sztring	Igen
last_id	sztring	Igen
has_more	Logikai	Igen

deleteVectorStoreFileResponse

Név	Típus	Kötelező
id	sztring	Igen
törölt	Logikai	Igen
object	sztring	Igen

object Enum: DeleteVectorStoreFileResponseObject

Érték	Leírás
vector_store.file.deleted

vectorStoreFileBatchObject

Egy vektortárolóhoz csatolt fájlköteg.

Név	Típus	Leírás	Kötelező
id	húr	Az API-végpontokban hivatkozható azonosító.	Igen
object	húr	Az objektum típusa, amely mindig `vector_store.file_batch`.	Igen
created_at	egész szám	A Vektortár-fájlok kötegének létrehozásakor használt Unix-időbélyeg (másodpercben).	Igen
vector_store_id	húr	Annak a vektortárolónak az azonosítója, amelyhez a fájl csatolva van.	Igen
status	húr	A vektortároló fájlok kötegének állapota, amely lehet `in_progress`, `completedcancelled` vagy `failed`.	Igen
file_counts	object		Igen

A file_counts tulajdonságai

in_progress

Név	Típus	Leírás	Alapértelmezett
in_progress	egész szám	A jelenleg feldolgozott fájlok száma.

kész

Név	Típus	Leírás	Alapértelmezett
kész	egész szám	A feldolgozott fájlok száma.

sikertelen

Név	Típus	Leírás	Alapértelmezett
sikertelen	egész szám	A feldolgozni nem sikerült fájlok száma.

Törölt

Név	Típus	Leírás	Alapértelmezett
Törölt	egész szám	A törölt fájlok száma.

teljes

Név	Típus	Leírás	Alapértelmezett
teljes	egész szám	A fájlok teljes száma.

object Enum: VectorStoreFileBatchObjectType

Érték	Leírás
vector_store.files_batch

status Enum: VectorStoreFileBatchObjectStatus

Érték	Leírás
in_progress
kész
Törölt
sikertelen

createVectorStoreFileBatchRequest

Név	Típus	Leírás	Kötelező	Alapértelmezett
file_ids	array	A vektortároló által használandó fájlazonosítók listája. Olyan eszközök esetén hasznos, amelyek `file_search` hozzáférhetnek a fájlokhoz.	Igen
chunking_strategy	chunkingStrategyRequestParam	A fájl(ok) darabolásához használt adattömb-stratégia. Ha nincs beállítva, használja a `auto` stratégiát.	Nem

assistantStreamEvent

Futtatás streamelésekor kibocsátott eseményt jelöl.

A kiszolgáló által küldött eseményfolyam minden eseménye rendelkezik és eventdata tulajdonsága van:

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

Eseményeket bocsátunk ki, amikor új objektum jön létre, áttűn egy új állapotra, vagy részekben (eltérésekben) streameljük őket. Kibocsátjuk thread.run.created például egy új futtatás létrehozásakor, thread.run.completed a futtatás befejeződésekor stb. Amikor egy asszisztens úgy dönt, hogy egy futtatás során üzenetet hoz létre, egy, egy thread.message.in_progress eseményt, számos thread.message.delta eseményt és végül egy eseményt thread.message.completed bocsátunk kithread.message.created event.

Idővel további eseményeket is hozzáadhatunk, ezért javasoljuk, hogy az ismeretlen eseményeket a kódban gondosan kezelje.

Ez az összetevő a következők egyike lehet:

threadStreamEvent

Ez az összetevő a következők egyike lehet:

thread.created

Új szál létrehozásakor következik be.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	threadObject	Üzeneteket tartalmazó szálat jelöl.	Igen

Adatok: threadObject

Event Enum: ThreadStreamEventEnum

Érték	Leírás
thread.created	A szál által létrehozott esemény

runStreamEvent

Ez az összetevő a következők egyike lehet:

thread.run.created

Új futtatás létrehozásakor következik be.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runObject	Egy szálon futtatott végrehajtást jelöl.	Igen

Adatok: runObject

Event Enum: RunStreamEventCreated

Érték	Leírás
thread.run.created

thread.run.queued

Akkor fordul elő, ha egy futtatás állapotba queued kerül.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runObject	Egy szálon futtatott végrehajtást jelöl.	Igen

Adatok: runObject

Event Enum: RunStreamEventQueued

Érték	Leírás
thread.run.queued

thread.run.in_progress

Akkor fordul elő, ha egy futtatás állapotba in_progress kerül.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runObject	Egy szálon futtatott végrehajtást jelöl.	Igen

Adatok: runObject

Event Enum: RunStreamEventInProgress

Érték	Leírás
thread.run.in_progress

thread.run.requires_action

Akkor fordul elő, ha egy futtatás állapotba requires_action kerül.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runObject	Egy szálon futtatott végrehajtást jelöl.	Igen

Adatok: runObject

Event Enum: RunStreamEventRequiresAction

Érték	Leírás
thread.run.requires_action

thread.run.completed

A futtatás befejezésekor következik be.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runObject	Egy szálon futtatott végrehajtást jelöl.	Igen

Adatok: runObject

Event Enum: RunStreamEventCompleted

Érték	Leírás
thread.run.completed

thread.run.failed

Akkor fordul elő, ha egy futtatás meghiúsul.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runObject	Egy szálon futtatott végrehajtást jelöl.	Igen

Adatok: runObject

Event Enum: RunStreamEventFailed

Érték	Leírás
thread.run.failed

thread.run.cancelling

Akkor fordul elő, ha egy futtatás állapotba cancelling kerül.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runObject	Egy szálon futtatott végrehajtást jelöl.	Igen

Adatok: runObject

Event Enum: RunStreamEventCancelling

Érték	Leírás
thread.run.cancelling

thread.run.cancelled

A futtatás megszakításakor következik be.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runObject	Egy szálon futtatott végrehajtást jelöl.	Igen

Adatok: runObject

Event Enum: RunStreamEventCancelled

Érték	Leírás
thread.run.cancelled

thread.run.expired

A futtatás lejáratakor következik be.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runObject	Egy szálon futtatott végrehajtást jelöl.	Igen

Adatok: runObject

Event Enum: RunStreamEventExpired

Érték	Leírás
thread.run.expired

runStepStreamEvent

Ez az összetevő a következők egyike lehet:

thread.run.step.created

Futtatási lépés létrehozásakor következik be.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runStepObject	Egy futtatás végrehajtásának lépését jelöli.	Igen

Adatok: runStepObject

Event Enum: RunStepStreamEventCreated

Érték	Leírás
thread.run.step.created

thread.run.step.in_progress

Akkor fordul elő, ha egy futtatási lépés egy in_progress állapotba kerül.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runStepObject	Egy futtatás végrehajtásának lépését jelöli.	Igen

Adatok: runStepObject

Event Enum: RunStepStreamEventInProgress

Érték	Leírás
thread.run.step.in_progress

thread.run.step.delta

Akkor fordul elő, ha egy futtatási lépés egyes részeit streameli.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runStepDeltaObject	Egy futtatási lépés változását jelöli, azaz a futtatási lépésben a streamelés során módosított mezőket.	Igen

Adatok: runStepDeltaObject

Event Enum: RunStepStreamEventDelta

Érték	Leírás
thread.run.step.delta

thread.run.step.completed

A futtatási lépés befejezésekor következik be.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runStepObject	Egy futtatás végrehajtásának lépését jelöli.	Igen

Adatok: runStepObject

Event Enum: RunStepStreamEventCompleted

Érték	Leírás
thread.run.step.completed

thread.run.step.failed

Akkor fordul elő, ha egy futtatási lépés meghiúsul.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runStepObject	Egy futtatás végrehajtásának lépését jelöli.	Igen

Adatok: runStepObject

Event Enum: RunStepStreamEventFailed

Érték	Leírás
thread.run.step.failed

thread.run.step.cancelled

Egy futtatási lépés megszakításakor következik be.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runStepObject	Egy futtatás végrehajtásának lépését jelöli.	Igen

Adatok: runStepObject

Event Enum: RunStepStreamEventCancelled

Érték	Leírás
thread.run.step.cancelled

thread.run.step.expired

A futtatási lépés lejáratakor következik be.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	runStepObject	Egy futtatás végrehajtásának lépését jelöli.	Igen

Adatok: runStepObject

Event Enum: RunStepStreamEventExpired

Érték	Leírás
thread.run.step.expired

messageStreamEvent

Ez az összetevő a következők egyike lehet:

thread.message.created

Üzenet létrehozásakor következik be.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	messageObject	Egy szálon belüli üzenetet jelöl.	Igen

Adatok: messageObject

Event Enum: MessageStreamEventCreated

Érték	Leírás
thread.message.created

thread.message.in_progress

Akkor fordul elő, ha egy üzenet egy in_progress állapotba kerül.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	messageObject	Egy szálon belüli üzenetet jelöl.	Igen

Adatok: messageObject

Event Enum: MessageStreamEventInProgress

Érték	Leírás
thread.message.in_progress

thread.message.delta

Az üzenet egyes részeinek streamelésekor fordul elő.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	messageDeltaObject	Üzenetváltozást jelöl, azaz az üzenet módosított mezőit a streamelés során.	Igen

Adatok: messageDeltaObject

Event Enum: MessageStreamEventDelta

Érték	Leírás
thread.message.delta

thread.message.completed

Üzenet befejezésekor következik be.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	messageObject	Egy szálon belüli üzenetet jelöl.	Igen

Adatok: messageObject

Event Enum: MessageStreamEventCompleted

Érték	Leírás
thread.message.completed

thread.message.incomplete

Akkor fordul elő, ha egy üzenet befejeződik, mielőtt befejeződne.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	messageObject	Egy szálon belüli üzenetet jelöl.	Igen

Adatok: messageObject

Event Enum: MessageStreamEventIncomplete

Érték	Leírás
thread.message.incomplete

errorEvent

Hiba esetén fordul elő. Ez belső kiszolgálóhiba vagy időtúllépés miatt fordulhat elő.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	hiba		Igen

event Enum: ErrorEventEnum

Érték	Leírás
hiba

doneEvent

Akkor fordul elő, ha egy stream véget ér.

Név	Típus	Leírás	Kötelező	Alapértelmezett
esemény	sztring		Igen
adatok	sztring		Igen

event Enum: DoneEventEnum

Érték	Leírás
kész

data Enum: DoneEventDataEnum

Érték	Leírás
[KÉSZ]

Következő lépések

Ismerje meg a modelleket , és finomhangoljon a REST API-val. További információ az Azure OpenAI-t használó mögöttes modellekről.

Megosztás a következőn keresztül:

Az Azure OpenAI Service REST API előzetes verziójának referenciája

API-specifikációk

Hitelesítés

REST API-verziószámozás

Adatsík-következtetés

Befejezések – Létrehozás

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Példák

Példa

Beágyazások – Létrehozás

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Használati tulajdonságok

prompt_tokens

total_tokens

Példák

Példa

Csevegés befejezése – Létrehozás

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Hangtulajdonságok

voice

format

Válaszok

Példák

Példa

Példa

Példa

Példa

Példa

Példa

Példa

Példa

Átiratok – Létrehozás

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Példák

Példa

Példa

Fordítások – Létrehozás

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Példák

Példa

Példa

Beszéd – Létrehozás

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Példák

Példa

Képgenerációk – Létrehozás

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Példák

Példa

Lista – Asszisztensek

URI-paraméterek

Kérelem fejléce

Válaszok

Példák

Példa

Létrehozás – Asszisztens

URI-paraméterek

Kérelem fejléce

Kérelem törzse