Azure OpenAI i REST API-referens för Microsoft Foundry Models

Den här artikeln innehåller information om REST API-slutpunkter för slutsatsdragning för Azure OpenAI.

API specs

Hantering och interaktion med Azure OpenAI-modeller och resurser är uppdelade på tre primära API-ytor:

Control plane
Dataplan – redigering
Dataplan – slutsatsdragning

Varje API-yta/specifikation kapslar in en annan uppsättning Azure OpenAI-funktioner. Varje API har en egen unik uppsättning förhandsversioner och stabila/allmänt tillgängliga API-versioner (GA). Förhandsversioner tenderar för närvarande att följa en månatlig takt.

Important

Det finns nu ett nytt api för förhandsversionsslutsats. Läs mer i vår livscykelguide för API.

API	Senaste förhandsversion	Senaste GA-versionen	Specifications	Description
Control plane	`2025-07-01-preview`	`2025-06-01`	Spec files	API:et för kontrollplan används för åtgärder som att skapa resurser, modelldistribution och andra resurshanteringsuppgifter på högre nivå. Kontrollplanet styr också vad som är möjligt att göra med funktioner som Azure Resource Manager, Bicep, Terraform och Azure CLI.
Data plane	`v1 preview`	`v1`	Spec files	API:et för dataplanet styr slutsatsdragnings- och redigeringsåtgärder.

Authentication

Azure OpenAI innehåller två metoder för autentisering. Du kan använda ANTINGEN API-nycklar eller Microsoft Entra ID.

API-nyckelautentisering: För den här typen av autentisering måste alla API-begäranden innehålla API-nyckeln i api-key HTTP-huvudet. Snabbstarten innehåller vägledning för hur du gör anrop med den här typen av autentisering.
Microsoft Entra ID-autentisering: Du kan autentisera ett API-anrop med hjälp av en Microsoft Entra token. Autentiseringstoken ingår i en begäran som Authorization rubrik. Den angivna token måste föregås av Bearer, till exempel Bearer YOUR_AUTH_TOKEN. Du kan läsa vår instruktioner för autentisera med Microsoft Entra ID.

REST API-versionshantering

Tjänst-API:erna är versionshanterade med frågeparametern api-version . Alla versioner följer YYYY-MM-DD datumstruktur. For example:

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

Slutsatsdragning av dataplan

Resten av artikeln beskriver GA-versionen av Azure OpenAI-dataplanets slutsatsdragningsspecifikation, 2024-10-21.

Om du letar efter dokumentation om den senaste förhandsversionen av API:et läser du det senaste api:et för förhandsversion av dataplanets slutsatsdragning

Completions

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

Skapar ett slutförande för den angivna prompten, parametrarna och den valda modellen.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Stöds Azure OpenAI-slutpunkter (protokoll och värdnamn, till exempel: `https://aoairesource.openai.azure.com`. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	Distributions-ID för modellen som distribuerades.
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Ange Azure OpenAI API-nyckel här

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
prompt	sträng eller matris	Uppmaningen att generera slutföranden för, kodade som en sträng, matris med strängar, matris med token eller matris med tokenmatriser. Observera att <\|endoftext\|> är dokumentavgränsaren som modellen ser under träningen, så om en fråga inte anges genereras modellen som från början av ett nytt dokument.	Yes
best_of	integer	Genererar `best_of` slutföranden på serversidan och returnerar den "bästa" (den med högsta loggens sannolikhet per token). Resultat kan inte strömmas. När det används med `n`kontrollerar `best_of` du antalet kandidatavslut och `n` anger hur många som ska returneras â€" `best_of` måste vara större än `n`. Observera: Eftersom den här parametern genererar många slutföranden kan den snabbt förbruka din tokenkvot. Använd noggrant och se till att du har rimliga inställningar för `max_tokens` och `stop`.	No	1
echo	boolean	Upprepa uppmaningen utöver slutförandet	No	False
frequency_penalty	number	Tal mellan -2.0 och 2.0. Positiva värden straffar nya token baserat på deras befintliga frekvens i texten hittills, vilket minskar modellens sannolikhet att upprepa samma rad ordagrant.	No	0
logit_bias	object	Ändra sannolikheten för att angivna token visas i slutförandet. Accepterar ett JSON-objekt som mappar token (som anges av deras token-ID i GPT-tokeniseraren) till ett associerat bias-värde från -100 till 100. Matematiskt läggs biasen till i de logits som genereras av modellen före sampling. Den exakta effekten varierar per modell, men värden mellan -1 och 1 bör minska eller öka sannolikheten för urval. värden som -100 eller 100 bör resultera i ett förbud eller exklusivt val av relevant token. Du kan till exempel skicka `{"50256": -100}` för att förhindra <att token \|endoftext\|> genereras.	No	None
logprobs	integer	Inkludera loggannolikheterna på de `logprobs` mest sannolika utdatatoken, samt de valda token. Om `logprobs` det till exempel är 5 returnerar API:et en lista över de fem mest sannolika token. API:et `logprob` returnerar alltid den samplade token, så det kan finnas upp till `logprobs+1` element i svaret. Det maximala värdet för `logprobs` är 5.	No	None
max_tokens	integer	Det maximala antalet token som kan genereras i slutförandet. Tokenantalet för din fråga plus `max_tokens` får inte överskrida modellens kontextlängd.	No	16
n	integer	Hur många slutföranden som ska genereras för varje fråga. Observera: Eftersom den här parametern genererar många slutföranden kan den snabbt förbruka din tokenkvot. Använd noggrant och se till att du har rimliga inställningar för `max_tokens` och `stop`.	No	1
presence_penalty	number	Tal mellan -2.0 och 2.0. Positiva värden straffar nya token baserat på om de visas i texten hittills, vilket ökar modellens sannolikhet att prata om nya ämnen.	No	0
seed	integer	Om det anges gör vårt system bästa för att sampla deterministiskt, så att upprepade begäranden med samma `seed` och parametrar ska returnera samma resultat. Determinism är inte garanterad och du bör referera till svarsparametern `system_fingerprint` för att övervaka ändringar i serverdelen.	No
stop	sträng eller matris	Upp till fyra sekvenser där API:et slutar generera ytterligare token. Den returnerade texten innehåller inte stoppsekvensen.	No
stream	boolean	Om du vill strömma tillbaka partiella förlopp. Om det anges skickas token som databaserade serverutskickade händelser när de blir tillgängliga, och strömmen avslutas av ett `data: [DONE]` meddelande.	No	False
suffix	string	Suffixet som kommer efter att infogad text har slutförts. Den här parametern stöds endast för `gpt-3.5-turbo-instruct`.	No	None
temperature	number	Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar vanligtvis att du ändrar detta eller `top_p` men inte båda.	No	1
top_p	number	Ett alternativ till sampling med temperatur, som kallas kärnsampling, där modellen tar hänsyn till resultatet av token med top_p sannolikhetsmassa. Så 0,1 innebär att endast token som består av de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller `temperature` men inte båda.	No	1
user	string	En unik identifierare som representerar slutanvändaren, som kan hjälpa till att övervaka och upptäcka missbruk.	No

Responses

Statuskod: 200

Description: OK

Content-Type	Type	Description
application/json	createCompletionResponse	Representerar ett slutförandesvar från API:et. Obs! Både strömmade och icke-strömmade svarsobjekt har samma form (till skillnad från chattslutpunkten).

Statuskod: standard

Beskrivning: Tjänsten är inte tillgänglig

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

Skapar ett slutförande för den angivna prompten, parametrarna och den valda modellen.

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
}

Svar: Statuskod: 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

