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

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-04-01-preview	2023-05-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	2024-05-01-preview	2024-06-01	Spec fájlok	Az adatsík-létrehozó API szabályozza a finomhangolást, a fájlfeltöltést, a betöltési feladatokat és bizonyos modellszintű lekérdezéseket
Adatsík – következtetés	2024-05-01-preview	2024-06-01	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/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 2024-05-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=2024-05-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 sztringek vagy sztringek tömbjeként kódolt befejezések létrehozására szolgáló kérés(ek). 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. A sztringlista maximális mérete 2048.	Nem
max_tokens	egész szám	A parancssor és a max_tokens tokenszáma nem haladhatja meg a modell környezethosszát. A legtöbb modell környezethossza 2048 token (kivéve a legújabb modelleket, amelyek támogatják a 4096-ot). Legalább 0.	Nem	16
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni. A magasabb értékek azt jelentik, hogy a modell több kockázatot vállal. A kreatívabb alkalmazásokhoz próbálja ki a 0.9-et, és a 0-t (arg maximális mintavételezést) a jól meghatározott válaszokkal rendelkezők számára. Általában azt javasoljuk, hogy módosítsa ezt vagy top_p, de mindkettőt nem.	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
logit_bias	object	Alapértelmezés szerint null. Módosítsa annak valószínűségét, hogy a megadott jogkivonatok megjelenjenek a befejezéskor. Elfogad egy json-objektumot, amely a jogkivonatokat (a GPT-tokenizerben megadott jogkivonat-azonosítójuk alapján) -100-ról 100-ra képez le egy társított elfogultsági értékre. Ezzel a tokenizer eszközzel (amely a GPT-2 és a GPT-3 esetében is működik) a szöveget tokenazonosítókká alakíthatja. 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. Például átadhatja a(z) {"50256":-100} értéket a <(z) |endoftext|> jogkivonat létrehozásának megakadályozásához.	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
n	egész szám	Hány befejezést kell létrehozni az egyes kérésekhez. Legalább 1 és legfeljebb 128 engedélyezett. 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 biztosít a max_tokens és a leállításhoz.	Nem	0
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 adat leállítja: [KÉSZ] üzenet.	Nem	Hamis
logprobs	egész szám	Adja meg a naplóprobok legvalószínűbb tokenjeinek napló valószínűségét, valamint a kiválasztott jogkivonatokat. Ha például a logprobs értéke 5, az API az 5 legvalószínűbb token listáját adja vissza. Az API mindig visszaadja a mintául szolgáló jogkivonat naplóprobját, így akár logprobs+1 elemek is lehetnek a válaszban. Legalább 0 és legfeljebb 5 engedélyezett.	Nem	Egyik sem
toldalék	húr	A beszúrt szöveg befejezése után megjelenő utótag.	Nem
echo	Logikai	A befejezés mellett a kérést is vissza kell adni	Nem	Hamis
állj	sztring vagy tömb	Legfeljebb 4 sorozat, ahol 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
completion_config	húr		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
best_of	egész szám	Létrehozza best_of kiszolgálóoldali befejezéseket, és a "legjobb" értéket adja vissza (a tokenenkénti legnagyobb naplózási valószínűséggel rendelkezőt). Az eredmények nem streamelhetők. Az n használatakor best_of határozza meg a jelölt befejezések számát, az n pedig azt határozza meg, hogy hányat kell visszaadni – best_of n-nél 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 biztosít a max_tokens és a leállításhoz. Maximális értéke 128.	Nem

Válaszok

Név	Típus	Leírás	Kötelező	Alapértelmezett
id	sztring		Igen
object	sztring		Igen
Létrehozott	egész szám		Igen
modell	sztring		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érelmek 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		Igen
használat	object		Nem

Használati tulajdonságok

completion_tokens

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

prompt_tokens

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

total_tokens

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

Állapotkód: 200

Leírás: OK

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

