Förhandsversionsreferens för Azure OpenAI Service REST API

Den här artikeln innehåller information om rest-API-slutpunkterna för inferens för Azure OpenAI.

API-specifikationer

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

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

API	Senaste förhandsversion	Senaste GA-versionen	Specifikationer	beskrivning
Kontrollplan	2024-06-01-preview	2024-10-01	Spec-filer	Azure OpenAI delar ett gemensamt kontrollplan med alla andra Azure AI-tjänster. Kontrollplans-API:et används för saker som att skapa Azure OpenAI-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.
Dataplan – redigering	2024-10-01-preview	2024-10-21	Spec-filer	API:et för redigering av dataplanet styr finjustering, filuppladdning, inmatningsjobb, batchfrågor och vissa frågor på modellnivå
Dataplan – slutsatsdragning	2024-10-01-preview	2024-10-21	Spec-filer	API:et för dataplansinferens tillhandahåller slutsatsdragningsfunktioner/slutpunkter för funktioner som slutföranden, chattavslutningar, inbäddningar, tal/viskningar, på dina data, Dall-e, assistenter osv.

Autentisering

Azure OpenAI tillhandahå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 guide om autentisering med Microsoft Entra-ID.

REST API-versionshantering

Tjänst-API:erna versionshanteras med frågeparametern api-version. Alla versioner följer datumstrukturen ÅÅÅÅÅ-MM-DD. Till exempel:

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 den senaste förhandsversionen av inferensspecifikationen för Azure OpenAI-dataplanet, 2024-10-01-preview. Den här artikeln innehåller dokumentation om de senaste förhandsgranskningsfunktionerna, till exempel assistenter, trådar och vektorlager.

Om du letar efter dokumentation om den senaste GA API-versionen läser du det senaste API:et för ga-dataplansinferens