Få en vektorrepresentation av en viss indata som enkelt kan användas av maskininlärningsmodeller och algoritmer.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Stöds Azure OpenAI-slutpunkter (protokoll och värdnamn, till exempel: `https://aoairesource.openai.azure.com`. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Ange Azure OpenAI API-nyckel här

Request Body

Content-Type: application/json

Name	Type	Description	Required
input	sträng eller matris	Indatatext som ska bäddas in, kodas som en sträng eller matris med token. Om du vill bädda in flera indata i en enda begäran skickar du en matris med strängar eller matriser med tokenmatriser. Indata får inte överskrida de maximala indatatoken för modellen (8 192 token för `text-embedding-ada-002`), får inte vara en tom sträng och alla matriser måste vara 2 048 dimensioner eller mindre.	Yes
user	string	En unik identifierare som representerar slutanvändaren, som kan hjälpa dig att övervaka och upptäcka missbruk.	No
input_type	string	indatatyp för inbäddningssökning som ska användas	No
encoding_format	string	Formatet för att returnera inbäddningarna i. Kan vara antingen `float` eller `base64`. Standardvärdet är `float`.	No
dimensions	integer	Antalet dimensioner som resulterande inbäddningar av utdata ska ha. Stöds endast i `text-embedding-3` och senare modeller.	No

Responses

Name	Type	Required
object	string	Yes
model	string	Yes
data	array	Yes
usage	object	Yes

Egenskaper för användning

prompt_tokens

Name	Type	Description	Default
prompt_tokens	integer

total_tokens

Name	Type	Description	Default
total_tokens	integer

Statuskod: 200

Description: OK

Content-Type	Type	Description
application/json	object

Examples

Example

Returnera inbäddningarna för en viss fråga.

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

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

Svar: Statuskod: 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

Skapar ett slutförande för chattmeddelandet

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Stöds Azure OpenAI-slutpunkter (protokoll och värdnamn, till exempel: `https://aoairesource.openai.azure.com`. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	Distributions-ID för modellen som distribuerades.
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Ange Azure OpenAI API-nyckel här

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
temperature	number	Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar vanligtvis att du ändrar detta eller `top_p` men inte båda.	No	1
top_p	number	Ett alternativ till sampling med temperatur, som kallas kärnsampling, där modellen tar hänsyn till resultatet av token med top_p sannolikhetsmassa. Så 0,1 innebär att endast token som består av de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller `temperature` men inte båda.	No	1
stream	boolean	Om det anges skickas delvisa meddelandedelta, till exempel i ChatGPT. Token skickas som serverutsända händelser endast för data när de blir tillgängliga, och strömmen avslutas av ett `data: [DONE]` meddelande.	No	False
stop	sträng eller matris	Upp till fyra sekvenser där API:et slutar generera ytterligare token.	No
max_tokens	integer	Det maximala antalet token som kan genereras i chattens slutförande. Den totala längden på indatatoken och genererade token begränsas av modellens kontextlängd.	No
max_completion_tokens	integer	En övre gräns för antalet token som kan genereras för en slutförande, inklusive synliga utdatatoken och resonemangstoken.	No
presence_penalty	number	Tal mellan -2.0 och 2.0. Positiva värden straffar nya token baserat på om de visas i texten hittills, vilket ökar modellens sannolikhet att prata om nya ämnen.	No	0
frequency_penalty	number	Tal mellan -2.0 och 2.0. Positiva värden straffar nya token baserat på deras befintliga frekvens i texten hittills, vilket minskar modellens sannolikhet att upprepa samma rad ordagrant.	No	0
logit_bias	object	Ändra sannolikheten för att angivna token visas i slutförandet. Accepterar ett JSON-objekt som mappar token (som anges av deras token-ID i tokenizern) till ett associerat bias-värde från -100 till 100. Matematiskt läggs biasen till i de logits som genereras av modellen före sampling. Den exakta effekten varierar per modell, men värden mellan -1 och 1 bör minska eller öka sannolikheten för urval. värden som -100 eller 100 bör resultera i ett förbud eller exklusivt val av relevant token.	No	None
user	string	En unik identifierare som representerar slutanvändaren, som kan hjälpa till att övervaka och upptäcka missbruk.	No
messages	array	En lista över meddelanden som består av konversationen hittills.	Yes
data_sources	array	Konfigurationsposterna för Azure OpenAI-chatttillägg som använder dem. Den här ytterligare specifikationen är endast kompatibel med Azure OpenAI.	No
logprobs	boolean	Om du vill returnera loggannolikheter för utdatatoken eller inte. Om sant returnerar loggannolikerna för varje utdatatoken som returneras i `content` i `message`.	No	False
top_logprobs	integer	Ett heltal mellan 0 och 20 som anger antalet mest sannolika token som ska returneras vid varje tokenposition, var och en med en associerad loggsannolikhet. `logprobs` måste anges till `true` om den här parametern används.	No
n	integer	Hur många alternativ för chattavslut som ska genereras för varje indatameddelande. Observera att du debiteras baserat på antalet genererade token i alla alternativ. Behåll `n` för `1` att minimera kostnaderna.	No	1
parallel_tool_calls	ParallelToolCalls	Om du vill aktivera parallell funktionsanrop under verktygsanvändning.	No	True
response_format	ResponseFormatText eller ResponseFormatJsonObject eller ResponseFormatJsonSchema	Ett objekt som anger det format som modellen måste mata ut. Kompatibel med GPT-4o, GPT-4o mini, GPT-4 Turbo och alla GPT-3.5 Turbo modeller nyare än `gpt-3.5-turbo-1106`. Inställning för att `{ "type": "json_schema", "json_schema": {...} }` aktivera strukturerade utdata som garanterar att modellen matchar ditt angivna JSON-schema. Inställningen för att `{ "type": "json_object" }` aktivera JSON-läge, vilket garanterar att meddelandet som modellen genererar är giltigt JSON. Viktigt: När du använder JSON-läge måste du också instruera modellen att skapa JSON själv via ett system- eller användarmeddelande. Utan detta kan modellen generera en avaktiverande ström av blanksteg tills genereringen når tokengränsen, vilket resulterar i en tidskrävande och till synes "fast" begäran. Observera också att meddelandeinnehållet kan vara delvis avskuret om `finish_reason="length"`, vilket indikerar att genereringen överskreds `max_tokens` eller konversationen överskred den maximala kontextlängden.	No
seed	integer	Den här funktionen finns i Beta. Om det anges gör vårt system bästa för att sampla deterministiskt, så att upprepade begäranden med samma `seed` och parametrar ska returnera samma resultat. Determinism är inte garanterad och du bör referera till svarsparametern `system_fingerprint` för att övervaka ändringar i serverdelen.	No
tools	array	En lista över verktyg som modellen kan anropa. För närvarande stöds endast funktioner som ett verktyg. Använd detta för att ange en lista över funktioner som modellen kan generera JSON-indata för. Högst 128 funktioner stöds.	No
tool_choice	chatCompletionToolChoiceOption	Styr vilket (om något) verktyg som anropas av modellen. `none` innebär att modellen inte anropar något verktyg och i stället genererar ett meddelande. `auto` innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett eller flera verktyg. `required` innebär att modellen måste anropa ett eller flera verktyg. Att ange ett visst verktyg via `{"type": "function", "function": {"name": "my_function"}}` tvingar modellen att anropa verktyget. `none` är standard när inga verktyg finns. `auto` är standardvärdet om det finns verktyg.	No
function_call	string eller chatCompletionFunctionCallOption	Inaktuell till förmån för `tool_choice`. Styr vilken (om någon) funktion som anropas av modellen. `none` innebär att modellen inte anropar en funktion och i stället genererar ett meddelande. `auto` innebär att modellen kan välja mellan att generera ett meddelande eller anropa en funktion. Om du anger en viss funktion via `{"name": "my_function"}` tvingar modellen att anropa den funktionen. `none` är standard när det inte finns några funktioner. `auto` är standardvärdet om det finns funktioner.	No
functions	array	Inaktuell till förmån för `tools`. En lista över funktioner som modellen kan generera JSON-indata för.	No

Responses

Statuskod: 200

Description: OK

Content-Type	Type	Description
application/json	createChatCompletionResponse eller createChatCompletionStreamResponse

Statuskod: standard

Beskrivning: Tjänsten är inte tillgänglig

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

Skapar ett slutförande för den angivna prompten, parametrarna och den valda modellen.

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

Svar: Statuskod: 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

Skapar ett slutförande baserat på Azure Sök efter data och systemtilldelad hanterad identitet.

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

Svar: Statuskod: 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

Skapar ett slutförande baserat på Azure Sökvektordata, tidigare assistentmeddelande och användartilldelad hanterad identitet.

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

Svar: Statuskod: 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

Skapar ett slutförande för den angivna 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"
     ]
    }
   }
  }
 ]
}

Svar: Statuskod: 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
    }
  }
}

Transkriptioner – Skapa

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