Á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=2024-05-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=2024-05-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ő	Alapértelmezett
bemenet	sztring vagy tömb	Beviteli szöveg a beágyazások lekéréséhez, sztringként kódolva. Ha több bemenet beágyazását szeretné lekérni egyetlen kérelemben, adjon át egy sztringtömböt. Az egyes bemenetek hossza nem haladhatja meg a 2048-at. Ha nem ágyaz be kódot, javasoljuk, hogy az új vonalakat (\n) cserélje le egyetlen szóközre a bemenetben, mivel alacsonyabb eredményeket észleltünk, amikor új vonalak vannak jelen.	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 float base64. 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	Leírás	Kötelező	Alapértelmezett
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=2024-05-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.017537864,
          -0.0020113448
        ]
      }
    ],
    "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=2024-05-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 4 sorozat, ahol 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.	Nem	4096
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
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
üzenet	array	Az eddig a beszélgetésből álló üzenetek listája. Példa Python-kódra.	Nem
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
n	egész szám	Hány csevegés-befejezési lehetőséget kell létrehozni az egyes bemeneti üzenetekhez.	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	0
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: . Ez a lehetőség jelenleg nem érhető el a gpt-4-vision-preview modellen.	Nem	Hamis
top_logprobs	egész szám	0 és 5 közötti egész szám, amely megadja, hogy az egyes tokenhelyzetekben a legvalószínűbb tokenek száma hány, és mindegyikhez tartozik napló valószínűsége. logprobs ezt a paramétert true kell beállítani.	Nem
response_format	object	Egy objektum, amely megadja a modell által kiadandó formátumot. A JSON mód engedélyezésére szolgál.	Nem
eszközök	array	A modell által meghívni kívánt 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.	Nem
tool_choice	chatCompletionToolChoiceOption	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 {"type": "function", "function": {"name": "my_function"}} a modellt.	Nem
functions	array	Elavult a javára tools. Azon függvények listája, amelyekhez a modell JSON-bemeneteket hozhat létre.	Nem
function_call	sztring vagy objektum	Elavult a javára tool_choice. Szabályozza, hogy a modell hogyan reagál a függvényhívásokra. A "none" azt jelenti, hogy a modell nem hív meg függvényt, és válaszol a végfelhasználónak. Az "auto" azt jelenti, hogy a modell választhat a végfelhasználók között, vagy meghívhat egy függvényt. Egy adott függvény megadása a modell meghívására kényszeríti {"name":\ "my_function"} a modellt. A "none" az alapértelmezett, ha nincsenek függvények. Az "auto" az alapértelmezett, ha függvények vannak jelen.	Nem

A response_format tulajdonságai

Típus

Név	Típus	Leírás	Alapértelmezett
típus	chatCompletionResponseFormat	json_object A JSON mód engedélyezése beállítás. Ez garantálja, hogy a modell által generált üzenet érvényes JSON-alapú.	text

Válaszok

Állapotkód: 200

Leírás: OK

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

Á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=2024-05-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 might 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=2024-05-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=2024-05-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=2024-05-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 AML-indexhez.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_ml_index",
   "parameters": {
    "project_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-id}",
    "name": "gm-cars",
    "version": "5",
    "authentication": {
     "type": "access_token",
     "access_token": "{access-token}"
    }
   }
  }
 ]
}

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",
                "file_path": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intents": [
              "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=2024-05-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

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

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

Képköteg létrehozása szöveges feliratból egy adott DALL-E modelltelepítésen

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 DALL-E .
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=2024-05-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=2024-05-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=2024-05-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=2024-05-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, retrievalvagy 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-4 Turbo és az összes GPT-3.5 Turbo modell azóta gpt-3.5-turbo-1106. 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 előfordulhat, hogy a modell egy névtelen térfolyamot hoz létre, amíg a generáció el nem éri a jogkivonat korlátját, ami hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részben megszakadhat, ha finish_reason="length"az azt jelzi, hogy a generálá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ó. Az asszisztenshez legfeljebb 1 vektortároló csatolható.
vector_stores	array	Segéd egy vektortároló létrehozásához file_ids és csatolja az asszisztenshez. Az asszisztenshez legfeljebb 1 vektortároló csatolható.

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=2024-05-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=2024-05-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=2024-05-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=2024-05-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 32768 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, retrievalvagy 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-4 Turbo és az összes GPT-3.5 Turbo modell azóta gpt-3.5-turbo-1106. 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 előfordulhat, hogy a modell egy névtelen térfolyamot hoz létre, amíg a generáció el nem éri a jogkivonat korlátját, ami hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részben megszakadhat, ha finish_reason="length"az azt jelzi, hogy a generálá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. Az asszisztenshez legfeljebb 1 vektortároló csatolható.

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=2024-05-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=2024-05-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=2024-05-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=2024-05-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ő	Alapértelmezett
ü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 1 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 1 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=2024-05-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=2024-05-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=2024-05-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=2024-05-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 1 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=2024-05-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=2024-05-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=2024-05-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=2024-05-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=2024-05-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=2024-05-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ő	Alapértelmezett
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=2024-05-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=2024-05-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=2024-05-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=2024-05-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=2024-05-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=2024-05-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
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 incompletefejező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 incompletefejező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
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4 Turbo és az összes GPT-3.5 Turbo modell azóta gpt-3.5-turbo-1106. 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 előfordulhat, hogy a modell egy névtelen térfolyamot hoz létre, amíg a generáció el nem éri a jogkivonat korlátját, ami hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részben megszakadhat, ha finish_reason="length"az azt jelzi, hogy a generálá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. Az asszisztenshez legfeljebb 1 vektortároló csatolható.

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=2024-05-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=2024-05-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=2024-05-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=2024-05-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
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 incompletefejező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 incompletefejező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
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4 Turbo és az összes GPT-3.5 Turbo modell azóta gpt-3.5-turbo-1106. 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 előfordulhat, hogy a modell egy névtelen térfolyamot hoz létre, amíg a generáció el nem éri a jogkivonat korlátját, ami hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részben megszakadhat, ha finish_reason="length"az azt jelzi, hogy a generálá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=2024-05-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=2024-05-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=2024-05-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=2024-05-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=2024-05-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=2024-05-01-preview

