Azure OpenAI az Microsoft Öntödei modellek REST API-referenciájában

Ez a cikk részletesen ismerteti az OpenAI Azure rest API-végpontjainak következtetését.

API specs

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

Control plane
Adatsík – létrehozás
Adatsík – következtetés

Minden API-felület/specifikáció különböző 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.

Important

Most már van egy új előzetes következtetési API. További információ az API életciklus-útmutatójában.

API	Legújabb előzetes kiadás	Legújabb GA-kiadás	Specifications	Description
Control plane	`2025-07-01-preview`	`2025-06-01`	Spec files	A vezérlősík API-t olyan műveletekhez használják, mint az 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 az olyan képességeket is szabályozza, mint a Azure Resource Manager, a Bicep, a Terraform és a Azure CLI.
Data plane	`v1 preview`	`v1`	Spec files	Az adatsík API-ja szabályozza a következtetési és szerzői műveleteket.

Authentication

Azure OpenAI két módszert biztosít a hitelesítéshez. Api-kulcsokat vagy Microsoft Entra ID is használhat.

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 Bearermeg kell előznieBearer YOUR_AUTH_TOKEN. A hitelesítéssel kapcsolatos útmutatónkat Microsoft Entra ID.

REST API-verziószámozás

A szolgáltatás API-jait a rendszer a lekérdezési api-version paraméterrel verziószámozza. Minden verzió az YYYY-MM-DD dátumstruktúrát követi. For example:

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

Adatsík-következtetés

A cikk további része a Azure OpenAI adatsík következtetési specifikációjának ga-kiadását ismerteti, 2024-10-21.

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

Completions

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

Befejezést hoz létre a megadott parancssorhoz, paraméterekhez és kiválasztott modellhez.

URI Parameters

Name	In	Required	Típus	Description
végpont	elérési út	Yes	karakterlánc 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	elérési út	Yes	karakterlánc	Az üzembe helyezett modell üzembehelyezési azonosítója.
api-version	lekérdezés	Yes	karakterlánc	API version

Request Header

Name	Required	Típus	Description
api-key	True	karakterlánc	Itt adja meg Azure OpenAI API-kulcsot

Request Body

Content-Type: application/json

Name	Típus	Description	Required	Default
kér	sztring vagy tömb	A befejezések létrehozására szolgáló kérések sztringként, sztringek tömbjeként, jogkivonatok tömbjeként vagy tokentömbként kódolva. Vegye figyelembe, hogy <a(z) \|endoftext\|> az a dokumentumelválasztó, amelyet a modell a betanítás során lát, így ha nincs megadva egy kérés, a modell úgy fog létrejönni, mintha egy új dokumentum elejéről származna.	Yes
best_of	egész szám	A befejezéseket `best_of` kiszolgálóoldalon hozza létre, és a "legjobb" értéket adja vissza (az, amelynek a legnagyobb a naplók valószínűsége jogkivonatonként). Az eredmények nem streamelhetők. A használat során `n`a jelölt befejezések számát szabályozza, `best_of` és `n` meghatározza, hogy hánynak kell visszaadnia a â € " `best_of` -nál `n`nagyobbnak kell lennie. Megjegyzés: Mivel ez a paraméter sok befejezést generál, gyorsan felhasználhatja a jogkivonatkvótát. Gondosan használja, és győződjön meg arról, hogy megfelelő beállításokat `max_tokensstop`és .	No	1
echo	boolean	A befejezés mellett a kérést is vissza kell adni	No	False
frequency_penalty	number	-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.	No	0
logit_bias	objektum	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-jogkivonat-kezelőben megadott jogkivonat-azonosítójuk alapján) egy társított elfogultsági értékre képezi le -100-ről 100-ra. 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; az olyan értékeknek, mint a -100 vagy a 100, a megfelelő jogkivonat kitiltását vagy kizárólagos kiválasztását kell eredményeznie. Átadhatja `{"50256": -100}` például a(z) \|endoftext\|< jogkivonat létrehozásának megakadályozását>.	No	None
logprobs	egész szám	Adja meg a napló valószínűségét a `logprobs` legvalószínűbb kimeneti jogkivonatokon, valamint a kiválasztott jogkivonatokon. Ha például `logprobs` 5, az API az öt legvalószínűbb jogkivonat listáját adja vissza. Az API mindig a `logprob` mintául szolgáló jogkivonatot adja vissza, így a válaszban `logprobs+1` akár elemek is lehetnek. A maximális érték `logprobs` 5.	No	None
max_tokens	egész szám	A befejezés során létrehozható jogkivonatok maximális száma. A parancssor jogkivonatszáma plusz `max_tokens` nem haladhatja meg a modell környezethosszát.	No	16
n	egész szám	Hány befejezést kell létrehozni az egyes kérésekhez. Megjegyzés: Mivel ez a paraméter sok befejezést generál, gyorsan felhasználhatja a jogkivonatkvótát. Gondosan használja, és győződjön meg arról, hogy megfelelő beállításokat `max_tokensstop`és .	No	1
presence_penalty	number	-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.	No	0
seed	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.	No
stop	sztring vagy tömb	Legfeljebb négy sorozat, amelyekben az API leállítja a további jogkivonatok generálását. A visszaadott szöveg nem tartalmazza a leállítási sorrendet.	No
adatfolyam	boolean	Azt határozza meg, hogy vissza szeretné-e streamelni a részleges előrehaladást. Ha be van állítva, a jogkivonatok csak a kiszolgáló által küldött eseményekként lesznek elküldve , amint elérhetővé válnak, és a streamet egy `data: [DONE]` üzenet leállítja.	No	False
suffix	karakterlánc	A beszúrt szöveg befejezése után megjelenő utótag. Ez a paraméter csak a következőhöz `gpt-3.5-turbo-instruct`támogatott: .	No	None
temperature	number	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.	No	1
top_p	number	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 az első 10% 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.	No	1
felhasználó	karakterlánc	A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében.	No

Responses

Állapotkód: 200

Description: OK

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

Állapotkód: alapértelmezett

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

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

Befejezést hoz létre a megadott parancssorhoz, paraméterekhez és kiválasztott modellhez.

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

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

Embeddings

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

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

URI Parameters

Name	In	Required	Típus	Description
végpont	elérési út	Yes	karakterlánc 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	elérési út	Yes	karakterlánc
api-version	lekérdezés	Yes	karakterlánc	API version

Request Header

Name	Required	Típus	Description
api-key	True	karakterlánc	Itt adja meg Azure OpenAI API-kulcsot

Request Body

Content-Type: application/json

Name	Típus	Description	Required
bevitel	sztring vagy tömb	Bemeneti szöveg beágyazásához, sztringként vagy tokentömbként kódolva. Ha több bemenetet szeretne beágyazni egyetlen kérelembe, adjon át sztringek vagy tokentömbök tömbjének tömböt. A bemenet nem haladhatja meg a modell maximális bemeneti jogkivonatait (8 192 token esetén `text-embedding-ada-002`), nem lehet üres sztring, és egy tömbnek legalább 2048 dimenziónak kell lennie.	Yes
felhasználó	karakterlánc	A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében.	No
input_type	karakterlánc	a használni kívánt beágyazási keresés bemeneti típusa	No
encoding_format	karakterlánc	A beágyazások visszaadásának formátuma. Lehet vagy `floatbase64`. Alapértelmezett érték: `float`.	No
dimensions	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.	No

Responses

Name	Típus	Required
objektum	karakterlánc	Yes
modell	karakterlánc	Yes
adat	tömb	Yes
felhasználás	objektum	Yes

Használati tulajdonságok

prompt_tokens

Name	Típus	Description	Default
prompt_tokens	egész szám

total_tokens

Name	Típus	Description	Default
total_tokens	egész szám

Állapotkód: 200

Description: OK

Content-Type	Type	Description
application/json	objektum

Examples

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

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

Válaszok: Állapotkód: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Chat completions

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

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

URI Parameters

