Megosztás a következőn keresztül:


Azure OpenAI szolgáltatás REST API-referencia

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

API-specifikációk

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

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

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

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

Hitelesítés

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

  • API-kulcs hitelesítése: Az ilyen típusú hitelesítéshez minden API-kérésnek tartalmaznia kell az API-kulcsot a api-key HTTP-fejlécben. A rövid útmutató útmutatást nyújt az ilyen típusú hitelesítéssel történő hívásokhoz.

  • Microsoft Entra ID-hitelesítés: Az API-hívásokat Microsoft Entra-jogkivonat használatával hitelesítheti. A hitelesítési jogkivonatok fejlécként szerepelnek a Authorization kérésekben. A megadott jogkivonatot például Bearer YOUR_AUTH_TOKENmeg kell előznieBearer. A Microsoft Entra ID-val történő hitelesítéssel kapcsolatos útmutatónkban olvashat.

REST API-verziószámozás

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

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

Adatsík-következtetés

A cikk további része az Azure OpenAI adatsík következtetési specifikációjának legújabb GA-kiadását ismerteti. 2024-06-01

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

Kiegészítés

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

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

URI-paraméterek

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

Kérelem fejléce

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

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név Típus Leírás Kötelező Alapértelmezett
haladéktalan sztring vagy tömb A sztringek vagy sztringek tömbjeként kódolt befejezések létrehozására szolgáló kérés(ek).
Vegye figyelembe, hogy <a(z) |endoftext|> az a dokumentumelválasztó, amelyet a modell a betanítás során lát, így ha a rendszer nem ad meg egy kérést, a modell úgy fog létrejönni, mintha egy új dokumentum elejéről származna. A sztringlista maximális mérete 2048.
Nem
max_tokens egész szám A parancssor és a max_tokens tokenszáma nem haladhatja meg a modell környezethosszát. A legtöbb modell környezethossza 2048 token (kivéve a legújabb modelleket, amelyek támogatják a 4096-ot). Legalább 0. Nem 16
hőmérséklet szám Milyen mintavételi hőmérsékletet kell használni. A magasabb értékek azt jelentik, hogy a modell több kockázatot vállal. A kreatívabb alkalmazásokhoz próbálja ki a 0.9-et, és a 0-t (arg maximális mintavételezést) a jól meghatározott válaszokkal rendelkezők számára.
Általában azt javasoljuk, hogy módosítsa ezt vagy top_p, de mindkettőt nem.
Nem 0
top_p szám A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti.
Általában azt javasoljuk, hogy módosítsa ezt vagy a hőmérsékletet, de mindkettőt nem.
Nem 0
logit_bias object Alapértelmezés szerint null. Módosítsa annak valószínűségét, hogy a megadott jogkivonatok megjelenjenek a befejezéskor. Elfogad egy json-objektumot, amely a jogkivonatokat (a GPT-tokenizerben megadott jogkivonat-azonosítójuk alapján) -100-ról 100-ra képez le egy társított elfogultsági értékre. Ezzel a tokenizer eszközzel (amely a GPT-2 és a GPT-3 esetében is működik) a szöveget tokenazonosítókká alakíthatja. Matematikailag a rendszer hozzáadja a torzításokat a modell által a mintavételezés előtt létrehozott logitokhoz. A pontos hatás modellenként eltérő lesz, de a -1 és az 1 közötti értékeknek csökkentenie vagy növelnie kell a kiválasztás valószínűségét; a -100 vagy a 100 értékhez hasonló értékek esetén a megfelelő jogkivonat kitiltása vagy kizárólagos kiválasztása szükséges. Például átadhatja a(z) {"50256":-100} értéket a <(z) |endoftext|> jogkivonat létrehozásának megakadályozásához. Nem
user húr A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében Nem
n egész szám Hány befejezést kell létrehozni az egyes kérésekhez. Legalább 1 és legfeljebb 128 engedélyezett.
Megjegyzés: Mivel ez a paraméter sok befejezést generál, gyorsan felhasználhatja a jogkivonatkvótát. Gondosan használja, és győződjön meg arról, hogy megfelelő beállításokat biztosít a max_tokens és a leállításhoz.
Nem 0
patak Logikai Azt határozza meg, hogy vissza szeretné-e streamelni a részleges előrehaladást. Ha be van állítva, a jogkivonatok csak a kiszolgáló által küldött eseményekként lesznek elküldve, amint elérhetővé válnak, és a streamet egy adat leállítja: [KÉSZ] üzenet. Nem Hamis
logprobs egész szám Adja meg a naplóprobok legvalószínűbb tokenjeinek napló valószínűségét, valamint a kiválasztott jogkivonatokat. Ha például a logprobs értéke 5, az API az 5 legvalószínűbb token listáját adja vissza. Az API mindig visszaadja a mintavételezett jogkivonat naplóprobját, így a válaszban legfeljebb logprobs+1 elem szerepelhet.
Legalább 0 és legfeljebb 5 engedélyezett.
Nem Egyik sem
toldalék húr A beszúrt szöveg befejezése után megjelenő utótag. Nem
echo Logikai A befejezés mellett a kérést is vissza kell adni Nem Hamis
állj sztring vagy tömb Legfeljebb 4 sorozat, ahol az API leállítja a további jogkivonatok generálását. A visszaadott szöveg nem tartalmazza a leállítási sorozatot. Nem
completion_config húr Nem
presence_penalty szám -2,0 és 2,0 közötti szám. A pozitív értékek büntetik az új jogkivonatokat attól függően, hogy az eddig megjelennek-e a szövegben, növelve a modell valószínűségét, hogy új témakörökről beszéljenek. Nem 0
frequency_penalty szám -2,0 és 2,0 közötti szám. A pozitív értékek a szövegben meglévő gyakoriságuk alapján büntetik az új jogkivonatokat, így csökken annak a valószínűsége, hogy a modell ugyanazt a sort szó szerint megismételi. Nem 0
best_of egész szám Létrehozza a best_of kiszolgálóoldali befejezéseket, és a "legjobb" értéket adja vissza (a tokenenkénti legnagyobb naplózási valószínűséggel rendelkezőt határozza meg). Az eredmények nem streamelhetők.
Az n használatakor best_of határozza meg a jelölt befejezések számát, az n pedig azt határozza meg, hogy hányat kell visszaadni – best_of n-nél nagyobbnak kell lennie.
Megjegyzés: Mivel ez a paraméter sok befejezést generál, gyorsan felhasználhatja a jogkivonatkvótát. Gondosan használja, és győződjön meg arról, hogy megfelelő beállításokat biztosít a max_tokens és a leállításhoz. Maximális értéke 128.
Nem