Ha egy futtatás rendelkezik a status: "requires_action" következővel, required_action.type submit_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

Ha egy futtatás rendelkezik a status: "requires_action" következővel, required_action.type submit_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.

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

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=2024-05-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=2024-05-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
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=2024-05-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=2024-05-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=2024-05-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=2024-05-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ő	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.	Nem
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

Vektortárolót hoz létre.

POST https://{endpoint}/openai/vector_stores?api-version=2024-05-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=2024-05-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=2024-05-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=2024-05-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ő	Alapértelmezett
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=2024-05-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=2024-05-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=2024-05-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=2024-05-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=2024-05-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=2024-05-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

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=2024-05-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=2024-05-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=2024-05-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=2024-05-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=2024-05-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=2024-05-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

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=2024-05-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=2024-05-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=2024-05-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=2024-05-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=2024-05-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=2024-05-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=2024-05-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
error	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ő	Alapértelmezett
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
error	dalleError		Nem

dalleError

Név	Típus	Leírás	Kötelező	Alapértelmezett
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ő	Alapértelmezett
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

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

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ő	Alapértelmezett
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
error	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ő	Alapértelmezett
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
error	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ő	Alapértelmezett
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
error	errorBase		Nem
protected_material_text	contentFilterDetectedResult		Nem
protected_material_code	contentFilterDetectedWithCitationResult		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érelmek 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	Leírás	Kötelező	Alapértelmezett
szexuális	contentFilterSeverityResult		Nem
erőszak	contentFilterSeverityResult		Nem
gyűlölet	contentFilterSeverityResult		Nem
self_harm	contentFilterSeverityResult		Nem

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.

Név	Típus	Leírás	Kötelező	Alapértelmezett
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 4 sorozat, ahol 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.	Nem	4096
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
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

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 4 sorozat, ahol 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.	Nem	4096
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
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
üzenet	array	Az eddig a beszélgetésből álló üzenetek listája. Példa Python-kódra.	Nem
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
n	egész szám	Hány csevegés-befejezési lehetőséget kell létrehozni az egyes bemeneti üzenetekhez.	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	0
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: . Ez a lehetőség jelenleg nem érhető el a gpt-4-vision-preview modellen.	Nem	Hamis
top_logprobs	egész szám	0 és 5 közötti egész szám, amely megadja, hogy az egyes tokenhelyzetekben a legvalószínűbb tokenek száma hány, és mindegyikhez tartozik napló valószínűsége. logprobs ezt a paramétert true kell beállítani.	Nem
response_format	object	Egy objektum, amely megadja a modell által kiadandó formátumot. A JSON mód engedélyezésére szolgál.	Nem
eszközök	array	A modell által meghívni kívánt 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.	Nem
tool_choice	chatCompletionToolChoiceOption	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 {"type": "function", "function": {"name": "my_function"}} a modellt.	Nem
functions	array	Elavult a javára tools. Azon függvények listája, amelyekhez a modell JSON-bemeneteket hozhat létre.	Nem
function_call	sztring vagy objektum	Elavult a javára tool_choice. Szabályozza, hogy a modell hogyan reagál a függvényhívásokra. A "none" azt jelenti, hogy a modell nem hív meg függvényt, és válaszol a végfelhasználónak. Az "auto" azt jelenti, hogy a modell választhat a végfelhasználók között, vagy meghívhat egy függvényt. Egy adott függvény megadása a modell meghívására kényszeríti {"name":\ "my_function"} a modellt. A "none" az alapértelmezett, ha nincsenek függvények. Az "auto" az alapértelmezett, ha függvények vannak jelen.	Nem