Name	In	Required	Típus	Description
végpont	elérési út	Yes	karakterlánc 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	elérési út	Yes	karakterlánc	Az üzembe helyezett modell üzembehelyezési azonosítója.
api-version	lekérdezés	Yes	karakterlánc	API version

Request Header

Name	Required	Típus	Description
api-key	True	karakterlánc	Itt adja meg Azure OpenAI API-kulcsot

Request Body

Content-Type: application/json

Name	Típus	Description	Required	Default
temperature	number	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.	No	1
top_p	number	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 az első 10% 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.	No	1
adatfolyam	boolean	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.	No	False
stop	sztring vagy tömb	Legfeljebb négy sorozat, amelyekben az API leállítja a további jogkivonatok generálását.	No
max_tokens	egész szám	A csevegés befejezésekor létrehozható jogkivonatok maximális száma. A bemeneti jogkivonatok és a létrehozott jogkivonatok teljes hosszát a modell környezethossza korlátozza.	No
max_completion_tokens	egész szám	A befejezéshez létrehozható tokenek számának felső határa, beleértve a látható kimeneti jogkivonatokat és az érvelési jogkivonatokat.	No
presence_penalty	number	-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.	No	0
frequency_penalty	number	-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.	No	0
logit_bias	objektum	Módosítsa annak valószínűségét, hogy a megadott jogkivonatok megjelenjenek a befejezéskor. Elfogad egy JSON-objektumot, amely leképzi a jogkivonatokat (a jogkivonat-azonosítójuk által megadott) egy társított torzító értékre -100-ról 100-ra. 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; az olyan értékeknek, mint a -100 vagy a 100, a megfelelő jogkivonat kitiltását vagy kizárólagos kiválasztását kell eredményeznie.	No	None
felhasználó	karakterlánc	A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében.	No
messages	tömb	Az eddig a beszélgetésből álló üzenetek listája.	Yes
data_sources	tömb	Az őket használó Azure OpenAI-csevegőbővítmények konfigurációs bejegyzései. Ez a további specifikáció csak Azure OpenAI-val kompatibilis.	No
logprobs	boolean	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`: .	No	False
top_logprobs	egész szám	Egy 0 és 20 közötti egész szám, amely megadja, hogy az egyes tokenpozíciókban a legvalószínűbb tokenek hányan térnek vissza, és mindegyikhez tartozik napló valószínűsége. `logprobs` ezt a paramétert `true` kell beállítani.	No
n	egész szám	Hány csevegés-befejezési lehetőséget kell létrehozni az egyes bemeneti üzenetekhez. Vegye figyelembe, hogy a díjakat a létrehozott jogkivonatok száma alapján számítjuk fel az összes lehetőség közül. Tartsa meg `n` a `1` költségek minimalizálását.	No	1
parallel_tool_calls	ParallelToolCalls	Engedélyezi-e a párhuzamos függvényhívást az eszköz használata során.	No	True
response_format	ResponseFormatText vagy ResponseFormatJsonObject vagy ResponseFormatJsonSchema	Egy objektum, amely megadja a modell által kiadandó formátumot. Kompatibilis a GPT-4o, GPT-4o mini, GPT-4 Turbo és az összes GPT-3.5 Turbo modellek újabb, mint `gpt-3.5-turbo-1106`. A strukturált kimeneteket engedélyező `{ "type": "json_schema", "json_schema": {...} }` beállítás, amely garantálja, hogy a modell megfelel a megadott JSON-sémának. A JSON mód engedélyezése, `{ "type": "json_object" }` amely garantálja, hogy a modell által generált üzenet érvényes JSON. Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha `finish_reason="length"`az azt jelzi, hogy a létrehozás túllépte `max_tokens` vagy a beszélgetés túllépte a környezet maximális hosszát.	No
seed	egész szám	Ez a funkció bétaverzióban érhető el. Ha meg van adva, a rendszerünk mindent megtesz annak érdekében, hogy determinisztikus mintát hozzon létre, így az azonos `seed` és paraméterekkel rendelkező ismétlődő kérelmeknek ugyanazt az eredményt kell visszaadnia. A determinizmus nem garantált, és a háttérrendszer változásainak figyeléséhez tekintse meg a `system_fingerprint` válaszparamétert.	No
tools	tömb	A modell által meghívható eszközök listája. Jelenleg csak a függvények támogatottak eszközként. Ezzel megadhatja azon függvények listáját, amelyekhez a modell JSON-bemeneteket hozhat létre. Legfeljebb 128 függvény támogatott.	No
tool_choice	chatCompletionToolChoiceOption	Azt szabályozza, hogy a modell melyik eszközt hívja meg (ha van ilyen). `none` azt jelenti, hogy a modell nem hív meg egyetlen eszközt sem, és ehelyett létrehoz egy üzenetet. `auto` azt jelenti, hogy a modell választhat egy üzenet létrehozása vagy egy vagy több eszköz meghívása között. `required` azt jelenti, hogy a modellnek egy vagy több eszközt kell meghívnia. Egy adott eszköz megadása az `{"type": "function", "function": {"name": "my_function"}}` eszköz meghívására kényszeríti a modellt. `none` az alapértelmezett, ha nincsenek eszközök. `auto` az alapértelmezett, ha az eszközök vannak jelen.	No
function_call	sztring vagy csevegésCompletionFunctionCallOption	Elavult a javára `tool_choice`. Azt szabályozza, hogy a modell melyik függvényt hívja meg (ha van ilyen). `none` azt jelenti, hogy a modell nem hív meg függvényt, hanem létrehoz egy üzenetet. `auto` azt jelenti, hogy a modell választhat az üzenet létrehozása vagy egy függvény meghívása között. Egy adott függvény megadása a modell meghívására kényszeríti `{"name": "my_function"}` a modellt. `none` az alapértelmezett, ha nincsenek függvények. `auto` az alapértelmezett, ha függvények vannak jelen.	No
functions	tömb	Elavult a javára `tools`. Azon függvények listája, amelyekhez a modell JSON-bemeneteket hozhat létre.	No

Responses

Állapotkód: 200

Description: OK

Content-Type	Type	Description
application/json	createChatCompletionResponse vagy createChatCompletionStreamResponse

Állapotkód: alapértelmezett

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

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

Befejezést hoz létre a megadott parancssorhoz, paraméterekhez és kiválasztott modellhez.

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

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

Válaszok: Állapotkód: 200

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

Example

A Azure Keresési adatok és a rendszer által hozzárendelt felügyelt identitás alapján hoz létre befejezést.

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

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

Example

Befejezést hoz létre Azure keresési vektoradatok, a korábbi segédü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-10-21

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

Example

Befejezést hoz létre a megadott Azure Cosmos DB.

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

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

Átiratok – Létrehozás

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

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

URI Parameters

Name	In	Required	Típus	Description
végpont	elérési út	Yes	karakterlánc 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	elérési út	Yes	karakterlánc	A beszéd–szöveg modell üzembehelyezési azonosítója. A támogatott modellekkel kapcsolatos információkért lásd: [/azure/ai-foundry/openai/concepts/models#audio-models].
api-version	lekérdezés	Yes	karakterlánc	API version

Request Header

Name	Required	Típus	Description
api-key	True	karakterlánc	Itt adja meg Azure OpenAI API-kulcsot

Request Body

Content-Type: multipart/form-data

Name	Típus	Description	Required	Default
fájl	karakterlánc	Az átírandó hangfájl-objektum.	Yes
kér	karakterlánc	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.	No
response_format	audioResponseFormat	Meghatározza a kimenet formátumát.	No
temperature	number	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.	No	0
nyelv	karakterlánc	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.	No

Responses

Állapotkód: 200

Description: OK

Content-Type	Type	Description
application/json	audioResponse vagy audioVerboseResponse
text/plain	karakterlánc	Átírt szöveg kimeneti formátumban (amikor response_format szöveg, vtt vagy srt volt).

Examples

Example

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-10-21

Válaszok: Állapotkód: 200

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

Example

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-10-21

"---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-10-21

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

URI Parameters

Name	In	Required	Típus	Description
végpont	elérési út	Yes	karakterlánc 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	elérési út	Yes	karakterlánc	Az üzembe helyezett suttogómodell üzembehelyezési azonosítója. A támogatott modellekkel kapcsolatos információkért lásd: [/azure/ai-foundry/openai/concepts/models#audio-models].
api-version	lekérdezés	Yes	karakterlánc	API version

Request Header

Name	Required	Típus	Description
api-key	True	karakterlánc	Itt adja meg Azure OpenAI API-kulcsot

Request Body

Content-Type: multipart/form-data

Name	Típus	Description	Required	Default
fájl	karakterlánc	A lefordítandó hangfájl.	Yes
kér	karakterlánc	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.	No
response_format	audioResponseFormat	Meghatározza a kimenet formátumát.	No
temperature	number	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.	No	0

Responses

Állapotkód: 200

Description: OK

Content-Type	Type	Description
application/json	audioResponse vagy audioVerboseResponse
text/plain	karakterlánc	Átírt szöveg kimeneti formátumban (amikor response_format szöveg, vtt vagy srt volt).

Examples

Example

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-10-21

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

Example

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-10-21

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

Image generation

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

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

URI Parameters

Name	In	Required	Típus	Description
végpont	elérési út	Yes	karakterlánc 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	elérési út	Yes	karakterlánc	Az üzembe helyezett dall-e modell üzembehelyezési azonosítója.
api-version	lekérdezés	Yes	karakterlánc	API version

Request Header

Name	Required	Típus	Description
api-key	True	karakterlánc	Itt adja meg Azure OpenAI API-kulcsot

Request Body

Content-Type: application/json

Name	Típus	Description	Required	Default
kér	karakterlánc	A kívánt kép(ek) szöveges leírása. A maximális hossz 4000 karakter.	Yes
n	egész szám	A létrehozandó képek száma.	No	1
size	imageSize	A létrehozott képek mérete.	No	1024x1024
response_format	imagesResponseFormat	A létrehozott képek visszaadott formátuma.	No	url
felhasználó	karakterlánc	A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében.	No
quality	imageQuality	A létrehozandó kép minősége.	No	szabvány
style	imageStyle	A létrehozott képek stílusa.	No	vivid

Responses

Állapotkód: 200

Description: Ok

Content-Type	Type	Description
application/json	generateImagesResponse

Állapotkód: alapértelmezett

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

Content-Type	Type	Description
application/json	dalleErrorResponse

Examples

Example

A rendszerképeket a rendszer kéri.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

{
 "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
          }
        },
        "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
          }
        }
      }
    ]
  }
}

Components

errorResponse

Name	Típus	Description	Required	Default
hiba	error		No

errorBase

Name	Típus	Description	Required	Default
kód	karakterlánc		No
üzenet	karakterlánc		No

hiba

Name	Típus	Description	Required
param	karakterlánc		No
típus	karakterlánc		No
inner_error	innerError	Belső hiba további részletekkel.	No

innerError

Belső hiba további részletekkel.

Name	Típus	Description	Required	Default
kód	innerErrorCode	A belső hibaobjektum hibakódjai.	No
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.	No

innerErrorCode

A belső hibaobjektum hibakódjai.

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

Type: string

Default:

Szám neve: InnerErrorCode

Enum Values:

Value	Description
ResponsibleAIPolicyViolation	A kérés megsértette az egyik további tartalomszűrő szabályt.

dalleErrorResponse

Name	Típus	Description	Required	Default
hiba	dalleError		No

dalleError

Name	Típus	Description	Required
param	karakterlánc		No
típus	karakterlánc		No
inner_error	dalleInnerError	Belső hiba további részletekkel.	No

dalleInnerError

Belső hiba további részletekkel.

Name	Típus	Description	Required
kód	innerErrorCode	A belső hibaobjektum hibakódjai.	No
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.	No
revised_prompt	karakterlánc	A rendszerkép létrehozásához használt kérés, ha a kérésnek volt valamilyen változata.	No

contentFilterResultBase

Name	Típus	Description	Required	Default
filtered	boolean		Yes

contentFilterSeverityResult

Name	Típus	Description	Required	Default
filtered	boolean		Yes
severity	karakterlánc		No

contentFilterDetectedResult

Name	Típus	Description	Required	Default
filtered	boolean		Yes
detected	boolean		No

contentFilterDetectedWithCitationResult

Name	Típus	Description	Required	Default
citation	objektum		No

Az idézet tulajdonságai

URL

Name	Típus	Description	Default
URL	karakterlánc

licenc

Name	Típus	Description	Default
licenc	karakterlánc

contentFilterResultsBase

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

Name	Típus	Required
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
hiba	errorBase	No

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.

Name	Típus	Required
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
hiba	errorBase	No
jailbreak	contentFilterDetectedResult	No

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.

Name	Típus	Required
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
hiba	errorBase	No
protected_material_text	contentFilterDetectedResult	No
protected_material_code	contentFilterDetectedWithCitationResult	No

promptFilterResult

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

Name	Típus	Description	Required	Default
prompt_index	egész szám		No
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.	No

promptFilterResults

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

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

dalleContentFilterResults

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

Name	Típus	Required
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No

dalleFilterResults

Name	Típus	Required
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
jailbreak	contentFilterDetectedResult	No

chatCompletionsRequestCommon

Name	Típus	Description	Required	Default
temperature	number	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.	No	1
top_p	number	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 az első 10% 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.	No	1
adatfolyam	boolean	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.	No	False
stop	sztring vagy tömb	Legfeljebb négy sorozat, amelyekben az API leállítja a további jogkivonatok generálását.	No
max_tokens	egész szám	A létrehozott válaszhoz engedélyezett jogkivonatok maximális száma. Alapértelmezés szerint a modell által visszaadható tokenek száma (4096 - prompt tokens) lesz. Ez az érték mostantól elavult `max_completion_tokens`, és nem kompatibilis az o1 sorozatú modellekkel.	No	4096
max_completion_tokens	egész szám	A befejezéshez létrehozható tokenek számának felső határa, beleértve a látható kimeneti jogkivonatokat és az érvelési jogkivonatokat.	No
presence_penalty	number	-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.	No	0
frequency_penalty	number	-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.	No	0
logit_bias	objektum	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 jogkivonat-azonosítójuk által megadott) egy társított torzító értékre képez le -100-ról 100-ra. 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; az olyan értékeknek, mint a -100 vagy a 100, a megfelelő jogkivonat kitiltását vagy kizárólagos kiválasztását kell eredményeznie.	No
felhasználó	karakterlánc	A végfelhasználót jelképező egyedi azonosító, amely segíthet az OpenAI Azure a visszaélések monitorozásában és észlelésében.	No

createCompletionRequest

Name	Típus	Description	Required	Default
kér	sztring vagy tömb	A befejezések létrehozására szolgáló kérések sztringként, sztringek tömbjeként, jogkivonatok tömbjeként vagy tokentömbként kódolva. Vegye figyelembe, hogy <a(z) \|endoftext\|> az a dokumentumelválasztó, amelyet a modell a betanítás során lát, így ha nincs megadva egy kérés, a modell úgy fog létrejönni, mintha egy új dokumentum elejéről származna.	Yes
best_of	egész szám	A befejezéseket `best_of` kiszolgálóoldalon hozza létre, és a "legjobb" értéket adja vissza (az, amelynek a legnagyobb a naplók valószínűsége jogkivonatonként). Az eredmények nem streamelhetők. A használat során `n`a jelölt befejezések számát szabályozza, `best_of` és `n` meghatározza, hogy hánynak kell visszaadnia a â € " `best_of` -nál `n`nagyobbnak kell lennie. Megjegyzés: Mivel ez a paraméter sok befejezést generál, gyorsan felhasználhatja a jogkivonatkvótát. Gondosan használja, és győződjön meg arról, hogy megfelelő beállításokat `max_tokensstop`és .	No	1
echo	boolean	A befejezés mellett a kérést is vissza kell adni	No	False
frequency_penalty	number	-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.	No	0
logit_bias	objektum	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-jogkivonat-kezelőben megadott jogkivonat-azonosítójuk alapján) egy társított elfogultsági értékre képezi le -100-ről 100-ra. 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; az olyan értékeknek, mint a -100 vagy a 100, a megfelelő jogkivonat kitiltását vagy kizárólagos kiválasztását kell eredményeznie. Átadhatja `{"50256": -100}` például a(z) \|endoftext\|< jogkivonat létrehozásának megakadályozását>.	No	None
logprobs	egész szám	Adja meg a napló valószínűségét a `logprobs` legvalószínűbb kimeneti jogkivonatokon, valamint a kiválasztott jogkivonatokon. Ha például `logprobs` 5, az API az öt legvalószínűbb jogkivonat listáját adja vissza. Az API mindig a `logprob` mintául szolgáló jogkivonatot adja vissza, így a válaszban `logprobs+1` akár elemek is lehetnek. A maximális érték `logprobs` 5.	No	None
max_tokens	egész szám	A befejezés során létrehozható jogkivonatok maximális száma. A parancssor jogkivonatszáma plusz `max_tokens` nem haladhatja meg a modell környezethosszát.	No	16
n	egész szám	Hány befejezést kell létrehozni az egyes kérésekhez. Megjegyzés: Mivel ez a paraméter sok befejezést generál, gyorsan felhasználhatja a jogkivonatkvótát. Gondosan használja, és győződjön meg arról, hogy megfelelő beállításokat `max_tokensstop`és .	No	1
presence_penalty	number	-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.	No	0
seed	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.	No
stop	sztring vagy tömb	Legfeljebb négy sorozat, amelyekben az API leállítja a további jogkivonatok generálását. A visszaadott szöveg nem tartalmazza a leállítási sorrendet.	No
adatfolyam	boolean	Azt határozza meg, hogy vissza szeretné-e streamelni a részleges előrehaladást. Ha be van állítva, a jogkivonatok csak a kiszolgáló által küldött eseményekként lesznek elküldve , amint elérhetővé válnak, és a streamet egy `data: [DONE]` üzenet leállítja.	No	False
suffix	karakterlánc	A beszúrt szöveg befejezése után megjelenő utótag. Ez a paraméter csak a következőhöz `gpt-3.5-turbo-instruct`támogatott: .	No	None
temperature	number	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.	No	1
top_p	number	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 az első 10% 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.	No	1
felhasználó	karakterlánc	A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében.	No

createCompletionResponse

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

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

createChatCompletionRequest

Name	Típus	Description	Required	Default
temperature	number	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.	No	1
top_p	number	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 az első 10% 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.	No	1
adatfolyam	boolean	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.	No	False
stop	sztring vagy tömb	Legfeljebb négy sorozat, amelyekben az API leállítja a további jogkivonatok generálását.	No
max_tokens	egész szám	A csevegés befejezésekor létrehozható jogkivonatok maximális száma. A bemeneti jogkivonatok és a létrehozott jogkivonatok teljes hosszát a modell környezethossza korlátozza.	No
max_completion_tokens	egész szám	A befejezéshez létrehozható tokenek számának felső határa, beleértve a látható kimeneti jogkivonatokat és az érvelési jogkivonatokat.	No
presence_penalty	number	-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.	No	0
frequency_penalty	number	-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.	No	0
logit_bias	objektum	Módosítsa annak valószínűségét, hogy a megadott jogkivonatok megjelenjenek a befejezéskor. Elfogad egy JSON-objektumot, amely leképzi a jogkivonatokat (a jogkivonat-azonosítójuk által megadott) egy társított torzító értékre -100-ról 100-ra. 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; az olyan értékeknek, mint a -100 vagy a 100, a megfelelő jogkivonat kitiltását vagy kizárólagos kiválasztását kell eredményeznie.	No	None
felhasználó	karakterlánc	A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében.	No
messages	tömb	Az eddig a beszélgetésből álló üzenetek listája.	Yes
data_sources	tömb	Az őket használó Azure OpenAI-csevegőbővítmények konfigurációs bejegyzései. Ez a további specifikáció csak Azure OpenAI-val kompatibilis.	No
logprobs	boolean	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`: .	No	False
top_logprobs	egész szám	Egy 0 és 20 közötti egész szám, amely megadja, hogy az egyes tokenpozíciókban a legvalószínűbb tokenek hányan térnek vissza, és mindegyikhez tartozik napló valószínűsége. `logprobs` ezt a paramétert `true` kell beállítani.	No
n	egész szám	Hány csevegés-befejezési lehetőséget kell létrehozni az egyes bemeneti üzenetekhez. Vegye figyelembe, hogy a díjakat a létrehozott jogkivonatok száma alapján számítjuk fel az összes lehetőség közül. Tartsa meg `n` a `1` költségek minimalizálását.	No	1
parallel_tool_calls	ParallelToolCalls	Engedélyezi-e a párhuzamos függvényhívást az eszköz használata során.	No	True
response_format	ResponseFormatText vagy ResponseFormatJsonObject vagy ResponseFormatJsonSchema	Egy objektum, amely megadja a modell által kiadandó formátumot. Kompatibilis a GPT-4o, GPT-4o mini, GPT-4 Turbo és az összes GPT-3.5 Turbo modellek újabb, mint `gpt-3.5-turbo-1106`. A strukturált kimeneteket engedélyező `{ "type": "json_schema", "json_schema": {...} }` beállítás, amely garantálja, hogy a modell megfelel a megadott JSON-sémának. A JSON mód engedélyezése, `{ "type": "json_object" }` amely garantálja, hogy a modell által generált üzenet érvényes JSON. Fontos: JSON-mód használata esetén a modellt arra is meg kell adnia, hogy saját maga állítson elő JSON-t egy rendszeren vagy felhasználói üzeneten keresztül. Enélkül a modell létrehozhat egy korlátlan térköz-adatfolyamot, amíg a generáció el nem éri a jogkivonat korlátját, ami egy hosszú ideig futó és látszólag "elakadt" kérést eredményez. Azt is vegye figyelembe, hogy az üzenet tartalma részlegesen megszakadhat, ha `finish_reason="length"`az azt jelzi, hogy a létrehozás túllépte `max_tokens` vagy a beszélgetés túllépte a környezet maximális hosszát.	No
seed	egész szám	Ez a funkció bétaverzióban érhető el. Ha meg van adva, a rendszerünk mindent megtesz annak érdekében, hogy determinisztikus mintát hozzon létre, így az azonos `seed` és paraméterekkel rendelkező ismétlődő kérelmeknek ugyanazt az eredményt kell visszaadnia. A determinizmus nem garantált, és a háttérrendszer változásainak figyeléséhez tekintse meg a `system_fingerprint` válaszparamétert.	No
tools	tömb	A modell által meghívható eszközök listája. Jelenleg csak a függvények támogatottak eszközként. Ezzel megadhatja azon függvények listáját, amelyekhez a modell JSON-bemeneteket hozhat létre. Legfeljebb 128 függvény támogatott.	No
tool_choice	chatCompletionToolChoiceOption	Azt szabályozza, hogy a modell melyik eszközt hívja meg (ha van ilyen). `none` azt jelenti, hogy a modell nem hív meg egyetlen eszközt sem, és ehelyett létrehoz egy üzenetet. `auto` azt jelenti, hogy a modell választhat egy üzenet létrehozása vagy egy vagy több eszköz meghívása között. `required` azt jelenti, hogy a modellnek egy vagy több eszközt kell meghívnia. Egy adott eszköz megadása az `{"type": "function", "function": {"name": "my_function"}}` eszköz meghívására kényszeríti a modellt. `none` az alapértelmezett, ha nincsenek eszközök. `auto` az alapértelmezett, ha az eszközök vannak jelen.	No
function_call	sztring vagy csevegésCompletionFunctionCallOption	Elavult a javára `tool_choice`. Azt szabályozza, hogy a modell melyik függvényt hívja meg (ha van ilyen). `none` azt jelenti, hogy a modell nem hív meg függvényt, hanem létrehoz egy üzenetet. `auto` azt jelenti, hogy a modell választhat az üzenet létrehozása vagy egy függvény meghívása között. Egy adott függvény megadása a modell meghívására kényszeríti `{"name": "my_function"}` a modellt. `none` az alapértelmezett, ha nincsenek függvények. `auto` az alapértelmezett, ha függvények vannak jelen.	No
functions	tömb	Elavult a javára `tools`. Azon függvények listája, amelyekhez a modell JSON-bemeneteket hozhat létre.	No