Válaszok

Név Típus Leírás Kötelező Alapértelmezett
id sztring Igen
object sztring Igen
Létrehozott egész szám Igen
modell sztring Igen
prompt_filter_results promptFilterResults A tartalomszűrés eredménye nulla vagy több kérés esetén jelenik meg a kérelemben. Streamelési kérés esetén a különböző kérések eredményei eltérő időpontokban vagy különböző megrendelésekben érkezhetnek. Nem
Választás array Igen
használat object Nem

Használati tulajdonságok

completion_tokens

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

Állapotkód: 200

Leírás: OK

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

Állapotkód: alapértelmezett

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

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

Példák

Példa

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

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

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

Válaszok: Állapotkód: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Beágyazások

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

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

URI-paraméterek

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

Kérelem fejléce

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

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név Típus Leírás Kötelező Alapértelmezett
bemenet sztring vagy tömb Beviteli szöveg a beágyazások lekéréséhez, sztringként kódolva. Ha több bemenet beágyazását szeretné lekérni egyetlen kérelemben, adjon át egy sztringtömböt. Minden bemenet hossza nem haladhatja meg a 2048-at.
Ha nem ágyaz be kódot, javasoljuk, hogy az új vonalakat (\n) cserélje le egyetlen szóközre a bemenetben, mivel alacsonyabb eredményeket észleltünk, amikor új vonalak vannak jelen.
Igen
user húr A végfelhasználót jelképező egyedi azonosító, amely segíthet a visszaélések monitorozásában és észlelésében. Nem
input_type húr a használni kívánt beágyazási keresés bemeneti típusa Nem
encoding_format húr A beágyazások visszaadásának formátuma. Lehet vagy float base64. Alapértelmezett érték: float. Nem
Méretek egész szám Az eredményként kapott kimeneti beágyazások dimenzióinak száma. Csak a későbbi és a későbbi modellekben text-embedding-3 támogatott. Nem

Válaszok

Név Típus Leírás Kötelező Alapértelmezett
object sztring Igen
modell sztring Igen
adatok array Igen
használat object Igen

Használati tulajdonságok

prompt_tokens

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

total_tokens

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

Állapotkód: 200

Leírás: OK

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

Példák

Példa

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

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