A response_format tulajdonságai

Típus

Név	Típus	Leírás	Alapértelmezett
típus	chatCompletionResponseFormat	json_object A JSON mód engedélyezése beállítás. Ez garantálja, hogy a modell által generált üzenet érvényes JSON-alapú.	text

chatCompletionResponseFormat

json_object A JSON mód engedélyezése beállítás. Ez garantálja, hogy a modell által generált üzenet érvényes JSON-alapú.

Leírás: A json_object JSON mód engedélyezése beállítás. Ez garantálja, hogy a modell által generált üzenet érvényes JSON-alapú.

Típus: sztring

Alapértelmezett: szöveg

Szám neve: ChatCompletionResponseFormat

Enumerálási értékek:

Érték	Leírás
text	A válaszformátum egyszerű szöveges sztring.
json_object	A válaszformátum egy JSON-objektum.

chatCompletionFunction

Név	Típus	Leírás	Kötelező	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.	Igen
leírás	húr	A függvény működésének leírása.	Nem
parameters	chatCompletionFunctionParameters	A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva. A formátum dokumentációját a JSON-séma referenciájában találja.	Nem

chatCompletionFunctionParameters

A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva. A formátum dokumentációját a JSON-séma referenciájában találja.

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

chatCompletionRequestMessage

Név	Típus	Leírás	Kötelező	Alapértelmezett
szerepkör	chatCompletionRequestMessageRole	Az üzenetek szerzőjének szerepe.	Igen

chatCompletionRequestMessageRole

Az üzenetek szerzőjének szerepe.

Leírás: Az üzenetek szerzőjének szerepe.

Típus: sztring

Alapértelmezett:

Enum Name: ChatCompletionRequestMessageRole

Enumerálási értékek:

Érték	Leírás
rendszer	Az üzenetkészítő szerepkör a rendszer.
user	Az üzenet szerzői szerepköre felhasználó.
asszisztens	Az üzenetkészítő szerepkör asszisztens.
eszköz	Az üzenetkészítő szerepkör eszköz.
függvény	Elavult. Az üzenetkészítő szerepkör függvény.

chatCompletionRequestMessageSystem

Név	Típus	Leírás	Kötelező	Alapértelmezett
szerepkör	chatCompletionRequestMessageRole	Az üzenetek szerzőjének szerepe.	Igen
content	húr	Az üzenet tartalma.	Nem

chatCompletionRequestMessageUser

Név	Típus	Leírás	Kötelező	Alapértelmezett
szerepkör	chatCompletionRequestMessageRole	Az üzenetek szerzőjének szerepe.	Igen
content	sztring vagy tömb		Nem

chatCompletionRequestMessageContentPart

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	chatCompletionRequestMessageContentPartType	A tartalomrész típusa.	Igen

chatCompletionRequestMessageContentPartType

A tartalomrész típusa.

Leírás: A tartalomrész típusa.

Típus: sztring

Alapértelmezett:

Enum Name: ChatCompletionRequestMessageContentPartType

Enumerálási értékek:

Érték	Leírás
text	A tartalomrész típusa szöveg.
image_url	A tartalomrész típusa image_url.

chatCompletionRequestMessageContentPartText

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	chatCompletionRequestMessageContentPartType	A tartalomrész típusa.	Igen
text	húr	A szöveges tartalom.	Nem

chatCompletionRequestMessageContentPartImage

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	chatCompletionRequestMessageContentPartType	A tartalomrész típusa.	Igen
url	húr	A rendszerkép URL-címe vagy a base64 kódolású képadatok.	Nem
részlet	imageDetailLevel	A kép részletességi szintjét adja meg.	Nem	auto

imageDetailLevel

A kép részletességi szintjét adja meg.

Leírás: A kép részletességi szintjét adja meg.

Típus: sztring

Alapértelmezett: automatikus

Szám neve: ImageDetailLevel

Enumerálási értékek:

Érték	Leírás
auto	A kép részletességi szintje automatikus.
alacsony	A kép részletességi szintje alacsony.
magas	A kép részletességi szintje magas.

chatCompletionRequestMessageAssistant

Név	Típus	Leírás	Kötelező	Alapértelmezett
szerepkör	chatCompletionRequestMessageRole	Az üzenetek szerzőjének szerepe.	Igen
content	húr	Az üzenet tartalma.	Nem
tool_calls	array	A modell által generált eszközhívások, például függvényhívások.	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

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

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.

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ési kérelem, 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_ml_index	Az Azure Machine Learning-index 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.
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 ú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
role_information	húr	Adja meg a modell utasításait arról, hogy hogyan kell viselkednie, és minden olyan környezetet, amelyre hivatkoznia kell a válasz létrehozásakor. Leírhatja az asszisztens személyiségét, és megtudhatja, hogyan formázhatja a válaszokat. 100 jogkivonatra vonatkozó korlát van, és a teljes jogkivonat-korlátnak számít.	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		Nem
include_contexts	array	A kimeneti környezet belefoglalt tulajdonságai. Ha nincs megadva, az alapértelmezett érték és intenta 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ő	Alapértelmezett
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.

azureMachineLearningIndexChatExtensionConfiguration

Az Azure Machine Learning-vektorindex 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	azureMachineLearningIndexChatExtensionParameters	Az Azure Machine Learning vektorindex-csevegőbővítmény paraméterei.	Nem

azureMachineLearningIndexChatExtensionParameters

Az Azure Machine Learning vektorindex-csevegőbővítmény paraméterei.

Név	Típus	Leírás	Kötelező	Alapértelmezett
hitelesítés	onYourDataAccessTokenAuthenticationOptions vagy onYourDataSystemAssignedManagedIdentityAuthenticationOptions vagy onYourDataUserAssignedManagedIdentityAuthenticationOptions		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. 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
role_information	húr	Adja meg a modell utasításait arról, hogy hogyan kell viselkednie, és minden olyan környezetet, amelyre hivatkoznia kell a válasz létrehozásakor. Leírhatja az asszisztens személyiségét, és megtudhatja, hogyan formázhatja a válaszokat. 100 jogkivonatra vonatkozó korlát van, és a teljes jogkivonat-korlátnak számít.	Nem
project_resource_id	húr	Az Azure Machine Learning-projekt erőforrás-azonosítója.	Igen
név	húr	Az Azure Machine Learning vektorindexének neve.	Igen
Verzió	húr	Az Azure Machine Learning-vektorindex verziója.	Igen
szűrő	húr	Keresési szűrő. Csak akkor támogatott, ha az Azure Machine Learning-vektorindex AzureSearch típusú.	Nem
include_contexts	array	A kimeneti környezet belefoglalt tulajdonságai. Ha nincs megadva, az alapértelmezett érték és intenta citations .	Nem

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
role_information	húr	Adja meg a modell utasításait arról, hogy hogyan kell viselkednie, és minden olyan környezetet, amelyre hivatkoznia kell a válasz létrehozásakor. Leírhatja az asszisztens személyiségét, és megtudhatja, hogyan formázhatja a válaszokat. 100 jogkivonatra vonatkozó korlát van, és a teljes jogkivonat-korlátnak számít.	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 intenta 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ő	Alapértelmezett
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 ú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
role_information	húr	Adja meg a modell utasításait arról, hogy hogyan kell viselkednie, és minden olyan környezetet, amelyre hivatkoznia kell a válasz létrehozásakor. Leírhatja az asszisztens személyiségét, és megtudhatja, hogyan formázhatja a válaszokat. 100 jogkivonatra vonatkozó korlát van, és a teljes jogkivonat-korlátnak számít.	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 intenta 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ő	Alapértelmezett
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.

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 ú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
role_information	húr	Adja meg a modell utasításait arról, hogy hogyan kell viselkednie, és minden olyan környezetet, amelyre hivatkoznia kell a válasz létrehozásakor. Leírhatja az asszisztens személyiségét, és megtudhatja, hogyan formázhatja a válaszokat. 100 jogkivonatra vonatkozó korlát van, és a teljes jogkivonat-korlátnak számít.	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	Egy 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 intenta 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ő	Alapértelmezett
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.

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ő	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ó 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

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.
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, amelyek beágyazásra vonatkozó Azure OpenAI-végponthíváson alapulnak.

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
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/embeddingsa következőnek kell lennie: . Az API-verzió lekérdezési paramétere 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ő	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
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

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ő	Alapértelmezett
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ézés