chatCompletionFunctions

Name	Típus	Description	Required
description	karakterlánc	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.	No
name	karakterlánc	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.	Yes
parameters	FunctionParameters	A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva. Példákért tekintse meg az útmutatót és a formátum dokumentációját ismertető JSON-sémahivatkozást . Az kihagyás `parameters` üres paraméterlistával rendelkező függvényt határoz meg.	No

chatCompletionFunctionCallOption

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

Name	Típus	Description	Required	Default
name	karakterlánc	A meghívandó függvény neve.	Yes

chatCompletionRequestMessage

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

chatCompletionRequestSystemMessage

Name	Típus	Description	Required
tartalom	sztring vagy tömb	A rendszerüzenet tartalma.	Yes
szerepkör	felsorolás	Ebben az esetben `system`az üzenetek szerzőjének szerepe. Lehetséges értékek: rendszer	Yes
name	karakterlánc	A résztvevő opcionális neve. Megadja a modellinformációkat, hogy különbséget tegyen az azonos szerepkörű résztvevők között.	No

chatCompletionRequestUserMessage

Name	Típus	Description	Required
tartalom	sztring vagy tömb	A felhasználói üzenet tartalma.	Yes
szerepkör	felsorolás	Ebben az esetben `user`az üzenetek szerzőjének szerepe. Lehetséges értékek: felhasználó	Yes
name	karakterlánc	A résztvevő opcionális neve. Megadja a modellinformációkat, hogy különbséget tegyen az azonos szerepkörű résztvevők között.	No