Slutföranden – Skapa

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

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

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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	Ja	sträng	Distributions-ID för modellen som distribuerades.
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
snabb	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.	Ja
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 nkontrollerar best_of du antalet kandidatavslut och n anger hur många som ska returneras â€" best_of måste vara större än n. Obs! 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.	Nej	1
eko	boolean	Upprepa uppmaningen utöver slutförandet	Nej	Falsk
frequency_penalty	Nummer	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.	Nej	0
logit_bias	objekt	Ändra sannolikheten för att angivna token visas i slutförandet. Accepterar ett JSON-objekt som mappar token (anges av deras token-ID i GPT-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 val. 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.	Nej	Ingen
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.	Nej	Ingen
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.	Nej	16
n	integer	Hur många slutföranden som ska genereras för varje fråga. Obs! 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.	Nej	1
presence_penalty	Nummer	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.	Nej	0
frö	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.	Nej
Stanna	sträng eller matris	Upp till fyra sekvenser där API:et slutar generera ytterligare token. Den returnerade texten innehåller inte stoppsekvensen.	Nej
ström	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.	Nej	Falsk
suffix	sträng	Suffixet som kommer efter att infogad text har slutförts. Den här parametern stöds endast för gpt-3.5-turbo-instruct.	Nej	Ingen
temperatur	Nummer	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.	Nej	1
top_p	Nummer	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 den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.	Nej	1
användare	sträng	En unik identifierare som representerar slutanvändaren, som kan hjälpa till att övervaka och upptäcka missbruk.	Nej

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
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

Innehållstyp	Typ	Beskrivning
application/json	errorResponse

Exempel

Exempel

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-01-preview

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

Inbäddningar – Skapa

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

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

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
indata	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.	Ja
användare	sträng	En unik identifierare som representerar slutanvändaren, som kan hjälpa dig att övervaka och upptäcka missbruk.	Nej
input_type	sträng	indatatyp för inbäddningssökning som ska användas	Nej
encoding_format	sträng	Formatet för att returnera inbäddningarna i. Kan vara antingen float eller base64. Standardvärdet är float.	Nej
dimensioner	integer	Antalet dimensioner som resulterande inbäddningar av utdata ska ha. Stöds endast i text-embedding-3 och senare modeller.	Nej

Svar

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
objekt	sträng		Ja
modell	sträng		Ja
data	matris		Ja
användning	objekt		Ja

Egenskaper för användning

prompt_tokens

Namn	Type	Beskrivning	Standard
prompt_tokens	integer

total_tokens

Namn	Type	Beskrivning	Standard
total_tokens	integer

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	objekt

Exempel

Exempel

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

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

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

Chatten har slutförts – Skapa

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

Skapar ett slutförande för chattmeddelandet

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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	Ja	sträng	Distributions-ID för modellen som distribuerades.
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
temperatur	Nummer	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.	Nej	1
top_p	Nummer	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 den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.	Nej	1
ström	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.	Nej	Falsk
Stanna	sträng eller matris	Upp till fyra sekvenser där API:et slutar generera ytterligare token.	Nej
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.	Nej
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. Detta stöds endast i o1-seriemodeller. Utökar stödet till andra modeller i framtida API-version.	Nej
presence_penalty	Nummer	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.	Nej	0
frequency_penalty	Nummer	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.	Nej	0
logit_bias	objekt	Ä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 val. värden som -100 eller 100 bör resultera i ett förbud eller exklusivt val av relevant token.	Nej	Ingen
användare	sträng	En unik identifierare som representerar slutanvändaren, som kan hjälpa till att övervaka och upptäcka missbruk.	Nej
meddelanden	matris	En lista över meddelanden som består av konversationen hittills.	Ja
data_sources	matris	Konfigurationsposterna för Azure OpenAI-chatttillägg som använder dem. Den här ytterligare specifikationen är endast kompatibel med Azure OpenAI.	Nej
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.	Nej	Falsk
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.	Nej
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.	Nej	1
parallel_tool_calls	ParallelToolCalls	Om du vill aktivera parallell funktionsanrop under verktygsanvändning.	Nej	Sann
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.	Nej
frö	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.	Nej
stream_options	chatCompletionStreamOptions	Alternativ för strömningssvar. Ange endast detta när du anger stream: true.	Nej	Ingen
verktyg	matris	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.	Nej
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.	Nej
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.	Nej
functions	matris	Inaktuell till förmån för tools. En lista över funktioner som modellen kan generera JSON-indata för.	Nej

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	createChatCompletionResponse eller createChatCompletionStreamResponse

Statuskod: standard

Beskrivning: Tjänsten är inte tillgänglig

Innehållstyp	Typ	Beskrivning
application/json	errorResponse

Exempel

Exempel

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-01-preview

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

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

Exempel

Skapar ett slutförande baserat på Azure Search-data och systemtilldelad hanterad identitet.

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

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

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

Exempel

Skapar ett slutförande baserat på Azure Search-bildvektordata.

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

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

Svar: Statuskod: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Exempel

Skapar ett slutförande baserat på Azure Search-vektordata, tidigare assistentmeddelande och användartilldelad hanterad identitet.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

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

Exempel

Skapar ett slutförande för den angivna Azure Cosmos DB.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

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

Exempel

Skapar ett slutförande för den angivna Mongo DB:en.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

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

Exempel

Skapar ett slutförande för den angivna Elasticsearch.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

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

Exempel

Skapar ett slutförande för den angivna Pinecone-resursen.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

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-01-preview

Transkriberar ljud till indataspråket.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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	Ja	sträng	Distributions-ID för viskningsmodellen.
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: flera delar/formulärdata

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
fil	sträng	Ljudfilsobjektet som ska transkriberas.	Ja
snabb	sträng	En valfri text som vägleder modellens formatmall eller fortsätter med ett tidigare ljudsegment. Uppmaningen ska matcha ljudspråket.	Nej
response_format	audioResponseFormat	Definierar formatet för utdata.	Nej
temperatur	Nummer	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.	Nej	0
språk	string	Språket för indataljudet. Om du anger indataspråket i ISO-639-1-format förbättras noggrannheten och svarstiden.	Nej
timestamp_granularities[]	matris	Tidsstämpelkornigheterna som ska fyllas i för den här transkriptionen. response_format måste anges verbose_json för att använda tidsstämpelkornigheter. Något av eller båda alternativen stöds: word, eller segment. Obs! Det finns ingen ytterligare svarstid för segmenttidsstämplar, men att generera ordtidsstämplar medför ytterligare svarstid.	Nej	['segment']

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	audioResponse eller audioVerboseResponse
text/plain	sträng	Transkriberad text i utdataformatet (när response_format var en text, vtt eller srt).

Exempel

Exempel

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-01-preview

Svar: Statuskod: 200

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

Exempel

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-01-preview

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

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-01-preview

Transkriberar och översätter indataljud till engelsk text.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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	Ja	sträng	Distributions-ID för viskningsmodellen som distribuerades.
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: flera delar/formulärdata

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
fil	sträng	Ljudfilen som ska översättas.	Ja
snabb	sträng	En valfri text som vägleder modellens formatmall eller fortsätter med ett tidigare ljudsegment. Uppmaningen ska vara på engelska.	Nej
response_format	audioResponseFormat	Definierar formatet för utdata.	Nej
temperatur	Nummer	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.	Nej	0

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	audioResponse eller audioVerboseResponse
text/plain	sträng	Transkriberad text i utdataformatet (när response_format var en text, vtt eller srt).

Exempel

Exempel

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-01-preview

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

Svar: Statuskod: 200

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

Exempel

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-01-preview

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

Svar: Statuskod: 200

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

Tal – Skapa

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

Genererar ljud från indatatexten.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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	Ja	sträng	Distributions-ID för tts-modellen som distribuerades.
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: flera delar/formulärdata

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
indata	sträng	Texten som ska syntetisera ljud för. Den maximala längden är 4 096 tecken.	Ja
voice	uppräkning	Rösten som ska användas för talsyntes. Möjliga värden: legering, eko, fabel, onyx, nova, skimmer	Ja
response_format	uppräkning	Formatet som ljudet ska syntetiseras i. Möjliga värden: mp3, opus, aac, flac, wav, pcm	Nej
hastighet	Nummer	Hastigheten för det syntetiserade ljudet. Välj ett värde från 0.25 till 4.0. 1.0 används som standard.	Nej	1.0

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/octet-stream	sträng

Exempel

Exempel

Syntetiserar ljud från den angivna texten.

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

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

Svar: Statuskod: 200

{
  "body": "101010101"
}

Bildgenerationer – Skapa

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

Genererar en batch med bilder från en texttext i en viss DALLE-modelldistribution

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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	Ja	sträng	Distributions-ID för dalle-modellen som distribuerades.
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
snabb	sträng	En textbeskrivning av de önskade bilderna. Den maximala längden är 4 000 tecken.	Ja
n	integer	Antalet bilder som ska genereras.	Nej	1
storlek	imageSize	Storleken på de genererade bilderna.	Nej	1 024 × 1 024
response_format	imagesResponseFormat	Formatet där de genererade bilderna returneras.	Nej	URL
användare	sträng	En unik identifierare som representerar slutanvändaren, som kan hjälpa till att övervaka och upptäcka missbruk.	Nej
kvalitet	imageQuality	Kvaliteten på den bild som ska genereras.	Nej	standard
style	imageStyle	Formatmallen för de genererade bilderna.	Nej	levande

Svar

Statuskod: 200

Beskrivning: Ok

Innehållstyp	Typ	Beskrivning
application/json	generateImagesResponse

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	dalleErrorResponse

Exempel

Exempel

Skapar avbildningar med en uppmaning.

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

{
 "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
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Lista – Assistenter

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

Returnerar en lista över assistenter.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
gräns	query	Nej	integer
order	query	Nej	sträng
efter	query	Nej	sträng
före	query	Nej	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	listAssistantsResponse

Exempel

Exempel

Returnerar en lista över assistenter.

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

Svar: Statuskod: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Skapa – assistent

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

Skapa en assistent med en modell och instruktioner.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
modell			Ja
namn	sträng	Namnet på assistenten. Den maximala längden är 256 tecken.	Nej
description	sträng	Beskrivningen av assistenten. Den maximala längden är 512 tecken.	Nej
instruktioner	sträng	Systeminstruktionerna som assistenten använder. Den maximala längden är 256 000 tecken.	Nej
verktyg	matris	En lista över verktyg som är aktiverade på assistenten. Det kan finnas högst 128 verktyg per assistent. Verktyg kan vara av typen code_interpreter, retrievaleller function.	Nej	[]
tool_resources	objekt	En uppsättning resurser som används av assistentens verktyg. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej
temperatur	Nummer	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.	Nej	1
top_p	Nummer	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 den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperatur men inte båda.	Nej	1
response_format	assistantsApiResponseFormatOption	Anger det format som modellen måste mata ut. Kompatibel med GPT-4 Turbo och alla GPT-3.5 Turbo modeller sedan gpt-3.5-turbo-1106. 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.	Nej

Egenskaper för tool_resources

code_interpreter

Namn	Type	Beskrivning	Standard
file_ids	matris	En lista över fil-ID:t som gjorts tillgängliga för code_interpreter verktyget. Det kan finnas högst 20 filer som är associerade med verktyget.	[]

file_search

Namn	Type	Beskrivning	Standard
vector_store_ids	matris	Vektorarkivet som är kopplat till den här assistenten. Det kan finnas högst ett vektorlager kopplat till assistenten.
vector_stores	matris	En hjälp för att skapa ett vektorlager med file_ids och koppla det till den här assistenten. Det kan finnas högst ett vektorlager kopplat till assistenten.

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	assistantObject	Representerar en assistant som kan anropa modellen och använda verktyg.

Exempel

Exempel

Skapa en assistent med en modell och instruktioner.

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

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

Svar: Statuskod: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Hämta - Assistent

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

Hämtar en assistent.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
assistant_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	assistantObject	Representerar en assistant som kan anropa modellen och använda verktyg.

Exempel

Exempel

Hämtar en assistent.

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

Svar: Statuskod: 200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Ändra – Assistent

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

Ändrar en assistent.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
assistant_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
modell			Nej
name	sträng	Namnet på assistenten. Den maximala längden är 256 tecken.	Nej
description	sträng	Beskrivningen av assistenten. Den maximala längden är 512 tecken.	Nej
instruktioner	sträng	Systeminstruktionerna som assistenten använder. Den maximala längden är 32 768 tecken.	Nej
verktyg	matris	En lista över verktyg som är aktiverade på assistenten. Det kan finnas högst 128 verktyg per assistent. Verktyg kan vara av typen code_interpreter, retrievaleller function.	Nej	[]
tool_resources	objekt	En uppsättning resurser som används av assistentens verktyg. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej
temperatur	Nummer	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.	Nej	1
top_p	Nummer	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 den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperatur men inte båda.	Nej	1
response_format	assistantsApiResponseFormatOption	Anger det format som modellen måste mata ut. Kompatibel med GPT-4 Turbo och alla GPT-3.5 Turbo modeller sedan gpt-3.5-turbo-1106. 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.	Nej

Egenskaper för tool_resources

code_interpreter

Namn	Type	Beskrivning	Standard
file_ids	matris	Åsidosätter listan över fil-ID:t som är tillgängliga för code_interpreter verktyget. Det kan finnas högst 20 filer som är associerade med verktyget.	[]

file_search

Namn	Type	Beskrivning	Standard
vector_store_ids	matris	Åsidosätter det vektorarkiv som är kopplat till den här assistenten. Det kan finnas högst ett vektorlager kopplat till assistenten.

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	assistantObject	Representerar en assistant som kan anropa modellen och använda verktyg.

Exempel

Exempel

Ändrar en assistent.

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

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

Svar: Statuskod: 200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Ta bort – assistent

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

Ta bort en assistent.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
assistant_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	deleteAssistantResponse

Exempel

Exempel

Tar bort en assistent.

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

Svar: Statuskod: 200

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

Skapa – tråd

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

Skapa en tråd.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
meddelanden	matris	En lista över meddelanden att starta tråden med.	Nej
tool_resources	objekt	En uppsättning resurser som görs tillgängliga för assistentens verktyg i den här tråden. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej

Egenskaper för tool_resources

code_interpreter

Namn	Type	Beskrivning	Standard
file_ids	matris	En lista över fil-ID:t som gjorts tillgängliga för code_interpreter verktyget. Det kan finnas högst 20 filer som är associerade med verktyget.	[]

file_search

Namn	Type	Beskrivning	Standard
vector_store_ids	matris	Vektorarkivet som är kopplat till den här tråden. Det kan finnas högst 1 vektorlager kopplat till tråden.
vector_stores	matris	En hjälp för att skapa ett vektorlager med file_ids och koppla det till den här tråden. Det kan finnas högst ett vektorlager kopplat till tråden.

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	threadObject	Representerar en tråd som innehåller meddelanden.

Exempel

Exempel

Skapar en tråd.

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

Svar: Statuskod: 200

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

Hämta – tråd

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

Hämtar en tråd.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	threadObject	Representerar en tråd som innehåller meddelanden.

Exempel

Exempel

Hämtar en tråd.

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

Svar: Statuskod: 200

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

Ändra – tråd

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

Ändrar en tråd.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
tool_resources	objekt	En uppsättning resurser som görs tillgängliga för assistentens verktyg i den här tråden. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej

Egenskaper för tool_resources

code_interpreter

Namn	Type	Beskrivning	Standard
file_ids	matris	En lista över fil-ID:t som gjorts tillgängliga för code_interpreter verktyget. Det kan finnas högst 20 filer som är associerade med verktyget.	[]

file_search

Namn	Type	Beskrivning	Standard
vector_store_ids	matris	Vektorarkivet som är kopplat till den här tråden. Det kan finnas högst ett vektorlager kopplat till tråden.

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	threadObject	Representerar en tråd som innehåller meddelanden.

Exempel

Exempel

Ändrar en tråd.

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

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

Svar: Statuskod: 200

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

Ta bort – tråd

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

Ta bort en tråd.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	deleteThreadResponse

Exempel

Exempel

Tar bort en tråd.

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

Svar: Statuskod: 200

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

Lista – Meddelanden

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

Returnerar en lista med meddelanden för en viss tråd.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
gräns	query	Nej	integer
order	query	Nej	sträng
efter	query	Nej	sträng
före	query	Nej	sträng
run_id	query	Nej	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	listMessagesResponse

Exempel

Exempel

Lista meddelanden

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

Svar: Statuskod: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Skapa – meddelande

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

Skapa ett meddelande.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
roll	sträng	Rollen för den entitet som skapar meddelandet. Tillåtna värden är: - user: Anger att meddelandet skickas av en faktisk användare och bör i de flesta fall användas för att representera användargenererade meddelanden. - assistant: Anger att meddelandet genereras av assistenten. Använd det här värdet för att infoga meddelanden från assistenten i konversationen.	Ja
innehåll	sträng	Innehållet i meddelandet.	Ja
Bilagor	matris	En lista över filer som är kopplade till meddelandet och de verktyg som de ska läggas till i.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	messageObject	Representerar ett meddelande i en tråd.

Exempel

Exempel

Skapa ett meddelande.

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

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

Svar: Statuskod: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

Hämta – meddelande

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

Hämta ett meddelande.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
message_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	messageObject	Representerar ett meddelande i en tråd.

Exempel

Exempel

Hämta ett meddelande.

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

Svar: Statuskod: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Ändra – meddelande

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

Ändrar ett meddelande.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
message_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	messageObject	Representerar ett meddelande i en tråd.

Exempel

Exempel

Ändra ett meddelande.

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

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

Svar: Statuskod: 200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

Skapa – tråda och köra

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

Skapa en tråd och kör den i en begäran.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
assistant_id	sträng	ID:t för assistenten som ska användas för att köra den här körningen.	Ja
tråd	createThreadRequest		Nej
modell	sträng	Distributionsnamnet för den modell som ska användas för att köra den här körningen. Om ett värde anges här åsidosätter det modellen som är associerad med assistenten. Om inte används modellen som är associerad med assistenten.	Nej
instruktioner	sträng	Åsidosätt standardsystemmeddelandet för assistenten. Detta är användbart för att ändra beteendet per körning.	Nej
verktyg	matris	Åsidosätt de verktyg som assistenten kan använda för den här körningen. Detta är användbart för att ändra beteendet per körning.	Nej
tool_resources	objekt	En uppsättning resurser som används av assistentens verktyg. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej
temperatur	Nummer	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.	Nej	1
top_p	Nummer	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 den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperatur men inte båda.	Nej	1
ström	boolean	Om truereturnerar returnerar en ström av händelser som inträffar under händelser som skickas av servern och avslutas när Körningen går in i ett terminaltillstånd med ett data: [DONE] meddelande.	Nej
stream_options	chatCompletionStreamOptions	Alternativ för strömningssvar. Ange endast detta när du anger stream: true.	Nej	Ingen
max_prompt_tokens	integer	Det maximala antalet prompttoken som kan användas under körningen. Körningen gör ett bästa försök att endast använda antalet angivna prompttoken över flera varv av körningen. Om körningen överskrider antalet angivna prompttoken avslutas körningen med statusen incomplete. Mer incomplete_details information finns i.	Nej
max_completion_tokens	integer	Det maximala antalet slutförandetoken som kan användas under körningen. Körningen gör ett bra försök att endast använda antalet angivna slutförandetoken över flera varv av körningen. Om körningen överskrider det angivna antalet slutförandetoken avslutas körningen med statusen incomplete. Mer incomplete_details information finns i.	Nej
truncation_strategy	truncationObject	Kontroller för hur en tråd trunkeras före körningen. Använd det här alternativet om du vill styra körningens inledande kontextfönster.	Nej
tool_choice	assistantsApiToolChoiceOption	Styr vilket (om något) verktyg som anropas av modellen. none innebär att modellen inte anropar några verktyg och i stället genererar ett meddelande. auto är standardvärdet och innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett verktyg. Om du anger ett visst verktyg som {"type": "file_search"} eller {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa verktyget.	Nej
parallel_tool_calls	ParallelToolCalls	Om du vill aktivera parallell funktionsanrop under verktygsanvändning.	Nej	Sann
response_format	assistantsApiResponseFormatOption	Anger det format som modellen måste mata ut. Kompatibel med GPT-4 Turbo och alla GPT-3.5 Turbo modeller sedan gpt-3.5-turbo-1106. 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.	Nej

Egenskaper för tool_resources

code_interpreter

Namn	Type	Beskrivning	Standard
file_ids	matris	En lista över fil-ID:t som gjorts tillgängliga för code_interpreter verktyget. Det kan finnas högst 20 filer som är associerade med verktyget.	[]

file_search

Namn	Type	Beskrivning	Standard
vector_store_ids	matris	ID:t för vektorarkivet som är kopplat till den här assistenten. Det kan finnas högst ett vektorlager kopplat till assistenten.

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	runObject	Representerar en körningskörning på en tråd.

Exempel

Exempel

Skapa en tråd och kör den i en begäran.

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

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

Svar: Statuskod: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Lista – Körningar

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

Returnerar en lista över körningar som tillhör en tråd.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
gräns	query	Nej	integer
order	query	Nej	sträng
efter	query	Nej	sträng
före	query	Nej	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	listRunsResponse

Exempel

Exempel

Returnerar en lista över körningar som tillhör en tråd.

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

Svar: Statuskod: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

Skapa – Kör

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

Skapa en körning.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
assistant_id	sträng	ID:t för assistenten som ska användas för att köra den här körningen.	Ja
modell	sträng	ID:t för modellen som ska användas för att köra den här körningen. Om ett värde anges här åsidosätter det modellen som är associerad med assistenten. Om inte används modellen som är associerad med assistenten.	Nej
instruktioner	sträng	Åsidosätt standardsystemmeddelandet för assistenten. Detta är användbart för att ändra beteendet per körning.	Nej
additional_instructions	sträng	Lägger till ytterligare instruktioner i slutet av instruktionerna för körningen. Detta är användbart för att ändra beteendet per körning utan att åsidosätta andra instruktioner.	Nej
additional_messages	matris	Lägger till ytterligare meddelanden i tråden innan körningen skapas.	Nej
verktyg	matris	Åsidosätt de verktyg som assistenten kan använda för den här körningen. Detta är användbart för att ändra beteendet per körning.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej
temperatur	Nummer	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.	Nej	1
top_p	Nummer	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 den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperatur men inte båda.	Nej	1
ström	boolean	Om truereturnerar returnerar en ström av händelser som inträffar under händelser som skickas av servern och avslutas när Körningen går in i ett terminaltillstånd med ett data: [DONE] meddelande.	Nej
max_prompt_tokens	integer	Det maximala antalet prompttoken som kan användas under körningen. Körningen gör ett bästa försök att endast använda antalet angivna prompttoken över flera varv av körningen. Om körningen överskrider antalet angivna prompttoken avslutas körningen med statusen incomplete. Mer incomplete_details information finns i.	Nej
max_completion_tokens	integer	Det maximala antalet slutförandetoken som kan användas under körningen. Körningen gör ett bra försök att endast använda antalet angivna slutförandetoken över flera varv av körningen. Om körningen överskrider det angivna antalet slutförandetoken avslutas körningen med statusen incomplete. Mer incomplete_details information finns i.	Nej
truncation_strategy	truncationObject	Kontroller för hur en tråd trunkeras före körningen. Använd det här alternativet om du vill styra körningens inledande kontextfönster.	Nej
tool_choice	assistantsApiToolChoiceOption	Styr vilket (om något) verktyg som anropas av modellen. none innebär att modellen inte anropar några verktyg och i stället genererar ett meddelande. auto är standardvärdet och innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett verktyg. Om du anger ett visst verktyg som {"type": "file_search"} eller {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa verktyget.	Nej
parallel_tool_calls	ParallelToolCalls	Om du vill aktivera parallell funktionsanrop under verktygsanvändning.	Nej	Sann
response_format	assistantsApiResponseFormatOption	Anger det format som modellen måste mata ut. Kompatibel med GPT-4 Turbo och alla GPT-3.5 Turbo modeller sedan gpt-3.5-turbo-1106. 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.	Nej

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	runObject	Representerar en körningskörning på en tråd.

Exempel

Exempel

Skapa en körning.

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

{
 "assistant_id": "asst_abc123"
}

Svar: Statuskod: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Hämta – Kör

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

Hämtar en körning.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
run_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	runObject	Representerar en körningskörning på en tråd.

Exempel

Exempel

Får en körning.

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

Svar: Statuskod: 200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

Ändra – Kör

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

Ändrar en körning.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
run_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	runObject	Representerar en körningskörning på en tråd.

Exempel

Exempel

Ändrar en körning.

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

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

Svar: Statuskod: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Skicka – verktygsutdata som ska köras

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

När en körning har status: "requires_action" och required_action.type är submit_tool_outputskan den här slutpunkten användas för att skicka utdata från verktygsanropen när alla har slutförts. Alla utdata måste skickas i en enda begäran.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
run_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
tool_outputs	matris	En lista över verktyg som utdata skickas för.	Ja
ström	boolean	Om truereturnerar returnerar en ström av händelser som inträffar under händelser som skickas av servern och avslutas när Körningen går in i ett terminaltillstånd med ett data: [DONE] meddelande.	Nej

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	runObject	Representerar en körningskörning på en tråd.

Exempel

Exempel

När en körning har status: "requires_action" och required_action.type är submit_tool_outputskan den här slutpunkten användas för att skicka utdata från verktygsanropen när alla har slutförts. Alla utdata måste skickas i en enda begäran.

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

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

Svar: Statuskod: 200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Avbryt – Kör

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

Avbryter en körning som är in_progress.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
run_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	runObject	Representerar en körningskörning på en tråd.

Exempel

Exempel

Avbryter en körning som är in_progress.

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

Svar: Statuskod: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

Lista – Körningssteg

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

Returnerar en lista över körningssteg som hör till en körning.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
run_id	path	Ja	sträng
gräns	query	Nej	integer
order	query	Nej	sträng
efter	query	Nej	sträng
före	query	Nej	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	listRunStepsResponse

Exempel

Exempel

Returnerar en lista över körningssteg som hör till en körning.

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

Svar: Statuskod: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

Get – Kör steg

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

Hämtar ett körningssteg.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
thread_id	path	Ja	sträng
run_id	path	Ja	sträng
step_id	path	Ja	sträng
api-version	query	Ja	sträng	API-version

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	runStepObject	Representerar ett steg i körningen av en körning.

Exempel

Exempel

Hämtar ett körningssteg.

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

Svar: Statuskod: 200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

Lista – Vektorlager

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

Returnerar en lista över vektorlager.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
gräns	query	Nej	integer
order	query	Nej	sträng
efter	query	Nej	sträng
före	query	Nej	sträng
api-version	query	Ja	sträng

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	listVectorStoresResponse

Exempel

Exempel

Returnerar en lista över vektorlager.

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

Svar: Statuskod: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

Skapa – vektorarkiv

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

Skapa ett vektorlager.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
api-version	query	Ja	sträng

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
file_ids	matris	En lista över fil-ID:t som vektorarkivet ska använda. Användbart för verktyg som file_search dessa kan komma åt filer.	Nej
name	sträng	Namnet på vektorarkivet.	Nej
expires_after	vectorStoreExpirationAfter	Förfalloprincipen för ett vektorlager.	Nej
chunking_strategy	autoChunkingStrategyRequestParam eller staticChunkingStrategyRequestParam	Segmenteringsstrategin som används för att segmentera filen eller filerna. Om den inte har angetts använder du auto strategin. Gäller endast om file_ids är icke-lydigt.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	vectorStoreObject	Ett vektorlager är en samling bearbetade filer som kan användas av file_search verktyget.

Exempel

Exempel

Skapar ett vektorlager.

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

Svar: Statuskod: 200

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

Hämta – Vektorarkiv

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

Hämtar ett vektorlager.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
vector_store_id	path	Ja	sträng
api-version	query	Ja	sträng

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	vectorStoreObject	Ett vektorlager är en samling bearbetade filer som kan användas av file_search verktyget.

Exempel

Exempel

Hämtar ett vektorlager.

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

Svar: Statuskod: 200

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

Ändra – Vektorarkiv

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

Ändrar ett vektorlager.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
vector_store_id	path	Ja	sträng
api-version	query	Ja	sträng

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
name	sträng	Namnet på vektorarkivet.	Nej
expires_after	vectorStoreExpirationAfter	Förfalloprincipen för ett vektorlager.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	vectorStoreObject	Ett vektorlager är en samling bearbetade filer som kan användas av file_search verktyget.

Exempel

Exempel

Ändrar ett vektorlager.

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

{
 "name": "Support FAQ"
}

Svar: Statuskod: 200

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

Ta bort – vektorarkiv

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

Ta bort ett vektorlager.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
vector_store_id	path	Ja	sträng
api-version	query	Ja	sträng

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	deleteVectorStoreResponse

Exempel

Exempel

Tar bort ett vektorlager.

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

Svar: Statuskod: 200

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

Lista – Vektorlagringsfiler

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

Returnerar en lista över vektorlagringsfiler.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
vector_store_id	path	Ja	sträng
gräns	query	Nej	integer
order	query	Nej	sträng
efter	query	Nej	sträng
före	query	Nej	sträng
filter	query	Nej	sträng
api-version	query	Ja	sträng

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	listVectorStoreFilesResponse

Exempel

Exempel

Returnerar en lista över vektorlagringsfiler.

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

Svar: Statuskod: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Skapa – Vektorlagringsfil

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

Skapa en vektorlagringsfil genom att koppla en fil till ett vektorlager.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
vector_store_id	path	Ja	sträng
api-version	query	Ja	sträng

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
file_id	sträng	Ett fil-ID som vektorarkivet ska använda. Användbart för verktyg som file_search dessa kan komma åt filer.	Ja
chunking_strategy	chunkingStrategyRequestParam	Segmenteringsstrategin som används för att segmentera filen eller filerna. Om den inte har angetts använder du auto strategin.	Nej

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	vectorStoreFileObject	En lista över filer som är kopplade till ett vektorarkiv.

Exempel

Exempel

Skapa en vektorlagringsfil genom att koppla en fil till ett vektorlager.

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

{
 "file_id": "file-abc123"
}

Svar: Statuskod: 200

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

Hämta – Vektorlagringsfil

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

Hämtar en vektorlagringsfil.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
vector_store_id	path	Ja	sträng
file_id	path	Ja	sträng
api-version	query	Ja	sträng

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	vectorStoreFileObject	En lista över filer som är kopplade till ett vektorarkiv.

Exempel

Exempel

Hämtar en vektorlagringsfil.

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

Svar: Statuskod: 200

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

Ta bort – Vektorlagringsfil

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

Ta bort en vektorlagringsfil. Då tas filen bort från vektorarkivet, men själva filen tas inte bort. Om du vill ta bort filen använder du borttagningsfilens slutpunkt.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
vector_store_id	path	Ja	sträng
file_id	path	Ja	sträng
api-version	query	Ja	sträng

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	deleteVectorStoreFileResponse

Exempel

Exempel

Ta bort en vektorlagringsfil. Då tas filen bort från vektorarkivet, men själva filen tas inte bort. Om du vill ta bort filen använder du borttagningsfilens slutpunkt.

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

Svar: Statuskod: 200

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

Skapa – Vektorlagringsfil batch

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

Skapa en vektorlagringsfilbatch.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
vector_store_id	path	Ja	sträng
api-version	query	Ja	sträng

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Begärandetext

Innehållstyp: program/json

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
file_ids	matris	En lista över fil-ID:t som vektorarkivet ska använda. Användbart för verktyg som file_search dessa kan komma åt filer.	Ja
chunking_strategy	chunkingStrategyRequestParam	Segmenteringsstrategin som används för att segmentera filen eller filerna. Om den inte har angetts använder du auto strategin.	Nej

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	vectorStoreFileBatchObject	En batch med filer som är kopplade till ett vektorlager.

Exempel

Exempel

Skapa en vektorlagringsfilbatch.

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

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

Svar: Statuskod: 200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Get – Vektorlagringsfil batch

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

Hämtar en vektorlagringsfilbatch.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
vector_store_id	path	Ja	sträng
batch_id	path	Ja	sträng
api-version	query	Ja	sträng

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	vectorStoreFileBatchObject	En batch med filer som är kopplade till ett vektorlager.

Exempel

Exempel

Hämtar en vektorlagringsfilbatch.

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

Svar: Statuskod: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

Avbryt – Vektorlagringsfil batch

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

Avbryt en vektorlagringsfilbatch. Detta försöker avbryta bearbetningen av filer i den här batchen så snart som möjligt.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
vector_store_id	path	Ja	sträng
batch_id	path	Ja	sträng
api-version	query	Ja	sträng

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	vectorStoreFileBatchObject	En batch med filer som är kopplade till ett vektorlager.

Exempel

Exempel

Avbryt en vektorlagringsfilbatch. Detta försöker avbryta bearbetningen av filer i den här batchen så snart som möjligt.

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

Svar: Statuskod: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

Lista – Batch-filer för vektorarkiv

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

Returnerar en lista över vektorlagringsfiler i en batch.

URI-parametrar

Name	I	Obligatoriskt	Type	Beskrivning
slutpunkt	path	Ja	sträng URL	Azure OpenAI-slutpunkter som stöds (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
vector_store_id	path	Ja	sträng
batch_id	path	Ja	sträng
gräns	query	Nej	integer
order	query	Nej	sträng
efter	query	Nej	sträng
före	query	Nej	sträng
filter	query	Nej	sträng
api-version	query	Ja	sträng

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
api-key	Sant	sträng	Ange Azure OpenAI API-nyckel här

Svar

Statuskod: 200

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	listVectorStoreFilesResponse

Exempel

Exempel

Returnerar en lista över vektorlagringsfiler.

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

Svar: Statuskod: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Komponenter

errorResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
fel	fel		Nej

errorBase

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
kod	string		Nej
meddelande	sträng		Nej

fel

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
Param	sträng		Nej
type	sträng		Nej
inner_error	innerError	Inre fel med ytterligare information.	Nej

innerError

Inre fel med ytterligare information.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
kod	innerErrorCode	Felkoder för det inre felobjektet.	Nej
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.	Nej

innerErrorCode

Felkoder för det inre felobjektet.

Beskrivning: Felkoder för det inre felobjektet.

Typ: sträng

Standard:

Uppräkningsnamn: InnerErrorCode

Uppräkningsvärden:

Värde	beskrivning
ResponsibleAIPolicyViolation	Uppmaningen bröt mot en av fler regler för innehållsfilter.

dalleErrorResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
fel	dalleError		Nej

dalleError

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
Param	sträng		Nej
type	sträng		Nej
inner_error	dalleInnerError	Inre fel med ytterligare information.	Nej

dalleInnerError

Inre fel med ytterligare information.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
kod	innerErrorCode	Felkoder för det inre felobjektet.	Nej
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.	Nej
revised_prompt	sträng	Uppmaningen som användes för att generera avbildningen, om det fanns någon revision av prompten.	Nej

contentFilterCompletionTextSpan

Beskriver ett intervall inom genererad slutförandetext. Förskjutning 0 är den första UTF32-kodpunkten i slutförandetexten.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
completion_start_offset	integer	Förskjutning av UTF32-kodpunkten som börjar intervallet.	Ja
completion_end_offset	integer	Förskjutning av den första UTF32-kodpunkten som undantas från intervallet. Det här fältet är alltid lika med completion_start_offset för tomma intervall. Det här fältet är alltid större än completion_start_offset för flera intervall.	Ja

contentFilterResultBase

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
filtrerad	boolean		Ja

contentFilterSeverityResult

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
filtrerad	boolean		Ja
allvarlighetsgrad	sträng		Nej

contentFilterDetectedResult

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
filtrerad	boolean		Ja
Upptäckt	boolean		Nej

contentFilterDetectedWithCitationResult

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
citat	objekt		Nej

Egenskaper för källhänvisning

webbadress

Namn	Type	Beskrivning	Standard
webbadress	sträng

licens

Namn	Type	Beskrivning	Standard
licens	sträng

contentFilterDetectedWithCompletionTextSpansResult

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
information	matris		Nej

contentFilterIdResult

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
filtrerad	boolean		Ja
id	sträng		Nej

contentFilterResultsBase

Information om resultatet av innehållsfiltreringen.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
sexuell	contentFilterSeverityResult		Nej
våld	contentFilterSeverityResult		Nej
hata	contentFilterSeverityResult		Nej
self_harm	contentFilterSeverityResult		Nej
Svordomar	contentFilterDetectedResult		Nej
custom_blocklists	contentFilterDetailedResults	Innehållsfiltreringsresultat med en detaljerad information om innehållsfilter-ID:t för de filtrerade segmenten.	Nej
fel	errorBase		Nej

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.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
sexuell	contentFilterSeverityResult		Nej
våld	contentFilterSeverityResult		Nej
hata	contentFilterSeverityResult		Nej
self_harm	contentFilterSeverityResult		Nej
Svordomar	contentFilterDetectedResult		Nej
custom_blocklists	contentFilterDetailedResults	Innehållsfiltreringsresultat med en detaljerad information om innehållsfilter-ID:t för de filtrerade segmenten.	Nej
fel	errorBase		Nej
Jailbreak	contentFilterDetectedResult		Nej
indirect_attack	contentFilterDetectedResult		Nej

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.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
sexuell	contentFilterSeverityResult		Nej
våld	contentFilterSeverityResult		Nej
hata	contentFilterSeverityResult		Nej
self_harm	contentFilterSeverityResult		Nej
Svordomar	contentFilterDetectedResult		Nej
custom_blocklists	contentFilterDetailedResults	Innehållsfiltreringsresultat med en detaljerad information om innehållsfilter-ID:t för de filtrerade segmenten.	Nej
fel	errorBase		Nej
protected_material_text	contentFilterDetectedResult		Nej
protected_material_code	contentFilterDetectedWithCitationResult		Nej
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		Nej

contentFilterDetailedResults

Innehållsfiltreringsresultat med en detaljerad information om innehållsfilter-ID:t för de filtrerade segmenten.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
filtrerad	boolean		Ja
information	matris		Nej

promptFilterResult

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
prompt_index	integer		Nej
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.	Nej

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.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
sexuell	contentFilterSeverityResult		Nej
våld	contentFilterSeverityResult		Nej
hata	contentFilterSeverityResult		Nej
self_harm	contentFilterSeverityResult		Nej

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.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
sexuell	contentFilterSeverityResult		Nej
våld	contentFilterSeverityResult		Nej
hata	contentFilterSeverityResult		Nej
self_harm	contentFilterSeverityResult		Nej
Svordomar	contentFilterDetectedResult		Nej
Jailbreak	contentFilterDetectedResult		Nej
custom_blocklists	contentFilterDetailedResults	Innehållsfiltreringsresultat med en detaljerad information om innehållsfilter-ID:t för de filtrerade segmenten.	Nej

chatCompletionsRequestCommon

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
temperatur	Nummer	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.	Nej	1
top_p	Nummer	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 den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.	Nej	1
ström	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.	Nej	Falsk
Stanna	sträng eller matris	Upp till 4 sekvenser där API:et slutar generera ytterligare token.	Nej
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). Detta är inte kompatibelt med o1-seriemodeller.	Nej	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. Detta stöds endast i o1-seriemodeller. Utökar stödet till andra modeller i framtida API-version.	Nej
presence_penalty	Nummer	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.	Nej	0
frequency_penalty	Nummer	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.	Nej	0
logit_bias	objekt	Ä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 val. värden som -100 eller 100 bör resultera i ett förbud eller exklusivt val av relevant token.	Nej
användare	sträng	En unik identifierare som representerar slutanvändaren, vilket kan hjälpa Azure OpenAI att övervaka och upptäcka missbruk.	Nej

createCompletionRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
snabb	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.	Ja
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 nkontrollerar best_of du antalet kandidatavslut och n anger hur många som ska returneras â€" best_of måste vara större än n. Obs! 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.	Nej	1
eko	boolean	Upprepa uppmaningen utöver slutförandet	Nej	Falsk
frequency_penalty	Nummer	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.	Nej	0
logit_bias	objekt	Ändra sannolikheten för att angivna token visas i slutförandet. Accepterar ett JSON-objekt som mappar token (anges av deras token-ID i GPT-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 val. 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.	Nej	Ingen
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 5 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.	Nej	Ingen
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.	Nej	16
n	integer	Hur många slutföranden som ska genereras för varje fråga. Obs! 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.	Nej	1
presence_penalty	Nummer	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.	Nej	0
frö	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.	Nej
Stanna	sträng eller matris	Upp till 4 sekvenser där API:et slutar generera ytterligare token. Den returnerade texten innehåller inte stoppsekvensen.	Nej
ström	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.	Nej	Falsk
suffix	sträng	Suffixet som kommer efter att infogad text har slutförts. Den här parametern stöds endast för gpt-3.5-turbo-instruct.	Nej	Ingen
temperatur	Nummer	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.	Nej	1
top_p	Nummer	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 den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.	Nej	1
användare	sträng	En unik identifierare som representerar slutanvändaren, som kan hjälpa till att övervaka och upptäcka missbruk.	Nej

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	En unik identifierare för slutförandet.	Ja
Val	matris	Listan över slutförandeval som modellen genererade för indataprompten.	Ja
skapad	integer	Unix-tidsstämpeln (i sekunder) för när slutförandet skapades.	Ja
modell	sträng	Den modell som används för slutförande.	Ja
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.	Nej
system_fingerprint	sträng	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.	Nej
objekt	uppräkning	Objekttypen, som alltid är "text_completion" Möjliga värden: text_completion	Ja
användning	completionUsage	Användningsstatistik för slutförandebegäran.	Nej

createChatCompletionRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
temperatur	Nummer	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.	Nej	1
top_p	Nummer	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 den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.	Nej	1
ström	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.	Nej	Falsk
Stanna	sträng eller matris	Upp till 4 sekvenser där API:et slutar generera ytterligare token.	Nej
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.	Nej
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. Detta stöds endast i o1-seriemodeller. Utökar stödet till andra modeller i framtida API-version.	Nej
presence_penalty	Nummer	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.	Nej	0
frequency_penalty	Nummer	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.	Nej	0
logit_bias	objekt	Ä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 val. värden som -100 eller 100 bör resultera i ett förbud eller exklusivt val av relevant token.	Nej	Ingen
användare	sträng	En unik identifierare som representerar slutanvändaren, som kan hjälpa till att övervaka och upptäcka missbruk.	Nej
meddelanden	matris	En lista över meddelanden som består av konversationen hittills.	Ja
data_sources	matris	Konfigurationsposterna för Azure OpenAI-chatttillägg som använder dem. Den här ytterligare specifikationen är endast kompatibel med Azure OpenAI.	Nej
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.	Nej	Falsk
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.	Nej
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.	Nej	1
parallel_tool_calls	ParallelToolCalls	Om du vill aktivera parallell funktionsanrop under verktygsanvändning.	Nej	Sann
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.	Nej
frö	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.	Nej
stream_options	chatCompletionStreamOptions	Alternativ för strömningssvar. Ange endast detta när du anger stream: true.	Nej	Ingen
verktyg	matris	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.	Nej
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.	Nej
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.	Nej
functions	matris	Inaktuell till förmån för tools. En lista över funktioner som modellen kan generera JSON-indata för.	Nej

chatCompletionFunctions

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
description	sträng	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	Nej
name	sträng	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.	Ja
parametrar	FunctionParameters	Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt. Se guiden](/azure/ai-services/openai/how-to/function-calling) för exempel och JSON-schemareferensen för dokumentation om formatet. Om du utelämnar parameters definieras en funktion med en tom parameterlista.	Nej

chatCompletionFunctionCallOption

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
name	sträng	Namnet på funktionen som ska anropas.	Ja

chatCompletionFunctionParameters

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

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

chatCompletionRequestMessage

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

chatCompletionRequestSystemMessage

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
innehåll	sträng eller matris	Innehållet i systemmeddelandet.	Ja
roll	uppräkning	Rollen som meddelandenas författare, i det här fallet system. Möjliga värden: system	Ja
namn	sträng	Ett valfritt namn för deltagaren. Tillhandahåller modellinformation för att skilja mellan deltagare med samma roll.	Nej

chatCompletionRequestUserMessage

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
innehåll	sträng eller matris	Innehållet i användarmeddelandet.	Ja
roll	uppräkning	Rollen som meddelandenas författare, i det här fallet user. Möjliga värden: användare	Ja
namn	sträng	Ett valfritt namn för deltagaren. Tillhandahåller modellinformation för att skilja mellan deltagare med samma roll.	Nej

chatCompletionRequestAssistantMessage

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
innehåll	sträng eller matris	Innehållet i assistentmeddelandet. Krävs om inte tool_calls eller function_call anges.	Nej
vägran	sträng	Assistentens avslagsmeddelande.	Nej
roll	uppräkning	Rollen som meddelandenas författare, i det här fallet assistant. Möjliga värden: assistent	Ja
namn	sträng	Ett valfritt namn för deltagaren. Tillhandahåller modellinformation för att skilja mellan deltagare med samma roll.	Nej
tool_calls	chatCompletionMessageToolCalls	Verktyget anropar som genereras av modellen, till exempel funktionsanrop.	Nej
function_call	objekt	Inaktuell och ersatt av tool_calls. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen.	Nej

Egenskaper för function_call

Argument

Namn	Type	Beskrivning	Standard
Argument	sträng	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

Namn	Type	Beskrivning	Standard
name	sträng	Namnet på funktionen som ska anropas.

chatCompletionRequestToolMessage

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
roll	uppräkning	Rollen som meddelandenas författare, i det här fallet tool. Möjliga värden: verktyg	Ja
innehåll	sträng eller matris	Innehållet i verktygsmeddelandet.	Ja
tool_call_id	sträng	Verktygsanrop som det här meddelandet svarar på.	Ja

chatCompletionRequestFunctionMessage

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
roll	uppräkning	Rollen som meddelandenas författare, i det här fallet function. Möjliga värden: funktion	Ja
innehåll	sträng	Innehållet i funktionsmeddelandet.	Ja
namn	sträng	Namnet på funktionen som ska anropas.	Ja

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	uppräkning	Typ av innehållsdel. Möjliga värden: text	Ja
text	sträng	Textinnehållet.	Ja

chatCompletionRequestMessageContentPartImage

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	uppräkning	Typ av innehållsdel. Möjliga värden: image_url	Ja
image_url	objekt		Ja

Egenskaper för image_url

URL

Namn	Type	Beskrivning	Standard
URL	sträng	Antingen en URL för bilden eller base64-kodade bilddata.

detalj

Namn	Type	Beskrivning	Standard
detalj	sträng	Anger detaljnivån för bilden. Läs mer i visionsguiden.	auto

chatCompletionRequestMessageContentPartRefusal

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	uppräkning	Typ av innehållsdel. Möjliga värden: avslag	Ja
vägran	sträng	Avslagsmeddelandet som genereras av modellen.	Ja

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.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
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.	Ja

azureChatExtensionType

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.

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

Typ: sträng

Standard:

Uppräkningsnamn: AzureChatExtensionType

Uppräkningsvärden:

Värde	beskrivning
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.
elasticsearch	Representerar användningen av Elasticsearch-index® som ett Azure OpenAI-chatttillägg.
mongo_db	Representerar användningen av Mongo DB som ett Azure OpenAI-chatttillägg.
tallkotte	Representerar användningen av Pinecone-index 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.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
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.	Ja
parametrar	azureSearchChatExtensionParameters	Parametrar för Azure Search när de används som ett Azure OpenAI-chatttillägg.	Nej

azureSearchChatExtensionParameters

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
autentisering	onYourDataApiKeyAuthenticationOptions eller onYourDataSystemAssignedManagedIdentityAuthenticationOptions eller onYourDataUserAssignedManagedIdentityAuthenticationOptions eller onYourDataAccessTokenAuthenticationOptions		Ja
top_n_documents	integer	Det konfigurerade högsta antalet dokument som ska användas för den konfigurerade frågan.	Nej
max_search_queries	integer	Maximalt antal omskrivna frågor som ska skickas till sökprovidern för ett användarmeddelande. Om det inte anges bestämmer systemet hur många frågor som ska skickas.	Nej
allow_partial_result	boolean	Om det anges som sant tillåter systemet att partiella sökresultat används och begäran misslyckas om alla frågor misslyckas. Om det inte anges eller anges som falskt misslyckas begäran om någon sökfråga misslyckas.	Nej	Falsk
in_scope	boolean	Om frågor ska begränsas till användning av indexerade data.	Nej
strikthet	integer	Den konfigurerade strängheten för sökrelevansfiltreringen. Ju högre strikthet, desto högre precision men lägre återkallande av svaret.	Nej
slutpunkt	sträng	Den absoluta slutpunktssökvägen som Azure Search-resursen ska använda.	Ja
index_name	sträng	Namnet på indexet som ska användas som tillgängligt i den refererade Azure Search-resursen.	Ja
fields_mapping	azureSearchIndexFieldMappingOptions	Valfria inställningar för att styra hur fält bearbetas när du använder en konfigurerad Azure Search-resurs.	Nej
query_type	azureSearchQueryType	Den typ av Azure Search-hämtningsfråga som ska köras när du använder den som ett Azure OpenAI-chatttillägg.	Nej
semantic_configuration	sträng	Den ytterligare semantiska konfigurationen för frågan.	Nej
filter	sträng	Sökfilter.	Nej
embedding_dependency	onYourDataEndpointVectorizationSource eller onYourDataDeploymentNameVectorizationSource eller onYourDataIntegratedVectorizationSource		Nej
include_contexts	matris	De inkluderade egenskaperna för utdatakontexten. Om det inte anges är citations standardvärdet och intent.	Nej

azureSearchIndexFieldMappingOptions

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
title_field	sträng	Namnet på det indexfält som ska användas som rubrik.	Nej
url_field	sträng	Namnet på det indexfält som ska användas som en URL.	Nej
filepath_field	sträng	Namnet på det indexfält som ska användas som en filsökväg.	Nej
content_fields	matris	Namnen på indexfält som ska behandlas som innehåll.	Nej
content_fields_separator	sträng	Det avgränsarmönster som innehållsfält ska använda.	Nej
vector_fields	matris	Namnen på fält som representerar vektordata.	Nej
image_vector_fields	matris	Namnen på fält som representerar bildvektordata.	Nej

azureSearchQueryType

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

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

Typ: sträng

Standard:

Uppräkningsnamn: AzureSearchQueryType

Uppräkningsvärden:

Värde	beskrivning
enkel	Representerar standard, enkel frågeparser.
semantik-	Representerar den semantiska frågeparsern för avancerad semantisk modellering.
vektor	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.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
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.	Ja
parametrar	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.	Nej

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.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
autentisering	onYourDataConnectionStringAuthenticationOptions	Autentiseringsalternativen för Azure OpenAI På dina data när du använder en anslutningssträng.	Ja
top_n_documents	integer	Det konfigurerade högsta antalet dokument som ska användas för den konfigurerade frågan.	Nej
max_search_queries	integer	Maximalt antal omskrivna frågor som ska skickas till sökprovidern för ett användarmeddelande. Om det inte anges bestämmer systemet hur många frågor som ska skickas.	Nej
allow_partial_result	boolean	Om det anges som sant tillåter systemet att partiella sökresultat används och begäran misslyckas om alla frågor misslyckas. Om det inte anges eller anges som falskt misslyckas begäran om någon sökfråga misslyckas.	Nej	Falsk
in_scope	boolean	Om frågor ska begränsas till användning av indexerade data.	Nej
strikthet	integer	Den konfigurerade strängheten för sökrelevansfiltreringen. Ju högre strikthet, desto högre precision men lägre återkallande av svaret.	Nej
database_name	sträng	MongoDB vCore-databasnamnet som ska användas med Azure Cosmos DB.	Ja
container_name	sträng	Namnet på Azure Cosmos DB-resurscontainern.	Ja
index_name	sträng	MongoDB vCore-indexnamnet som ska användas med Azure Cosmos DB.	Ja
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.	Ja
embedding_dependency	onYourDataEndpointVectorizationSource eller onYourDataDeploymentNameVectorizationSource		Ja
include_contexts	matris	De inkluderade egenskaperna för utdatakontexten. Om det inte anges är citations standardvärdet och intent.	Nej

azureCosmosDBFieldMappingOptions

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
title_field	sträng	Namnet på det indexfält som ska användas som rubrik.	Nej
url_field	sträng	Namnet på det indexfält som ska användas som en URL.	Nej
filepath_field	sträng	Namnet på det indexfält som ska användas som en filsökväg.	Nej
content_fields	matris	Namnen på indexfält som ska behandlas som innehåll.	Ja
content_fields_separator	sträng	Det avgränsarmönster som innehållsfält ska använda.	Nej
vector_fields	matris	Namnen på fält som representerar vektordata.	Ja

elasticsearchChatExtensionConfiguration

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
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.	Ja
parametrar	elasticsearchChatExtensionParameters	Parametrar som ska användas när elasticsearch® konfigureras som ett Azure OpenAI-chatttillägg.	Nej

elasticsearchChatExtensionParameters

Parametrar som ska användas när elasticsearch® konfigureras som ett Azure OpenAI-chatttillägg.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
autentisering	onYourDataKeyAndKeyIdAuthenticationOptions eller onYourDataEncodedApiKeyAuthenticationOptions		Ja
top_n_documents	integer	Det konfigurerade högsta antalet dokument som ska användas för den konfigurerade frågan.	Nej
max_search_queries	integer	Det maximala antalet omskrivna frågor ska skickas till sökprovidern för ett användarmeddelande. Om det inte anges bestämmer systemet hur många frågor som ska skickas.	Nej
allow_partial_result	boolean	Om det anges som sant tillåter systemet att partiella sökresultat används och begäran misslyckas om alla frågor misslyckas. Om det inte anges eller anges som falskt misslyckas begäran om någon sökfråga misslyckas.	Nej	Falsk
in_scope	boolean	Om frågor ska begränsas till användning av indexerade data.	Nej
strikthet	integer	Den konfigurerade strängheten för sökrelevansfiltreringen. Ju högre strikthet, desto högre precision men lägre återkallande av svaret.	Nej
slutpunkt	sträng	Elasticsearchs® slutpunkt.	Ja
index_name	sträng	Indexnamnet elasticsearch®.	Ja
fields_mapping	elasticsearchIndexFieldMappingOptions	Valfria inställningar för att styra hur fält bearbetas när du använder en konfigurerad Elasticsearch-resurs®.	Nej
query_type	elasticsearchQueryType	Den typ av Elasticsearch-hämtningsfråga® som ska köras när den används som ett Azure OpenAI-chatttillägg.	Nej
embedding_dependency	onYourDataEndpointVectorizationSource eller onYourDataDeploymentNameVectorizationSource eller onYourDataModelIdVectorizationSource		Nej
include_contexts	matris	De inkluderade egenskaperna för utdatakontexten. Om det inte anges är citations standardvärdet och intent.	Nej

elasticsearchIndexFieldMappingOptions

Valfria inställningar för att styra hur fält bearbetas när du använder en konfigurerad Elasticsearch-resurs®.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
title_field	sträng	Namnet på det indexfält som ska användas som rubrik.	Nej
url_field	sträng	Namnet på det indexfält som ska användas som en URL.	Nej
filepath_field	sträng	Namnet på det indexfält som ska användas som en filsökväg.	Nej
content_fields	matris	Namnen på indexfält som ska behandlas som innehåll.	Nej
content_fields_separator	sträng	Det avgränsarmönster som innehållsfält ska använda.	Nej
vector_fields	matris	Namnen på fält som representerar vektordata.	Nej

elasticsearchQueryType

Den typ av Elasticsearch-hämtningsfråga® som ska köras när den används som ett Azure OpenAI-chatttillägg.

Beskrivning: Den typ av Elasticsearch-hämtningsfråga® som ska köras när du använder den som ett Azure OpenAI-chatttillägg.

Typ: sträng

Standard:

Uppräkningsnamn: ElasticsearchQueryType

Uppräkningsvärden:

Värde	beskrivning
enkel	Representerar standard, enkel frågeparser.
vektor	Representerar vektorsökning över beräknade data.

mongoDBChatExtensionConfiguration

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
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.	Ja
parametrar	mongoDBChatExtensionParameters	Parametrar som ska användas när du konfigurerar Azure OpenAI På dina datachatttillägg när du använder Mongo DB.	Nej

mongoDBChatExtensionParameters

Parametrar som ska användas när du konfigurerar Azure OpenAI På dina datachatttillägg när du använder Mongo DB.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
autentisering	onYourDataUsernameAndPasswordAuthenticationOptions	Autentiseringsalternativen för Azure OpenAI På dina data när du använder ett användarnamn och ett lösenord.	Ja
top_n_documents	integer	Det konfigurerade högsta antalet dokument som ska användas för den konfigurerade frågan.	Nej
max_search_queries	integer	Det maximala antalet omskrivna frågor ska skickas till sökprovidern för ett användarmeddelande. Om det inte anges bestämmer systemet hur många frågor som ska skickas.	Nej
allow_partial_result	boolean	Om det anges som sant tillåter systemet att partiella sökresultat används och begäran misslyckas om alla frågor misslyckas. Om det inte anges eller anges som falskt misslyckas begäran om någon sökfråga misslyckas.	Nej	Falsk
in_scope	boolean	Om frågor ska begränsas till användning av indexerade data.	Nej
strikthet	integer	Den konfigurerade strängheten för sökrelevansfiltreringen. Ju högre strikthet, desto högre precision men lägre återkallande av svaret.	Nej
slutpunkt	sträng	Namnet på Mongo DB-klusterslutpunkten.	Ja
database_name	sträng	Namnet på Mongo DB-databasen.	Ja
collection_name	sträng	Namnet på Mongo DB-samlingen.	Ja
app_name	sträng	Namnet på Mongo DB-programmet.	Ja
index_name	sträng	Namnet på Mongo DB-indexet.	Ja
fields_mapping	mongoDBFieldMappingOptions	Valfria inställningar för att styra hur fält bearbetas när du använder en konfigurerad Mongo DB-resurs.	Ja
embedding_dependency	onYourDataEndpointVectorizationSource eller onYourDataDeploymentNameVectorizationSource		Ja
include_contexts	matris	De inkluderade egenskaperna för utdatakontexten. Om det inte anges är citations standardvärdet och intent.	Nej

mongoDBFieldMappingOptions

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
title_field	sträng	Namnet på det indexfält som ska användas som rubrik.	Nej
url_field	sträng	Namnet på det indexfält som ska användas som en URL.	Nej
filepath_field	sträng	Namnet på det indexfält som ska användas som en filsökväg.	Nej
content_fields	matris	Namnen på indexfält som ska behandlas som innehåll.	Ja
content_fields_separator	sträng	Det avgränsarmönster som innehållsfält ska använda.	Nej
vector_fields	matris	Namnen på fält som representerar vektordata.	Ja

pineconeChatExtensionConfiguration

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
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.	Ja
parametrar	pineconeChatExtensionParameters	Parametrar för att konfigurera Azure OpenAI Pinecone-chatttillägg.	Nej

pineconeChatExtensionParameters

Parametrar för att konfigurera Azure OpenAI Pinecone-chatttillägg.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
autentisering	onYourDataApiKeyAuthenticationOptions	Autentiseringsalternativen för Azure OpenAI På dina data när du använder en API-nyckel.	Ja
top_n_documents	integer	Det konfigurerade högsta antalet dokument som ska användas för den konfigurerade frågan.	Nej
max_search_queries	integer	Det maximala antalet omskrivna frågor ska skickas till sökprovidern för ett användarmeddelande. Om det inte anges bestämmer systemet hur många frågor som ska skickas.	Nej
allow_partial_result	boolean	Om det anges som sant tillåter systemet att partiella sökresultat används och begäran misslyckas om alla frågor misslyckas. Om det inte anges eller anges som falskt misslyckas begäran om någon sökfråga misslyckas.	Nej	Falsk
in_scope	boolean	Om frågor ska begränsas till användning av indexerade data.	Nej
strikthet	integer	Den konfigurerade strängheten för sökrelevansfiltreringen. Ju högre strikthet, desto högre precision men lägre återkallande av svaret.	Nej
-miljö	sträng	Miljönamnet Pinecone.	Ja
index_name	sträng	Namnet på Pinecone-databasindexet.	Ja
fields_mapping	pineconeFieldMappingOptions	Valfria inställningar för att styra hur fält bearbetas när du använder en konfigurerad Pinecone-resurs.	Ja
embedding_dependency	onYourDataDeploymentNameVectorizationSource	Information om en vektoriseringskälla, som används av Azure OpenAI på dina data vid tillämpning av vektorsökning, som är baserad på ett internt distributionsnamn för inbäddningsmodellen i samma Azure OpenAI-resurs.	Ja
include_contexts	matris	De inkluderade egenskaperna för utdatakontexten. Om det inte anges är citations standardvärdet och intent.	Nej

pineconeFieldMappingOptions

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
title_field	sträng	Namnet på det indexfält som ska användas som rubrik.	Nej
url_field	sträng	Namnet på det indexfält som ska användas som en URL.	Nej
filepath_field	sträng	Namnet på det indexfält som ska användas som en filsökväg.	Nej
content_fields	matris	Namnen på indexfält som ska behandlas som innehåll.	Ja
content_fields_separator	sträng	Det avgränsarmönster som innehållsfält ska använda.	Nej

onYourDataAuthenticationOptions

Autentiseringsalternativen för Azure OpenAI på dina data.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	onYourDataAuthenticationType	De autentiseringstyper som stöds med Azure OpenAI på dina data.	Ja

onYourDataContextProperty

Kontextegenskapen.

Beskrivning: Kontextegenskapen.

Typ: sträng

Standard:

Uppräkningsnamn: OnYourDataContextProperty

Uppräkningsvärden:

Värde	beskrivning
Citat	Egenskapen citations .
avsikt	Egenskapen intent .
all_retrieved_documents	Egenskapen all_retrieved_documents .

onYourDataAuthenticationType

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

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

Typ: sträng

Standard:

Uppräkningsnamn: OnYourDataAuthenticationType

Uppräkningsvärden:

Värde	beskrivning
api_key	Autentisering via API-nyckel.
connection_string	Autentisering via anslutningssträng.
key_and_key_id	Autentisering via nyckel- och nyckel-ID-par.
encoded_api_key	Autentisering via kodad API-nyckel.
access_token	Autentisering via åtkomsttoken.
system_assigned_managed_identity	Autentisering via systemtilldelad hanterad identitet.
user_assigned_managed_identity	Autentisering via användartilldelad hanterad identitet.
username_and_password	Autentisering via användarnamn och lösenord.

onYourDataApiKeyAuthenticationOptions

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	onYourDataAuthenticationType	De autentiseringstyper som stöds med Azure OpenAI på dina data.	Ja
nyckel	sträng	API-nyckeln som ska användas för autentisering.	Nej

onYourDataConnectionStringAuthenticationOptions

Autentiseringsalternativen för Azure OpenAI På dina data när du använder en anslutningssträng.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	onYourDataAuthenticationType	De autentiseringstyper som stöds med Azure OpenAI på dina data.	Ja
connection_string	sträng	Den anslutningssträng som ska användas för autentisering.	Nej

onYourDataKeyAndKeyIdAuthenticationOptions

Autentiseringsalternativen för Azure OpenAI På dina data när du använder ett Elasticsearch-nyckel- och nyckel-ID-par.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	onYourDataAuthenticationType	De autentiseringstyper som stöds med Azure OpenAI på dina data.	Ja
nyckel	sträng	Elasticsearch-nyckeln som ska användas för autentisering.	Nej
key_id	sträng	Elasticsearch-nyckel-ID:t som ska användas för autentisering.	Nej

onYourDataEncodedApiKeyAuthenticationOptions

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	onYourDataAuthenticationType	De autentiseringstyper som stöds med Azure OpenAI på dina data.	Ja
encoded_api_key	sträng	Elasticsearch-kodad API-nyckel som ska användas för autentisering.	Nej

onYourDataAccessTokenAuthenticationOptions

Autentiseringsalternativen för Azure OpenAI På dina data när du använder åtkomsttoken.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	onYourDataAuthenticationType	De autentiseringstyper som stöds med Azure OpenAI på dina data.	Ja
access_token	sträng	Åtkomsttoken som ska användas för autentisering.	Nej

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	onYourDataAuthenticationType	De autentiseringstyper som stöds med Azure OpenAI på dina data.	Ja

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	onYourDataAuthenticationType	De autentiseringstyper som stöds med Azure OpenAI på dina data.	Ja
managed_identity_resource_id	sträng	Resurs-ID för den användartilldelade hanterade identitet som ska användas för autentisering.	Nej

onYourDataUsernameAndPasswordAuthenticationOptions

Autentiseringsalternativen för Azure OpenAI På dina data när du använder ett användarnamn och ett lösenord.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	onYourDataAuthenticationType	De autentiseringstyper som stöds med Azure OpenAI på dina data.	Ja
användarnamn	sträng	Användarnamnet som ska användas för autentisering.	Nej
password	sträng	Lösenordet. för autentisering.	Nej

onYourDataVectorizationSource

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	onYourDataVectorizationSourceType	Representerar de tillgängliga källor som Azure OpenAI På dina data kan använda för att konfigurera vektorisering av data för användning med vektorsökning.	Ja

onYourDataVectorizationSourceType

Representerar de tillgängliga källor som Azure OpenAI On Your Data kan använda för att konfigurera vektorisering av data för användning med vektorsökning.

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

Typ: sträng

Standard:

Uppräkningsnamn: OnYourDataVectorizationSourceType

Uppräkningsvärden:

Värde	beskrivning
slutpunkt	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.
integrerad	Representerar den integrerade vektoriseraren som definierats i sökresursen.
model_id	Representerar ett specifikt inbäddningsmodell-ID enligt definitionen i söktjänsten. Stöds för närvarande endast av Elasticsearch®.

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 Azure OpenAI-slutpunktsanrop för inbäddningar.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	onYourDataVectorizationSourceType	Representerar de tillgängliga källor som Azure OpenAI På dina data kan använda för att konfigurera vektorisering av data för användning med vektorsökning.	Ja
slutpunkt	sträng	Anger resursslutpunkts-URL:en som inbäddningar ska hämtas från. Den ska vara i formatet https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Frågeparametern api-version är inte tillåten.	Nej
autentisering	onYourDataApiKeyAuthenticationOptions eller onYourDataAccessTokenAuthenticationOptions		Nej
dimensioner	integer	Antalet dimensioner som inbäddningarna ska ha. Stöds endast i text-embedding-3 och senare modeller.	Nej

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äddningsmodellens distributionsnamn i samma Azure OpenAI-resurs.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	onYourDataVectorizationSourceType	Representerar de tillgängliga källor som Azure OpenAI På dina data kan använda för att konfigurera vektorisering av data för användning med vektorsökning.	Ja
deployment_name	sträng	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.	Nej
dimensioner	integer	Antalet dimensioner som inbäddningarna ska ha. Stöds endast i text-embedding-3 och senare modeller.	Nej

onYourDataIntegratedVectorizationSource

Representerar den integrerade vektoriseraren som definierats i sökresursen.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	onYourDataVectorizationSourceType	Representerar de tillgängliga källor som Azure OpenAI På dina data kan använda för att konfigurera vektorisering av data för användning med vektorsökning.	Ja

onYourDataModelIdVectorizationSource

Information om en vektoriseringskälla, som används av Azure OpenAI på dina data vid tillämpning av vektorsökning, som baseras på ett modell-ID för söktjänsten. Stöds för närvarande endast av Elasticsearch®.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	onYourDataVectorizationSourceType	Representerar de tillgängliga källor som Azure OpenAI På dina data kan använda för att konfigurera vektorisering av data för användning med vektorsökning.	Ja
model_id	sträng	Anger det modell-ID som ska användas för vektorisering. Det här modell-ID:t måste definieras i söktjänsten.	Nej

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.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
Citat	matris	Datakällans hämtningsresultat, som används för att generera assistentmeddelandet i svaret.	Nej
avsikt	sträng	Den identifierade avsikten från chatthistoriken, som används för att gå vidare till nästa tur för att överföra kontexten.	Nej
all_retrieved_documents	matris	Alla hämtade dokument.	Nej

citat

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
innehåll	sträng	Innehållet i källhänvisning.	Ja
rubrik	sträng	Rubriken på citatet.	Nej
URL	sträng	URL:en för källhänvisning.	Nej
filepath	sträng	Filsökvägen för källhänvisning.	Nej
chunk_id	sträng	Citatets segment-ID.	Nej
rerank_score	Nummer	Omrankningspoängen för det hämtade dokumentet.	Nej

retrievedDocument

Det hämtade dokumentet.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
innehåll	sträng	Innehållet i källhänvisning.	Ja
rubrik	sträng	Rubriken på citatet.	Nej
URL	sträng	URL:en för källhänvisning.	Nej
filepath	sträng	Filsökvägen för källhänvisning.	Nej
chunk_id	sträng	Citatets segment-ID.	Nej
rerank_score	Nummer	Omrankningspoängen för det hämtade dokumentet.	Nej
search_queries	matris	Sökfrågorna som används för att hämta dokumentet.	Nej
data_source_index	integer	Datakällans index.	Nej
original_search_score	Nummer	Den ursprungliga sökpoängen för det hämtade dokumentet.	Nej
filter_reason	filterReason	Filtreringsorsaken till det hämtade dokumentet.	Nej

filterReason

Filtreringsorsaken till det hämtade dokumentet.

Beskrivning: Filtreringsorsaken till det hämtade dokumentet.

Typ: sträng

Standard:

Uppräkningsnamn: FilterReason

Uppräkningsvärden:

Värde	beskrivning
poäng	Dokumentet filtreras efter det ursprungliga tröskelvärdet för sökpoäng som definierats av strictness konfigurerat.
ändra rangordning	Dokumentet filtreras inte efter det ursprungliga tröskelvärdet för sökpoäng, utan filtreras efter omrankningspoäng och top_n_documents konfiguration.

chatCompletionMessageToolCall

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	ID:t för verktygsanropet.	Ja
type	toolCallType	Typ av verktygsanrop, i det här fallet function.	Ja
function	objekt	Den funktion som modellen anropade.	Ja

Egenskaper för funktionen

name

Namn	Type	Beskrivning	Standard
name	sträng	Namnet på funktionen som ska anropas.

Argument

Namn	Type	Beskrivning	Standard
Argument	sträng	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.

Typ: sträng

Standard:

Uppräkningsnamn: ToolCallType

Uppräkningsvärden:

Värde	beskrivning
function	Verktygsanropstypen är funktion.

chatCompletionRequestMessageTool

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
tool_call_id	sträng	Verktygsanrop som det här meddelandet svarar på.	Nej
innehåll	sträng	Innehållet i meddelandet.	Nej

chatCompletionRequestMessageFunction

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
roll	uppräkning	Rollen som meddelandenas författare, i det här fallet function. Möjliga värden: funktion	Nej
name	sträng	Innehållet i meddelandet.	Nej
innehåll	sträng	Innehållet i meddelandet.	Nej

createChatCompletionResponse

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	En unik identifierare för chattens slutförande.	Ja
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.	Nej
Val	matris	En lista över alternativ för chattens slutförande. Kan vara mer än en om n är större än 1.	Ja
skapad	integer	Unix-tidsstämpeln (i sekunder) för när chatten slutfördes skapades.	Ja
modell	sträng	Modellen som används för chattens slutförande.	Ja
system_fingerprint	sträng	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.	Nej
objekt	uppräkning	Objekttypen, som alltid chat.completionär . Möjliga värden: chat.completion	Ja
användning	completionUsage	Användningsstatistik för slutförandebegäran.	Nej

createChatCompletionStreamResponse

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	En unik identifierare för chattens slutförande. Varje segment har samma ID.	Ja
Val	matris	En lista över alternativ för chattens slutförande. Kan innehålla fler än ett element om n det är större än 1.	Ja
skapad	integer	Unix-tidsstämpeln (i sekunder) för när chatten slutfördes skapades. Varje segment har samma tidsstämpel.	Ja
modell	sträng	Modellen som ska generera slutförandet.	Ja
system_fingerprint	sträng	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.	Nej
objekt	uppräkning	Objekttypen, som alltid chat.completion.chunkär . Möjliga värden: chat.completion.chunk	Ja

chatCompletionStreamResponseDelta

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
innehåll	sträng	Innehållet i segmentmeddelandet.	Nej
function_call	objekt	Inaktuell och ersatt av tool_calls. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen.	Nej
tool_calls	matris		Nej
roll	uppräkning	Rollen som författare till det här meddelandet. Möjliga värden: system, användare, assistent, verktyg	Nej
vägran	sträng	Avslagsmeddelandet som genereras av modellen.	Nej

Egenskaper för function_call

Argument

Namn	Type	Beskrivning	Standard
Argument	sträng	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

Namn	Type	Beskrivning	Standard
name	sträng	Namnet på funktionen som ska anropas.

chatCompletionMessageToolCallChunk

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
index	integer		Ja
id	sträng	ID:t för verktygsanropet.	Nej
type	uppräkning	Verktygets typ. För närvarande stöds endast function . Möjliga värden: funktion	Nej
function	objekt		Nej

Egenskaper för funktionen

name

Namn	Type	Beskrivning	Standard
name	sträng	Namnet på funktionen som ska anropas.

Argument

Namn	Type	Beskrivning	Standard
Argument	sträng	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.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
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.	Nej

chatCompletionChoiceLogProbs

Logga sannolikhetsinformation för valet.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
innehåll	matris	En lista över meddelandeinnehållstoken med loggens sannolikhetsinformation.	Ja
vägran	matris	En lista över token för meddelandevägran med loggens sannolikhetsinformation.	Nej

chatCompletionTokenLogprob

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
token	sträng	Token.	Ja
logprob	Nummer	Loggens sannolikhet för denna token.	Ja
byte	matris	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.	Ja
top_logprobs	matris	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.	Ja

chatCompletionResponseMessage

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
roll	chatCompletionResponseMessageRole	Rollen som upphovsman till svarsmeddelandet.	Ja
vägran	sträng	Avslagsmeddelandet som genereras av modellen.	Ja
innehåll	sträng	Innehållet i meddelandet.	Ja
tool_calls	matris	Verktyget anropar som genereras av modellen, till exempel funktionsanrop.	Nej
function_call	chatCompletionFunctionCall	Inaktuell och ersatt av tool_calls. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen.	Nej
sammanhang	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.	Nej

chatCompletionResponseMessageRole

Rollen som upphovsman till svarsmeddelandet.

Beskrivning: Rollen som upphovsman till svarsmeddelandet.

Typ: sträng

Standard:

Uppräkningsvärden:

• assistent

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.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	uppräkning	Verktygets typ. För närvarande stöds endast function . Möjliga värden: funktion	Ja
function	objekt		Ja

Egenskaper för funktionen

name

Namn	Type	Beskrivning	Standard
name	sträng	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.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
name	sträng	Namnet på funktionen som ska anropas.	Ja
Argument	sträng	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.	Ja

completionUsage

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
prompt_tokens	integer	Antal token i prompten.	Ja
completion_tokens	integer	Antal token i det genererade slutförandet.	Ja
total_tokens	integer	Totalt antal token som används i begäran (fråga + slutförande).	Ja
prompt_tokens_details	objekt	Information om prompttoken.	Nej
completion_tokens_details	objekt	Uppdelning av token som används i en slutförande.	Nej

Egenskaper för prompt_tokens_details

cached_tokens

Namn	Type	Beskrivning	Standard
cached_tokens	integer	Antalet cachelagrade prompttoken.

Egenskaper för completion_tokens_details

reasoning_tokens

Namn	Type	Beskrivning	Standard
reasoning_tokens	integer	Token som genereras av modellen för resonemang.

chatCompletionTool

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	uppräkning	Verktygets typ. För närvarande stöds endast function . Möjliga värden: funktion	Ja
function	FunctionObject		Ja

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
description	sträng	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	Nej
name	sträng	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.	Ja
parametrar	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.	Nej
sträng	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.	Nej	Falsk

ResponseFormatText

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	uppräkning	Typ av svarsformat som definieras: text Möjliga värden: text	Ja

ResponseFormatJsonObject

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	uppräkning	Typ av svarsformat som definieras: json_object Möjliga värden: json_object	Ja

ResponseFormatJsonSchemaSchema

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

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

ResponseFormatJsonSchema

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	uppräkning	Typ av svarsformat som definieras: json_schema Möjliga värden: json_schema	Ja
json_schema	objekt		Ja

Egenskaper för json_schema

description

Name	Type	Beskrivning	Standardvärde
description	sträng	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

Namn	Type	Beskrivning	Standard
name	sträng	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

Namn	Type	Beskrivning	Standard
schema	ResponseFormatJsonSchemaSchema	Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt.

sträng

Namn	Type	Beskrivning	Standard
sträng	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.	Falsk

chatCompletionChoiceCommon

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
index	integer		Nej
finish_reason	sträng		Nej

createTranslationRequest

Översättningsbegäran.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
fil	sträng	Ljudfilen som ska översättas.	Ja
snabb	sträng	En valfri text som vägleder modellens formatmall eller fortsätter med ett tidigare ljudsegment. Uppmaningen ska vara på engelska.	Nej
response_format	audioResponseFormat	Definierar formatet för utdata.	Nej
temperatur	Nummer	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.	Nej	0

audioResponse

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
text	sträng	Översatt eller transkriberad text.	Ja

audioVerboseResponse

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
text	sträng	Översatt eller transkriberad text.	Ja
aktivitet	sträng	Typ av ljudaktivitet.	Nej
språk	string	Språk.	Nej
varaktighet	Nummer	Varaktighet.	Nej
Segment	matris		Nej
ord	matris		Nej

audioResponseFormat

Definierar formatet för utdata.

Beskrivning: Definierar formatet för utdata.

Typ: sträng

Standard:

Uppräkningsvärden:

• json
• text
• srt
• verbose_json
• vtt

createTranscriptionRequest

Transkriptionsbegäran.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
fil	sträng	Ljudfilsobjektet som ska transkriberas.	Ja
snabb	sträng	En valfri text som vägleder modellens formatmall eller fortsätter med ett tidigare ljudsegment. Uppmaningen ska matcha ljudspråket.	Nej
response_format	audioResponseFormat	Definierar formatet för utdata.	Nej
temperatur	Nummer	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.	Nej	0
språk	string	Språket för indataljudet. Om du anger indataspråket i ISO-639-1-format förbättras noggrannheten och svarstiden.	Nej
timestamp_granularities[]	matris	Tidsstämpelkornigheterna som ska fyllas i för den här transkriptionen. response_format måste anges verbose_json för att använda tidsstämpelkornigheter. Något av eller båda alternativen stöds: word, eller segment. Obs! Det finns ingen ytterligare svarstid för segmenttidsstämplar, men att generera ordtidsstämplar medför ytterligare svarstid.	Nej	['segment']

audioSegment

Transkriptions- eller översättningssegment.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	integer	Segmentidentifierare.	Nej
söka	Nummer	Förskjutning av segmentet.	Nej
start	Nummer	Segmentstartsförskjutning.	Nej
end	Nummer	Segmentslutförskjutning.	Nej
text	sträng	Segmentera text.	Nej
Token	matris	Token för texten.	Nej
temperatur	Nummer	Temperatur.	Nej
avg_logprob	Nummer	Genomsnittlig loggsannolikheten.	Nej
compression_ratio	Nummer	Kompressionsförhållande.	Nej
no_speech_prob	Nummer	Sannolikhet för "inget tal".	Nej

audioWord

Transkriptions- eller översättningsord.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
ord	sträng	Word	Nej
start	Nummer	Startförskjutning i Word.	Nej
end	Nummer	Förskjutning av Word-slut.	Nej

createSpeechRequest

Talbegäran.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
indata	sträng	Texten som ska syntetisera ljud för. Den maximala längden är 4 096 tecken.	Ja
voice	uppräkning	Rösten som ska användas för talsyntes. Möjliga värden: legering, eko, fabel, onyx, nova, skimmer	Ja
response_format	uppräkning	Formatet som ljudet ska syntetiseras i. Möjliga värden: mp3, opus, aac, flac, wav, pcm	Nej
hastighet	Nummer	Hastigheten för det syntetiserade ljudet. Välj ett värde från 0.25 till 4.0. 1.0 används som standard.	Nej	1.0

imageQuality

Kvaliteten på den bild som ska genereras.

Beskrivning: Kvaliteten på den bild som ska genereras.

Typ: sträng

Standard: standard

Uppräkningsnamn: Kvalitet

Uppräkningsvärden:

Värde	beskrivning
standard	Standardkvalitet skapar bilder med standardkvalitet.
hårddisk	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.

Typ: sträng

Standard: url

Uppräkningsnamn: ImagesResponseFormat

Uppräkningsvärden:

Värde	beskrivning
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.

Typ: sträng

Standard: 1024x1024

Uppräkningsnamn: Storlek

Uppräkningsvärden:

Värde	beskrivning
256x256	Den genererade bildens önskade storlek är 256 x 256 bildpunkter. Stöds endast för dall-e-2.
512 × 512	Den genererade bildens önskade storlek är 512 x 512 bildpunkter. Stöds endast för dall-e-2.
1792x1024	Den genererade bildens önskade storlek är 1 792 x 1 024 bildpunkter. Stöds endast för dall-e-3.
1024x1792	Den genererade bildens önskade storlek är 1 024 x 1 792 bildpunkter. Stöds endast för dall-e-3.
1 024 × 1 024	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.

Typ: sträng

Standard: levande

Uppräkningsnamn: Formatmall

Uppräkningsvärden:

Värde	beskrivning
levande	Levande skapar bilder som är hyperrealistiska och dramatiska.
naturlig	Naturliga skapar bilder som är mer naturliga och mindre hyperrealistiska.

imageGenerationsRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
snabb	sträng	En textbeskrivning av de önskade bilderna. Den maximala längden är 4 000 tecken.	Ja
n	integer	Antalet bilder som ska genereras.	Nej	1
storlek	imageSize	Storleken på de genererade bilderna.	Nej	1 024 × 1 024
response_format	imagesResponseFormat	Formatet där de genererade bilderna returneras.	Nej	URL
användare	sträng	En unik identifierare som representerar slutanvändaren, som kan hjälpa till att övervaka och upptäcka missbruk.	Nej
kvalitet	imageQuality	Kvaliteten på den bild som ska genereras.	Nej	standard
style	imageStyle	Formatmallen för de genererade bilderna.	Nej	levande

generateImagesResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
skapad	integer	Unix-tidsstämpeln när åtgärden skapades.	Ja
data	matris	Resultatdata för åtgärden, om det lyckas	Ja

imageResult

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
URL	sträng	Bild-URL:en.	Nej
b64_json	sträng	Den base64-kodade avbildningen	Nej
content_filter_results	dalleContentFilterResults	Information om resultatet av innehållsfiltreringen.	Nej
revised_prompt	sträng	Uppmaningen som användes för att generera avbildningen, om det fanns någon revision av prompten.	Nej
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.	Nej

linje

Ett innehållsradsobjekt som består av en intilliggande sekvens med innehållselement, till exempel ord och markeringsmarkeringar.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
text	sträng		Ja
Spänner över	matris	En matris med intervall som representerar identifierade objekt och dess avgränsningsruta.	Ja

spann

Ett span-objekt som representerar ett identifierat objekt och dess avgränsningsruta.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
text	sträng	Textinnehållet i det spann som representerar det identifierade objektet.	Ja
förskjutning	integer	Teckenförskjutningen i texten där intervallet börjar. Den här förskjutningen definieras som positionen för det första tecknet i intervallet och räknas från början av texten som Unicode-kodpunkter.	Ja
längd	integer	Längden på intervallet i tecken, mätt i Unicode-kodpunkter.	Ja
polygon	matris	En matris med objekt som representerar punkter i polygonen som omger det identifierade objektet.	Ja

runCompletionUsage

Användningsstatistik som är relaterad till körningen. Det här värdet blir null om körningen inte är i ett terminaltillstånd (t.ex. in_progress, queuedosv.).

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
completion_tokens	integer	Antal slutförandetoken som används under körningen.	Ja
prompt_tokens	integer	Antal prompttoken som används under körningen.	Ja
total_tokens	integer	Totalt antal token som används (prompt + slutförande).	Ja

runStepCompletionUsage

Användningsstatistik som är relaterad till körningssteget. Det här värdet kommer att vara null medan körningsstegets status är in_progress.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
completion_tokens	integer	Antal slutförandetoken som används under körningssteget.	Ja
prompt_tokens	integer	Antal prompttoken som används under körningssteget.	Ja
total_tokens	integer	Totalt antal token som används (prompt + slutförande).	Ja

assistantsApiResponseFormatOption

Anger det format som modellen måste mata ut. Kompatibel med GPT-4 Turbo och alla GPT-3.5 Turbo modeller sedan gpt-3.5-turbo-1106.

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.

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

assistantsApiResponseFormat

Ett objekt som beskriver modellens förväntade utdata. Om json_object endast function typ tools tillåts skickas till Kör. Om text modellen kan returnera text eller något värde som behövs.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Måste vara en av text eller json_object.	Nej	text

typ Uppräkning: AssistenterApiResponseFormat

Värde	beskrivning
text
json_object

assistantObject

Representerar en assistant som kan anropa modellen och använda verktyg.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	Identifieraren, som kan refereras till i API-slutpunkter.	Ja
objekt	sträng	Objekttypen, som alltid assistantär .	Ja
created_at	integer	Unix-tidsstämpeln (i sekunder) för när assistenten skapades.	Ja
namn	sträng	Namnet på assistenten. Den maximala längden är 256 tecken.	Ja
beskrivning	sträng	Beskrivningen av assistenten. Den maximala längden är 512 tecken.	Ja
modell	sträng	ID för modellen som ska användas. Du kan använda API:et Listmodeller för att se alla tillgängliga modeller.	Ja
instruktioner	sträng	Systeminstruktionerna som assistenten använder. Den maximala längden är 256 000 tecken.	Ja
verktyg	matris	En lista över verktyg som är aktiverade på assistenten. Det kan finnas högst 128 verktyg per assistent. Verktyg kan vara av typen code_interpreter, file_searcheller function.	Ja	[]
tool_resources	objekt	En uppsättning resurser som används av assistentens verktyg. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Ja
temperatur	Nummer	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.	Nej	1
top_p	Nummer	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 den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperatur men inte båda.	Nej	1
response_format	assistantsApiResponseFormatOption	Anger det format som modellen måste mata ut. Kompatibel med GPT-4 Turbo och alla GPT-3.5 Turbo modeller sedan gpt-3.5-turbo-1106. 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.	Nej

Egenskaper för tool_resources

code_interpreter

Namn	Type	Beskrivning	Standard
file_ids	matris	En lista över fil-ID:t som gjorts tillgängliga för code_interpreter verktyget. Det kan finnas högst 20 filer som är associerade med verktyget.	[]

file_search

Namn	Type	Beskrivning	Standard
vector_store_ids	matris	ID:t för vektorarkivet som är kopplat till den här assistenten. Det kan finnas högst 1 vektorlager kopplat till assistenten.

object Enum: AssistantObjectType

Värde	beskrivning
assistent	Objekttypen, som alltid är assistent

createAssistantRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
modell			Ja
namn	sträng	Namnet på assistenten. Den maximala längden är 256 tecken.	Nej
description	sträng	Beskrivningen av assistenten. Den maximala längden är 512 tecken.	Nej
instruktioner	sträng	Systeminstruktionerna som assistenten använder. Den maximala längden är 256 000 tecken.	Nej
verktyg	matris	En lista över verktyg som är aktiverade på assistenten. Det kan finnas högst 128 verktyg per assistent. Verktyg kan vara av typen code_interpreter, retrievaleller function.	Nej	[]
tool_resources	objekt	En uppsättning resurser som används av assistentens verktyg. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej
temperatur	Nummer	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.	Nej	1
top_p	Nummer	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 den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperatur men inte båda.	Nej	1
response_format	assistantsApiResponseFormatOption	Anger det format som modellen måste mata ut. Kompatibel med GPT-4 Turbo och alla GPT-3.5 Turbo modeller sedan gpt-3.5-turbo-1106. 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.	Nej

Egenskaper för tool_resources

code_interpreter

Namn	Type	Beskrivning	Standard
file_ids	matris	En lista över fil-ID:t som gjorts tillgängliga för code_interpreter verktyget. Det kan finnas högst 20 filer som är associerade med verktyget.	[]

file_search

Namn	Type	Beskrivning	Standard
vector_store_ids	matris	Vektorarkivet som är kopplat till den här assistenten. Det kan finnas högst 1 vektorlager kopplat till assistenten.
vector_stores	matris	En hjälp för att skapa ett vektorlager med file_ids och koppla det till den här assistenten. Det kan finnas högst 1 vektorlager kopplat till assistenten.

modifyAssistantRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
modell			Nej
name	sträng	Namnet på assistenten. Den maximala längden är 256 tecken.	Nej
description	sträng	Beskrivningen av assistenten. Den maximala längden är 512 tecken.	Nej
instruktioner	sträng	Systeminstruktionerna som assistenten använder. Den maximala längden är 32768 tecken.	Nej
verktyg	matris	En lista över verktyg som är aktiverade på assistenten. Det kan finnas högst 128 verktyg per assistent. Verktyg kan vara av typen code_interpreter, retrievaleller function.	Nej	[]
tool_resources	objekt	En uppsättning resurser som används av assistentens verktyg. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej
temperatur	Nummer	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.	Nej	1
top_p	Nummer	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 den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperatur men inte båda.	Nej	1
response_format	assistantsApiResponseFormatOption	Anger det format som modellen måste mata ut. Kompatibel med GPT-4 Turbo och alla GPT-3.5 Turbo modeller sedan gpt-3.5-turbo-1106. 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.	Nej

Egenskaper för tool_resources

code_interpreter

Namn	Type	Beskrivning	Standard
file_ids	matris	Åsidosätter listan över fil-ID:t som är tillgängliga för code_interpreter verktyget. Det kan finnas högst 20 filer som är associerade med verktyget.	[]

file_search

Namn	Type	Beskrivning	Standard
vector_store_ids	matris	Åsidosätter det vektorarkiv som är kopplat till den här assistenten. Det kan finnas högst 1 vektorlager kopplat till assistenten.

deleteAssistantResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	string		Ja
borttaget	boolean		Ja
objekt	sträng		Ja

object Enum: DeleteAssistantResponseState

Värde	beskrivning
assistant.deleted

listAssistantsResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
objekt	sträng		Ja
data	matris		Ja
first_id	sträng		Ja
last_id	sträng		Ja
has_more	boolean		Ja

assistantToolsCode

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Vilken typ av verktyg som definieras: code_interpreter	Ja

typ Uppräkning: assistantToolsCodeType

Värde	beskrivning
code_interpreter

assistantToolsFileSearch

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Vilken typ av verktyg som definieras: file_search	Ja
file_search	objekt	Åsidosättningar för filsökningsverktyget.	Nej

Egenskaper för file_search

max_num_results

Namn	Type	Beskrivning	Standard
max_num_results	integer	Det maximala antalet resultat som filsökningsverktyget ska mata ut. Standardvärdet är 20 för gpt-4* modeller och 5 för gpt-3.5-turbo. Det här talet ska vara mellan 1 och 50 inklusive. Observera att filsökningsverktyget kan mata ut färre än max_num_results resultaten.

typ Uppräkning: assistantToolsFileSearchType

Värde	beskrivning
file_search

assistantToolsFileSearchTypeOnly

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Vilken typ av verktyg som definieras: file_search	Ja

typ Uppräkning: assistantToolsFileSearchType

Värde	beskrivning
file_search

assistantToolsFunction

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Vilken typ av verktyg som definieras: function	Ja
function	objekt	Funktionsdefinitionen.	Ja

Egenskaper för funktionen

description

Name	Type	Beskrivning	Standardvärde
description	sträng	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.

name

Namn	Type	Beskrivning	Standard
name	sträng	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.

parametrar

Namn	Type	Beskrivning	Standard
parametrar	chatCompletionFunctionParameters	Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt. Se guiden för exempel och JSON-schemareferensen för dokumentation om formatet.

typ Uppräkning: assistantToolsFunction

Värde	beskrivning
function

truncationObject

Kontroller för hur en tråd trunkeras före körningen. Använd det här alternativet om du vill styra körningens inledande kontextfönster.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Den trunkeringsstrategi som ska användas för tråden. Standardvärdet är auto. Om den är inställd last_messagespå trunkeras tråden till de n senaste meddelandena i tråden. När det är inställt på autokommer meddelanden i mitten av tråden att tas bort för att passa modellens kontextlängd. max_prompt_tokens	Ja
last_messages	integer	Antalet senaste meddelanden från tråden när du skapar kontexten för körningen.	Nej

typ Uppräkning: TruncationType

Värde	beskrivning
auto
last_messages

assistantsApiToolChoiceOption

Styr vilket (om något) verktyg som anropas av modellen. none innebär att modellen inte anropar några verktyg och i stället genererar ett meddelande. auto är standardvärdet och innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett verktyg. Om du anger ett visst verktyg som {"type": "file_search"} eller {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa verktyget.

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

assistantsNamedToolChoice

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

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Verktygets typ. Om typen är functionmåste funktionsnamnet anges	Ja
function	objekt		Nej

Egenskaper för funktionen

name

Namn	Type	Beskrivning	Standard
name	sträng	Namnet på funktionen som ska anropas.

typ Uppräkning: AssistantsNamedToolChoiceType

Värde	beskrivning
function
code_interpreter
file_search

runObject

Representerar en körningskörning på en tråd.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	Identifieraren, som kan refereras till i API-slutpunkter.	Ja
objekt	sträng	Objekttypen, som alltid thread.runär .	Ja
created_at	integer	Unix-tidsstämpeln (i sekunder) för när körningen skapades.	Ja
thread_id	sträng	ID:t för tråden som kördes på som en del av den här körningen.	Ja
assistant_id	sträng	ID:t för assistenten som används för körningen av den här körningen.	Ja
status	sträng	Status för körningen, som kan vara antingen , , , , , , , completedeller expired. failedcancelledcancellingrequires_actionin_progressqueued	Ja
required_action	objekt	Information om den åtgärd som krävs för att fortsätta körningen. Kommer att vara null om ingen åtgärd krävs.	Ja
last_error	objekt	Det sista felet som är associerat med den här körningen. Kommer att vara null om det inte finns några fel.	Ja
expires_at	integer	Unix-tidsstämpeln (i sekunder) för när körningen upphör att gälla.	Ja
started_at	integer	Unix-tidsstämpeln (i sekunder) för när körningen startades.	Ja
cancelled_at	integer	Unix-tidsstämpeln (i sekunder) för när körningen avbröts.	Ja
failed_at	integer	Unix-tidsstämpeln (i sekunder) för när körningen misslyckades.	Ja
completed_at	integer	Unix-tidsstämpeln (i sekunder) för när körningen slutfördes.	Ja
incomplete_details	objekt	Information om varför körningen är ofullständig. null Blir om körningen inte är ofullständig.	Ja
modell	sträng	Modellen som assistenten använde för den här körningen.	Ja
instruktioner	sträng	Instruktionerna som assistenten använde för den här körningen.	Ja
verktyg	matris	Listan över verktyg som assistenten använde för den här körningen.	Ja	[]
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Ja
användning	runCompletionUsage	Användningsstatistik som är relaterad till körningen. Det här värdet blir null om körningen inte är i ett terminaltillstånd (t.ex. in_progress, queuedosv.).	Ja
temperatur	Nummer	Den samplingstemperatur som används för den här körningen. Om den inte har angetts är standardvärdet 1.	Nej
top_p	Nummer	Kärnsamplingsvärdet som används för den här körningen. Om den inte har angetts är standardvärdet 1.	Nej
max_prompt_tokens	integer	Det maximala antalet prompttoken som har angetts för att ha använts under körningen.	Ja
max_completion_tokens	integer	Det maximala antalet slutförandetoken som har angetts för att ha använts under körningen.	Ja
truncation_strategy	truncationObject	Kontroller för hur en tråd trunkeras före körningen. Använd det här alternativet om du vill styra körningens inledande kontextfönster.	Ja
tool_choice	assistantsApiToolChoiceOption	Styr vilket (om något) verktyg som anropas av modellen. none innebär att modellen inte anropar några verktyg och i stället genererar ett meddelande. auto är standardvärdet och innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett verktyg. Om du anger ett visst verktyg som {"type": "file_search"} eller {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa verktyget.	Ja
parallel_tool_calls	ParallelToolCalls	Om du vill aktivera parallell funktionsanrop under verktygsanvändning.	Nej	Sann
response_format	assistantsApiResponseFormatOption	Anger det format som modellen måste mata ut. Kompatibel med GPT-4 Turbo och alla GPT-3.5 Turbo modeller sedan gpt-3.5-turbo-1106. 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.	Ja

Egenskaper för required_action

type

Namn	Type	Beskrivning	Standard
type	sträng	För tillfället är detta alltid submit_tool_outputs.

submit_tool_outputs

Namn	Type	Beskrivning	Standard
tool_calls	matris	En lista över relevanta verktygsanrop.

Egenskaper för last_error

kod

Namn	Type	Beskrivning	Standard
kod	sträng	En av server_error eller rate_limit_exceeded.

meddelande

Namn	Type	Beskrivning	Standard
meddelande	sträng	En läsbar beskrivning av felet.

Egenskaper för incomplete_details

orsak

Namn	Type	Beskrivning	Standard
orsak	sträng	Anledningen till att körningen är ofullständig. Detta pekar på vilken specifik tokengräns som uppnåddes under körningen.

object Enum: runObjectType

Värde	beskrivning
thread.run	Körningsobjekttypen som alltid är thread.run

status Enum: RunObjectStatus

Värde	beskrivning
Kö	Det köade tillståndet
in_progress	Tillståndet in_progress
requires_action	Tillståndet required_action
Avbryta	Avbrutet tillstånd
Annullerat	Det avbrutna tillståndet
Misslyckades	Det misslyckade tillståndet
slutfört	Det slutförda tillståndet
Löpt ut	Tillståndet har upphört att gälla

createRunRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
assistant_id	sträng	ID:t för assistenten som ska användas för att köra den här körningen.	Ja
modell	sträng	Distributions-ID för modellen som ska användas för att köra den här körningen. Om ett värde anges här åsidosätter det modellen som är associerad med assistenten. Om inte används modellen som är associerad med assistenten.	Nej
instruktioner	sträng	Åsidosätt standardsystemmeddelandet för assistenten. Detta är användbart för att ändra beteendet per körning.	Nej
additional_instructions	sträng	Lägger till ytterligare instruktioner i slutet av instruktionerna för körningen. Detta är användbart för att ändra beteendet per körning utan att åsidosätta andra instruktioner.	Nej
additional_messages	matris	Lägger till ytterligare meddelanden i tråden innan körningen skapas.	Nej
verktyg	matris	Åsidosätt de verktyg som assistenten kan använda för den här körningen. Detta är användbart för att ändra beteendet per körning.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej
temperatur	Nummer	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.	Nej	1
top_p	Nummer	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 den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperatur men inte båda.	Nej	1
ström	boolean	Om truereturnerar returnerar en ström av händelser som inträffar under händelser som skickas av servern och avslutas när Körningen går in i ett terminaltillstånd med ett data: [DONE] meddelande.	Nej
max_prompt_tokens	integer	Det maximala antalet prompttoken som kan användas under körningen. Körningen gör ett bästa försök att endast använda antalet angivna prompttoken över flera varv av körningen. Om körningen överskrider antalet angivna prompttoken avslutas körningen med statusen incomplete. Mer incomplete_details information finns i.	Nej
max_completion_tokens	integer	Det maximala antalet slutförandetoken som kan användas under körningen. Körningen gör ett bra försök att endast använda antalet angivna slutförandetoken över flera varv av körningen. Om körningen överskrider det angivna antalet slutförandetoken avslutas körningen med statusen incomplete. Mer incomplete_details information finns i.	Nej
truncation_strategy	truncationObject	Kontroller för hur en tråd trunkeras före körningen. Använd det här alternativet om du vill styra körningens inledande kontextfönster.	Nej
tool_choice	assistantsApiToolChoiceOption	Styr vilket (om något) verktyg som anropas av modellen. none innebär att modellen inte anropar några verktyg och i stället genererar ett meddelande. auto är standardvärdet och innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett verktyg. Om du anger ett visst verktyg som {"type": "file_search"} eller {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa verktyget.	Nej
parallel_tool_calls	ParallelToolCalls	Om du vill aktivera parallell funktionsanrop under verktygsanvändning.	Nej	Sann
response_format	assistantsApiResponseFormatOption	Anger det format som modellen måste mata ut. Kompatibel med GPT-4 Turbo och alla GPT-3.5 Turbo modeller sedan gpt-3.5-turbo-1106. 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.	Nej

listRunsResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
objekt	sträng		Ja
data	matris		Ja
first_id	sträng		Ja
last_id	sträng		Ja
has_more	boolean		Ja

modifyRunRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej

submitToolOutputsRunRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
tool_outputs	matris	En lista över verktyg som utdata skickas för.	Ja
ström	boolean	Om truereturnerar returnerar en ström av händelser som inträffar under händelser som skickas av servern och avslutas när Körningen går in i ett terminaltillstånd med ett data: [DONE] meddelande.	Nej

runToolCallObject

Verktygsanropsobjekt

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	ID:t för verktygsanropet. Det här ID:t måste refereras när du skickar utdata från verktyget med hjälp av utdata från verktyget Skicka för att köra slutpunkten.	Ja
type	sträng	Typ av verktygsanrop som utdata krävs för. För tillfället är detta alltid function.	Ja
function	objekt	Funktionsdefinitionen.	Ja

Egenskaper för funktionen

name

Namn	Type	Beskrivning	Standard
name	sträng	Namnet på funktionen.

Argument

Namn	Type	Beskrivning	Standard
Argument	sträng	Argumenten som modellen förväntar sig att du skickar till funktionen.

typ Uppräkning: RunToolCallObjectType

Värde	beskrivning
function

createThreadAndRunRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
assistant_id	sträng	ID:t för assistenten som ska användas för att köra den här körningen.	Ja
tråd	createThreadRequest		Nej
modell	sträng	Distributionsnamnet för den modell som ska användas för att köra den här körningen. Om ett värde anges här åsidosätter det modellen som är associerad med assistenten. Om inte används modellen som är associerad med assistenten.	Nej
instruktioner	sträng	Åsidosätt standardsystemmeddelandet för assistenten. Detta är användbart för att ändra beteendet per körning.	Nej
verktyg	matris	Åsidosätt de verktyg som assistenten kan använda för den här körningen. Detta är användbart för att ändra beteendet per körning.	Nej
tool_resources	objekt	En uppsättning resurser som används av assistentens verktyg. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej
temperatur	Nummer	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.	Nej	1
top_p	Nummer	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 den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperatur men inte båda.	Nej	1
ström	boolean	Om truereturnerar returnerar en ström av händelser som inträffar under händelser som skickas av servern och avslutas när Körningen går in i ett terminaltillstånd med ett data: [DONE] meddelande.	Nej
stream_options	chatCompletionStreamOptions	Alternativ för strömningssvar. Ange endast detta när du anger stream: true.	Nej	Ingen
max_prompt_tokens	integer	Det maximala antalet prompttoken som kan användas under körningen. Körningen gör ett bästa försök att endast använda antalet angivna prompttoken över flera varv av körningen. Om körningen överskrider antalet angivna prompttoken avslutas körningen med statusen incomplete. Mer incomplete_details information finns i.	Nej
max_completion_tokens	integer	Det maximala antalet slutförandetoken som kan användas under körningen. Körningen gör ett bra försök att endast använda antalet angivna slutförandetoken över flera varv av körningen. Om körningen överskrider det angivna antalet slutförandetoken avslutas körningen med statusen incomplete. Mer incomplete_details information finns i.	Nej
truncation_strategy	truncationObject	Kontroller för hur en tråd trunkeras före körningen. Använd det här alternativet om du vill styra körningens inledande kontextfönster.	Nej
tool_choice	assistantsApiToolChoiceOption	Styr vilket (om något) verktyg som anropas av modellen. none innebär att modellen inte anropar några verktyg och i stället genererar ett meddelande. auto är standardvärdet och innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett verktyg. Om du anger ett visst verktyg som {"type": "file_search"} eller {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa verktyget.	Nej
parallel_tool_calls	ParallelToolCalls	Om du vill aktivera parallell funktionsanrop under verktygsanvändning.	Nej	Sann
response_format	assistantsApiResponseFormatOption	Anger det format som modellen måste mata ut. Kompatibel med GPT-4 Turbo och alla GPT-3.5 Turbo modeller sedan gpt-3.5-turbo-1106. 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.	Nej

Egenskaper för tool_resources

code_interpreter

Namn	Type	Beskrivning	Standard
file_ids	matris	En lista över fil-ID:t som gjorts tillgängliga för code_interpreter verktyget. Det kan finnas högst 20 filer som är associerade med verktyget.	[]

file_search

Namn	Type	Beskrivning	Standard
vector_store_ids	matris	ID:t för vektorarkivet som är kopplat till den här assistenten. Det kan finnas högst 1 vektorlager kopplat till assistenten.

threadObject

Representerar en tråd som innehåller meddelanden.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	Identifieraren, som kan refereras till i API-slutpunkter.	Ja
objekt	sträng	Objekttypen, som alltid threadär .	Ja
created_at	integer	Unix-tidsstämpeln (i sekunder) för när tråden skapades.	Ja
tool_resources	objekt	En uppsättning resurser som görs tillgängliga för assistentens verktyg i den här tråden. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.	Ja
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Ja

Egenskaper för tool_resources

code_interpreter

Namn	Type	Beskrivning	Standard
file_ids	matris	En lista över fil-ID:t som gjorts tillgängliga för code_interpreter verktyget. Det kan finnas högst 20 filer som är associerade med verktyget.	[]

file_search

Namn	Type	Beskrivning	Standard
vector_store_ids	matris	Vektorarkivet som är kopplat till den här tråden. Det kan finnas högst 1 vektorlager kopplat till tråden.

object Enum: ThreadObjectType

Värde	beskrivning
tråd	Typen av trådobjekt som alltid är thread

createThreadRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
meddelanden	matris	En lista över meddelanden att starta tråden med.	Nej
tool_resources	objekt	En uppsättning resurser som görs tillgängliga för assistentens verktyg i den här tråden. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej

Egenskaper för tool_resources

code_interpreter

Namn	Type	Beskrivning	Standard
file_ids	matris	En lista över fil-ID:t som gjorts tillgängliga för code_interpreter verktyget. Det kan finnas högst 20 filer som är associerade med verktyget.	[]

file_search

Namn	Type	Beskrivning	Standard
vector_store_ids	matris	Vektorarkivet som är kopplat till den här tråden. Det kan finnas högst 1 vektorlager kopplat till tråden.
vector_stores	matris	En hjälp för att skapa ett vektorlager med file_ids och koppla det till den här tråden. Det kan finnas högst 1 vektorlager kopplat till tråden.

modifyThreadRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
tool_resources	objekt	En uppsättning resurser som görs tillgängliga för assistentens verktyg i den här tråden. Resurserna är specifika för typen av verktyg. Verktyget kräver till exempel code_interpreter en lista över fil-ID:t, medan file_search verktyget kräver en lista över vektorarkiv-ID:t.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej

Egenskaper för tool_resources

code_interpreter

Namn	Type	Beskrivning	Standard
file_ids	matris	En lista över fil-ID:t som gjorts tillgängliga för code_interpreter verktyget. Det kan finnas högst 20 filer som är associerade med verktyget.	[]

file_search

Namn	Type	Beskrivning	Standard
vector_store_ids	matris	Vektorarkivet som är kopplat till den här tråden. Det kan finnas högst 1 vektorlager kopplat till tråden.

deleteThreadResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	string		Ja
borttaget	boolean		Ja
objekt	sträng		Ja

object Enum: DeleteThreadResponseObjectState

Värde	beskrivning
thread.deleted	Status för att ta bort trådsvarsobjekt som är thread.deleted

listThreadsResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
objekt	sträng		Ja
data	matris		Ja
first_id	sträng		Ja
last_id	sträng		Ja
has_more	boolean		Ja

messageObject

Representerar ett meddelande i en tråd.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	Identifieraren, som kan refereras till i API-slutpunkter.	Ja
objekt	sträng	Objekttypen, som alltid thread.messageär .	Ja
created_at	integer	Unix-tidsstämpeln (i sekunder) för när meddelandet skapades.	Ja
thread_id	sträng	det tråd-ID som det här meddelandet tillhör.	Ja
status	sträng	Status för meddelandet, som kan vara antingen in_progress, incompleteeller completed.	Ja
incomplete_details	objekt	Information om varför meddelandet är ofullständigt finns i ett ofullständigt meddelande.	Ja
completed_at	integer	Unix-tidsstämpeln (i sekunder) för när meddelandet slutfördes.	Ja
incomplete_at	integer	Unix-tidsstämpeln (i sekunder) för när meddelandet har markerats som ofullständigt.	Ja
roll	sträng	Entiteten som skapade meddelandet. En av user eller assistant.	Ja
innehåll	matris	Innehållet i meddelandet i matrisen med text och/eller bilder.	Ja
assistant_id	sträng	Om tillämpligt, ID:t för assistenten som skapade det här meddelandet.	Ja
run_id	sträng	Om tillämpligt, ID:t för körningen som är associerad med redigeringen av det här meddelandet.	Ja
Bilagor	matris	En lista över filer som är kopplade till meddelandet och de verktyg som de har lagts till i.	Ja
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Ja

Egenskaper för incomplete_details

orsak

Namn	Type	Beskrivning	Standard
orsak	sträng	Anledningen till att meddelandet är ofullständigt.

object Enum: MessageObjectType

Värde	beskrivning
thread.message	Meddelandeobjekttypen som är thread.message

status Uppräkning: MessageObjectStatus

Värde	beskrivning
in_progress
ofullständig
slutfört

rolluppräkning: MessageObjectRole

Värde	beskrivning
användare
assistent

messageDeltaObject

Representerar ett meddelandedelta, d.v.s. ändrade fält i ett meddelande under strömning.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	Identifieraren för meddelandet, som kan refereras till i API-slutpunkter.	Ja
objekt	sträng	Objekttypen, som alltid thread.message.deltaär .	Ja
delta	objekt	Deltat som innehåller fälten som har ändrats i meddelandet.	Ja

Egenskaper för delta

roll

Namn	Type	Beskrivning	Standard
roll	sträng	Entiteten som skapade meddelandet. En av user eller assistant.

innehåll

Namn	Type	Beskrivning	Standard
innehåll	matris	Innehållet i meddelandet i matrisen med text och/eller bilder.

object Enum: MessageDeltaObjectType

Värde	beskrivning
thread.message.delta

createMessageRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
roll	sträng	Rollen för den entitet som skapar meddelandet. Tillåtna värden är: - user: Anger att meddelandet skickas av en faktisk användare och bör i de flesta fall användas för att representera användargenererade meddelanden. - assistant: Anger att meddelandet genereras av assistenten. Använd det här värdet för att infoga meddelanden från assistenten i konversationen.	Ja
innehåll	sträng	Innehållet i meddelandet.	Ja
Bilagor	matris	En lista över filer som är kopplade till meddelandet och de verktyg som de ska läggas till i.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej

rolluppräkning: CreateMessageRequestRole

Värde	beskrivning
användare
assistent

modifyMessageRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej

deleteMessageResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	string		Ja
borttaget	boolean		Ja
objekt	sträng		Ja

object Enum: DeleteMessageResponseObject

Värde	beskrivning
thread.message.deleted	Status för borttagning av meddelandesvarsobjekt

listMessagesResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
objekt	sträng		Ja
data	matris		Ja
first_id	sträng		Ja
last_id	sträng		Ja
has_more	boolean		Ja

messageContentImageFileObject

Refererar till en bildfil i innehållet i ett meddelande.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Alltid image_file.	Ja
image_file	objekt		Ja

Egenskaper för image_file

file_id

Namn	Type	Beskrivning	Standard
file_id	sträng	Fil-ID för bilden i meddelandeinnehållet.

typ Uppräkning: MessageContentImageFileObjectType

Värde	beskrivning
image_file	Filtypen för meddelandeinnehållsbild

messageContentTextObject

Textinnehållet som ingår i ett meddelande.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Alltid text.	Ja
text	objekt		Ja

Egenskaper för text

värde

Namn	Type	Beskrivning	Standard
värde	sträng	De data som utgör texten.

Anteckningar

Namn	Type	Beskrivning	Standard
Anteckningar	matris

type Enum: messageContentTextObjectType

Värde	beskrivning
text	Objekttyp för meddelandeinnehållstext

messageContentTextAnnotationsFileCitationObject

Ett citat i meddelandet som pekar på ett specifikt citat från en specifik fil som är associerad med assistenten eller meddelandet. Genereras när assistenten använder verktyget "hämtning" för att söka i filer.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Alltid file_citation.	Ja
text	sträng	Texten i meddelandeinnehållet som måste ersättas.	Ja
file_citation	objekt		Ja
start_index	integer		Ja
end_index	integer		Ja

Egenskaper för file_citation

file_id

Namn	Type	Beskrivning	Standard
file_id	sträng	ID:t för den specifika fil som källhänvisning kommer från.

typ Uppräkning: FileCitationObjectType

Värde	beskrivning
file_citation	Filcitationsobjekttypen

messageContentTextAnnotationsFilePathObject

En URL för filen som genereras när assistenten code_interpreter använde verktyget för att generera en fil.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Alltid file_path.	Ja
text	sträng	Texten i meddelandeinnehållet som måste ersättas.	Ja
file_path	objekt		Ja
start_index	integer		Ja
end_index	integer		Ja

Egenskaper för file_path

file_id

Namn	Type	Beskrivning	Standard
file_id	sträng	ID:t för filen som genererades.

typ Uppräkning: FilePathObjectType

Värde	beskrivning
file_path	Filsökvägsobjekttypen

messageDeltaContentImageFileObject

Refererar till en bildfil i innehållet i ett meddelande.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
index	integer	Indexet för innehållsdelen i meddelandet.	Ja
type	sträng	Alltid image_file.	Ja
image_file	objekt		Nej

Egenskaper för image_file

file_id

Namn	Type	Beskrivning	Standard
file_id	sträng	Fil-ID för bilden i meddelandeinnehållet.

typ Uppräkning: MessageDeltaContentImageFileObjectType

Värde	beskrivning
image_file

messageDeltaContentTextObject

Textinnehållet som ingår i ett meddelande.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
index	integer	Indexet för innehållsdelen i meddelandet.	Ja
type	sträng	Alltid text.	Ja
text	objekt		Nej

Egenskaper för text

värde

Namn	Type	Beskrivning	Standard
värde	sträng	De data som utgör texten.

Anteckningar

Namn	Type	Beskrivning	Standard
Anteckningar	matris

typ Uppräkning: MessageDeltaContentTextObjectType

Värde	beskrivning
text

messageDeltaContentTextAnnotationsFileCitationObject

Ett citat i meddelandet som pekar på ett specifikt citat från en specifik fil som är associerad med assistenten eller meddelandet. Genereras när assistenten använder verktyget "file_search" för att söka i filer.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
index	integer	Indexet för anteckningen i textinnehållsdelen.	Ja
type	sträng	Alltid file_citation.	Ja
text	sträng	Texten i meddelandeinnehållet som måste ersättas.	Nej
file_citation	objekt		Nej
start_index	integer		Nej
end_index	integer		Nej

Egenskaper för file_citation

file_id

Namn	Type	Beskrivning	Standard
file_id	sträng	ID:t för den specifika fil som källhänvisning kommer från.

citera

Namn	Type	Beskrivning	Standard
citera	sträng	Det specifika citatet i filen.

typ Uppräkning: MessageDeltaContentTextAnnotationsFileCitationObjectType

Värde	beskrivning
file_citation

messageDeltaContentTextAnnotationsFilePathObject

En URL för filen som genereras när assistenten code_interpreter använde verktyget för att generera en fil.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
index	integer	Indexet för anteckningen i textinnehållsdelen.	Ja
type	sträng	Alltid file_path.	Ja
text	sträng	Texten i meddelandeinnehållet som måste ersättas.	Nej
file_path	objekt		Nej
start_index	integer		Nej
end_index	integer		Nej

Egenskaper för file_path

file_id

Namn	Type	Beskrivning	Standard
file_id	sträng	ID:t för filen som genererades.

type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

Värde	beskrivning
file_path

runStepObject

Representerar ett steg i körningen av en körning.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	Identifieraren för körningssteget, som kan refereras till i API-slutpunkter.	Ja
objekt	sträng	Objekttypen, som alltid assistant.run.stepär .	Ja
created_at	integer	Unix-tidsstämpeln (i sekunder) för när körningssteget skapades.	Ja
assistant_id	sträng	ID:t för assistenten som är associerad med körningssteget.	Ja
thread_id	sträng	ID:t för tråden som kördes.	Ja
run_id	sträng	ID:t för körningen som det här körningssteget är en del av.	Ja
type	sträng	Typen av körningssteg, som kan vara antingen message_creation eller tool_calls.	Ja
status	sträng	Status för körningen, som kan vara antingen in_progress, cancelled, failed, completedeller expired.	Ja
step_details	runStepDetailsMessageCreationObject eller runStepDetailsToolCallsObject	Information om körningssteget.	Ja
last_error	objekt	Det sista felet som är associerat med det här körningssteget. Kommer att vara null om det inte finns några fel.	Ja
expired_at	integer	Unix-tidsstämpeln (i sekunder) för när körningssteget upphörde att gälla. Ett steg anses ha upphört att gälla om den överordnade körningen har upphört att gälla.	Ja
cancelled_at	integer	Unix-tidsstämpeln (i sekunder) för när körningssteget avbröts.	Ja
failed_at	integer	Unix-tidsstämpeln (i sekunder) för när körningssteget misslyckades.	Ja
completed_at	integer	Unix-tidsstämpeln (i sekunder) för när körningssteget slutfördes.	Ja
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Ja

Egenskaper för last_error

kod

Namn	Type	Beskrivning	Standard
kod	sträng	En av server_error eller rate_limit_exceeded.

meddelande

Namn	Type	Beskrivning	Standard
meddelande	sträng	En läsbar beskrivning av felet.

object Enum: RunStepObjectType

Värde	beskrivning
assistant.run.step	Objekttypen, som alltid är assistant.run.step

typ Uppräkning: RunStepObjectType

Värde	beskrivning
message_creation	Steget message_creation körning
tool_calls	Steget tool_calls körning

status Uppräkning: RunStepObjectStatus

Värde	beskrivning
in_progress	Körningsstatus för in_progress
Annullerat	Status för avbruten körning
Misslyckades	Status för avbruten körning
slutfört	Status för avbruten körning
Löpt ut	Status för avbruten körning

runStepDeltaObject

Representerar ett körningsstegsdelta, d.v.s. ändrade fält i ett körningssteg under strömning.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	Identifieraren för körningssteget, som kan refereras till i API-slutpunkter.	Ja
objekt	sträng	Objekttypen, som alltid thread.run.step.deltaär .	Ja
delta	objekt	Delta som innehåller fälten som har ändrats i körningssteget.	Ja

Egenskaper för delta

step_details

Namn	Type	Beskrivning	Standard
step_details	runStepDeltaStepDetailsMessageCreationObject eller runStepDeltaStepDetailsToolCallsObject	Information om körningssteget.

object Enum: RunStepDeltaObjectType

Värde	beskrivning
thread.run.step.delta

listRunStepsResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
objekt	sträng		Ja
data	matris		Ja
first_id	sträng		Ja
last_id	sträng		Ja
has_more	boolean		Ja

runStepDetailsMessageCreationObject

Information om hur meddelandet skapas i körningssteget.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Alltid message_creation.	Ja
message_creation	objekt		Ja

Egenskaper för message_creation

message_id

Namn	Type	Beskrivning	Standard
message_id	sträng	ID:t för meddelandet som skapades av det här körningssteget.

typ Uppräkning: RunStepDetailsMessageCreationObjectType

Värde	beskrivning
message_creation

runStepDeltaStepDetailsMessageCreationObject

Information om hur meddelandet skapas i körningssteget.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Alltid message_creation.	Ja
message_creation	objekt		Nej

Egenskaper för message_creation

message_id

Namn	Type	Beskrivning	Standard
message_id	sträng	ID:t för meddelandet som skapades av det här körningssteget.

typ Uppräkning: RunStepDeltaStepDetailsMessageCreationObjectType

Värde	beskrivning
message_creation

runStepDetailsToolCallsObject

Information om verktygsanropet.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Alltid tool_calls.	Ja
tool_calls	matris	En matris med verktyg anropar körningssteget. Dessa kan associeras med någon av tre typer av verktyg: code_interpreter, retrieval eller function.	Ja

typ Uppräkning: RunStepDetailsToolCallsObjectType

Värde	beskrivning
tool_calls

runStepDeltaStepDetailsToolCallsObject

Information om verktygsanropet.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Alltid tool_calls.	Ja
tool_calls	matris	En matris med verktyg anropar körningssteget. Dessa kan associeras med någon av tre typer av verktyg: code_interpreter, file_search eller function.	Nej

typ Uppräkning: RunStepDeltaStepDetailsToolCallsObjectType

Värde	beskrivning
tool_calls

runStepDetailsToolCallsCodeObject

Information om kodtolkarverktyget anropar körningssteget.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	ID:t för verktygsanropet.	Ja
type	sträng	Typ av verktygsanrop. Detta kommer alltid att vara code_interpreter för den här typen av verktygsanrop.	Ja
code_interpreter	objekt	Kodtolkarverktygets anropsdefinition.	Ja

Egenskaper för code_interpreter

indata

Namn	Type	Beskrivning	Standard
indata	sträng	Indata till kodtolkarverktygets anrop.

Utgångar

Namn	Type	Beskrivning	Standard
Utgångar	matris	Utdata från kodtolkverktygets anrop. Kodtolkare kan mata ut ett eller flera objekt, inklusive text (logs) eller bilder (image). Var och en av dessa representeras av en annan objekttyp.

typ Uppräkning: RunStepDetailsToolCallsCodeObjectType

Värde	beskrivning
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

Information om kodtolkarverktyget anropar körningssteget.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
index	integer	Indexet för verktygsanropet i verktyget anropar matrisen.	Ja
id	sträng	ID:t för verktygsanropet.	Nej
type	sträng	Typ av verktygsanrop. Detta kommer alltid att vara code_interpreter för den här typen av verktygsanrop.	Ja
code_interpreter	objekt	Kodtolkarverktygets anropsdefinition.	Nej

Egenskaper för code_interpreter

indata

Namn	Type	Beskrivning	Standard
indata	sträng	Indata till kodtolkarverktygets anrop.

Utgångar

Namn	Type	Beskrivning	Standard
Utgångar	matris	Utdata från kodtolkverktygets anrop. Kodtolkare kan mata ut ett eller flera objekt, inklusive text (logs) eller bilder (image). Var och en av dessa representeras av en annan objekttyp.

typ Uppräkning: RunStepDeltaStepDetailsToolCallsCodeObjectType

Värde	beskrivning
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

Textutdata från kodtolkverktyget anropar som en del av ett körningssteg.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Alltid logs.	Ja
loggar	sträng	Textutdata från kodtolkverktyget anropar.	Ja

typ Uppräkning: RunStepDetailsToolCallsCodeOutputLogsObjectType

Värde	beskrivning
loggar

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

Textutdata från kodtolkverktyget anropar som en del av ett körningssteg.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
index	integer	Indexet för utdata i utdatamatrisen.	Ja
type	sträng	Alltid logs.	Ja
loggar	sträng	Textutdata från kodtolkverktyget anropar.	Nej

typ Uppräkning: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

Värde	beskrivning
loggar

runStepDetailsToolCallsCodeOutputImageObject

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Alltid image.	Ja
bild	objekt		Ja

Egenskaper för avbildning

file_id

Namn	Type	Beskrivning	Standard
file_id	sträng	Bildens fil-ID.

typ Uppräkning: RunStepDetailsToolCallsCodeOutputImageObjectType

Värde	beskrivning
bild

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
index	integer	Indexet för utdata i utdatamatrisen.	Ja
type	sträng	Alltid image.	Ja
bild	objekt		Nej

Egenskaper för avbildning

file_id

Namn	Type	Beskrivning	Standard
file_id	sträng	Bildens fil-ID.

typ Uppräkning: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

Värde	beskrivning
bild

runStepDetailsToolCallsFileSearchObject

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	ID:t för verktyget anropar objektet.	Ja
type	sträng	Typ av verktygsanrop. Detta kommer alltid att vara file_search för den här typen av verktygsanrop.	Ja
file_search	objekt	För tillfället kommer detta alltid att vara ett tomt objekt.	Ja

typ Uppräkning: RunStepDetailsToolCallsFileSearchObjectType

Värde	beskrivning
file_search

runStepDeltaStepDetailsToolCallsFileSearchObject

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
index	integer	Indexet för verktygsanropet i verktyget anropar matrisen.	Ja
id	sträng	ID:t för verktyget anropar objektet.	Nej
type	sträng	Typ av verktygsanrop. Detta kommer alltid att vara retrieval för den här typen av verktygsanrop.	Ja
file_search	objekt	För tillfället kommer detta alltid att vara ett tomt objekt.	Ja

typ Uppräkning: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Värde	beskrivning
file_search

runStepDetailsToolCallsFunctionObject

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	ID:t för verktyget anropar objektet.	Ja
type	sträng	Typ av verktygsanrop. Detta kommer alltid att vara function för den här typen av verktygsanrop.	Ja
function	objekt	Definitionen av funktionen som anropades.	Ja

Egenskaper för funktionen

name

Namn	Type	Beskrivning	Standard
name	sträng	Namnet på funktionen.

Argument

Namn	Type	Beskrivning	Standard
Argument	sträng	Argumenten som skickas till funktionen.

utdata

Namn	Type	Beskrivning	Standard
utdata	sträng	Funktionens utdata. Detta är null om utdata inte har skickats ännu.

typ Uppräkning: RunStepDetailsToolCallsFunctionObjectType

Värde	beskrivning
function

runStepDeltaStepDetailsToolCallsFunctionObject

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
index	integer	Indexet för verktygsanropet i verktyget anropar matrisen.	Ja
id	sträng	ID:t för verktyget anropar objektet.	Nej
type	sträng	Typ av verktygsanrop. Detta kommer alltid att vara function för den här typen av verktygsanrop.	Ja
function	objekt	Definitionen av funktionen som anropades.	Nej

Egenskaper för funktionen

name

Namn	Type	Beskrivning	Standard
name	sträng	Namnet på funktionen.

Argument

Namn	Type	Beskrivning	Standard
Argument	sträng	Argumenten som skickas till funktionen.

utdata

Namn	Type	Beskrivning	Standard
utdata	sträng	Funktionens utdata. Detta är null om utdata inte har skickats ännu.

typ Uppräkning: RunStepDetailsToolCallsFunctionObjectType

Värde	beskrivning
function

vectorStoreExpirationAfter

Förfalloprincipen för ett vektorlager.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
ankare	sträng	Tidsstämpel för fästpunkt varefter förfalloprincipen gäller. Fästpunkter som stöds: last_active_at.	Ja
dagar	integer	Antalet dagar efter ankartiden som vektorlagret upphör att gälla.	Ja

anchor Enum: VectorStoreExpirationAfterAnchor

Värde	beskrivning
last_active_at	Tidsstämpeln för fästpunkten varefter förfalloprincipen gäller.

vectorStoreObject

Ett vektorlager är en samling bearbetade filer som kan användas av file_search verktyget.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	Identifieraren, som kan refereras till i API-slutpunkter.	Ja
objekt	uppräkning	Objekttypen, som alltid vector_storeär . Möjliga värden: vector_store	Ja
created_at	integer	Unix-tidsstämpeln (i sekunder) för när vektorlagret skapades.	Ja
namn	sträng	Namnet på vektorarkivet.	Ja
usage_bytes	integer	Det totala antalet byte som används av filerna i vektorarkivet.	Ja
file_counts	objekt		Ja
status	sträng	Status för vektorlagret, som kan vara antingen expired, in_progresseller completed. completed Statusen anger att vektorlagret är redo att användas.	Ja
expires_after	vectorStoreExpirationAfter	Förfalloprincipen för ett vektorlager.	Nej
expires_at	integer	Unix-tidsstämpeln (i sekunder) för när vektorlagret upphör att gälla.	Nej
last_active_at	integer	Unix-tidsstämpeln (i sekunder) för när vektorlagret senast var aktivt.	Ja
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Ja

Egenskaper för file_counts

in_progress

Namn	Type	Beskrivning	Standard
in_progress	integer	Antalet filer som bearbetas för närvarande.

slutfört

Namn	Type	Beskrivning	Standard
slutfört	integer	Antalet filer som har bearbetats.

Misslyckades

Namn	Type	Beskrivning	Standard
Misslyckades	integer	Antalet filer som inte har bearbetats.

Annullerat

Namn	Type	Beskrivning	Standard
Annullerat	integer	Antalet filer som avbröts.

summa

Namn	Type	Beskrivning	Standard
summa	integer	Det totala antalet filer.

status Enum: VectorStoreObjectStatus

Värde	beskrivning
Löpt ut
in_progress
slutfört

createVectorStoreRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
file_ids	matris	En lista över fil-ID:t som vektorarkivet ska använda. Användbart för verktyg som file_search dessa kan komma åt filer.	Nej
name	sträng	Namnet på vektorarkivet.	Nej
expires_after	vectorStoreExpirationAfter	Förfalloprincipen för ett vektorlager.	Nej
chunking_strategy	autoChunkingStrategyRequestParam eller staticChunkingStrategyRequestParam	Segmenteringsstrategin som används för att segmentera filen eller filerna. Om den inte har angetts använder du auto strategin. Gäller endast om file_ids är icke-lydigt.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej

updateVectorStoreRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
name	sträng	Namnet på vektorarkivet.	Nej
expires_after	vectorStoreExpirationAfter	Förfalloprincipen för ett vektorlager.	Nej
metadata	objekt	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara högst 64 tecken långa och värden kan vara högst 512 tecken långa.	Nej

listVectorStoresResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
objekt	sträng		Ja
data	matris		Ja
first_id	sträng		Ja
last_id	sträng		Ja
has_more	boolean		Ja

deleteVectorStoreResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	string		Ja
borttaget	boolean		Ja
objekt	sträng		Ja

object Enum: DeleteVectorStoreResponseObject

Värde	beskrivning
vector_store.deleted	Borttagningsvektorarkivets svarsobjekttillstånd

vectorStoreFileObject

En lista över filer som är kopplade till ett vektorarkiv.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	Identifieraren, som kan refereras till i API-slutpunkter.	Ja
objekt	sträng	Objekttypen, som alltid vector_store.fileär .	Ja
usage_bytes	integer	Den totala vektorlagringsanvändningen i byte. Observera att detta kan skilja sig från den ursprungliga filstorleken.	Ja
created_at	integer	Unix-tidsstämpeln (i sekunder) för när vektorlagringsfilen skapades.	Ja
vector_store_id	sträng	ID:t för vektorarkivet som filen är kopplad till.	Ja
status	sträng	Status för vektorlagringsfilen, som kan vara antingen in_progress, completed, cancelledeller failed. Statusen completed anger att vektorlagringsfilen är klar för användning.	Ja
last_error	objekt	Det sista felet som är associerat med den här vektorlagringsfilen. Kommer att vara null om det inte finns några fel.	Ja
chunking_strategy	autoChunkingStrategyRequestParam eller staticChunkingStrategyRequestParam	Segmenteringsstrategin som används för att segmentera filen eller filerna. Om den inte har angetts använder du auto strategin. Gäller endast om file_ids är icke-lydigt.	Nej

Egenskaper för last_error

kod

Namn	Type	Beskrivning	Standard
kod	sträng	En av server_error eller rate_limit_exceeded.

meddelande

Namn	Type	Beskrivning	Standard
meddelande	sträng	En läsbar beskrivning av felet.

object Enum: VectorStoreFileObjectType

Värde	beskrivning
vector_store.file

status Enum: VectorStoreFileObjectStatus

Värde	beskrivning
in_progress
slutfört
Annullerat
Misslyckades

otherChunkingStrategyResponseParam

Detta returneras när segmenteringsstrategin är okänd. Det beror vanligtvis på att filen indexerades innan chunking_strategy konceptet introducerades i API:et.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Alltid other.	Ja

typ Uppräkning: OtherChunkingStrategyResponseParamType

Värde	beskrivning
other

staticChunkingStrategyResponseParam

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	sträng	Alltid static.	Ja
static	staticChunkingStrategy		Ja

typ Uppräkning: StaticChunkingStrategyResponseParamType

Värde	beskrivning
static

staticChunkingStrategy

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
max_chunk_size_tokens	integer	Det maximala antalet token i varje segment. Standardvärdet är 800. Det minsta värdet är 100 och det maximala värdet är 4096.	Ja
chunk_overlap_tokens	integer	Antalet token som överlappar mellan segment. Standardvärdet är 400. Observera att överlappningen inte får överstiga hälften av max_chunk_size_tokens.	Ja

autoChunkingStrategyRequestParam

Standardstrategin. Den här strategin använder för närvarande en max_chunk_size_tokens av 800 och chunk_overlap_tokens av 400.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	uppräkning	Alltid auto. Möjliga värden: automatiskt	Ja

staticChunkingStrategyRequestParam

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
type	uppräkning	Alltid static. Möjliga värden: statisk	Ja
static	staticChunkingStrategy		Ja

chunkingStrategyRequestParam

Segmenteringsstrategin som används för att segmentera filen eller filerna. Om den inte har angetts använder du auto strategin.

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

createVectorStoreFileRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
file_id	sträng	Ett fil-ID som vektorarkivet ska använda. Användbart för verktyg som file_search dessa kan komma åt filer.	Ja
chunking_strategy	chunkingStrategyRequestParam	Segmenteringsstrategin som används för att segmentera filen eller filerna. Om den inte har angetts använder du auto strategin.	Nej

listVectorStoreFilesResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
objekt	sträng		Ja
data	matris		Ja
first_id	sträng		Ja
last_id	sträng		Ja
has_more	boolean		Ja

deleteVectorStoreFileResponse

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	string		Ja
borttaget	boolean		Ja
objekt	sträng		Ja

object Enum: DeleteVectorStoreFileResponseObject

Värde	beskrivning
vector_store.file.deleted

vectorStoreFileBatchObject

En batch med filer som är kopplade till ett vektorlager.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
id	sträng	Identifieraren, som kan refereras till i API-slutpunkter.	Ja
objekt	sträng	Objekttypen, som alltid vector_store.file_batchär .	Ja
created_at	integer	Unix-tidsstämpeln (i sekunder) för när batchen för vektorlagringsfiler skapades.	Ja
vector_store_id	sträng	ID:t för vektorarkivet som filen är kopplad till.	Ja
status	sträng	Status för batchen för vektorlagringsfiler, som kan vara antingen in_progress, completedeller cancelled failed.	Ja
file_counts	objekt		Ja

Egenskaper för file_counts

in_progress

Namn	Type	Beskrivning	Standard
in_progress	integer	Antalet filer som bearbetas för närvarande.

slutfört

Namn	Type	Beskrivning	Standard
slutfört	integer	Antalet filer som har bearbetats.

Misslyckades

Namn	Type	Beskrivning	Standard
Misslyckades	integer	Antalet filer som inte har bearbetats.

Annullerat

Namn	Type	Beskrivning	Standard
Annullerat	integer	Antalet filer som avbröts.

summa

Namn	Type	Beskrivning	Standard
summa	integer	Det totala antalet filer.

object Enum: VectorStoreFileBatchObjectType

Värde	beskrivning
vector_store.files_batch

status Enum: VectorStoreFileBatchObjectStatus

Värde	beskrivning
in_progress
slutfört
Annullerat
Misslyckades

createVectorStoreFileBatchRequest

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
file_ids	matris	En lista över fil-ID:t som vektorarkivet ska använda. Användbart för verktyg som file_search dessa kan komma åt filer.	Ja
chunking_strategy	chunkingStrategyRequestParam	Segmenteringsstrategin som används för att segmentera filen eller filerna. Om den inte har angetts använder du auto strategin.	Nej

assistantStreamEvent

Representerar en händelse som genereras när en Körning strömmas.

Varje händelse i en händelseström som skickas till servern har en event och-egenskap data :

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

Vi genererar händelser när ett nytt objekt skapas, övergår till ett nytt tillstånd eller strömmas i delar (delta). Vi genererar thread.run.created till exempel när en ny körning skapas, thread.run.completed när en körning har slutförts och så vidare. När en assistent väljer att skapa ett meddelande under en körning genererar vi en thread.message.created event, en thread.message.in_progress händelse, många thread.message.delta händelser och slutligen en thread.message.completed händelse.

Vi kan lägga till ytterligare händelser över tid, så vi rekommenderar att du hanterar okända händelser korrekt i koden.

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

threadStreamEvent

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

thread.created

Inträffar när en ny tråd skapas.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	threadObject	Representerar en tråd som innehåller meddelanden.	Ja

Data: threadObject

Händelseuppräkning: ThreadStreamEventEnum

Värde	beskrivning
thread.created	Händelsen som skapades av tråden

---

runStreamEvent

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

thread.run.created

Inträffar när en ny körning skapas.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runObject	Representerar en körningskörning på en tråd.	Ja

Data: runObject

Händelseuppräkning: RunStreamEventSkapad

Värde	beskrivning
thread.run.created

---

thread.run.queued

Inträffar när en körning flyttas till en queued status.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runObject	Representerar en körningskörning på en tråd.	Ja

Data: runObject

Händelseuppräkning: RunStreamEventQueued

Värde	beskrivning
thread.run.queued

---

thread.run.in_progress

Inträffar när en körning flyttas till en in_progress status.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runObject	Representerar en körningskörning på en tråd.	Ja

Data: runObject

Händelseuppräkning: RunStreamEventInProgress

Värde	beskrivning
thread.run.in_progress

---

thread.run.requires_action

Inträffar när en körning flyttas till en requires_action status.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runObject	Representerar en körningskörning på en tråd.	Ja

Data: runObject

Händelseuppräkning: RunStreamEventRequiresAction

Värde	beskrivning
thread.run.requires_action

---

thread.run.completed

Inträffar när en körning har slutförts.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runObject	Representerar en körningskörning på en tråd.	Ja

Data: runObject

Händelseuppräkning: RunStreamEventCompleted

Värde	beskrivning
thread.run.completed

---

thread.run.failed

Inträffar när en körning misslyckas.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runObject	Representerar en körningskörning på en tråd.	Ja

Data: runObject

Händelseuppräkning: RunStreamEventFailed

Värde	beskrivning
thread.run.failed

---

thread.run.cancelling

Inträffar när en körning flyttas till en cancelling status.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runObject	Representerar en körningskörning på en tråd.	Ja

Data: runObject

Händelseuppräkning: RunStreamEventCancelling

Värde	beskrivning
thread.run.cancelling

---

thread.run.cancelled

Inträffar när en körning avbryts.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runObject	Representerar en körningskörning på en tråd.	Ja

Data: runObject

Händelseuppräkning: RunStreamEventCancelled

Värde	beskrivning
thread.run.cancelled

---

thread.run.expired

Inträffar när en körning upphör att gälla.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runObject	Representerar en körningskörning på en tråd.	Ja

Data: runObject

Händelseuppräkning: RunStreamEventExpired

Värde	beskrivning
thread.run.expired

---

runStepStreamEvent

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

thread.run.step.created

Inträffar när ett körningssteg skapas.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runStepObject	Representerar ett steg i körningen av en körning.	Ja

Data: runStepObject

Händelseuppräkning: RunStepStreamEventSkapad

Värde	beskrivning
thread.run.step.created

---

thread.run.step.in_progress

Inträffar när ett körningssteg flyttas till ett in_progress tillstånd.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runStepObject	Representerar ett steg i körningen av en körning.	Ja

Data: runStepObject

Händelseuppräkning: RunStepStreamEventInProgress

Värde	beskrivning
thread.run.step.in_progress

---

thread.run.step.delta

Inträffar när delar av ett körningssteg strömmas.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runStepDeltaObject	Representerar ett körningsstegsdelta, d.v.s. ändrade fält i ett körningssteg under strömning.	Ja

Data: runStepDeltaObject

Händelseuppräkning: RunStepStreamEventDelta

Värde	beskrivning
thread.run.step.delta

---

thread.run.step.completed

Inträffar när ett körningssteg har slutförts.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runStepObject	Representerar ett steg i körningen av en körning.	Ja

Data: runStepObject

Händelseuppräkning: RunStepStreamEventCompleted

Värde	beskrivning
thread.run.step.completed

---

thread.run.step.failed

Inträffar när ett körningssteg misslyckas.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runStepObject	Representerar ett steg i körningen av en körning.	Ja

Data: runStepObject

Händelseuppräkning: RunStepStreamEventFailed

Värde	beskrivning
thread.run.step.failed

---

thread.run.step.cancelled

Inträffar när ett körningssteg avbryts.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runStepObject	Representerar ett steg i körningen av en körning.	Ja

Data: runStepObject

Händelseuppräkning: RunStepStreamEventCancelled

Värde	beskrivning
thread.run.step.cancelled

---

thread.run.step.expired

Inträffar när ett körningssteg upphör att gälla.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	runStepObject	Representerar ett steg i körningen av en körning.	Ja

Data: runStepObject

Händelseuppräkning: RunStepStreamEventExpired

Värde	beskrivning
thread.run.step.expired

---

messageStreamEvent

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

thread.message.created

Inträffar när ett meddelande skapas.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	messageObject	Representerar ett meddelande i en tråd.	Ja

Data: messageObject

Händelseuppräkning: MessageStreamEventSkapad

Värde	beskrivning
thread.message.created

---

thread.message.in_progress

Inträffar när ett meddelande flyttas till ett in_progress tillstånd.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	messageObject	Representerar ett meddelande i en tråd.	Ja

Data: messageObject

Händelseuppräkning: MessageStreamEventInProgress

Värde	beskrivning
thread.message.in_progress

---

thread.message.delta

Inträffar när delar av ett meddelande strömmas.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	messageDeltaObject	Representerar ett meddelandedelta, d.v.s. ändrade fält i ett meddelande under strömning.	Ja

Data: messageDeltaObject

Händelseuppräkning: MessageStreamEventDelta

Värde	beskrivning
thread.message.delta

---

thread.message.completed

Inträffar när ett meddelande har slutförts.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	messageObject	Representerar ett meddelande i en tråd.	Ja

Data: messageObject

Händelseuppräkning: MessageStreamEventCompleted

Värde	beskrivning
thread.message.completed

---

thread.message.incomplete

Inträffar när ett meddelande slutar innan det har slutförts.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	messageObject	Representerar ett meddelande i en tråd.	Ja

Data: messageObject

Händelseuppräkning: MessageStreamEventIncomplete

Värde	beskrivning
thread.message.incomplete

---

errorEvent

Inträffar när ett fel inträffar. Detta kan inträffa på grund av ett internt serverfel eller en tidsgräns.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	fel		Ja

event Enum: ErrorEventEnum

Värde	beskrivning
fel

doneEvent

Inträffar när en ström slutar.

Namn	Type	Beskrivning	Obligatoriskt	Standardvärde
händelse	sträng		Ja
data	sträng		Ja

event Enum: DoneEventEnum

Värde	beskrivning
klar

datauppräkning: DoneEventDataEnum

Värde	beskrivning
[KLAR]

Nästa steg

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