Idézetadatok egy csevegés befejezésére vonatkozó válaszüzenethez.

Név	Típus	Leírás	Kötelező	Alapértelmezett
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

retrievedDocument

A lekért dokumentum.

Név	Típus	Leírás	Kötelező	Alapértelmezett
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
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
rerank_score	szám	A lekért dokumentum rerank-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ő	Alapértelmezett
id	húr	Az eszközhívás azonosítója.	Igen
típus	toolCallType	Ebben az esetben functionaz 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.

Argumentumok

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 a függvényséma által nem definiált paramétereket is létrehozhat. 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
szerepkör	chatCompletionRequestMessageRole	Az üzenetek szerzőjének szerepe.	Igen
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ő	Alapértelmezett
szerepkör	Enum	Ebben az esetben functionaz üzenetek szerzőjének szerepe. Lehetséges értékek: függvény	Igen
név	húr	Az üzenet tartalma.	Nem
content	húr	Az üzenet tartalma.	Nem

createChatCompletionResponse

Név	Típus	Leírás	Kötelező	Alapértelmezett
id	húr	A csevegés befejezésének egyedi azonosítója.	Igen
object	chatCompletionResponseObject	Az objektum típusa.	Igen
Létrehozott	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
használat	completionUsage	A befejezési kérelem használati statisztikái.	Nem
system_fingerprint	húr	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
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érelmek 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		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

chatCompletionTokenLogprob

Név	Típus	Leírás	Kötelező	Alapértelmezett
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. 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ő	Alapértelmezett
szerepkör	chatCompletionResponseMessageRole	A válaszüzenet szerzőjének szerepe.	Nem
content	húr	Az üzenet tartalma.	Nem
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
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

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 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 {"type": "function", "function": {"name": "my_function"}} a modellt.

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

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 a függvényséma által nem definiált paramétereket is létrehozhat. A függvény meghívása előtt ellenőrizze a kód argumentumait.	Igen

chatCompletionsResponseCommon

Név	Típus	Leírás	Kötelező	Alapértelmezett
id	húr	A csevegés befejezésének egyedi azonosítója.	Igen
object	chatCompletionResponseObject	Az objektum típusa.	Igen
Létrehozott	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
használat	completionUsage	A befejezési kérelem használati statisztikái.	Nem
system_fingerprint	húr	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

chatCompletionResponseObject

Az objektum típusa.

Leírás: Az objektum típusa.

Típus: sztring

Alapértelmezett:

Enum Name: ChatCompletionResponseObject

Enumerálási értékek:

Érték	Leírás
chat.completion	Az objektum típusa a csevegés befejezése.

completionUsage

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

Név	Típus	Leírás	Kötelező	Alapértelmezett
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

chatCompletionTool

Név	Típus	Leírás	Kötelező	Alapértelmezett
típus	chatCompletionToolType	Az eszköz típusa. Jelenleg csak function a támogatottak.	Igen
függvény	object		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.

Paraméterek

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. A formátum dokumentációját a JSON-séma referenciájában találja.

Függvényparaméterek

A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva. A formátum dokumentációját a JSON-séma referenciájában találja.

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. A formátum dokumentációját a JSON-séma referenciájában találja. Az kihagyás parameters üres paraméterlistával rendelkező függvényt határoz meg.	Nem

chatCompletionToolType

Az eszköz típusa. Jelenleg csak function a támogatottak.

Leírás: Az eszköz típusa. Jelenleg csak function a támogatottak.

Típus: sztring

Alapértelmezett:

Enum Name: ChatCompletionToolType

Enumerálási értékek:

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

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ő	Alapértelmezett
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: wordvagy segment. Megjegyzés: A szegmens időbélyegei nem járnak további késéssel, de a szavak időbélyegeinek 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ő	Alapértelmezett
id	egész szám	Szegmensazonosító.	Nem
keres	szám	A szegmens eltolása.	Nem
start	szám	A 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ő	Alapértelmezett
szó	húr	Word	Nem
start	szám	A kezdő eltolás szó.	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.25 4.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étrehozott	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ő	Alapértelmezett
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