chatCompletionRequestAssistantMessage

Name	Típus	Description	Required
tartalom	sztring vagy tömb	Az asszisztens üzenetének tartalma. Kötelező, kivéve, ha `tool_callsfunction_call` meg van adva vagy meg van adva.	No
refusal	karakterlánc	Az asszisztens elutasító üzenete.	No
szerepkör	felsorolás	Ebben az esetben `assistant`az üzenetek szerzőjének szerepe. Lehetséges értékek: asszisztens	Yes
name	karakterlánc	A résztvevő opcionális neve. Megadja a modellinformációkat, hogy különbséget tegyen az azonos szerepkörű résztvevők között.	No
tool_calls	chatCompletionMessageToolCalls	A modell által generált eszközhívások, például függvényhívások.	No
function_call	objektum	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.	No

A function_call tulajdonságai

arguments

Name	Típus	Description	Default
arguments	karakterlánc	A függvény meghívására használható argumentumok, amelyeket a modell JSON formátumban hoz létre. Vegye figyelembe, hogy a modell nem mindig hoz létre érvényes JSON-t, és olyan paramétereket is létrehozhat, amelyeket a függvényséma nem határoz meg. A függvény meghívása előtt ellenőrizze a kód argumentumait.

name

Name	Típus	Description	Default
name	karakterlánc	A meghívandó függvény neve.