{
 "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,
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Csevegés befejezése

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

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

URI-paraméterek

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

Kérelem fejléce

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

Kérelem törzse

Tartalomtípus: alkalmazás/json

Név Típus Leírás Kötelező Alapértelmezett
hőmérséklet szám Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet.
Általában azt javasoljuk, hogy módosítsa ezt vagy top_p mindkettőt, de nem mindkettőt.
Nem 0
top_p szám A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti.
Általában azt javasoljuk, hogy módosítsa ezt vagy temperature mindkettőt, de nem mindkettőt.
Nem 0
patak Logikai Ha be van állítva, a rendszer részleges üzenet-különbözeteket küld, például a ChatGPT-ben. A jogkivonatok csak a kiszolgáló által küldött eseményekként lesznek elküldve, amint elérhetővé válnak, és a streamet egy data: [DONE] üzenet leállítja. Nem Hamis
állj sztring vagy tömb Legfeljebb 4 sorozat, ahol az API leállítja a további jogkivonatok generálását. Nem
max_tokens egész szám A létrehozott válaszhoz engedélyezett jogkivonatok maximális száma. Alapértelmezés szerint a modell által visszaadható tokenek száma (4096 - prompt tokens) lesz. Nem 4096
presence_penalty szám -2,0 és 2,0 közötti szám. A pozitív értékek büntetik az új jogkivonatokat attól függően, hogy az eddig megjelennek-e a szövegben, növelve a modell valószínűségét, hogy új témakörökről beszéljenek. Nem 0
frequency_penalty szám -2,0 és 2,0 közötti szám. A pozitív értékek a szövegben meglévő gyakoriságuk alapján büntetik az új jogkivonatokat, így csökken annak a valószínűsége, hogy a modell ugyanazt a sort szó szerint megismételi. Nem 0
logit_bias object Módosítsa annak valószínűségét, hogy a megadott jogkivonatok megjelenjenek a befejezéskor. Elfogad egy json-objektumot, amely -100-ról 100-ra képez le jogkivonatokat (a jogkivonat-azonosítójuk által megadott) egy társított elfogultsági értékre. Matematikailag a rendszer hozzáadja a torzításokat a modell által a mintavételezés előtt létrehozott logitokhoz. A pontos hatás modellenként eltérő lesz, de a -1 és az 1 közötti értékeknek csökkentenie vagy növelnie kell a kiválasztás valószínűségét; a -100 vagy a 100 értékhez hasonló értékek esetén a megfelelő jogkivonat kitiltása vagy kizárólagos kiválasztása szükséges. Nem
user húr A végfelhasználót jelképező egyedi azonosító, amely segíthet az Azure OpenAI-nak a visszaélések monitorozásában és észlelésében. Nem
üzenet array Az eddig a beszélgetésből álló üzenetek listája. Példa Python-kódra. Nem
data_sources array Az őket használó Azure OpenAI-csevegőbővítmények konfigurációs bejegyzései.
Ez a további specifikáció csak az Azure OpenAI-val kompatibilis.
Nem
n egész szám Hány csevegés-befejezési lehetőséget kell létrehozni az egyes bemeneti üzenetekhez. Nem 0
mag egész szám Ha meg van adva, a rendszerünk mindent megtesz annak érdekében, hogy determinisztikus mintát hozzon létre, így az azonos seed és paraméterekkel rendelkező ismétlődő kérelmeknek ugyanazt az eredményt kell visszaadnia. A determinizmus nincs meghatározva, és a háttérrendszer változásainak figyeléséhez tekintse meg a system_fingerprint válaszparamétert. Nem 0
logprobs Logikai A kimeneti jogkivonatok naplós valószínűségének visszaadása vagy sem. Ha igaz, akkor az egyes kimeneti jogkivonatok napló valószínűségét adja vissza a content következőben message: . Ez a lehetőség jelenleg nem érhető el a gpt-4-vision-preview modellen. Nem Hamis
top_logprobs egész szám 0 és 5 közötti egész szám, amely megadja, hogy az egyes tokenhelyzetekben a legvalószínűbb tokenek száma hány, és mindegyikhez tartozik napló valószínűsége. logprobs ezt a paramétert true kell beállítani. Nem
response_format object Egy objektum, amely megadja a modell által kiadandó formátumot. A JSON mód engedélyezésére szolgál. Nem
eszközök array A modell által meghí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. Nem
tool_choice chatCompletionToolChoiceOption Azt szabályozza, hogy a modell melyik függvényt hívja meg (ha van ilyen). none azt jelenti, hogy a modell nem hív meg függvényt, hanem létrehoz egy üzenetet. auto azt jelenti, hogy a modell választhat az üzenet létrehozása vagy egy függvény meghívása között. Egy adott függvény megadása a modell meghívására kényszeríti {"type": "function", "function": {"name": "my_function"}} a modellt. Nem
functions array Elavult a javára tools. Azon függvények listája, amelyekhez a modell JSON-bemeneteket hozhat létre. Nem
function_call sztring vagy objektum Elavult a javára tool_choice. Szabályozza, hogy a modell hogyan reagál a függvényhívásokra. A "none" azt jelenti, hogy a modell nem hív meg függvényt, és válaszol a végfelhasználónak. Az "auto" azt jelenti, hogy a modell választhat a végfelhasználók között, vagy meghívhat egy függvényt. Egy adott függvény megadása a modell meghívására kényszeríti {"name":\ "my_function"} a modellt. A "none" az alapértelmezett, ha nincsenek függvények. Az "auto" az alapértelmezett, ha függvények vannak jelen. Nem

A response_format tulajdonságai

Típus

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

Válaszok

Állapotkód: 200

Leírás: OK

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

Állapotkód: alapértelmezett

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

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

Példák

Példa

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

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

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

Válaszok: Állapotkód: 200

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

Példa

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

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

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

Válaszok: Állapotkód: 200

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

Példa

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

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

{
 "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're an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Válaszok: Állapotkód: 200

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

Példa

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

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

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

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

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

URI-paraméterek

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

Kérelem fejléce

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

Kérelem törzse

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

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

Válaszok

Állapotkód: 200

Leírás: OK

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

Példák

Példa

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

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

Válaszok: Állapotkód: 200

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

Példa

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

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

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

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

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

URI-paraméterek

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

Kérelem fejléce

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

Kérelem törzse

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

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

Válaszok

Állapotkód: 200

Leírás: OK

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

Példák

Példa

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

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

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

Válaszok: Állapotkód: 200

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

Példa

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

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

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

Képgenerálás

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

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

URI-paraméterek

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

Kérelem fejléce

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

Kérelem törzse

Tartalomtípus: alkalmazás/json

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

Válaszok

Állapotkód: 200

Leírás: Ok

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

Állapotkód: alapértelmezett

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

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

Példák

Példa

A rendszerképeket a rendszer kéri.

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

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

Összetevők

errorResponse

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

errorBase

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

Hiba

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

innerError

Belső hiba további részletekkel.

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

innerErrorCode

A belső hibaobjektum hibakódjai.

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

Típus: sztring

Alapértelmezett:

Szám neve: InnerErrorCode

Enumerálási értékek:

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

dalleErrorResponse

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

dalleError

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

dalleInnerError

Belső hiba további részletekkel.

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

contentFilterResultBase

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

contentFilterSeverityResult

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

contentFilterDetectedResult

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

contentFilterDetectedWithCitationResult

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

Az idézet tulajdonságai

URL-cím

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

Licenc

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

contentFilterResultsBase

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

Név Típus Leírás Kötelező Alapértelmezett
szexuális contentFilterSeverityResult Nem
erőszak contentFilterSeverityResult Nem
gyűlölet contentFilterSeverityResult Nem
self_harm contentFilterSeverityResult Nem
szentségtörés contentFilterDetectedResult Nem
error errorBase Nem

contentFilterPromptResults

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

Név Típus Leírás Kötelező Alapértelmezett
szexuális contentFilterSeverityResult Nem
erőszak contentFilterSeverityResult Nem
gyűlölet contentFilterSeverityResult Nem
self_harm contentFilterSeverityResult Nem
szentségtörés contentFilterDetectedResult Nem
error errorBase Nem
Szökik contentFilterDetectedResult Nem

contentFilterChoiceResults

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

Név Típus Leírás Kötelező Alapértelmezett
szexuális contentFilterSeverityResult Nem
erőszak contentFilterSeverityResult Nem
gyűlölet contentFilterSeverityResult Nem
self_harm contentFilterSeverityResult Nem
szentségtörés contentFilterDetectedResult Nem
error errorBase Nem
protected_material_text contentFilterDetectedResult Nem
protected_material_code contentFilterDetectedWithCitationResult Nem

promptFilterResult

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

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

promptFilterResults

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

dalleContentFilterResults

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

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

dalleFilterResults

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

Név Típus Leírás Kötelező Alapértelmezett
szexuális contentFilterSeverityResult Nem
erőszak contentFilterSeverityResult Nem
gyűlölet contentFilterSeverityResult Nem
self_harm contentFilterSeverityResult Nem
szentségtörés contentFilterDetectedResult Nem
Szökik contentFilterDetectedResult Nem

chatCompletionsRequestCommon

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

createChatCompletionRequest

Név Típus Leírás Kötelező Alapértelmezett
hőmérséklet szám Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet.
Általában azt javasoljuk, hogy módosítsa ezt vagy top_p mindkettőt, de nem mindkettőt.
Nem 0
top_p szám A hőmérséklettel történő mintavételezés alternatíva, az úgynevezett magmintavétel, ahol a modell a tokenek eredményeit top_p valószínűségi tömeggel veszi figyelembe. A 0.1 tehát csak a felső 10%-os valószínűségi tömeget tartalmazó jogkivonatokat jelenti.
Általában azt javasoljuk, hogy módosítsa ezt vagy temperature mindkettőt, de nem mindkettőt.
Nem 0
patak Logikai Ha be van állítva, a rendszer részleges üzenet-különbözeteket küld, például a ChatGPT-ben. A jogkivonatok csak a kiszolgáló által küldött eseményekként lesznek elküldve, amint elérhetővé válnak, és a streamet egy data: [DONE] üzenet leállítja. Nem Hamis
állj sztring vagy tömb Legfeljebb 4 sorozat, ahol az API leállítja a további jogkivonatok generálását. Nem
max_tokens egész szám A létrehozott válaszhoz engedélyezett jogkivonatok maximális száma. Alapértelmezés szerint a modell által visszaadható tokenek száma (4096 - prompt tokens) lesz. Nem 4096
presence_penalty szám -2,0 és 2,0 közötti szám. A pozitív értékek büntetik az új jogkivonatokat attól függően, hogy az eddig megjelennek-e a szövegben, növelve a modell valószínűségét, hogy új témakörökről beszéljenek. Nem 0
frequency_penalty szám -2,0 és 2,0 közötti szám. A pozitív értékek a szövegben meglévő gyakoriságuk alapján büntetik az új jogkivonatokat, így csökken annak a valószínűsége, hogy a modell ugyanazt a sort szó szerint megismételi. Nem 0
logit_bias object Módosítsa annak valószínűségét, hogy a megadott jogkivonatok megjelenjenek a befejezéskor. Elfogad egy json-objektumot, amely -100-ról 100-ra képez le jogkivonatokat (a jogkivonat-azonosítójuk által megadott) egy társított elfogultsági értékre. Matematikailag a rendszer hozzáadja a torzításokat a modell által a mintavételezés előtt létrehozott logitokhoz. A pontos hatás modellenként eltérő lesz, de a -1 és az 1 közötti értékeknek csökkentenie vagy növelnie kell a kiválasztás valószínűségét; a -100 vagy a 100 értékhez hasonló értékek esetén a megfelelő jogkivonat kitiltása vagy kizárólagos kiválasztása szükséges. Nem
user húr A végfelhasználót jelképező egyedi azonosító, amely segíthet az Azure OpenAI-nak a visszaélések monitorozásában és észlelésében. Nem
üzenet array Az eddig a beszélgetésből álló üzenetek listája. Példa Python-kódra. Nem
data_sources array Az őket használó Azure OpenAI-csevegőbővítmények konfigurációs bejegyzései.
Ez a további specifikáció csak az Azure OpenAI-val kompatibilis.
Nem
n egész szám Hány csevegés-befejezési lehetőséget kell létrehozni az egyes bemeneti üzenetekhez. Nem 0
mag egész szám Ha meg van adva, a rendszerünk mindent megtesz annak érdekében, hogy determinisztikus mintát hozzon létre, így az azonos seed és paraméterekkel rendelkező ismétlődő kérelmeknek ugyanazt az eredményt kell visszaadnia. A determinizmus nincs meghatározva, és a háttérrendszer változásainak figyeléséhez tekintse meg a system_fingerprint válaszparamétert. Nem 0
logprobs Logikai A kimeneti jogkivonatok naplós valószínűségének visszaadása vagy sem. Ha igaz, akkor az egyes kimeneti jogkivonatok napló valószínűségét adja vissza a content következőben message: . Ez a lehetőség jelenleg nem érhető el a gpt-4-vision-preview modellen. Nem Hamis
top_logprobs egész szám 0 és 5 közötti egész szám, amely megadja, hogy az egyes tokenhelyzetekben a legvalószínűbb tokenek száma hány, és mindegyikhez tartozik napló valószínűsége. logprobs ezt a paramétert true kell beállítani. Nem
response_format object Egy objektum, amely megadja a modell által kiadandó formátumot. A JSON mód engedélyezésére szolgál. Nem
eszközök array A modell által meghí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. Nem
tool_choice chatCompletionToolChoiceOption Azt szabályozza, hogy a modell melyik függvényt hívja meg (ha van ilyen). none azt jelenti, hogy a modell nem hív meg függvényt, hanem létrehoz egy üzenetet. auto azt jelenti, hogy a modell választhat az üzenet létrehozása vagy egy függvény meghívása között. Egy adott függvény megadása a modell meghívására kényszeríti {"type": "function", "function": {"name": "my_function"}} a modellt. Nem
functions array Elavult a javára tools. Azon függvények listája, amelyekhez a modell JSON-bemeneteket hozhat létre. Nem
function_call sztring vagy objektum Elavult a javára tool_choice. Szabályozza, hogy a modell hogyan reagál a függvényhívásokra. A "none" azt jelenti, hogy a modell nem hív meg függvényt, és válaszol a végfelhasználónak. Az "auto" azt jelenti, hogy a modell választhat a végfelhasználók között, vagy meghívhat egy függvényt. Egy adott függvény megadása a modell meghívására kényszeríti {"name":\ "my_function"} a modellt. A "none" az alapértelmezett, ha nincsenek függvények. Az "auto" az alapértelmezett, ha függvények vannak jelen. Nem

A response_format tulajdonságai

Típus

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

chatCompletionResponseFormat

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

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

Típus: sztring

Alapértelmezett: szöveg

Szám neve: ChatCompletionResponseFormat

Enumerálási értékek:

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

chatCompletionFunction

Név Típus Leírás Kötelező Alapértelmezett
név húr A meghívandó függvény neve. A-z, A-Z, 0-9, vagy aláhúzásjeleket és kötőjeleket kell tartalmaznia, legfeljebb 64 hosszúságúak. Igen
leírás húr A függvény működésének leírása. Nem
parameters chatCompletionFunctionParameters A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva. A formátum dokumentációját a JSON-séma referenciájában találja. Nem

chatCompletionFunctionParameters

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

chatCompletionRequestMessage

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

chatCompletionRequestMessageRole

Az üzenetek szerzőjének szerepe.

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

Típus: sztring

Alapértelmezett:

Enum Name: ChatCompletionRequestMessageRole

Enumerálási értékek:

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

chatCompletionRequestMessageSystem

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

chatCompletionRequestMessageUser

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

chatCompletionRequestMessageContentPart

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

chatCompletionRequestMessageContentPartType

A tartalomrész típusa.

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

Típus: sztring

Alapértelmezett:

Enum Name: ChatCompletionRequestMessageContentPartType

Enumerálási értékek:

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

chatCompletionRequestMessageContentPartText

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

chatCompletionRequestMessageContentPartImage

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

imageDetailLevel

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

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

Típus: sztring

Alapértelmezett: automatikus

Szám neve: ImageDetailLevel

Enumerálási értékek:

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

chatCompletionRequestMessageAssistant

Név Típus Leírás Kötelező Alapértelmezett
szerepkör chatCompletionRequestMessageRole Az üzenetek szerzőjének szerepe. Igen
content húr Az üzenet tartalma. Nem
tool_calls array A modell által generált eszközhívások, például függvényhívások. Nem
kontextus azureChatExtensionsMessageContext Az Azure OpenAI-csevegőbővítmények használatakor elérhető további környezeti információk megjelenítése
a megfelelő csevegés-befejezési válasz létrehozásakor. Ez a környezeti információ csak akkor van kitöltve, ha
egy egyező bővítmény használatára konfigurált Azure OpenAI-kérés használatával.
Nem

azureChatExtensionConfiguration

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

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

azureChatExtensionType

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

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

Típus: sztring

Alapértelmezett:

Enum Name: AzureChatExtensionType

Enumerálási értékek:

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

azureSearchChatExtensionConfiguration

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

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

azureSearchChatExtensionParameters

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

Név Típus Leírás Kötelező Alapértelmezett
hitelesítés onYourDataApiKeyAuthenticationOptions vagy onYourDataSystemAssignedManagedIdentityAuthenticationOptions vagy onYourDataUserAssignedManagedIdentityAuthenticationOptions Igen
top_n_documents egész szám A konfigurált lekérdezéshez használható dokumentumok maximális száma. Nem
in_scope Logikai Azt határozza meg, hogy a lekérdezések az indexelt adatok használatára legyenek-e korlátozva. Nem
szigorúság egész szám A keresési relevancia szűrésének konfigurált szigorúsága. Minél magasabb a szigorúság, annál nagyobb a pontosság, de annál kisebb a válasz visszahívása. Nem
role_information húr Adja meg a modell utasításait arról, hogy hogyan kell viselkednie, és minden olyan környezetet, amelyre hivatkoznia kell a válasz létrehozásakor. Leírhatja az asszisztens személyiségét, és megtudhatja, hogyan formázhatja a válaszokat. 100 jogkivonatra vonatkozó korlát van, és a teljes jogkivonat-korlátnak számít. Nem
endpoint húr A használni kívánt Azure Search-erőforrás abszolút végponti elérési útja. Igen
index_name húr A hivatkozott Azure Search-erőforrásban elérhetőként használni kívánt index neve. Igen
fields_mapping azureSearchIndexFieldMappingOptions Nem kötelező beállítások a mezők feldolgozásának szabályozásához konfigurált Azure Search-erőforrás használatakor. Nem
query_type azureSearchQueryType Az Azure Search lekéréses lekérdezésének típusa, amelyet Azure OpenAI-csevegőbővítményként való használatakor végre kell hajtani. Nem
semantic_configuration húr A lekérdezés további szemantikai konfigurációja. Nem
szűrő húr Keresési szűrő. Nem
embedding_dependency onYourDataEndpointVectorizationSource vagy onYourDataDeploymentNameVectorizationSource Nem

azureSearchIndexFieldMappingOptions

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

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

azureSearchQueryType

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

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

Típus: sztring

Alapértelmezett:

Enum Name: azureSearchQueryType

Enumerálási értékek:

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

azureCosmosDBChatExtensionConfiguration

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

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

azureCosmosDBChatExtensionParameters

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

Név Típus Leírás Kötelező Alapértelmezett
hitelesítés onYourDataConnectionStringAuthenticationOptions Az Azure OpenAI on Your Data hitelesítési lehetőségei kapcsolati sztring használatakor. Igen
top_n_documents egész szám A konfigurált lekérdezéshez használható dokumentumok maximális száma. Nem
in_scope Logikai Azt határozza meg, hogy a lekérdezések az indexelt adatok használatára legyenek-e korlátozva. Nem
szigorúság egész szám A keresési relevancia szűrésének konfigurált szigorúsága. Minél magasabb a szigorúság, annál nagyobb a pontosság, de annál kisebb a válasz visszahívása. Nem
role_information húr Adja meg a modell utasításait arról, hogy hogyan kell viselkednie, és minden olyan környezetet, amelyre hivatkoznia kell a válasz létrehozásakor. Leírhatja az asszisztens személyiségét, és megtudhatja, hogyan formázhatja a válaszokat. 100 jogkivonatra vonatkozó korlát van, és a teljes jogkivonat-korlátnak számít. Nem
database_name húr Az Azure Cosmos DB-hez használandó MongoDB virtuálismag-adatbázis neve. Igen
container_name húr Az Azure Cosmos DB-erőforrástároló neve. Igen
index_name húr Az Azure Cosmos DB-vel használandó MongoDB virtuálismag-index neve. Igen
fields_mapping azureCosmosDBFieldMappingOptions Nem kötelező beállítások a mezők feldolgozásának szabályozásához konfigurált Azure Cosmos DB-erőforrás használatakor. Igen
embedding_dependency onYourDataEndpointVectorizationSource vagy onYourDataDeploymentNameVectorizationSource Igen

azureCosmosDBFieldMappingOptions

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

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

onYourDataAuthenticationOptions

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

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

onYourDataAuthenticationType

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

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

Típus: sztring

Alapértelmezett:

Szám neve: OnYourDataAuthenticationType

Enumerálási értékek:

Érték Leírás
api_key Hitelesítés API-kulccsal.
connection_string Hitelesítés kapcsolati sztring keresztül.
system_assigned_managed_identity Hitelesítés rendszer által hozzárendelt felügyelt identitáson keresztül.
user_assigned_managed_identity Hitelesítés felhasználó által hozzárendelt felügyelt identitáson keresztül.

onYourDataApiKeyAuthenticationOptions

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

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

onYourDataConnectionStringAuthenticationOptions

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

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

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataVectorizationSource

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

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

onYourDataVectorizationSourceType

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

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

Típus: sztring

Alapértelmezett:

Szám neve: OnYourDataVectorizationSourceType

Enumerálási értékek:

Érték Leírás
endpoint Az Azure OpenAI beágyazási modellbe irányuló nyilvános hívások által végrehajtott vektorizálást jelöli.
deployment_name A használni kívánt Ada-modell üzembehelyezési nevét jelöli. Ennek a modellnek ugyanabban az Azure OpenAI-erőforrásban kell lennie, de
Az adatszolgáltató ezt a modelltelepítést egy belső hívással fogja használni, nem pedig nyilvánosan, amely lehetővé teszi a vektorok
privát hálózatokban is kereshet.

onYourDataDeploymentNameVectorizationSource

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

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

onYourDataEndpointVectorizationSource

Az Azure OpenAI által az Adatokon lévő Azure OpenAI által a vektorkeresés alkalmazásakor használt vektorizációs forrás részletei, amelyek az Azure OpenAI nyilvános beágyazási végpontján alapulnak.

Név Típus Leírás Kötelező Alapértelmezett
típus onYourDataVectorizationSourceType Az Azure OpenAI On Your Data által az adatok vektorizálásának konfigurálásához használható rendelkezésre álló forrásokat jelöli
vektorkeresés.
Igen
hitelesítés onYourDataApiKeyAuthenticationOptions Az Azure OpenAI on Your Data hitelesítési lehetőségei API-kulcs használata esetén. Nem
endpoint húr Meghatározza a vektorizáláshoz használni kívánt végpontot. Ennek a végpontnak ugyanabban az Azure OpenAI-erőforrásban kell lennie, de az Adatok szolgáltatás ezt a végpontot egy belső híváson keresztül fogja használni, nem pedig egy nyilvánost, amely lehetővé teszi a vektorkeresést még a privát hálózatokban is. Nem

azureChatExtensionsMessageContext

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

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

Idézés

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

Név Típus Leírás Kötelező Alapértelmezett
content húr Az idézet tartalma. Igen
cím húr Az idézet címe. Nem
url húr Az idézet URL-címe. Nem
filepath húr Az idézet fájl elérési útja. Nem
chunk_id húr Az idézet adattömb-azonosítója. Nem

chatCompletionMessageToolCall

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

Függvény tulajdonságai

Név

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

Argumentumok

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

toolCallType

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

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

Típus: sztring

Alapértelmezett:

Szám neve: ToolCallType

Enumerálási értékek:

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

chatCompletionRequestMessageTool

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

chatCompletionRequestMessageFunction

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

createChatCompletionResponse

Név Típus Leírás Kötelező Alapértelmezett
id húr A csevegés befejezésének egyedi azonosítója. Igen
object chatCompletionResponseObject Az objektum típusa. Igen
Létrehozott egész szám A csevegés befejezésének unix időbélyege (másodpercben). Igen
modell húr A csevegés befejezéséhez használt modell. Igen
használat completionUsage A befejezési kérelem használati statisztikái. Nem
system_fingerprint húr A kérelemparaméterrel seed együtt használható annak megértéséhez, hogy mikor történtek olyan háttérbeli módosítások, amelyek hatással lehetnek a determinizmusra. Nem
prompt_filter_results promptFilterResults A tartalomszűrés eredménye nulla vagy több kérés esetén jelenik meg a kérelemben. Streamelési kérés esetén a különböző kérések eredményei eltérő időpontokban vagy különböző megrendelésekben érkezhetnek. Nem
Választás array Nem

chatCompletionChoiceLogProbs

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

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

chatCompletionTokenLogprob

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

chatCompletionResponseMessage

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

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

chatCompletionResponseMessageRole

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

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

Típus: sztring

Alapértelmezett:

Enumerálási értékek:

  • asszisztens

chatCompletionToolChoiceOption

Azt szabályozza, hogy a modell melyik függvényt hívja meg (ha van ilyen). none azt jelenti, hogy a modell nem hív meg függvényt, hanem létrehoz egy üzenetet. auto azt jelenti, hogy a modell választhat az üzenet létrehozása vagy egy függvény meghívása között. Egy adott függvény megadása a modell meghívására kényszeríti {"type": "function", "function": {"name": "my_function"}} a modellt.

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

chatCompletionNamedToolChoice

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

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

Függvény tulajdonságai

Név

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

chatCompletionFunctionCall

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

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

chatCompletionsResponseCommon

Név Típus Leírás Kötelező Alapértelmezett
id húr A csevegés befejezésének egyedi azonosítója. Igen
object chatCompletionResponseObject Az objektum típusa. Igen
Létrehozott egész szám A csevegés befejezésének unix időbélyege (másodpercben). Igen
modell húr A csevegés befejezéséhez használt modell. Igen
használat completionUsage A befejezési kérelem használati statisztikái. Nem
system_fingerprint húr A kérelemparaméterrel seed együtt használható annak megértéséhez, hogy mikor történtek olyan háttérbeli módosítások, amelyek hatással lehetnek a determinizmusra. Nem

chatCompletionResponseObject

Az objektum típusa.

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

Típus: sztring

Alapértelmezett:

Enum Name: ChatCompletionResponseObject

Enumerálási értékek:

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

completionUsage

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

Név Típus Leírás Kötelező Alapértelmezett
prompt_tokens egész szám A jogkivonatok száma a parancssorban. Igen
completion_tokens egész szám A létrehozott befejezésben lévő tokenek száma. Igen
total_tokens egész szám A kérelemben használt tokenek teljes száma (parancssor + befejezés). Igen

chatCompletionTool

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

Függvény tulajdonságai

Leírás

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

Név

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

Paraméterek

Név Típus Leírás Alapértelmezett
parameters chatCompletionFunctionParameters A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva. A formátum dokumentációját a JSON-séma referenciájában találja.

chatCompletionToolType

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

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

Típus: sztring

Alapértelmezett:

Enum Name: ChatCompletionToolType

Enumerálási értékek:

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

chatCompletionChoiceCommon

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

createTranslationRequest

Fordítási kérelem.

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

audioResponse

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

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

audioVerboseResponse

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

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

audioResponseFormat

Meghatározza a kimenet formátumát.

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

Típus: sztring

Alapértelmezett:

Enumerálási értékek:

  • json
  • text
  • srt
  • verbose_json
  • vtt

createTranscriptionRequest

Átírási kérelem.

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

audioSegment

Átirat vagy fordítási szegmens.

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

imageQuality

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

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

Típus: sztring

Alapértelmezett: standard

Enum name: Quality

Enumerálási értékek:

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

imagesResponseFormat

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

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

Típus: sztring

Alapértelmezett: URL-cím

Enum Name: ImagesResponseFormat

Enumerálási értékek:

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

imageSize

A létrehozott képek mérete.

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

Típus: sztring

Alapértelmezett: 1024x1024

Szám neve: Méret

Enumerálási értékek:

Érték Leírás
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.
1024 x 1024 A létrehozott kép kívánt mérete 1024x1024 képpont.

imageStyle

A létrehozott képek stílusa.

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

Típus: sztring

Alapértelmezett: élénk

Szám neve: Stílus

Enumerálási értékek:

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

imageGenerationsRequest

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

generateImagesResponse

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

imageResult

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

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

Befejezési bővítmények

A befejezési bővítmények nem részei az 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 az Azure OpenAI adatsík következtetési specifikációjának legújabb GA-verziójának.

Szövegfelolvasás

Jelenleg nem része az 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 előzetes verzióját .

Következő lépések

Ismerje meg a modelleket , és finomhangoljon a REST API-val. További információ az Azure OpenAI-t használó mögöttes modellekről.