Sor

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ő	Alapértelmezett
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ő	Alapértelmezett
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ő	Alapértelmezett
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-4 Turbo és az összes GPT-3.5 Turbo modell azóta gpt-3.5-turbo-1106.

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 előfordulhat, hogy a modell egy névtelen térfolyamot hoz létre, amíg a generáció el nem éri a jogkivonat korlátját, ami hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részben megszakadhat, ha finish_reason="length"az azt jelzi, hogy a generálá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_objecta 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. Az API-val megtekintheti az List models összes elérhető modellt, vagy megtekintheti a modell áttekintését a leírásukért.	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_searchvagy 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-4 Turbo és az összes GPT-3.5 Turbo modell azóta gpt-3.5-turbo-1106. 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 előfordulhat, hogy a modell egy névtelen térfolyamot hoz létre, amíg a generáció el nem éri a jogkivonat korlátját, ami hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részben megszakadhat, ha finish_reason="length"az azt jelzi, hogy a generálá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. Az asszisztenshez legfeljebb 1 vektortároló csatolható.

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, retrievalvagy 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-4 Turbo és az összes GPT-3.5 Turbo modell azóta gpt-3.5-turbo-1106. 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 előfordulhat, hogy a modell egy névtelen térfolyamot hoz létre, amíg a generáció el nem éri a jogkivonat korlátját, ami hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részben megszakadhat, ha finish_reason="length"az azt jelzi, hogy a generálá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ó. Az asszisztenshez legfeljebb 1 vektortároló csatolható.
vector_stores	array	Segéd egy vektortároló létrehozásához file_ids és csatolja az asszisztenshez. Az asszisztenshez legfeljebb 1 vektortároló csatolható.

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 32768 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, retrievalvagy 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-4 Turbo és az összes GPT-3.5 Turbo modell azóta gpt-3.5-turbo-1106. 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 előfordulhat, hogy a modell egy névtelen térfolyamot hoz létre, amíg a generáció el nem éri a jogkivonat korlátját, ami hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részben megszakadhat, ha finish_reason="length"az azt jelzi, hogy a generálá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. Az asszisztenshez legfeljebb 1 vektortároló csatolható.

deleteAssistantResponse

Név	Típus	Leírás	Kötelező	Alapértelmezett
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	Leírás	Kötelező	Alapértelmezett
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

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.

Paraméterek

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. A formátum dokumentációját a JSON-séma referenciájában találja.

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 semmilyen eszközt, és ehelyett létrehoz egy üzenetet. 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, completedvagy 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 hiányos.	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, queuedstb.).	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 semmilyen eszközt, és ehelyett létrehoz egy üzenetet. 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
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4 Turbo és az összes GPT-3.5 Turbo modell azóta gpt-3.5-turbo-1106. 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 előfordulhat, hogy a modell egy névtelen térfolyamot hoz létre, amíg a generáció el nem éri a jogkivonat korlátját, ami hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részben megszakadhat, ha finish_reason="length"az azt jelzi, hogy a generálá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

Kód

Név	Típus	Leírás	Alapértelmezett
code	húr	Az egyik vagy server_error rate_limit_exceededa 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

Ok

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 incompletefejező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 incompletefejező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 semmilyen eszközt, és ehelyett létrehoz egy üzenetet. 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
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4 Turbo és az összes GPT-3.5 Turbo modell azóta gpt-3.5-turbo-1106. 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 előfordulhat, hogy a modell egy névtelen térfolyamot hoz létre, amíg a generáció el nem éri a jogkivonat korlátját, ami hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részben megszakadhat, ha finish_reason="length"az azt jelzi, hogy a generálá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	Leírás	Kötelező	Alapértelmezett
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ő	Alapértelmezett
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 végpont használatával küldi Submit tool outputs to run el.	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.

Argumentumok

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ó modelltelepítés neve. 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
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 incompletefejező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 incompletefejező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 semmilyen eszközt, és ehelyett létrehoz egy üzenetet. 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
response_format	assistantsApiResponseFormatOption	Megadja a modell kimenetének formátumát. Kompatibilis a GPT-4 Turbo és az összes GPT-3.5 Turbo modell azóta gpt-3.5-turbo-1106. 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 előfordulhat, hogy a modell egy névtelen térfolyamot hoz létre, amíg a generáció el nem éri a jogkivonat korlátját, ami hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részben megszakadhat, ha finish_reason="length"az azt jelzi, hogy a generálá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. Az asszisztenshez legfeljebb 1 vektortároló csatolható.

threadObject

Üzeneteket tartalmazó szálat 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.	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 1 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ő	Alapértelmezett
ü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 1 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 1 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 1 vektortároló csatolható.