chatCompletionRequestToolMessage

Name	Típus	Description	Required
szerepkör	felsorolás	Ebben az esetben `tool`az üzenetek szerzőjének szerepe. Lehetséges értékek: eszköz	Yes
tartalom	sztring vagy tömb	Az eszközüzenet tartalma.	Yes
tool_call_id	karakterlánc	Eszközhívás, amelyre az üzenet válaszol.	Yes

chatCompletionRequestFunctionMessage

Name	Típus	Description	Required
szerepkör	felsorolás	Ebben az esetben `function`az üzenetek szerzőjének szerepe. Lehetséges értékek: függvény	Yes
tartalom	karakterlánc	A függvényüzenet tartalma.	Yes
name	karakterlánc	A meghívandó függvény neve.	Yes

chatCompletionRequestSystemMessageContentPart

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

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestAssistantMessageContentPart

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

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

Name	Típus	Description	Required	Default
típus	felsorolás	A tartalomrész típusa. Lehetséges értékek: szöveg	Yes
SMS	karakterlánc	A szöveges tartalom.	Yes

chatCompletionRequestMessageContentPartImage

Name	Típus	Description	Required	Default
típus	felsorolás	A tartalomrész típusa. Lehetséges értékek: image_url	Yes
image_url	objektum		Yes

A image_url tulajdonságai

url

Name	Típus	Description	Default
url	karakterlánc	A rendszerkép URL-címe vagy a base64 kódolású képadatok.

detail

Name	Típus	Description	Default
detail	karakterlánc	A kép részletességi szintjét adja meg. További információ a Vision útmutatójában.	auto

chatCompletionRequestMessageContentPartRefusal

Name	Típus	Description	Required	Default
típus	felsorolás	A tartalomrész típusa. Lehetséges értékek: elutasítás	Yes
refusal	karakterlánc	A modell által generált elutasítási üzenet.	Yes

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 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 Azure OpenAI-val kompatibilis.

Name	Típus	Description	Required	Default
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 Azure OpenAI-csevegésbővítmények használatával bővíti a válasz viselkedését. Ennek a konfigurációnak a használata csak Azure OpenAI-val kompatibilis.	Yes

azureChatExtensionType

Description: 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 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 Azure OpenAI-val kompatibilis.

Type: string

Default:

Enum Name: AzureChatExtensionType

Enum Values:

Value	Description
azure_search	A Azure Search Azure OpenAI csevegőbővítményként való használatát jelöli.
azure_cosmos_db	A Azure Cosmos DB Azure OpenAI csevegőbővítményként való használatát jelöli.

azureSearchChatExtensionConfiguration

A Azure Search konfigurálható beállításainak konkrét megjelenítése Azure OpenAI csevegőbővítményként való használatakor.

Name	Típus	Description	Required	Default
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 Azure OpenAI-csevegésbővítmények használatával bővíti a válasz viselkedését. Ennek a konfigurációnak a használata csak Azure OpenAI-val kompatibilis.	Yes
parameters	azureSearchChatExtensionParameters	A Azure Search paraméterei Azure OpenAI csevegőbővítményként használva.	No

azureSearchChatExtensionParameters

A Azure Search paraméterei Azure OpenAI csevegőbővítményként használva.

Name	Típus	Description	Required
hitelesítés	onYourDataApiKeyAuthenticationOptions vagy onYourDataSystemAssignedManagedIdentityAuthenticationOptions vagy onYourDataUserAssignedManagedIdentityAuthenticationOptions		Yes
top_n_documents	egész szám	A konfigurált lekérdezéshez használható dokumentumok maximális száma.	No
in_scope	boolean	Azt határozza meg, hogy a lekérdezések az indexelt adatok használatára legyenek-e korlátozva.	No
strictness	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.	No
role_information	karakterlánc	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.	No
végpont	karakterlánc	A használni kívánt Azure keresési erőforrás abszolút végpontjának elérési útja.	Yes
index_name	karakterlánc	A hivatkozott Azure Keresési erőforrásban elérhetőként használni kívánt index neve.	Yes
fields_mapping	azureSearchIndexFieldMappingOptions	Nem kötelező beállítások a mezők feldolgozásának szabályozásához konfigurált Azure keresési erőforrás használatakor.	No
query_type	azureSearchQueryType	A Azure Keresési lekérdezés típusa, amelyet Azure OpenAI-csevegőbővítményként való használatakor végre kell hajtani.	No
semantic_configuration	karakterlánc	A lekérdezés további szemantikai konfigurációja.	No
szűrő	karakterlánc	Search filter.	No
embedding_dependency	onYourDataEndpointVectorizationSource vagy onYourDataDeploymentNameVectorizationSource		No