Transkriberar ljud till indataspråket.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Stöds Azure OpenAI-slutpunkter (protokoll och värdnamn, till exempel: `https://aoairesource.openai.azure.com`. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	Distributions-ID för tal till text-modellen. Information om modeller som stöds finns i [/azure/ai-foundry/openai/concepts/models#audio-models].
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Ange Azure OpenAI API-nyckel här

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required	Default
file	string	Ljudfilsobjektet som ska transkriberas.	Yes
prompt	string	En valfri text som vägleder modellens formatmall eller fortsätter med ett tidigare ljudsegment. Uppmaningen ska matcha ljudspråket.	No
response_format	audioResponseFormat	Definierar formatet för utdata.	No
temperature	number	Provtagningstemperaturen, mellan 0 och 1. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Om värdet är 0 använder modellen loggsannolikhet för att automatiskt öka temperaturen tills vissa tröskelvärden uppnås.	No	0
language	string	Språket för indataljudet. Om du anger indataspråket i ISO-639-1-format förbättras noggrannheten och svarstiden.	No

Responses

Statuskod: 200

Description: OK

Content-Type	Type	Description
application/json	audioResponse eller audioVerboseResponse
text/plain	string	Transkriberad text i utdataformatet (när response_format var en text, vtt eller srt).

Examples

Example

Hämtar transkriberad text och associerade metadata från angivna talade ljuddata.

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

Svar: Statuskod: 200

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

Example

Hämtar transkriberad text och associerade metadata från angivna talade ljuddata.

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

Svar: Statuskod: 200

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

Översättningar – Skapa

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

Transkriberar och översätter indataljud till engelsk text.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Stöds Azure OpenAI-slutpunkter (protokoll och värdnamn, till exempel: `https://aoairesource.openai.azure.com`. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	Distributions-ID för viskningsmodellen som distribuerades. Information om modeller som stöds finns i [/azure/ai-foundry/openai/concepts/models#audio-models].
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Ange Azure OpenAI API-nyckel här

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required	Default
file	string	Ljudfilen som ska översättas.	Yes
prompt	string	En valfri text som vägleder modellens formatmall eller fortsätter med ett tidigare ljudsegment. Uppmaningen ska vara på engelska.	No
response_format	audioResponseFormat	Definierar formatet för utdata.	No
temperature	number	Provtagningstemperaturen, mellan 0 och 1. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Om värdet är 0 använder modellen loggsannolikhet för att automatiskt öka temperaturen tills vissa tröskelvärden uppnås.	No	0

Responses

Statuskod: 200

Description: OK

Content-Type	Type	Description
application/json	audioResponse eller audioVerboseResponse
text/plain	string	Transkriberad text i utdataformatet (när response_format var en text, vtt eller srt).

Examples

Example

Hämtar engelskspråkig transkriberad text och associerade metadata från angivna talade ljuddata.

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

Svar: Statuskod: 200

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

Example

Hämtar engelskspråkig transkriberad text och associerade metadata från angivna talade ljuddata.

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

Svar: Statuskod: 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

Genererar en batch med bilder från en texttext på en viss dall-e-modelldistribution

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Stöds Azure OpenAI-slutpunkter (protokoll och värdnamn, till exempel: `https://aoairesource.openai.azure.com`. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	Distributions-ID för den dall-e-modell som distribuerades.
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Ange Azure OpenAI API-nyckel här

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
prompt	string	En textbeskrivning av de önskade bilderna. Den maximala längden är 4 000 tecken.	Yes
n	integer	Antalet bilder som ska genereras.	No	1
size	imageSize	Storleken på de genererade bilderna.	No	1024x1024
response_format	imagesResponseFormat	Formatet där de genererade bilderna returneras.	No	url
user	string	En unik identifierare som representerar slutanvändaren, som kan hjälpa till att övervaka och upptäcka missbruk.	No
quality	imageQuality	Kvaliteten på den bild som ska genereras.	No	standard
style	imageStyle	Formatmallen för de genererade bilderna.	No	vivid

Responses

Statuskod: 200

Description: Ok

Content-Type	Type	Description
application/json	generateImagesResponse

Statuskod: standard

Beskrivning: Ett fel uppstod.

Content-Type	Type	Description
application/json	dalleErrorResponse

Examples

Example

Skapar avbildningar med en uppmaning.

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

Svar: Statuskod: 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	Type	Description	Required	Default
error	error		No

errorBase

Name	Type	Description	Required	Default
code	string		No
message	string		No

error

Name	Type	Description	Required
param	string		No
type	string		No
inner_error	innerError	Inre fel med ytterligare information.	No

innerError

Inre fel med ytterligare information.

Name	Type	Description	Required	Default
code	innerErrorCode	Felkoder för det inre felobjektet.	No
content_filter_results	contentFilterPromptResults	Information om innehållsfiltreringskategorin (hat, sexuellt, våld, self_harm), om det har upptäckts, samt allvarlighetsnivån (very_low, låg, medelhög, hög skala som avgör intensiteten och risknivån för skadligt innehåll) och om den har filtrerats eller inte. Information om jailbreak-innehåll och svordomar, om det har identifierats och om det har filtrerats eller inte. Och information om kundens blocklista, om den har filtrerats och dess ID.	No

innerErrorCode

Felkoder för det inre felobjektet.

Beskrivning: Felkoder för det inre felobjektet.

Type: string

Default:

Uppräkningsnamn: InnerErrorCode

Enum Values:

Value	Description
ResponsibleAIPolicyViolation	Uppmaningen bröt mot en av fler regler för innehållsfilter.

dalleErrorResponse

Name	Type	Description	Required	Default
error	dalleError		No

dalleError

Name	Type	Description	Required
param	string		No
type	string		No
inner_error	dalleInnerError	Inre fel med ytterligare information.	No

dalleInnerError

Inre fel med ytterligare information.

Name	Type	Description	Required
code	innerErrorCode	Felkoder för det inre felobjektet.	No
content_filter_results	dalleFilterResults	Information om innehållsfiltreringskategorin (hat, sexuellt, våld, self_harm), om det har upptäckts, samt allvarlighetsnivån (very_low, låg, medelhög, hög skala som avgör intensiteten och risknivån för skadligt innehåll) och om den har filtrerats eller inte. Information om jailbreak-innehåll och svordomar, om det har identifierats och om det har filtrerats eller inte. Och information om kundens blocklista, om den har filtrerats och dess ID.	No
revised_prompt	string	Uppmaningen som användes för att generera avbildningen, om det fanns någon revision av prompten.	No

contentFilterResultBase

Name	Type	Description	Required	Default
filtered	boolean		Yes

contentFilterSeverityResult

Name	Type	Description	Required	Default
filtered	boolean		Yes
severity	string		No

contentFilterDetectedResult

Name	Type	Description	Required	Default
filtered	boolean		Yes
detected	boolean		No

contentFilterDetectedWithCitationResult

Name	Type	Description	Required	Default
citation	object		No

Egenskaper för källhänvisning

URL

Name	Type	Description	Default
URL	string

license

Name	Type	Description	Default
license	string

contentFilterResultsBase

Information om resultatet av innehållsfiltreringen.

Name	Type	Required
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
error	errorBase	No

contentFilterPromptResults

Information om innehållsfiltreringskategorin (hat, sexuellt, våld, self_harm), om det har upptäckts, samt allvarlighetsnivån (very_low, låg, medelhög, hög skala som avgör intensiteten och risknivån för skadligt innehåll) och om den har filtrerats eller inte. Information om jailbreak-innehåll och svordomar, om det har identifierats och om det har filtrerats eller inte. Och information om kundens blocklista, om den har filtrerats och dess ID.

Name	Type	Required
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
error	errorBase	No
jailbreak	contentFilterDetectedResult	No

contentFilterChoiceResults

Information om innehållsfiltreringskategorin (hat, sexuellt, våld, self_harm), om det har upptäckts, samt allvarlighetsnivån (very_low, låg, medelhög, hög skala som avgör intensiteten och risknivån för skadligt innehåll) och om den har filtrerats eller inte. Information om text från tredje part och svordomar, om den har identifierats och om den har filtrerats eller inte. Och information om kundens blocklista, om den har filtrerats och dess ID.

Name	Type	Required
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
error	errorBase	No
protected_material_text	contentFilterDetectedResult	No
protected_material_code	contentFilterDetectedWithCitationResult	No

promptFilterResult

Resultat av innehållsfiltrering för en enda fråga i begäran.

Name	Type	Description	Required	Default
prompt_index	integer		No
content_filter_results	contentFilterPromptResults	Information om innehållsfiltreringskategorin (hat, sexuellt, våld, self_harm), om det har upptäckts, samt allvarlighetsnivån (very_low, låg, medelhög, hög skala som avgör intensiteten och risknivån för skadligt innehåll) och om den har filtrerats eller inte. Information om jailbreak-innehåll och svordomar, om det har identifierats och om det har filtrerats eller inte. Och information om kundens blocklista, om den har filtrerats och dess ID.	No

promptFilterResults

Innehållsfiltreringsresultat för noll eller fler frågor i begäran. I en strömningsbegäran kan resultat för olika frågor komma vid olika tidpunkter eller i olika beställningar.

Inga egenskaper har definierats för den här komponenten.

dalleContentFilterResults

Information om resultatet av innehållsfiltreringen.

Name	Type	Required
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No

dalleFilterResults

Name	Type	Required
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
jailbreak	contentFilterDetectedResult	No

chatCompletionsRequestCommon

Name	Type	Description	Required	Default
temperature	number	Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar vanligtvis att du ändrar detta eller `top_p` men inte båda.	No	1
top_p	number	Ett alternativ till sampling med temperatur, som kallas kärnsampling, där modellen tar hänsyn till resultatet av token med top_p sannolikhetsmassa. Så 0,1 innebär att endast token som består av de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller `temperature` men inte båda.	No	1
stream	boolean	Om det anges skickas delvisa meddelandedelta, till exempel i ChatGPT. Token skickas som serverutsända händelser endast för data när de blir tillgängliga, och strömmen avslutas av ett `data: [DONE]` meddelande.	No	False
stop	sträng eller matris	Upp till fyra sekvenser där API:et slutar generera ytterligare token.	No
max_tokens	integer	Det maximala antalet token som tillåts för det genererade svaret. Som standard är antalet token som modellen kan returnera (4096 – prompttoken). Det här värdet är nu inaktuellt till förmån `max_completion_tokens`för , och är inte kompatibelt med o1-seriemodeller.	No	4096
max_completion_tokens	integer	En övre gräns för antalet token som kan genereras för en slutförande, inklusive synliga utdatatoken och resonemangstoken.	No
presence_penalty	number	Tal mellan -2.0 och 2.0. Positiva värden straffar nya token baserat på om de visas i texten hittills, vilket ökar modellens sannolikhet att prata om nya ämnen.	No	0
frequency_penalty	number	Tal mellan -2.0 och 2.0. Positiva värden straffar nya token baserat på deras befintliga frekvens i texten hittills, vilket minskar modellens sannolikhet att upprepa samma rad ordagrant.	No	0
logit_bias	object	Ändra sannolikheten för att angivna token visas i slutförandet. Accepterar ett json-objekt som mappar token (som anges av deras token-ID i tokenizern) till ett associerat bias-värde från -100 till 100. Matematiskt läggs biasen till i de logits som genereras av modellen före sampling. Den exakta effekten varierar per modell, men värden mellan -1 och 1 bör minska eller öka sannolikheten för urval. värden som -100 eller 100 bör resultera i ett förbud eller exklusivt val av relevant token.	No
user	string	En unik identifierare som representerar slutanvändaren, som kan hjälpa Azure OpenAI att övervaka och upptäcka missbruk.	No

createCompletionRequest

Name	Type	Description	Required	Default
prompt	sträng eller matris	Uppmaningen att generera slutföranden för, kodade som en sträng, matris med strängar, matris med token eller matris med tokenmatriser. Observera att <\|endoftext\|> är dokumentavgränsaren som modellen ser under träningen, så om en fråga inte anges genereras modellen som från början av ett nytt dokument.	Yes
best_of	integer	Genererar `best_of` slutföranden på serversidan och returnerar den "bästa" (den med högsta loggens sannolikhet per token). Resultat kan inte strömmas. När det används med `n`kontrollerar `best_of` du antalet kandidatavslut och `n` anger hur många som ska returneras â€" `best_of` måste vara större än `n`. Observera: Eftersom den här parametern genererar många slutföranden kan den snabbt förbruka din tokenkvot. Använd noggrant och se till att du har rimliga inställningar för `max_tokens` och `stop`.	No	1
echo	boolean	Upprepa uppmaningen utöver slutförandet	No	False
frequency_penalty	number	Tal mellan -2.0 och 2.0. Positiva värden straffar nya token baserat på deras befintliga frekvens i texten hittills, vilket minskar modellens sannolikhet att upprepa samma rad ordagrant.	No	0
logit_bias	object	Ändra sannolikheten för att angivna token visas i slutförandet. Accepterar ett JSON-objekt som mappar token (som anges av deras token-ID i GPT-tokeniseraren) till ett associerat bias-värde från -100 till 100. Matematiskt läggs biasen till i de logits som genereras av modellen före sampling. Den exakta effekten varierar per modell, men värden mellan -1 och 1 bör minska eller öka sannolikheten för urval. värden som -100 eller 100 bör resultera i ett förbud eller exklusivt val av relevant token. Du kan till exempel skicka `{"50256": -100}` för att förhindra <att token \|endoftext\|> genereras.	No	None
logprobs	integer	Inkludera loggannolikheterna på de `logprobs` mest sannolika utdatatoken, samt de valda token. Om `logprobs` det till exempel är 5 returnerar API:et en lista över de fem mest sannolika token. API:et `logprob` returnerar alltid den samplade token, så det kan finnas upp till `logprobs+1` element i svaret. Det maximala värdet för `logprobs` är 5.	No	None
max_tokens	integer	Det maximala antalet token som kan genereras i slutförandet. Tokenantalet för din fråga plus `max_tokens` får inte överskrida modellens kontextlängd.	No	16
n	integer	Hur många slutföranden som ska genereras för varje fråga. Observera: Eftersom den här parametern genererar många slutföranden kan den snabbt förbruka din tokenkvot. Använd noggrant och se till att du har rimliga inställningar för `max_tokens` och `stop`.	No	1
presence_penalty	number	Tal mellan -2.0 och 2.0. Positiva värden straffar nya token baserat på om de visas i texten hittills, vilket ökar modellens sannolikhet att prata om nya ämnen.	No	0
seed	integer	Om det anges gör vårt system bästa för att sampla deterministiskt, så att upprepade begäranden med samma `seed` och parametrar ska returnera samma resultat. Determinism är inte garanterad och du bör referera till svarsparametern `system_fingerprint` för att övervaka ändringar i serverdelen.	No
stop	sträng eller matris	Upp till fyra sekvenser där API:et slutar generera ytterligare token. Den returnerade texten innehåller inte stoppsekvensen.	No
stream	boolean	Om du vill strömma tillbaka partiella förlopp. Om det anges skickas token som databaserade serverutskickade händelser när de blir tillgängliga, och strömmen avslutas av ett `data: [DONE]` meddelande.	No	False
suffix	string	Suffixet som kommer efter att infogad text har slutförts. Den här parametern stöds endast för `gpt-3.5-turbo-instruct`.	No	None
temperature	number	Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar vanligtvis att du ändrar detta eller `top_p` men inte båda.	No	1
top_p	number	Ett alternativ till sampling med temperatur, som kallas kärnsampling, där modellen tar hänsyn till resultatet av token med top_p sannolikhetsmassa. Så 0,1 innebär att endast token som består av de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller `temperature` men inte båda.	No	1
user	string	En unik identifierare som representerar slutanvändaren, som kan hjälpa till att övervaka och upptäcka missbruk.	No

createCompletionResponse

Representerar ett slutförandesvar från API:et. Obs! Både strömmade och icke-strömmade svarsobjekt har samma form (till skillnad från chattslutpunkten).

Name	Type	Description	Required
id	string	En unik identifierare för slutförandet.	Yes
choices	array	Listan över slutförandeval som modellen genererade för indataprompten.	Yes
created	integer	Unix-tidsstämpeln (i sekunder) för när slutförandet skapades.	Yes
model	string	Den modell som används för slutförande.	Yes
prompt_filter_results	promptFilterResults	Innehållsfiltreringsresultat för noll eller fler frågor i begäran. I en strömningsbegäran kan resultat för olika frågor komma vid olika tidpunkter eller i olika beställningar.	No
system_fingerprint	string	Det här fingeravtrycket representerar serverdelskonfigurationen som modellen körs med. Kan användas tillsammans med parametern `seed` för begäran för att förstå när serverdelsändringar har gjorts som kan påverka determinismen.	No
object	enum	Objekttypen, som alltid är "text_completion" Möjliga värden: text_completion	Yes
usage	completionUsage	Användningsstatistik för slutförandebegäran.	No

createChatCompletionRequest

Name	Type	Description	Required	Default
temperature	number	Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar vanligtvis att du ändrar detta eller `top_p` men inte båda.	No	1
top_p	number	Ett alternativ till sampling med temperatur, som kallas kärnsampling, där modellen tar hänsyn till resultatet av token med top_p sannolikhetsmassa. Så 0,1 innebär att endast token som består av de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller `temperature` men inte båda.	No	1
stream	boolean	Om det anges skickas delvisa meddelandedelta, till exempel i ChatGPT. Token skickas som serverutsända händelser endast för data när de blir tillgängliga, och strömmen avslutas av ett `data: [DONE]` meddelande.	No	False
stop	sträng eller matris	Upp till fyra sekvenser där API:et slutar generera ytterligare token.	No
max_tokens	integer	Det maximala antalet token som kan genereras i chattens slutförande. Den totala längden på indatatoken och genererade token begränsas av modellens kontextlängd.	No
max_completion_tokens	integer	En övre gräns för antalet token som kan genereras för en slutförande, inklusive synliga utdatatoken och resonemangstoken.	No
presence_penalty	number	Tal mellan -2.0 och 2.0. Positiva värden straffar nya token baserat på om de visas i texten hittills, vilket ökar modellens sannolikhet att prata om nya ämnen.	No	0
frequency_penalty	number	Tal mellan -2.0 och 2.0. Positiva värden straffar nya token baserat på deras befintliga frekvens i texten hittills, vilket minskar modellens sannolikhet att upprepa samma rad ordagrant.	No	0
logit_bias	object	Ändra sannolikheten för att angivna token visas i slutförandet. Accepterar ett JSON-objekt som mappar token (som anges av deras token-ID i tokenizern) till ett associerat bias-värde från -100 till 100. Matematiskt läggs biasen till i de logits som genereras av modellen före sampling. Den exakta effekten varierar per modell, men värden mellan -1 och 1 bör minska eller öka sannolikheten för urval. värden som -100 eller 100 bör resultera i ett förbud eller exklusivt val av relevant token.	No	None
user	string	En unik identifierare som representerar slutanvändaren, som kan hjälpa till att övervaka och upptäcka missbruk.	No
messages	array	En lista över meddelanden som består av konversationen hittills.	Yes
data_sources	array	Konfigurationsposterna för Azure OpenAI-chatttillägg som använder dem. Den här ytterligare specifikationen är endast kompatibel med Azure OpenAI.	No
logprobs	boolean	Om du vill returnera loggannolikheter för utdatatoken eller inte. Om sant returnerar loggannolikerna för varje utdatatoken som returneras i `content` i `message`.	No	False
top_logprobs	integer	Ett heltal mellan 0 och 20 som anger antalet mest sannolika token som ska returneras vid varje tokenposition, var och en med en associerad loggsannolikhet. `logprobs` måste anges till `true` om den här parametern används.	No
n	integer	Hur många alternativ för chattavslut som ska genereras för varje indatameddelande. Observera att du debiteras baserat på antalet genererade token i alla alternativ. Behåll `n` för `1` att minimera kostnaderna.	No	1
parallel_tool_calls	ParallelToolCalls	Om du vill aktivera parallell funktionsanrop under verktygsanvändning.	No	True
response_format	ResponseFormatText eller ResponseFormatJsonObject eller ResponseFormatJsonSchema	Ett objekt som anger det format som modellen måste mata ut. Kompatibel med GPT-4o, GPT-4o mini, GPT-4 Turbo och alla GPT-3.5 Turbo modeller nyare än `gpt-3.5-turbo-1106`. Inställning för att `{ "type": "json_schema", "json_schema": {...} }` aktivera strukturerade utdata som garanterar att modellen matchar ditt angivna JSON-schema. Inställningen för att `{ "type": "json_object" }` aktivera JSON-läge, vilket garanterar att meddelandet som modellen genererar är giltigt JSON. Viktigt: När du använder JSON-läge måste du också instruera modellen att skapa JSON själv via ett system- eller användarmeddelande. Utan detta kan modellen generera en avaktiverande ström av blanksteg tills genereringen når tokengränsen, vilket resulterar i en tidskrävande och till synes "fast" begäran. Observera också att meddelandeinnehållet kan vara delvis avskuret om `finish_reason="length"`, vilket indikerar att genereringen överskreds `max_tokens` eller konversationen överskred den maximala kontextlängden.	No
seed	integer	Den här funktionen finns i Beta. Om det anges gör vårt system bästa för att sampla deterministiskt, så att upprepade begäranden med samma `seed` och parametrar ska returnera samma resultat. Determinism är inte garanterad och du bör referera till svarsparametern `system_fingerprint` för att övervaka ändringar i serverdelen.	No
tools	array	En lista över verktyg som modellen kan anropa. För närvarande stöds endast funktioner som ett verktyg. Använd detta för att ange en lista över funktioner som modellen kan generera JSON-indata för. Högst 128 funktioner stöds.	No
tool_choice	chatCompletionToolChoiceOption	Styr vilket (om något) verktyg som anropas av modellen. `none` innebär att modellen inte anropar något verktyg och i stället genererar ett meddelande. `auto` innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett eller flera verktyg. `required` innebär att modellen måste anropa ett eller flera verktyg. Att ange ett visst verktyg via `{"type": "function", "function": {"name": "my_function"}}` tvingar modellen att anropa verktyget. `none` är standard när inga verktyg finns. `auto` är standardvärdet om det finns verktyg.	No
function_call	string eller chatCompletionFunctionCallOption	Inaktuell till förmån för `tool_choice`. Styr vilken (om någon) funktion som anropas av modellen. `none` innebär att modellen inte anropar en funktion och i stället genererar ett meddelande. `auto` innebär att modellen kan välja mellan att generera ett meddelande eller anropa en funktion. Om du anger en viss funktion via `{"name": "my_function"}` tvingar modellen att anropa den funktionen. `none` är standard när det inte finns några funktioner. `auto` är standardvärdet om det finns funktioner.	No
functions	array	Inaktuell till förmån för `tools`. En lista över funktioner som modellen kan generera JSON-indata för.	No

chatCompletionFunctions

Name	Type	Description	Required
description	string	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	No
name	string	Namnet på den funktion som ska anropas. Måste vara a-z, A-Z, 0-9, eller innehålla understreck och bindestreck, med en maximal längd på 64.	Yes
parameters	FunctionParameters	Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt. Se guiden för exempel och JSON-schemareferensen för dokumentation om formatet. Om du utelämnar `parameters` definieras en funktion med en tom parameterlista.	No

chatCompletionFunctionCallOption

Om du anger en viss funktion via {"name": "my_function"} tvingar modellen att anropa den funktionen.

Name	Type	Description	Required	Default
name	string	Namnet på funktionen som ska anropas.	Yes

chatCompletionRequestMessage

Den här komponenten kan vara något av följande:

chatCompletionRequestSystemMessage

Name	Type	Description	Required
content	sträng eller matris	Innehållet i systemmeddelandet.	Yes
role	enum	Rollen som meddelandenas författare, i det här fallet `system`. Möjliga värden: system	Yes
name	string	Ett valfritt namn för deltagaren. Tillhandahåller modellinformation för att skilja mellan deltagare med samma roll.	No

chatCompletionRequestUserMessage

Name	Type	Description	Required
content	sträng eller matris	Innehållet i användarmeddelandet.	Yes
role	enum	Rollen som meddelandenas författare, i det här fallet `user`. Möjliga värden: användare	Yes
name	string	Ett valfritt namn för deltagaren. Tillhandahåller modellinformation för att skilja mellan deltagare med samma roll.	No

chatCompletionRequestAssistantMessage

Name	Type	Description	Required
content	sträng eller matris	Innehållet i assistentmeddelandet. Krävs om inte `tool_calls` eller `function_call` anges.	No
refusal	string	Assistentens avslagsmeddelande.	No
role	enum	Rollen som meddelandenas författare, i det här fallet `assistant`. Möjliga värden: assistent	Yes
name	string	Ett valfritt namn för deltagaren. Tillhandahåller modellinformation för att skilja mellan deltagare med samma roll.	No
tool_calls	chatCompletionMessageToolCalls	Verktyget anropar som genereras av modellen, till exempel funktionsanrop.	No
function_call	object	Inaktuell och ersatt av `tool_calls`. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen.	No

Egenskaper för function_call

arguments

Name	Type	Description	Default
arguments	string	Argumenten för att anropa funktionen med, som genereras av modellen i JSON-format. Observera att modellen inte alltid genererar giltig JSON och kan generera parametrar som inte definierats av funktionsschemat. Verifiera argumenten i koden innan du anropar funktionen.

name

Name	Type	Description	Default
name	string	Namnet på funktionen som ska anropas.

chatCompletionRequestToolMessage

Name	Type	Description	Required
role	enum	Rollen som meddelandenas författare, i det här fallet `tool`. Möjliga värden: verktyg	Yes
content	sträng eller matris	Innehållet i verktygsmeddelandet.	Yes
tool_call_id	string	Verktygsanrop som det här meddelandet svarar på.	Yes

chatCompletionRequestFunctionMessage

Name	Type	Description	Required
role	enum	Rollen som meddelandenas författare, i det här fallet `function`. Möjliga värden: funktion	Yes
content	string	Innehållet i funktionsmeddelandet.	Yes
name	string	Namnet på funktionen som ska anropas.	Yes

chatCompletionRequestSystemMessageContentPart

Den här komponenten kan vara något av följande:

chatCompletionRequestUserMessageContentPart

Den här komponenten kan vara något av följande:

chatCompletionRequestAssistantMessageContentPart

Den här komponenten kan vara något av följande:

chatCompletionRequestToolMessageContentPart

Den här komponenten kan vara något av följande:

chatCompletionRequestMessageContentPartText

Name	Type	Description	Required	Default
type	enum	Typ av innehållsdel. Möjliga värden: text	Yes
text	string	Textinnehållet.	Yes

chatCompletionRequestMessageContentPartImage

Name	Type	Description	Required	Default
type	enum	Typ av innehållsdel. Möjliga värden: image_url	Yes
image_url	object		Yes

Egenskaper för image_url

url

Name	Type	Description	Default
url	string	Antingen en URL för bilden eller base64-kodade bilddata.

detail

Name	Type	Description	Default
detail	string	Anger detaljnivån för bilden. Läs mer i visionsguiden.	auto

chatCompletionRequestMessageContentPartRefusal

Name	Type	Description	Required	Default
type	enum	Typ av innehållsdel. Möjliga värden: avslag	Yes
refusal	string	Avslagsmeddelandet som genereras av modellen.	Yes

azureChatExtensionConfiguration

En representation av konfigurationsdata för ett enda Azure OpenAI-chatttillägg. Detta används av en begäran om slutförande av chatten som ska använda Azure OpenAI-chatttillägg för att öka svarsbeteendet. Användningen av den här konfigurationen är endast kompatibel med Azure OpenAI.

Name	Type	Description	Required	Default
type	azureChatExtensionType	En representation av konfigurationsdata för ett enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chatt slutförandebegäran som ska använda Azure OpenAI-chatttillägg för att öka svarsbeteendet. Användningen av den här konfigurationen är endast kompatibel med Azure OpenAI.	Yes

azureChatExtensionType

Description: En representation av konfigurationsdata för ett enda Azure OpenAI-chatttillägg. Detta används av en begäran om slutförande av chatten som ska använda Azure OpenAI-chatttillägg för att öka svarsbeteendet. Användningen av den här konfigurationen är endast kompatibel med Azure OpenAI.

Type: string

Default:

Uppräkningsnamn: AzureChatExtensionType

Enum Values:

Value	Description
azure_search	Representerar användningen av Azure Search som ett Azure OpenAI-chatttillägg.
azure_cosmos_db	Representerar användningen av Azure Cosmos DB som ett Azure OpenAI-chatttillägg.

azureSearchChatExtensionConfiguration

En specifik representation av konfigurerbara alternativ för Azure Search när du använder det som ett Azure OpenAI-chatttillägg.

Name	Type	Description	Required	Default
type	azureChatExtensionType	En representation av konfigurationsdata för ett enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chatt slutförandebegäran som ska använda Azure OpenAI-chatttillägg för att öka svarsbeteendet. Användningen av den här konfigurationen är endast kompatibel med Azure OpenAI.	Yes
parameters	azureSearchChatExtensionParameters	Parametrar för Azure Search när det används som ett Azure OpenAI-chatttillägg.	No

azureSearchChatExtensionParameters

Parametrar för Azure Search när det används som ett Azure OpenAI-chatttillägg.

Name	Type	Description	Required
authentication	onYourDataApiKeyAuthenticationOptions eller onYourDataSystemAssignedManagedIdentityAuthenticationOptions eller onYourDataUserAssignedManagedIdentityAuthenticationOptions		Yes
top_n_documents	integer	Det konfigurerade högsta antalet dokument som ska användas för den konfigurerade frågan.	No
in_scope	boolean	Om frågor ska begränsas till användning av indexerade data.	No
strictness	integer	Den konfigurerade strängheten för sökrelevansfiltreringen. Ju högre strikthet, desto högre precision men lägre återkallande av svaret.	No
role_information	string	Ge modellinstruktionerna om hur den ska bete sig och vilken kontext den ska referera till när du genererar ett svar. Du kan beskriva assistentens personlighet och berätta hur du formaterar svar. Det finns en gräns på 100 token för den och den räknas mot den totala tokengränsen.	No
endpoint	string	Den absoluta slutpunktssökvägen för den Azure sökresurs som ska användas.	Yes
index_name	string	Namnet på indexet som ska användas som tillgängligt i den refererade Azure sökresursen.	Yes
fields_mapping	azureSearchIndexFieldMappingOptions	Valfria inställningar för att styra hur fält bearbetas när du använder en konfigurerad Azure sökresurs.	No
query_type	azureSearchQueryType	Den typ av Azure sökhämtningsfråga som ska köras när du använder den som ett Azure OpenAI-chatttillägg.	No
semantic_configuration	string	Den ytterligare semantiska konfigurationen för frågan.	No
filter	string	Search filter.	No
embedding_dependency	onYourDataEndpointVectorizationSource eller onYourDataDeploymentNameVectorizationSource		No

azureSearchIndexFieldMappingOptions

Valfria inställningar för att styra hur fält bearbetas när du använder en konfigurerad Azure sökresurs.

Name	Type	Description	Required
title_field	string	Namnet på det indexfält som ska användas som rubrik.	No
url_field	string	Namnet på det indexfält som ska användas som en URL.	No
filepath_field	string	Namnet på det indexfält som ska användas som en filsökväg.	No
content_fields	array	Namnen på indexfält som ska behandlas som innehåll.	No
content_fields_separator	string	Det avgränsarmönster som innehållsfält ska använda.	No
vector_fields	array	Namnen på fält som representerar vektordata.	No

azureSearchQueryType

Den typ av Azure sökhämtningsfråga som ska köras när du använder den som ett Azure OpenAI-chatttillägg.

Description: Den typ av Azure sökhämtningsfråga som ska köras när du använder den som ett Azure OpenAI-chatttillägg.

Type: string

Default:

Uppräkningsnamn: AzureSearchQueryType

Enum Values:

Value	Description
simple	Representerar standard, enkel frågeparser.
semantic	Representerar den semantiska frågeparsern för avancerad semantisk modellering.
vector	Representerar vektorsökning över beräknade data.
vector_simple_hybrid	Representerar en kombination av den enkla frågestrategin med vektordata.
vector_semantic_hybrid	Representerar en kombination av semantisk sökning och vektordatafrågor.

azureCosmosDBChatExtensionConfiguration

En specifik representation av konfigurerbara alternativ för Azure Cosmos DB när du använder det som ett Azure OpenAI-chatttillägg.

Name	Type	Description	Required	Default
type	azureChatExtensionType	En representation av konfigurationsdata för ett enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chatt slutförandebegäran som ska använda Azure OpenAI-chatttillägg för att öka svarsbeteendet. Användningen av den här konfigurationen är endast kompatibel med Azure OpenAI.	Yes
parameters	azureCosmosDBChatExtensionParameters	Parametrar som ska användas när du konfigurerar Azure OpenAI på dina datachatttillägg när du använder Azure Cosmos DB för MongoDB vCore.	No

azureCosmosDBChatExtensionParameters

Parametrar som ska användas när du konfigurerar Azure OpenAI på dina datachatttillägg när du använder Azure Cosmos DB för MongoDB vCore.

Name	Type	Description	Required
authentication	onYourDataConnectionStringAuthenticationOptions	Autentiseringsalternativen för Azure OpenAI på dina data när du använder en reťazec pripojenia.	Yes
top_n_documents	integer	Det konfigurerade högsta antalet dokument som ska användas för den konfigurerade frågan.	No
in_scope	boolean	Om frågor ska begränsas till användning av indexerade data.	No
strictness	integer	Den konfigurerade strängheten för sökrelevansfiltreringen. Ju högre strikthet, desto högre precision men lägre återkallande av svaret.	No
role_information	string	Ge modellinstruktionerna om hur den ska bete sig och vilken kontext den ska referera till när du genererar ett svar. Du kan beskriva assistentens personlighet och berätta hur du formaterar svar. Det finns en gräns på 100 token för den och den räknas mot den totala tokengränsen.	No
database_name	string	MongoDB vCore-databasnamnet som ska användas med Azure Cosmos DB.	Yes
container_name	string	Namnet på Azure Cosmos DB resurscontainer.	Yes
index_name	string	MongoDB vCore-indexnamnet som ska användas med Azure Cosmos DB.	Yes
fields_mapping	azureCosmosDBFieldMappingOptions	Valfria inställningar för att styra hur fält bearbetas när du använder en konfigurerad Azure Cosmos DB resurs.	Yes
embedding_dependency	onYourDataEndpointVectorizationSource eller onYourDataDeploymentNameVectorizationSource		Yes

azureCosmosDBFieldMappingOptions

Valfria inställningar för att styra hur fält bearbetas när du använder en konfigurerad Azure Cosmos DB resurs.

Name	Type	Description	Required
title_field	string	Namnet på det indexfält som ska användas som rubrik.	No
url_field	string	Namnet på det indexfält som ska användas som en URL.	No
filepath_field	string	Namnet på det indexfält som ska användas som en filsökväg.	No
content_fields	array	Namnen på indexfält som ska behandlas som innehåll.	Yes
content_fields_separator	string	Det avgränsarmönster som innehållsfält ska använda.	No
vector_fields	array	Namnen på fält som representerar vektordata.	Yes

onYourDataAuthenticationOptions

Autentiseringsalternativen för Azure OpenAI på dina data.

Name	Type	Description	Required	Default
type	onYourDataAuthenticationType	De autentiseringstyper som stöds med Azure OpenAI på dina data.	Yes

onYourDataAuthenticationType

De autentiseringstyper som stöds med Azure OpenAI på dina data.

Description: De autentiseringstyper som stöds med Azure OpenAI på dina data.

Type: string

Default:

Uppräkningsnamn: OnYourDataAuthenticationType

Enum Values:

Value	Description
api_key	Autentisering via API-nyckel.
connection_string	Autentisering via reťazec pripojenia.
system_assigned_managed_identity	Autentisering via systemtilldelad hanterad identitet.
user_assigned_managed_identity	Autentisering via användartilldelad hanterad identitet.

onYourDataApiKeyAuthenticationOptions

Autentiseringsalternativen för Azure OpenAI på dina data när du använder en API-nyckel.

Name	Type	Description	Required	Default
type	onYourDataAuthenticationType	De autentiseringstyper som stöds med Azure OpenAI på dina data.	Yes
key	string	API-nyckeln som ska användas för autentisering.	No

onYourDataConnectionStringAuthenticationOptions

Autentiseringsalternativen för Azure OpenAI på dina data när du använder en reťazec pripojenia.

Name	Type	Description	Required	Default
type	onYourDataAuthenticationType	De autentiseringstyper som stöds med Azure OpenAI på dina data.	Yes
connection_string	string	Den reťazec pripojenia som ska användas för autentisering.	No

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

Autentiseringsalternativen för Azure OpenAI på dina data när du använder en systemtilldelad hanterad identitet.

Name	Type	Description	Required	Default
type	onYourDataAuthenticationType	De autentiseringstyper som stöds med Azure OpenAI på dina data.	Yes

onYourDataUserAssignedManagedIdentityAuthenticationOptions

Autentiseringsalternativen för Azure OpenAI på dina data när du använder en användartilldelad hanterad identitet.

Name	Type	Description	Required	Default
type	onYourDataAuthenticationType	De autentiseringstyper som stöds med Azure OpenAI på dina data.	Yes
managed_identity_resource_id	string	Resurs-ID för den användartilldelade hanterade identitet som ska användas för autentisering.	No

onYourDataVectorizationSource

En abstrakt representation av en vektoriseringskälla för Azure OpenAI på dina data med vektorsökning.

Name	Type	Description	Required	Default
type	onYourDataVectorizationSourceType	Representerar tillgängliga källor Azure OpenAI på dina data kan använda för att konfigurera vektorisering av data för användning med vector search.	Yes

onYourDataVectorizationSourceType

Representerar tillgängliga källor Azure OpenAI På dina data kan använda för att konfigurera vektorisering av data för användning med vektorsökning.

Description: Representerar tillgängliga källor Azure OpenAI På dina data kan använda för att konfigurera vektorisering av data för användning med
vector search.

Type: string

Default:

Uppräkningsnamn: OnYourDataVectorizationSourceType

Enum Values:

Value	Description
endpoint	Representerar vektorisering som utförs av offentliga tjänstanrop till en Azure OpenAI-inbäddningsmodell.
deployment_name	Representerar ett distributionsnamn för Ada-modellen som ska användas. Den här modelldistributionen måste finnas i samma Azure OpenAI-resurs, men På Dina data använder den här modelldistributionen via ett internt anrop i stället för ett offentligt, vilket möjliggör vektor även i privata nätverk.

onYourDataDeploymentNameVectorizationSource

Information om en vektoriseringskälla som används av Azure OpenAI på dina data när du tillämpar vektorsökning, som baseras på ett internt namn på inbäddningsmodellen i samma Azure OpenAI-resurs.

Name	Type	Description	Required	Default
type	onYourDataVectorizationSourceType	Representerar tillgängliga källor Azure OpenAI på dina data kan använda för att konfigurera vektorisering av data för användning med vector search.	Yes
deployment_name	string	Anger namnet på modelldistributionen som ska användas för vektorisering. Den här modelldistributionen måste finnas i samma Azure OpenAI-resurs, men På dina data använder den här modelldistributionen via ett internt anrop i stället för ett offentligt, vilket möjliggör vektorsökning även i privata nätverk.	No

onYourDataEndpointVectorizationSource

Information om en vektoriseringskälla, som används av Azure OpenAI på dina data vid tillämpning av vektorsökning, som baseras på ett offentligt Azure OpenAI-slutpunktsanrop för inbäddningar.

Name	Type	Description	Required
type	onYourDataVectorizationSourceType	Representerar tillgängliga källor Azure OpenAI på dina data kan använda för att konfigurera vektorisering av data för användning med vector search.	Yes
authentication	onYourDataApiKeyAuthenticationOptions	Autentiseringsalternativen för Azure OpenAI på dina data när du använder en API-nyckel.	No
endpoint	string	Anger slutpunkten som ska användas för vektorisering. Den här slutpunkten måste finnas i samma Azure OpenAI-resurs, men På dina data använder den här slutpunkten via ett internt anrop i stället för ett offentligt, vilket möjliggör vektorsökning även i privata nätverk.	No

azureChatExtensionsMessageContext

En representation av den ytterligare kontextinformation som är tillgänglig när Azure OpenAI-chatttillägg ingår i genereringen av ett motsvarande svar om chattens slutförande. Den här kontextinformationen fylls bara i när du använder en Azure OpenAI-begäran som konfigurerats för att använda ett matchande tillägg.

Name	Type	Description	Required	Default
citations	array	Datakällans hämtningsresultat, som används för att generera assistentmeddelandet i svaret.	No
intent	string	Den identifierade avsikten från chatthistoriken, som används för att gå vidare till nästa tur för att överföra kontexten.	No

citation

källhänvisningsinformation för ett svarsmeddelande om att chatten har slutförts.

Name	Type	Description	Required
content	string	Innehållet i källhänvisning.	Yes
title	string	Rubriken på citatet.	No
url	string	URL:en för källhänvisning.	No
filepath	string	Filsökvägen för källhänvisning.	No
chunk_id	string	Citatets segment-ID.	No

chatCompletionMessageToolCall

Name	Type	Description	Required
id	string	ID:t för verktygsanropet.	Yes
type	toolCallType	Typ av verktygsanrop, i det här fallet `function`.	Yes
function	object	Den funktion som modellen anropade.	Yes

Egenskaper för funktionen

name

Name	Type	Description	Default
name	string	Namnet på funktionen som ska anropas.

arguments

Name	Type	Description	Default
arguments	string	Argumenten för att anropa funktionen med, som genereras av modellen i JSON-format. Observera att modellen inte alltid genererar giltig JSON och kan generera parametrar som inte definierats av funktionsschemat. Verifiera argumenten i koden innan du anropar funktionen.

toolCallType

Typ av verktygsanrop, i det här fallet function.

Beskrivning: Typ av verktygsanrop, i det här fallet function.

Type: string

Default:

Uppräkningsnamn: ToolCallType

Enum Values:

Value	Description
function	Verktygsanropstypen är funktion.

chatCompletionRequestMessageTool

Name	Type	Description	Required	Default
tool_call_id	string	Verktygsanrop som det här meddelandet svarar på.	No
content	string	Innehållet i meddelandet.	No

chatCompletionRequestMessageFunction

Name	Type	Description	Required
role	enum	Rollen som meddelandenas författare, i det här fallet `function`. Möjliga värden: funktion	No
name	string	Innehållet i meddelandet.	No
content	string	Innehållet i meddelandet.	No

createChatCompletionResponse

Representerar ett svar för chattens slutförande som returneras av modellen, baserat på de angivna indata.

Name	Type	Description	Required
id	string	En unik identifierare för chattens slutförande.	Yes
prompt_filter_results	promptFilterResults	Innehållsfiltreringsresultat för noll eller fler frågor i begäran. I en strömningsbegäran kan resultat för olika frågor komma vid olika tidpunkter eller i olika beställningar.	No
choices	array	En lista över alternativ för chattens slutförande. Kan vara mer än en om `n` är större än 1.	Yes
created	integer	Unix-tidsstämpeln (i sekunder) för när chatten slutfördes skapades.	Yes
model	string	Modellen som används för chattens slutförande.	Yes
system_fingerprint	string	Det här fingeravtrycket representerar serverdelskonfigurationen som modellen körs med. Kan användas tillsammans med parametern `seed` för begäran för att förstå när serverdelsändringar har gjorts som kan påverka determinismen.	No
object	enum	Objekttypen, som alltid `chat.completion`är . Möjliga värden: chat.completion	Yes
usage	completionUsage	Användningsstatistik för slutförandebegäran.	No

createChatCompletionStreamResponse

Representerar en strömmad del av ett chattsvar som returneras av modellen, baserat på angivna indata.

Name	Type	Description	Required
id	string	En unik identifierare för chattens slutförande. Varje segment har samma ID.	Yes
choices	array	En lista över alternativ för chattens slutförande. Kan innehålla fler än ett element om `n` det är större än 1.	Yes
created	integer	Unix-tidsstämpeln (i sekunder) för när chatten slutfördes skapades. Varje segment har samma tidsstämpel.	Yes
model	string	Modellen som ska generera slutförandet.	Yes
system_fingerprint	string	Det här fingeravtrycket representerar serverdelskonfigurationen som modellen körs med. Kan användas tillsammans med parametern `seed` för begäran för att förstå när serverdelsändringar har gjorts som kan påverka determinismen.	No
object	enum	Objekttypen, som alltid `chat.completion.chunk`är . Möjliga värden: chat.completion.chunk	Yes

chatCompletionStreamResponseDelta

Ett delta i chatten som genereras av strömmade modellsvar.

Name	Type	Description	Required
content	string	Innehållet i segmentmeddelandet.	No
function_call	object	Inaktuell och ersatt av `tool_calls`. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen.	No
tool_calls	array		No
role	enum	Rollen som författare till det här meddelandet. Möjliga värden: system, användare, assistent, verktyg	No
refusal	string	Avslagsmeddelandet som genereras av modellen.	No

Egenskaper för function_call

arguments

Name	Type	Description	Default
arguments	string	Argumenten för att anropa funktionen med, som genereras av modellen i JSON-format. Observera att modellen inte alltid genererar giltig JSON och kan generera parametrar som inte definierats av funktionsschemat. Verifiera argumenten i koden innan du anropar funktionen.

name

Name	Type	Description	Default
name	string	Namnet på funktionen som ska anropas.

chatCompletionMessageToolCallChunk

Name	Type	Description	Required
index	integer		Yes
id	string	ID:t för verktygsanropet.	No
type	enum	Verktygets typ. För närvarande stöds endast `function` . Möjliga värden: funktion	No
function	object		No

Egenskaper för funktionen

name

Name	Type	Description	Default
name	string	Namnet på funktionen som ska anropas.

arguments

Name	Type	Description	Default
arguments	string	Argumenten för att anropa funktionen med, som genereras av modellen i JSON-format. Observera att modellen inte alltid genererar giltig JSON och kan generera parametrar som inte definierats av funktionsschemat. Verifiera argumenten i koden innan du anropar funktionen.

chatCompletionStreamOptions

Alternativ för strömningssvar. Ange endast detta när du anger stream: true.

Name	Type	Description	Required	Default
include_usage	boolean	Om det anges strömmas ytterligare ett segment före meddelandet `data: [DONE]` . Fältet `usage` i det här segmentet visar tokenanvändningsstatistiken för hela begäran och fältet `choices` kommer alltid att vara en tom matris. Alla andra segment innehåller också ett `usage` fält, men med ett null-värde.	No

chatCompletionChoiceLogProbs

Logga sannolikhetsinformation för valet.

Name	Type	Description	Required	Default
content	array	En lista över meddelandeinnehållstoken med loggens sannolikhetsinformation.	Yes
refusal	array	En lista över token för meddelandevägran med loggens sannolikhetsinformation.	No

chatCompletionTokenLogprob

Name	Type	Description	Required
token	string	The token.	Yes
logprob	number	Loggens sannolikhet för denna token.	Yes
bytes	array	En lista över heltal som representerar UTF-8 byte-representationen av token. Användbart i fall där tecken representeras av flera token och deras byterepresentationer måste kombineras för att generera rätt textrepresentation. Kan vara `null` om det inte finns någon byterepresentation för token.	Yes
top_logprobs	array	Lista över de mest sannolika token och deras loggsannolikhet vid den här tokenpositionen. I sällsynta fall kan det finnas färre än antalet begärda `top_logprobs` som returneras.	Yes

chatCompletionResponseMessage

Ett meddelande om att chatten har slutförts som genererats av modellen.

Name	Type	Description	Required
role	chatCompletionResponseMessageRole	Rollen som upphovsman till svarsmeddelandet.	Yes
refusal	string	Avslagsmeddelandet som genereras av modellen.	Yes
content	string	Innehållet i meddelandet.	Yes
tool_calls	array	Verktyget anropar som genereras av modellen, till exempel funktionsanrop.	No
function_call	chatCompletionFunctionCall	Inaktuell och ersatt av `tool_calls`. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen.	No
context	azureChatExtensionsMessageContext	En representation av den ytterligare kontextinformation som är tillgänglig när Azure OpenAI-chatttillägg ingår i genereringen av ett motsvarande svar om chattens slutförande. Den här kontextinformationen fylls bara i när med hjälp av en Azure OpenAI-begäran som konfigurerats för att använda ett matchande tillägg.	No

chatCompletionResponseMessageRole

Rollen som upphovsman till svarsmeddelandet.

Beskrivning: Rollen som upphovsman till svarsmeddelandet.

Type: string

Default:

Enum Values:

assistant

chatCompletionToolChoiceOption

Styr vilket (om något) verktyg som anropas av modellen. none innebär att modellen inte anropar något verktyg och i stället genererar ett meddelande. auto innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett eller flera verktyg. required innebär att modellen måste anropa ett eller flera verktyg. Att ange ett visst verktyg via {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa verktyget. none är standard när inga verktyg finns. auto är standardvärdet om det finns verktyg.

Den här komponenten kan vara något av följande:

chatCompletionNamedToolChoice

Anger ett verktyg som modellen ska använda. Använd för att tvinga modellen att anropa en specifik funktion.

Name	Type	Description	Required	Default
type	enum	Verktygets typ. För närvarande stöds endast `function` . Möjliga värden: funktion	Yes
function	object		Yes

Egenskaper för funktionen

name

Name	Type	Description	Default
name	string	Namnet på funktionen som ska anropas.

ParallelToolCalls

Om du vill aktivera parallell funktionsanrop under verktygsanvändning.

Inga egenskaper har definierats för den här komponenten.

chatCompletionMessageToolCalls

Verktyget anropar som genereras av modellen, till exempel funktionsanrop.

Inga egenskaper har definierats för den här komponenten.

chatCompletionFunctionCall

Inaktuell och ersatt av tool_calls. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen.

Name	Type	Description	Required	Default
name	string	Namnet på funktionen som ska anropas.	Yes
arguments	string	Argumenten för att anropa funktionen med, som genereras av modellen i JSON-format. Observera att modellen inte alltid genererar giltig JSON och kan generera parametrar som inte definierats av funktionsschemat. Verifiera argumenten i koden innan du anropar funktionen.	Yes

completionUsage

Användningsstatistik för slutförandebegäran.

Name	Type	Description	Required
prompt_tokens	integer	Antal token i prompten.	Yes
completion_tokens	integer	Antal token i det genererade slutförandet.	Yes
total_tokens	integer	Totalt antal token som används i begäran (fråga + slutförande).	Yes
completion_tokens_details	object	Uppdelning av token som används i en slutförande.	No

Egenskaper för completion_tokens_details

reasoning_tokens

Name	Type	Description	Default
reasoning_tokens	integer	Token som genereras av modellen för resonemang.

chatCompletionTool

Name	Type	Description	Required	Default
type	enum	Verktygets typ. För närvarande stöds endast `function` . Möjliga värden: funktion	Yes
function	FunctionObject		Yes

FunctionParameters

Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt. Se guiden för exempel och JSON-schemareferensen för dokumentation om formatet.

Om du utelämnar parameters definieras en funktion med en tom parameterlista.

Inga egenskaper har definierats för den här komponenten.

FunctionObject

Name	Type	Description	Required	Default
description	string	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	No
name	string	Namnet på den funktion som ska anropas. Måste vara a-z, A-Z, 0-9, eller innehålla understreck och bindestreck, med en maximal längd på 64.	Yes
parameters	FunctionParameters	Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt. Se guiden för exempel och JSON-schemareferensen för dokumentation om formatet. Om du utelämnar `parameters` definieras en funktion med en tom parameterlista.	No
strict	boolean	Om du vill aktivera strikt schemaefterlevnad när funktionsanropet genereras. Om värdet är true följer modellen det exakta schemat som definierats i fältet `parameters` . Endast en delmängd av JSON-schemat stöds när `strict` är `true`.	No	False

ResponseFormatText

Name	Type	Description	Required	Default
type	enum	Typ av svarsformat som definieras: `text` Möjliga värden: text	Yes

ResponseFormatJsonObject

Name	Type	Description	Required	Default
type	enum	Typ av svarsformat som definieras: `json_object` Möjliga värden: json_object	Yes

ResponseFormatJsonSchemaSchema

Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt.

Inga egenskaper har definierats för den här komponenten.

ResponseFormatJsonSchema

Name	Type	Description	Required	Default
type	enum	Typ av svarsformat som definieras: `json_schema` Möjliga värden: json_schema	Yes
json_schema	object		Yes

Egenskaper för json_schema

description

Name	Type	Description	Default
description	string	En beskrivning av vad svarsformatet är till för, som används av modellen för att avgöra hur du ska svara i formatet.

name

Name	Type	Description	Default
name	string	Namnet på svarsformatet. Måste vara a-z, A-Z, 0-9, eller innehålla understreck och bindestreck, med en maximal längd på 64.

schema

Name	Type	Description	Default
schema	ResponseFormatJsonSchemaSchema	Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt.

strict

Name	Type	Description	Default
strict	boolean	Om du vill aktivera strikt schemaefterlevnad när utdata genereras. Om värdet är true följer modellen alltid det exakta schema som definierats i fältet `schema` . Endast en delmängd av JSON-schemat stöds när `strict` är `true`.	False

chatCompletionChoiceCommon

Name	Type	Description	Required	Default
index	integer		No
finish_reason	string		No

createTranslationRequest

Translation request.

Name	Type	Description	Required	Default
file	string	Ljudfilen som ska översättas.	Yes
prompt	string	En valfri text som vägleder modellens formatmall eller fortsätter med ett tidigare ljudsegment. Uppmaningen ska vara på engelska.	No
response_format	audioResponseFormat	Definierar formatet för utdata.	No
temperature	number	Provtagningstemperaturen, mellan 0 och 1. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Om värdet är 0 använder modellen loggsannolikhet för att automatiskt öka temperaturen tills vissa tröskelvärden uppnås.	No	0

audioResponse

Översättnings- eller transkriptionssvar när response_format var json

Name	Type	Description	Required	Default
text	string	Översatt eller transkriberad text.	Yes

audioVerboseResponse

Översättnings- eller transkriptionssvar när response_format verbose_json

Name	Type	Description	Required
text	string	Översatt eller transkriberad text.	Yes
task	string	Typ av ljudaktivitet.	No
language	string	Language.	No
duration	number	Duration.	No
segments	array		No

audioResponseFormat

Definierar formatet för utdata.

Beskrivning: Definierar formatet för utdata.

Type: string

Default:

Enum Values:

json
text
srt
verbose_json
vtt

createTranscriptionRequest

Transcription request.

Name	Type	Description	Required	Default
file	string	Ljudfilsobjektet som ska transkriberas.	Yes
prompt	string	En valfri text som vägleder modellens formatmall eller fortsätter med ett tidigare ljudsegment. Uppmaningen ska matcha ljudspråket.	No
response_format	audioResponseFormat	Definierar formatet för utdata.	No
temperature	number	Provtagningstemperaturen, mellan 0 och 1. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Om värdet är 0 använder modellen loggsannolikhet för att automatiskt öka temperaturen tills vissa tröskelvärden uppnås.	No	0
language	string	Språket för indataljudet. Om du anger indataspråket i ISO-639-1-format förbättras noggrannheten och svarstiden.	No

audioSegment

Transkriptions- eller översättningssegment.

Name	Type	Description	Required
id	integer	Segment identifier.	No
seek	number	Förskjutning av segmentet.	No
start	number	Segmentstartsförskjutning.	No
end	number	Segmentslutförskjutning.	No
text	string	Segment text.	No
tokens	array	Token för texten.	No
temperature	number	Temperature.	No
avg_logprob	number	Genomsnittlig loggsannolikheten.	No
compression_ratio	number	Compression ratio.	No
no_speech_prob	number	Sannolikhet för `no speech`.	No

imageQuality

Kvaliteten på den bild som ska genereras.

Beskrivning: Kvaliteten på den bild som ska genereras.

Type: string

Default: standard

Uppräkningsnamn: Kvalitet

Enum Values:

Value	Description
standard	Standardkvalitet skapar bilder med standardkvalitet.
hd	HD-kvalitet skapar bilder med finare information och större konsekvens i bilden.

imagesResponseFormat

Formatet där de genererade bilderna returneras.

Beskrivning: Formatet där de genererade bilderna returneras.

Type: string

Default: url

Uppräkningsnamn: ImagesResponseFormat

Enum Values:

Value	Description
url	Den URL som ger tillfällig åtkomst för att ladda ned de genererade avbildningarna.
b64_json	De genererade bilderna returneras som base64-kodad sträng.

imageSize

Storleken på de genererade bilderna.

Beskrivning: Storleken på de genererade bilderna.

Type: string

Default: 1024x1024

Uppräkningsnamn: Storlek

Enum Values:

Value	Description
1792x1024	Den genererade bildens önskade storlek är 1 792 x 1 024 bildpunkter.
1024x1792	Den genererade bildens önskade storlek är 1 024 x 1 792 bildpunkter.
1024x1024	Den genererade bildens önskade storlek är 1 024 x 1 024 bildpunkter.

imageStyle

Formatmallen för de genererade bilderna.

Beskrivning: Formatmallen för de genererade bilderna.

Type: string

Default: vivid

Uppräkningsnamn: Formatmall

Enum Values:

Value	Description
vivid	Levande skapar bilder som är hyperrealistiska och dramatiska.
natural	Naturliga skapar bilder som är mer naturliga och mindre hyperrealistiska.

imageGenerationsRequest

Name	Type	Description	Required	Default
prompt	string	En textbeskrivning av de önskade bilderna. Den maximala längden är 4 000 tecken.	Yes
n	integer	Antalet bilder som ska genereras.	No	1
size	imageSize	Storleken på de genererade bilderna.	No	1024x1024
response_format	imagesResponseFormat	Formatet där de genererade bilderna returneras.	No	url
user	string	En unik identifierare som representerar slutanvändaren, som kan hjälpa till att övervaka och upptäcka missbruk.	No
quality	imageQuality	Kvaliteten på den bild som ska genereras.	No	standard
style	imageStyle	Formatmallen för de genererade bilderna.	No	vivid

generateImagesResponse

Name	Type	Description	Required	Default
created	integer	Unix-tidsstämpeln när åtgärden skapades.	Yes
data	array	Resultatdata för åtgärden, om det lyckas	Yes

imageResult

Bild-URL:en eller den kodade bilden om den lyckas och ett annat fel.

Name	Type	Description	Required
url	string	Bild-URL:en.	No
b64_json	string	Den base64-kodade avbildningen	No
content_filter_results	dalleContentFilterResults	Information om resultatet av innehållsfiltreringen.	No
revised_prompt	string	Uppmaningen som användes för att generera avbildningen, om det fanns någon revision av prompten.	No
prompt_filter_results	dalleFilterResults	Information om innehållsfiltreringskategorin (hat, sexuellt, våld, self_harm), om det har upptäckts, samt allvarlighetsnivån (very_low, låg, medelhög, hög skala som avgör intensiteten och risknivån för skadligt innehåll) och om den har filtrerats eller inte. Information om jailbreak-innehåll och svordomar, om det har identifierats och om det har filtrerats eller inte. Och information om kundens blocklista, om den har filtrerats och dess ID.	No

Completions extensions

Tillägg för slutföranden är inte en del av den senaste GA-versionen av Azure OpenAI-dataplanets slutsatsdragningsspecifikation.

Chatmessage

Chattmeddelandeobjektet är inte en del av den senaste GA-versionen av Azure OpenAI-dataplanets slutsatsdragningsspecifikation.

Text till tal (förhandsversion)

Ingår för närvarande inte i den senaste Azure OpenAI GA-versionen av Azure OpenAI-dataplanets slutsatsspecifikation. Mer information om den här funktionen finns i den senaste preview versionen.

Next steps

Lär dig mer om modeller och finjustering med REST-API:et. Läs mer om underlying modeller som driver Azure OpenAI.

Feedback

Var den här sidan till hjälp?

Last updated on 2026-04-30