deleteThreadResponse

Név	Típus	Leírás	Kötelező	Alapértelmezett
id	sztring		Igen
törölt	Logikai		Igen
object	sztring		Igen

object Enum: DeleteThreadResponseObjectState

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

listThreadsResponse

Név	Típus	Leírás	Kötelező	Alapértelmezett
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ő	Alapértelmezett
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, incompletevagy 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 user assistanta 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

Ok

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ő	Alapértelmezett
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 user assistanta másik.

Tartalom

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ő	Alapértelmezett
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	Leírás	Kötelező	Alapértelmezett
id	sztring		Igen
törölt	Logikai		Igen
object	sztring		Igen

object Enum: DeleteMessageResponseObject

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

listMessagesResponse

Név	Típus	Leírás	Kötelező	Alapértelmezett
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.

Jegyzetek

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ő	Alapértelmezett
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.

Ajánlat

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

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ő	Alapértelmezett
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ő	Alapértelmezett
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ő	Alapértelmezett
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.

Jegyzetek

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ő	Alapértelmezett
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.

Ajánlat

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ő	Alapértelmezett
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ő	Alapértelmezett
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_creation tool_calls.	Igen
status	húr	A futtatás állapota, amely lehet in_progress, cancelled, failed, completedvagy 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

Kód

Név	Típus	Leírás	Alapértelmezett
code	húr	Az egyik vagy server_error rate_limit_exceededa 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ő	Alapértelmezett
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	Leírás	Kötelező	Alapértelmezett
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_interpretervagy retrieval function.	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_interpretervagy file_search function.	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ő	Alapértelmezett
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

Bevitel

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ő	Alapértelmezett
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

Bevitel

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ő	Alapértelmezett
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ő	Alapértelmezett
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ő	Alapértelmezett
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

típus Enum: RunStepDetailsToolCallsFileSearchObjectType

Érték	Leírás
file_search

runStepDeltaStepDetailsToolCallsFileSearchObject

Név	Típus	Leírás	Kötelező	Alapértelmezett
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ő	Alapértelmezett
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.

Argumentumok

Név	Típus	Leírás	Alapértelmezett
Érvek	húr	A függvénynek átadott argumentumok.

Hozam

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 submitted megadva.

típus Enum: RunStepDetailsToolCallsFunctionObjectType

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

runStepDeltaStepDetailsToolCallsFunctionObject

Név	Típus	Leírás	Kötelező	Alapértelmezett
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.

Argumentumok

Név	Típus	Leírás	Alapértelmezett
Érvek	húr	A függvénynek átadott argumentumok.

Hozam

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ő	Alapértelmezett
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_progressvagy 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.

Befejeződött

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.

Érvénytelenítve

Név	Típus	Leírás	Alapértelmezett
Törölt	egész szám	A törölt fájlok száma.

Összesen

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ő	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.	Nem
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

updateVectorStoreRequest

Név	Típus	Leírás	Kötelező	Alapértelmezett
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	Leírás	Kötelező	Alapértelmezett
object	sztring		Igen
adatok	array		Igen
first_id	sztring		Igen
last_id	sztring		Igen
has_more	Logikai		Igen

deleteVectorStoreResponse

Név	Típus	Leírás	Kötelező	Alapértelmezett
id	sztring		Igen
törölt	Logikai		Igen
object	sztring		Igen

object Enum: DeleteVectorStoreResponseObject

Érték	Leírás
vector_store.deleted	A törölt vektortároló válaszobjektumának állapota

vectorStoreFileObject

Vektortárolóhoz csatolt fájlok listája.

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 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, completedvagy 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

A last_error tulajdonságai

Kód

Név	Típus	Leírás	Alapértelmezett
code	húr	Az egyik vagy server_error rate_limit_exceededa 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

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

listVectorStoreFilesResponse

Név	Típus	Leírás	Kötelező	Alapértelmezett
object	sztring		Igen
adatok	array		Igen
first_id	sztring		Igen
last_id	sztring		Igen
has_more	Logikai		Igen

deleteVectorStoreFileResponse

Név	Típus	Leírás	Kötelező	Alapértelmezett
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ő	Alapértelmezett
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.

Befejeződött

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.

Érvénytelenítve

Név	Típus	Leírás	Alapértelmezett
Törölt	egész szám	A törölt fájlok száma.

Összesen

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

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 event data 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 gondosan kezelje a kódban.

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
error

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.