azureSearchIndexFieldMappingOptions

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

Name	Típus	Description	Required
title_field	karakterlánc	A címként használni kívánt indexmező neve.	No
url_field	karakterlánc	Az URL-címként használni kívánt indexmező neve.	No
filepath_field	karakterlánc	A fájlútvonalként használandó indexmező neve.	No
content_fields	tömb	A tartalomként kezelendő indexmezők nevei.	No
content_fields_separator	karakterlánc	Az elválasztó minta, amelyet a tartalommezőknek használniuk kell.	No
vector_fields	tömb	A vektoradatokat ábrázoló mezők nevei.	No

azureSearchQueryType

A Azure Keresési lekérdezés típusa, amelyet Azure OpenAI-csevegőbővítményként való használatakor végre kell hajtani.

Description: A Azure Keresési lekérdezés típusa, amelyet Azure OpenAI-csevegőbővítményként való használatakor kell végrehajtani.

Type: string

Default:

Enum Name: AzureSearchQueryType

Enum Values:

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

azureCosmosDBChatExtensionConfiguration

A Azure Cosmos DB konfigurálható beállításainak konkrét megjelenítése Azure OpenAI-csevegőbővítményként való használatakor.

Name	Típus	Description	Required	Default
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 Azure OpenAI-csevegésbővítmények használatával bővíti a válasz viselkedését. Ennek a konfigurációnak a használata csak Azure OpenAI-val kompatibilis.	Yes
parameters	azureCosmosDBChatExtensionParameters	A Azure OpenAI on Your Data csevegőbővítmények Azure Cosmos DB konfigurálásakor használandó paraméterek MongoDB vCore.	No

azureCosmosDBChatExtensionParameters

A MongoDB virtuális maghoz készült Azure Cosmos DB használatakor Azure OpenAI on Your Data csevegőbővítmények konfigurálásakor használandó paraméterek.

Name	Típus	Description	Required
hitelesítés	onYourDataConnectionStringAuthenticationOptions	Az OpenAI Azure hitelesítési beállításai az adatokon kapcsolati karakterlánc használatakor.	Yes
top_n_documents	egész szám	A konfigurált lekérdezéshez használható dokumentumok maximális száma.	No
in_scope	boolean	Azt határozza meg, hogy a lekérdezések az indexelt adatok használatára legyenek-e korlátozva.	No
strictness	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.	No
role_information	karakterlánc	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.	No
database_name	karakterlánc	A MongoDB virtuális mag adatbázisának neve, amelyet a Azure Cosmos DB használ.	Yes
container_name	karakterlánc	A Azure Cosmos DB erőforrástároló neve.	Yes
index_name	karakterlánc	A MongoDB virtuálismag-index neve, amelyet a Azure Cosmos DB használ.	Yes
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.	Yes
embedding_dependency	onYourDataEndpointVectorizationSource vagy onYourDataDeploymentNameVectorizationSource		Yes

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.

Name	Típus	Description	Required
title_field	karakterlánc	A címként használni kívánt indexmező neve.	No
url_field	karakterlánc	Az URL-címként használni kívánt indexmező neve.	No
filepath_field	karakterlánc	A fájlútvonalként használandó indexmező neve.	No
content_fields	tömb	A tartalomként kezelendő indexmezők nevei.	Yes
content_fields_separator	karakterlánc	Az elválasztó minta, amelyet a tartalommezőknek használniuk kell.	No
vector_fields	tömb	A vektoradatokat ábrázoló mezők nevei.	Yes

onYourDataAuthenticationOptions

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

Name	Típus	Description	Required	Default
típus	onYourDataAuthenticationType	Az adatokon Azure OpenAI-val támogatott hitelesítési típusok.	Yes

onYourDataAuthenticationType

Az adatokon Azure OpenAI-val támogatott hitelesítési típusok.

Description: A Azure OpenAI on Your Data szolgáltatással támogatott hitelesítési típusok.

Type: string

Default:

Szám neve: OnYourDataAuthenticationType

Enum Values:

Value	Description
api_key	Hitelesítés API-kulccsal.
connection_string	Hitelesítés kapcsolati karakterlánc 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 OpenAI on Your Data api-kulcs használatakor Azure hitelesítési beállításai.

Name	Típus	Description	Required	Default
típus	onYourDataAuthenticationType	Az adatokon Azure OpenAI-val támogatott hitelesítési típusok.	Yes
kulcs	karakterlánc	A hitelesítéshez használandó API-kulcs.	No

onYourDataConnectionStringAuthenticationOptions

Az OpenAI Azure hitelesítési beállításai az adatokon kapcsolati karakterlánc használatakor.

Name	Típus	Description	Required	Default
típus	onYourDataAuthenticationType	Az adatokon Azure OpenAI-val támogatott hitelesítési típusok.	Yes
connection_string	karakterlánc	A hitelesítéshez használni kívánt kapcsolati karakterlánc.	No

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

A rendszer által hozzárendelt felügyelt identitás használatakor Azure OpenAI on Your Data hitelesítési beállításai.

Name	Típus	Description	Required	Default
típus	onYourDataAuthenticationType	Az adatokon Azure OpenAI-val támogatott hitelesítési típusok.	Yes

onYourDataUserAssignedManagedIdentityAuthenticationOptions

A felhasználó által hozzárendelt felügyelt identitás használatakor Azure OpenAI on Your Data hitelesítési beállításai.

Name	Típus	Description	Required	Default
típus	onYourDataAuthenticationType	Az adatokon Azure OpenAI-val támogatott hitelesítési típusok.	Yes
managed_identity_resource_id	karakterlánc	A hitelesítéshez használandó, felhasználó által hozzárendelt felügyelt identitás erőforrás-azonosítója.	No

onYourDataVectorizationSource

Vektorizációs forrás absztrakt ábrázolása Azure OpenAI on Your Data vektorkereséssel.

Name	Típus	Description	Required	Default
típus	onYourDataVectorizationSourceType	Azokat a rendelkezésre álló forrásokat jelöli, Azure az OpenAI On Your Data használatával konfigurálhatja az adatok vektorizálását vector search.	Yes

onYourDataVectorizationSourceType

Azokat a rendelkezésre álló forrásokat jelöli, Azure OpenAI On Your Data konfigurálhatja az adatok vektorizálását vektorkereséshez.

Description: Azokat a rendelkezésre álló forrásokat jelöli, Azure az OpenAI On Your Data használatával konfigurálhatja az adatok vektorizálását a következőkkel való használatra:
vector search.

Type: string

Default:

Szám neve: OnYourDataVectorizationSourceType

Enum Values:

Value	Description
végpont	A Azure OpenAI-beágyazási modellhez intézett 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 a 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.

onYourDataDeploymentNameVectorizationSource

Az OpenAI on Your Data Azure által a vektorkeresés alkalmazásakor használt vektorizációs forrás részletei, amelyek egy belső beágyazási modell üzembehelyezési nevére épülnek ugyanabban a Azure OpenAI-erőforrásban.

Name	Típus	Description	Required	Default
típus	onYourDataVectorizationSourceType	Azokat a rendelkezésre álló forrásokat jelöli, Azure az OpenAI On Your Data használatával konfigurálhatja az adatok vektorizálását vector search.	Yes
deployment_name	karakterlánc	Megadja a vektorizáláshoz használni kívánt modelltelepítés nevét. Ennek a modellnek ugyanabban a Azure OpenAI-erőforrásban kell lennie, de az Adatok lapon ezt a modelltelepítést egy belső hívással fogja használni, nem pedig nyilvánosan, amely lehetővé teszi a vektorkeresést még a privát hálózatokban is.	No

onYourDataEndpointVectorizationSource

A vektorizációs forrás részletei, amelyeket Azure OpenAI az adatokon vektorkeresés alkalmazásakor használ, amely egy nyilvános Azure OpenAI-végpont beágyazási hívásán alapul.

Name	Típus	Description	Required
típus	onYourDataVectorizationSourceType	Azokat a rendelkezésre álló forrásokat jelöli, Azure az OpenAI On Your Data használatával konfigurálhatja az adatok vektorizálását vector search.	Yes
hitelesítés	onYourDataApiKeyAuthenticationOptions	Az OpenAI on Your Data api-kulcs használatakor Azure hitelesítési beállításai.	No
végpont	karakterlánc	Meghatározza a vektorizáláshoz használni kívánt végpontot. Ennek a végpontnak ugyanabban a Azure OpenAI-erőforrásban kell lennie, de az Adatok lapon ezt a végpontot nem nyilvános, hanem belső hívással fogja használni, amely lehetővé teszi a vektorkeresést még a magánhálózatokban is.	No

azureChatExtensionsMessageContext

A Azure OpenAI-csevegőbővítmények létrehozásakor elérhető további környezeti információk megjelenítése a megfelelő csevegéskiegészítési válasz létrehozásában. Ezek a környezeti információk csak akkor lesznek kitöltve, ha Azure OpenAI-kérést használnak, amely egyező bővítmény használatára van konfigurálva.

Name	Típus	Description	Required	Default
citations	tömb	Az adatforrás lekérési eredménye, amely az asszisztens üzenetének a válaszban való létrehozásához használatos.	No
szándék	karakterlánc	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.	No

citation

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

Name	Típus	Description	Required
tartalom	karakterlánc	Az idézet tartalma.	Yes
title	karakterlánc	Az idézet címe.	No
url	karakterlánc	Az idézet URL-címe.	No
filepath	karakterlánc	Az idézet fájl elérési útja.	No
chunk_id	karakterlánc	Az idézet adattömb-azonosítója.	No

chatCompletionMessageToolCall

Name	Típus	Description	Required
id	karakterlánc	Az eszközhívás azonosítója.	Yes
típus	toolCallType	Ebben az esetben `function`az eszközhívás típusa.	Yes
függvény	objektum	A modell által hívott függvény.	Yes

Függvény tulajdonságai

name

Name	Típus	Description	Default
name	karakterlánc	A meghívandó függvény neve.

arguments

Name	Típus	Description	Default
arguments	karakterlánc	A függvény meghívására használható argumentumok, amelyeket a modell JSON formátumban hoz létre. Vegye figyelembe, hogy a modell nem mindig hoz létre érvényes JSON-t, és olyan paramétereket is létrehozhat, amelyeket a függvényséma nem határoz meg. A függvény meghívása előtt ellenőrizze a kód argumentumait.

toolCallType

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

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

Type: string

Default:

Szám neve: ToolCallType

Enum Values:

Value	Description
függvény	Az eszközhívás típusa függvény.

chatCompletionRequestMessageTool

Name	Típus	Description	Required	Default
tool_call_id	karakterlánc	Eszközhívás, amelyre az üzenet válaszol.	No
tartalom	karakterlánc	Az üzenet tartalma.	No

chatCompletionRequestMessageFunction

Name	Típus	Description	Required
szerepkör	felsorolás	Ebben az esetben `function`az üzenetek szerzőjének szerepe. Lehetséges értékek: függvény	No
name	karakterlánc	Az üzenet tartalma.	No
tartalom	karakterlánc	Az üzenet tartalma.	No

createChatCompletionResponse

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

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

createChatCompletionStreamResponse

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

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

chatCompletionStreamResponseDelta

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

Name	Típus	Description	Required
tartalom	karakterlánc	Az adattömbüzenet tartalma.	No
function_call	objektum	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.	No
tool_calls	tömb		No
szerepkör	felsorolás	Az üzenet szerzőjének szerepe. Lehetséges értékek: rendszer, felhasználó, asszisztens, eszköz	No
refusal	karakterlánc	A modell által generált elutasítási üzenet.	No

A function_call tulajdonságai

arguments

Name	Típus	Description	Default
arguments	karakterlánc	A függvény meghívására használható argumentumok, amelyeket a modell JSON formátumban hoz létre. Vegye figyelembe, hogy a modell nem mindig hoz létre érvényes JSON-t, és olyan paramétereket is létrehozhat, amelyeket a függvényséma nem határoz meg. A függvény meghívása előtt ellenőrizze a kód argumentumait.

name

Name	Típus	Description	Default
name	karakterlánc	A meghívandó függvény neve.

chatCompletionMessageToolCallChunk

Name	Típus	Description	Required
index	egész szám		Yes
id	karakterlánc	Az eszközhívás azonosítója.	No
típus	felsorolás	Az eszköz típusa. Jelenleg csak `function` a támogatottak. Lehetséges értékek: függvény	No
függvény	objektum		No

Függvény tulajdonságai

name

Name	Típus	Description	Default
name	karakterlánc	A meghívandó függvény neve.

arguments

Name	Típus	Description	Default
arguments	karakterlánc	A függvény meghívására használható argumentumok, amelyeket a modell JSON formátumban hoz létre. Vegye figyelembe, hogy a modell nem mindig hoz létre érvényes JSON-t, és olyan paramétereket is létrehozhat, amelyeket a függvényséma nem határoz meg. A függvény meghívása előtt ellenőrizze a kód argumentumait.

chatCompletionStreamOptions

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

Name	Típus	Description	Required	Default
include_usage	boolean	Ha be van állítva, egy további adattömb lesz streamelve az `data: [DONE]` üzenet előtt. Az `usage` adattömb mezője a teljes kérelem jogkivonat-használati statisztikáit jeleníti meg, és a `choices` mező mindig üres tömb lesz. Az összes többi adattömb tartalmaz egy `usage` mezőt is, de null értékkel.	No

chatCompletionChoiceLogProbs

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

Name	Típus	Description	Required	Default
tartalom	tömb	Az üzenettartalom-jogkivonatok listája naplók valószínűségi adataival.	Yes
refusal	tömb	Az üzenetmegtagadási jogkivonatok listája a napló valószínűségi adataival.	No

chatCompletionTokenLogprob

Name	Típus	Description	Required
kód	karakterlánc	The token.	Yes
logprob	number	A jogkivonat naplójának valószínűsége.	Yes
bytes	tömb	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.	Yes
top_logprobs	tömb	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.	Yes

chatCompletionResponseMessage

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

Name	Típus	Description	Required
szerepkör	chatCompletionResponseMessageRole	A válaszüzenet szerzőjének szerepe.	Yes
refusal	karakterlánc	A modell által generált elutasítási üzenet.	Yes
tartalom	karakterlánc	Az üzenet tartalma.	Yes
tool_calls	tömb	A modell által generált eszközhívások, például függvényhívások.	No
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.	No
környezet	azureChatExtensionsMessageContext	A 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 Azure OpenAI-kérést használ, amely egyező bővítmény használatára van konfigurálva.	No

chatCompletionResponseMessageRole

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

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

Type: string

Default:

Enum Values:

segéd

chatCompletionToolChoiceOption

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

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

chatCompletionNamedToolChoice

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

Name	Típus	Description	Required	Default
típus	felsorolás	Az eszköz típusa. Jelenleg csak `function` a támogatottak. Lehetséges értékek: függvény	Yes
függvény	objektum		Yes

Függvény tulajdonságai

name

Name	Típus	Description	Default
name	karakterlánc	A meghívandó függvény neve.

ParallelToolCalls

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

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

chatCompletionMessageToolCalls

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

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

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.

Name	Típus	Description	Required	Default
name	karakterlánc	A meghívandó függvény neve.	Yes
arguments	karakterlánc	A függvény meghívására használható argumentumok, amelyeket a modell JSON formátumban hoz létre. Vegye figyelembe, hogy a modell nem mindig hoz létre érvényes JSON-t, és olyan paramétereket is létrehozhat, amelyeket a függvényséma nem határoz meg. A függvény meghívása előtt ellenőrizze a kód argumentumait.	Yes

completionUsage

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

Name	Típus	Description	Required
prompt_tokens	egész szám	A jogkivonatok száma a parancssorban.	Yes
completion_tokens	egész szám	A létrehozott befejezésben lévő tokenek száma.	Yes
total_tokens	egész szám	A kérelemben használt tokenek teljes száma (parancssor + befejezés).	Yes
completion_tokens_details	objektum	A befejezéskor használt jogkivonatok lebontása.	No

A completion_tokens_details tulajdonságai

reasoning_tokens

Name	Típus	Description	Default
reasoning_tokens	egész szám	A modell által az érveléshez létrehozott jogkivonatok.

chatCompletionTool

Name	Típus	Description	Required	Default
típus	felsorolás	Az eszköz típusa. Jelenleg csak `function` a támogatottak. Lehetséges értékek: függvény	Yes
függvény	FunctionObject		Yes

FunctionParameters

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

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

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

FunctionObject

Name	Típus	Description	Required	Default
description	karakterlánc	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.	No
name	karakterlánc	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.	Yes
parameters	FunctionParameters	A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva. Példákért tekintse meg az útmutatót és a formátum dokumentációját ismertető JSON-sémahivatkozást . Az kihagyás `parameters` üres paraméterlistával rendelkező függvényt határoz meg.	No
strict	boolean	A függvényhívás létrehozásakor engedélyezze-e a szigorú sémabetartást. Ha igaz értékre van állítva, a modell a mezőben meghatározott sémát `parameters` követi. Csak a JSON-séma egy részhalmaza támogatott, ha `strict` az .`true`	No	False

ResponseFormatText

Name	Típus	Description	Required	Default
típus	felsorolás	A definiált válaszformátum típusa: `text` Lehetséges értékek: szöveg	Yes

ResponseFormatJsonObject

Name	Típus	Description	Required	Default
típus	felsorolás	A definiált válaszformátum típusa: `json_object` Lehetséges értékek: json_object	Yes

ResponseFormatJsonSchemaSchema

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

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

ResponseFormatJsonSchema

Name	Típus	Description	Required	Default
típus	felsorolás	A definiált válaszformátum típusa: `json_schema` Lehetséges értékek: json_schema	Yes
json_schema	objektum		Yes

A json_schema tulajdonságai

description

Name	Típus	Description	Default
description	karakterlánc	A modell a válaszformátum leírásával határozza meg, hogyan válaszoljon a formátumra.

name

Name	Típus	Description	Default
name	karakterlánc	A válaszformátum neve. A-z, A-Z, 0-9, vagy aláhúzásjeleket és kötőjeleket kell tartalmaznia, legfeljebb 64 hosszúságúak.

séma

Name	Típus	Description	Default
séma	ResponseFormatJsonSchemaSchema	A válaszformátum sémája, amely JSON-sémaobjektumként van leírva.

strict

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

chatCompletionChoiceCommon

Name	Típus	Description	Required	Default
index	egész szám		No
finish_reason	karakterlánc		No

createTranslationRequest

Translation request.

Name	Típus	Description	Required	Default
fájl	karakterlánc	A lefordítandó hangfájl.	Yes
kér	karakterlánc	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.	No
response_format	audioResponseFormat	Meghatározza a kimenet formátumát.	No
temperature	number	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.	No	0

audioResponse

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

Name	Típus	Description	Required	Default
SMS	karakterlánc	Lefordított vagy átírt szöveg.	Yes

audioVerboseResponse

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

Name	Típus	Description	Required
SMS	karakterlánc	Lefordított vagy átírt szöveg.	Yes
feladat	karakterlánc	A hangfeladat típusa.	No
nyelv	karakterlánc	Language.	No
duration	number	Duration.	No
segments	tömb		No

audioResponseFormat

Meghatározza a kimenet formátumát.

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

Type: string

Default:

Enum Values:

json
SMS
srt
verbose_json
vtt

createTranscriptionRequest

Transcription request.

Name	Típus	Description	Required	Default
fájl	karakterlánc	Az átírandó hangfájl-objektum.	Yes
kér	karakterlánc	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.	No
response_format	audioResponseFormat	Meghatározza a kimenet formátumát.	No
temperature	number	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.	No	0
nyelv	karakterlánc	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.	No

audioSegment

Átirat vagy fordítási szegmens.

Name	Típus	Description	Required
id	egész szám	Segment identifier.	No
seek	number	A szegmens eltolása.	No
start	number	Szegmens kezdő eltolása.	No
end	number	Szegmens vége eltolása.	No
SMS	karakterlánc	Segment text.	No
tokens	tömb	A szöveg jogkivonatai.	No
temperature	number	Temperature.	No
avg_logprob	number	Átlagos napló valószínűsége.	No
compression_ratio	number	Compression ratio.	No
no_speech_prob	number	Annak valószínűsége, hogy `no speech`.	No

imageQuality

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

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

Type: string

Default: standard

Enum name: Quality

Enum Values:

Value	Description
szabvány	A standard minőség szabványos minőségű képeket hoz létre.
hd	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.

Type: string

Default: url

Enum Name: ImagesResponseFormat

Enum Values:

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

Type: string

Default: 1024x1024

Szám neve: Méret

Enum Values:

Value	Description
1792x1024	A létrehozott kép kívánt mérete 1792x1024 képpont.
1024x1792	A létrehozott kép kívánt mérete 1024x1792 képpont.
1024x1024	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.

Type: string

Default: vivid

Szám neve: Stílus

Enum Values:

Value	Description
vivid	Az Élénk hiperreális és drámai képeket hoz létre.
natural	A Natural természetesebb és kevésbé hiperreális képeket hoz létre.

imageGenerationsRequest

Name	Típus	Description	Required	Default
kér	karakterlánc	A kívánt kép(ek) szöveges leírása. A maximális hossz 4000 karakter.	Yes
n	egész szám	A létrehozandó képek száma.	No	1
size	imageSize	A létrehozott képek mérete.	No	1024x1024
response_format	imagesResponseFormat	A létrehozott képek visszaadott formátuma.	No	url
felhasználó	karakterlánc	A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében.	No
quality	imageQuality	A létrehozandó kép minősége.	No	szabvány
style	imageStyle	A létrehozott képek stílusa.	No	vivid

generateImagesResponse

Name	Típus	Description	Required	Default
created	egész szám	A unix időbélyeg a művelet létrehozásakor.	Yes
adat	tömb	A művelet eredményadatai, ha sikeresek	Yes

imageResult

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

Name	Típus	Description	Required
url	karakterlánc	A kép URL-címe.	No
b64_json	karakterlánc	A base64 kódolású rendszerkép	No
content_filter_results	dalleContentFilterResults	Információ a tartalomszűrési eredményekről.	No
revised_prompt	karakterlánc	A rendszerkép létrehozásához használt kérés, ha a kérésnek volt valamilyen változata.	No
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.	No

Completions extensions

A befejezési bővítmények nem részei a Azure OpenAI adatsík következtetési specifikációjának legújabb GA-verziójának.

Chatmessage

A csevegőüzenet-objektum nem része a Azure OpenAI adatsík következtetési specifikációjának legújabb GA-verziójának.

Szövegfelolvasás (előzetes verzió)

Jelenleg nem része a Azure OpenAI adatsík következtetési specifikációjának legújabb Azure OpenAI GA-verziójának. Tekintse meg a funkció legújabb preview verzióját.

Next steps

Ismerje meg a modelleket, és finomhangoljon a REST API-val. További információ az OpenAI Azure megértett modellekről.

Visszajelzés

Hasznosnak találta ezt az oldalt?

Last updated on 2026-04-30