Kommentar
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
Denna artikel ger detaljer om slutpunkterna för REST API för Azure OpenAI.
API specs
Hantering och interaktion med Azure OpenAI-modeller och resurser är uppdelad över tre huvudsakliga API-ytor:
- Control plane
- Dataplan – författarskap
- Dataplan – inferens
Varje API-yta/specifikation kapslar in en annan uppsättning Azure OpenAI-funktioner. Varje API har sin egen unika uppsättning förhandsvisningar och stabila/allmänt tillgängliga (GA) API-releaser. Förhandsvisningar följer för närvarande en månatlig rytm.
Important
Det finns nu ett nytt API för förhandsgranskningsinferens. Läs mer i vår guide för API-livscykeln.
| API | Senaste förhandsvisningen | Senaste GA-utgåvan | Specifications | Description |
|---|---|---|---|---|
| Control plane | 2025-07-01-preview |
2025-06-01 |
Spec files | Kontrollplanets API används för operationer som att skapa resurser, modellutrullning och andra högre nivåuppgifter inom resurshantering. Kontrollplanet styr också vad som är möjligt att göra med funktioner som Azure Resource Manager, Bicep, Terraform och Azure CLI. |
| Data plane | v1 preview |
v1 |
Spec files | Data plane API styr inferens- och författaroperationer. |
Authentication
Azure OpenAI erbjuder två metoder för autentisering. Du kan använda antingen API-nycklar eller Microsoft Entra ID.
API-nyckelautentisering: För denna typ av autentisering måste alla API-förfrågningar inkludera API-nyckeln i
api-keyHTTP-headern. Quickstart ger vägledning för hur man gör samtal med denna typ av autentisering.Microsoft Entra ID autentisering: Du kan autentisera ett API-anrop med en Microsoft Entra-token. Autentiseringstoken ingår i en förfrågan som
Authorizationheader. Den givna token måste föregås avBearer, till exempelBearer YOUR_AUTH_TOKEN. Du kan läsa vår guide om autentisera med Microsoft Entra ID.
REST API-versionshantering
Tjänste-API:erna versioneras med hjälp av frågeparametern api-version . Alla versioner följer YYYY-MM-DD datumstrukturen. For example:
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01
Dataplansinferens
Resten av artikeln täcker 2025-04-01-preview förhandsversionen av Azure OpenAI dataplansinferensspecifikation.
Om du letar efter dokumentation om den senaste GA API-releasen, se det senaste GA data plane inference API
Kompletteringar - Skapa
POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview
Skapar en komplettering för den tillhandahållna prompten, parametrarna och den valda modellen.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| deployment-id | path | Yes | string | |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| best_of | integer | Genererar best_of fullbordanden serversidan och returnerar "bäst" (den med högst loggsannolikhet per token). Resultaten kan inte strömmas.När den används med nstyr best_of den antalet kandidatkompletteringar och n specificerar hur många som ska returneras ââìâ“ best_of måste vara större än n.Notera: Eftersom denna parameter genererar många kompletteringar kan den snabbt förbruka din tokenkvot. Använd noggrant och se till att du har rimliga inställningar för max_tokens och stop. |
No | 1 |
| echo | boolean | Echo tillbaka prompten utöver slutförandet | No | False |
| frequency_penalty | number | Siffran mellan -2,0 och 2,0. Positiva värden straffar nya tokens baserat på deras befintliga frekvens i texten hittills, vilket minskar modellens sannolikhet att upprepa samma rad ordagrant. | No | 0 |
| logit_bias | object | Ändra sannolikheten för att specificerade tokens ska dyka upp i slutförandet. Accepterar ett JSON-objekt som mappar tokens (specificerade av deras token-ID i GPT-tokenizern) till ett associerat biasvärde från -100 till 100. Matematiskt läggs biasen till de logits som genereras av modellen före urvalet. Den exakta effekten varierar mellan modellen, men värden mellan -1 och 1 bör minska eller öka sannolikheten för urval; Värden som -100 eller 100 bör leda till avstängning eller exklusivt val av relevant token. Som exempel kan du passa {"50256": -100} för att förhindra <att |endoftext|> token genereras. |
No | None |
| logprobs | integer | Inkludera logsannolikheterna på de logprobs mest sannolika utdatatokenen, samt de valda tokens. Till exempel, om logprobs är 5, returnerar API:et en lista över de 5 mest sannolika tokens. API:et returnerar alltid den logprob samplade token, så det kan finnas upp till element logprobs+1 i svaret.Maxvärdet för logprobs är 5. |
No | None |
| max_tokens | integer | Det maximala antalet tokens som kan genereras i slutförandet. Token-antalet för din prompt plus max_tokens får inte överstiga modellens kontextlängd. |
No | 16 |
| n | integer | Hur många kompletteringar som ska genereras för varje prompt. Notera: Eftersom denna parameter genererar många kompletteringar kan den snabbt förbruka din tokenkvot. Använd noggrant och se till att du har rimliga inställningar för max_tokens och stop. |
No | 1 |
| presence_penalty | number | Siffran mellan -2,0 och 2,0. Positiva värden straffar nya tokens baserat på om de hittills förekommer i texten, vilket ökar modellens sannolikhet att tala om nya ämnen. | No | 0 |
| prompt | Sträng eller array | Prompten för att generera kompletta ord för, kodad som en sträng, array av strängar, array av tokens eller array av tokenarrayer. Observera att <|endoftext|> är dokumentseparatorn som modellen ser under träningen, så om en prompt inte specificeras genererar modellen som om den vore från början av ett nytt dokument. |
Yes | |
| seed | integer | Om det specificeras gör vårt system sitt bästa för att provta deterministiskt, så att upprepade förfrågningar med samma seed och parametrar ska ge samma resultat.Determinism är inte garanterad, och du bör använda responsparametern system_fingerprint för att övervaka förändringar i backend. |
No | |
| stop | Sträng eller array | Upp till fyra sekvenser där API:et slutar generera ytterligare tokens. Den returnerade texten kommer inte att innehålla stoppsekvensen. | No | |
| stream | boolean | Om man ska streama tillbaka delvis framsteg. Om de är satta skickas tokens som data-enbart serverskickade händelser när de blir tillgängliga, och strömmen avslutas med ett data: [DONE] meddelande.
Exempel Python kod. |
No | False |
| suffix | string | Suffixet som kommer efter att den insatta texten har slutförts. Denna parameter stöds endast för gpt-3.5-turbo-instruct. |
No | None |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar generellt att ändra detta eller top_p båda. |
No | 1 |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperature båda. |
No | 1 |
| user | string | En unik identifierare som representerar din slutanvändare, vilket kan hjälpa till att övervaka och upptäcka missbruk. |
No |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | createCompletionResponse |
Statuskod: standard
Beskrivning: Tjänsten är inte tillgänglig
| Content-Type | Type | Description |
|---|---|---|
| application/json | errorResponse |
Examples
Example
Skapar en komplettering för den tillhandahållna prompten, parametrarna och den valda modellen.
POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-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
}
}
}
Embeddings - Skapa
POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview
Få en vektorrepresentation av en given input som enkelt kan konsumeras av maskininlärningsmodeller och algoritmer.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| deployment-id | path | Yes | string | Distributions-ID:t för modellen som implementerades. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| dimensions | integer | Antalet dimensioner som de resulterande utdatainbäddningarna bör ha. Endast stödd i text-embedding-3 och senare modeller. |
No | |
| encoding_format | string | Formatet för att returnera inbäddningarna. Det kan vara antingen float eller base64. Går som standard till float. |
No | |
| input | Sträng eller array | Mata in text för att bädda in, kodad som en sträng eller array av tokens. För att bädda in flera indata i en enda förfrågan, skicka en array av strängar eller en array av tokenarrayer. Inmatningen får inte överstiga maxantalet inmatningstoken för modellen (8 192 tokens för text-embedding-ada-002), får inte vara en tom sträng, och varje array måste vara 2 048 dimensioner eller mindre. |
Yes | |
| input_type | string | Inmatningstyp av inbäddningssökning att använda | No | |
| user | string | En unik identifierare som representerar din slutanvändare, vilket kan hjälpa till att övervaka och upptäcka missbruk. | No |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | object |
Examples
Example
Returnera embeddingarna för en given prompt.
POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-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.0020113448
]
}
],
"usage": {
"prompt_tokens": 4,
"total_tokens": 4
}
}
}
Chattfullbordanden - Skapa
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview
Skapar en komplettering för chattmeddelandet
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| deployment-id | path | Yes | string | |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| audio | object | Parametrar för ljudutgång. Krävs när ljudutgång begärs med modalities: ["audio"]. |
No | |
| └─ format | enum | Specificerar utgångsljudformatet. Måste vara en av wav, mp3, , flac, opus, eller pcm16. Möjliga värden: wav, mp3, flac, opus, pcm16 |
No | |
| └─ voice | enum | Specificerar rösttypen. Stödda röster är alloy, echo, , fable, onyx, novaoch shimmer.Möjliga värden: alloy, echo, fable, onyx, nova, shimmer |
No | |
| data_sources | array | Konfigurationsposterna för Azure OpenAI-chatttillägg som använder dem. Denna extra specifikation är endast kompatibel med Azure OpenAI. |
No | |
| frequency_penalty | number | Siffran mellan -2,0 och 2,0. Positiva värden straffar nya tokens baserat på deras befintliga frekvens i texten hittills, vilket minskar modellens sannolikhet att upprepa samma rad ordagrant. |
No | 0 |
| function_call | sträng eller chatCompletionFunctionCallOption | Föråldrad till förmån för tool_choice.Styr vilken (om någon) funktion som anropas av modellen. none betyder att modellen inte anropar en funktion utan istället genererar ett meddelande.auto innebär att modellen kan välja mellan att generera ett meddelande eller anropa en funktion.Att specificera en viss funktion via {"name": "my_function"} tvingar modellen att anropa den funktionen.none är standarden när inga funktioner finns.
auto är standard om funktioner finns. |
No | |
| functions | array | Föråldrad till förmån för tools.En lista över funktioner som modellen kan generera JSON-indata för. |
No | |
| logit_bias | object | Ändra sannolikheten för att specificerade tokens ska dyka upp i slutförandet. Accepterar ett JSON-objekt som mappar tokens (specificerade av deras token-ID i tokenizern) till ett associerat biasvärde från -100 till 100. Matematiskt läggs biasen till de logits som genereras av modellen före urvalet. Den exakta effekten varierar mellan modellen, men värden mellan -1 och 1 bör minska eller öka sannolikheten för urval; Värden som -100 eller 100 bör leda till avstängning eller exklusivt val av relevant token. |
No | None |
| logprobs | boolean | Om man ska returnera loggsannolikheter för utdatatokens eller inte. Om sann, returnerar logsannolikheterna för varje utdata som returnerats i av contentmessage. |
No | False |
| max_completion_tokens | integer | En övre gräns för antalet tokens som kan genereras för en fullbordan, inklusive synliga utdatatokens och resonemangstokens. | No | |
| max_tokens | integer | Det maximala antalet tokens som kan genereras i chatten. Den totala längden på inmatningstokens och genererade tokens begränsas av modellens kontextlängd. |
No | |
| messages | array | En lista med meddelanden som utgör konversationen hittills. Exempel Python kod. | Yes | |
| metadata | object | Utvecklardefinierade taggar och värden som används för att filtrera färdigställanden i den lagrade fullföljandeinstrumentpanelen. | No | |
| modalities | ChatCompletionModalities | Utdatatyper som du vill att modellen ska generera för denna förfrågan. De flesta modeller kan generera text, vilket är standard: ["text"]Modellen gpt-4o-audio-preview kan också användas för att generera ljud. För att begära att denna modell genererar både text- och ljudsvar kan du använda:["text", "audio"] |
No | |
| n | integer | Hur många chattfullbordandeval som ska genereras för varje inmatningsmeddelande. Du debiteras baserat på antalet genererade tokens i alla val. Se n till att 1 minimera kostnaderna. |
No | 1 |
| parallel_tool_calls | ParallelToolCalls | Om man ska aktivera parallell funktionsanrop under verktygsanvändning. | No | True |
| prediction | PredictionContent | Konfiguration för en förutsagd utgång, vilket kan förbättra responstiderna avsevärt när stora delar av modellens respons är kända i förväg. Detta är vanligast när du regenererar en fil med endast mindre ändringar i det mesta av innehållet. | No | |
| presence_penalty | number | Siffran mellan -2,0 och 2,0. Positiva värden straffar nya tokens baserat på om de hittills förekommer i texten, vilket ökar modellens sannolikhet att tala om nya ämnen. |
No | 0 |
| reasoning_effort | enum |
Endast O1-modeller Begränsar ansträngningen i resonemanget för resonemangsmodeller. För närvarande stödda värden är low, medium, och high. Att minska resonemangsansträngningen kan leda till snabbare svar och färre tokens som används på resonemang i ett svar.Möjliga värden: low, medium, high |
No | |
| response_format | ResponseFormatText eller ResponseFormatJsonObject eller ResponseFormatJsonSchema | Ett objekt som specificerar formatet som modellen måste ge utmatning. 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ällningen till { "type": "json_schema", "json_schema": {...} } aktiverar strukturerade utdata, som garanterar att modellen matchar ditt tillhandahållna JSON-schema.Att sätta på { "type": "json_object" } aktiverar 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 själv producera JSON via ett system- eller användarmeddelande. Utan detta kan modellen generera en oändlig ström av whitespace tills genereringen når tokengränsen, vilket resulterar i en långvarig och till synes "fastkilad" förfrågan. Observera också att meddelandeinnehållet kan vara delvis avskuret om finish_reason="length", vilket indikerar att genereringen överskridits max_tokens eller att konversationen överskred maxkontextlängden. |
No | |
| seed | integer | Denna funktion är i beta. Om det specificeras gör vårt system sitt bästa för att provta deterministiskt, så att upprepade förfrågningar med samma seed och parametrar ska ge samma resultat.Determinism är inte garanterad, och du bör använda responsparametern system_fingerprint för att övervaka förändringar i backend. |
No | |
| stop | Sträng eller array | Upp till 4 sekvenser där API:et slutar generera ytterligare tokens. |
No | |
| store | boolean | Om vi ska lagra resultatet från denna chattförfrågan för användning i våra modelldestillations- eller utvärderingsprodukter. | No | |
| stream | boolean | Om det är satt skickas partiella meddelandedeltas, som i ChatGPT. Tokens skickas som data-enbart serverskickade händelser när de blir tillgängliga, och strömmen avslutas med ett data: [DONE] meddelande.
Exempel Python kod. |
No | False |
| stream_options | chatCompletionStreamOptions | Alternativ för streaming-respons. Ställ in detta först när du sätter stream: true. |
No | None |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar generellt att ändra detta eller top_p båda. |
No | 1 |
| tool_choice | chatCompletionToolChoiceOption | Styr vilket (om något) verktyg som anropas av modellen.
none Det betyder att modellen inte anropar något verktyg utan istället genererar ett meddelande.
auto Det innebär att modellen kan välja mellan att generera ett meddelande eller att anropa ett eller flera verktyg.
required betyder att modellen måste anropa ett eller flera verktyg. Att specificera ett visst verktyg via {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa det verktyget.
none är standarden när inga verktyg finns.
auto är standarden om verktyg finns. |
No | |
| tools | array | En lista över verktyg som modellen kan anropa. För närvarande stöds endast funktioner som verktyg. Använd detta för att tillhandahålla en lista över funktioner som modellen kan generera JSON-indata för. Maximalt 128 funktioner stöds. |
No | |
| top_logprobs | integer | Ett heltal mellan 0 och 20 som anger antalet mest sannolika tokens att returnera vid varje tokenposition, var och en med tillhörande log-sannolikhet.
logprobs måste sättas till true om denna parameter används. |
No | |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperature båda. |
No | 1 |
| user | string | En unik identifierare som representerar din slutanvändare, vilket kan hjälpa till att övervaka och upptäcka missbruk. |
No | |
| user_security_context | userSecurityContext | Användarsäkerhetskontexten innehåller flera parametrar som beskriver själva AI-applikationen och slutanvändaren som interagerar med AI-applikationen. Dessa områden hjälper dina säkerhetsteam att undersöka och mildra säkerhetsincidenter genom att erbjuda ett heltäckande tillvägagångssätt för att skydda dina AI-applikationer. Lär dig mer om att skydda AI-applikationer med hjälp av Microsoft Defender för molnet. | No |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | object |
Statuskod: standard
Beskrivning: Tjänsten är inte tillgänglig
| Content-Type | Type | Description |
|---|---|---|
| application/json | errorResponse |
Examples
Example
Skapar en komplettering för den tillhandahållna prompten, parametrarna och den valda modellen.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-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
}
}
}
Example
Skapar en komplettering baserad på Azure Search-data och systemtilldelad hanterad identitet.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-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
}
}
}
Example
Skapar en komplettering baserad på Azure Search-bildvektordata.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-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
}
}
}
Example
Skapar en komplettering baserad på Azure Search-vektordata, tidigare assistentmeddelande och användartilldelad hanterad identitet.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-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
}
}
}
Example
Skapar en komplettering för den medföljande Azure Cosmos DB.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-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
}
}
}
Example
Skapar en komplettering för den tillhandahållna Mongo DB.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-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
}
}
}
Example
Skapar en komplettering för den tillhandahållna Elasticsearch.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-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
}
}
}
Example
Skapar en komplettering för den tillhandahållna Pinecone-resursen.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-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=2025-04-01-preview
Transkriberar ljudet till inmatningsspråket.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| deployment-id | path | Yes | string | |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: multipart/form-data
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| model | string | ID på modellen att använda. Alternativen är , , , , whisper-1och gpt-4o-transcribe-diarize. gpt-4o-mini-transcribe-2025-12-15gpt-4o-mini-transcribegpt-4o-transcribe |
Yes | |
| file | string | Ljudfilobjektet att transkribera. | Yes | |
| language | string | Språket för inmatningsljudet. Att tillhandahålla inmatningsspråket i ISO-639-1-format förbättrar noggrannhet och latens. | No | |
| prompt | string | En valfri text för att styra modellens stil eller fortsätta ett tidigare ljudsegment. Prompten ska matcha ljudspråket. | No | |
| response_format | audioResponseFormat | Definierar formatet på utdatan. | No | |
| temperature | number | Provtagningstemperaturen, mellan 0 och 1. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Om den sätts till 0 använder modellen logaritmisk sannolikhet för att automatiskt öka temperaturen tills vissa tröskelvärden nås. | No | 0 |
| timestamp_granularities[] | array | Tidsstämpelns granulariteter för denna transkription.
response_format måste vara inställd verbose_json på att använda tidsstämpelgranulariteter. Antingen eller båda dessa alternativ stöds: word, eller segment. Observera: Det finns ingen extra latens för segmenttidsstämplar, men generering av ordtidsstämplar medför ytterligare latens. |
No | ['segment'] |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | object | |
| text/plain | string | Transkriberad text i utdataformatet (när response_format var en av text, vtt eller srt). |
Examples
Example
Får transkriberad text och tillhörande metadata från tillhandahållen talad ljuddata.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview
Svar: Statuskod: 200
{
"body": {
"text": "A structured object when requesting json or verbose_json"
}
}
Example
Får transkriberad text och tillhörande metadata från tillhandahållen talad ljuddata.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-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=2025-04-01-preview
Transkriberar och översätter inmatat ljud till engelsk text.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| deployment-id | path | Yes | string | |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: multipart/form-data
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file | string | Ljudfilen att översätta. | Yes | |
| prompt | string | En valfri text för att styra modellens stil eller fortsätta ett tidigare ljudsegment. Uppgiften ska vara på engelska. | No | |
| response_format | audioResponseFormat | Definierar formatet på utdatan. | No | |
| temperature | number | Provtagningstemperaturen, mellan 0 och 1. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Om den sätts till 0 använder modellen logaritmisk sannolikhet för att automatiskt öka temperaturen tills vissa tröskelvärden nås. | No | 0 |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | object | |
| text/plain | string | Transkriberad text i utdataformatet (när response_format var text, vtt eller srt). |
Examples
Example
Hämtar engelskspråkig transkriberad text och tillhörande metadata från tillhandahållen talad ljuddata.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-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"
}
}
Example
Hämtar engelskspråkig transkriberad text och tillhörande metadata från tillhandahållen talad ljuddata.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-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=2025-04-01-preview
Genererar ljud från inmatningstexten.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| deployment-id | path | Yes | string | |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: multipart/form-data
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input | string | Texten för att syntetisera ljud för. Den maximala längden är 4 096 tecken. | Yes | |
| response_format | enum | Formatet för att syntetisera ljudet i. Möjliga värden: mp3, opus, aac, flac, wav, pcm |
No | |
| speed | number | Hastigheten på det syntetiserade ljudet. Välj ett värde från 0.25 till 4.0.
1.0 är standard. |
No | 1.0 |
| voice | enum | Rösten att använda för talsyntes. Möjliga värden: alloy, echo, fable, onyx, nova, shimmer |
Yes |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/octet-stream | string |
Examples
Example
Syntetiserar ljud från den medföljande texten.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview
{
"input": "Hi! What are you going to make?",
"voice": "fable",
"response_format": "mp3"
}
Svar: Statuskod: 200
{
"body": "101010101"
}
Bildgenereringar - Skapa
POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview
Genererar en batch bilder från en texttext i en given bildgenereringsmodellutplacering
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| deployment-id | path | Yes | string | |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| background | imageBackground | Tillåter att man kan ställa in transparens för bakgrunden på de genererade bilderna. Denna parameter stöds endast för modeller i GPT-image-1-serien. | No | auto |
| n | integer | Antalet bilder som ska genereras. För dall-e-3 stöds endast n=1. | No | 1 |
| output_compression | integer | Kompressionsnivån (0–100%) för de genererade bilderna. Denna parameter stöds endast för gpt-image-1-seriemodeller med jpeg-utdataformat. | No | 100 |
| output_format | imagesOutputFormat | Filformatet i vilket de genererade bilderna returneras. Stöds endast för GPT-image-1-seriens modeller. | No | png |
| prompt | string | En textbeskrivning av den önskade bilden/bilderna. Maxlängden är 32 000 tecken för GPT-image-1-serien och 4 000 tecken för dall-e-3 | Yes | |
| partial_images | integer | Antalet delvisa bilder som ska genereras. Denna parameter används för strömmande svar som returnerar delvisa bilder. Värdet måste vara mellan 0 och 3. När det sätts till 0 kommer svaret att vara en enda bild som skickas i en strömningshändelse. Observera att den slutgiltiga bilden kan skickas innan hela antalet delvisa bilder genereras om hela bilden genereras snabbare. | 0 | |
| stream | boolean | Redigera bilden i streamingläge. | no | false |
| quality | imageQuality | Bildkvaliteten som kommer att genereras. | No | auto |
| response_format | imagesResponseFormat | Formatet i vilket de genererade bilderna returneras. Denna parameter stöds inte för gpt-image-1-seriemodeller som alltid returnerar base64-kodade bilder.Möjliga värden: url, b64_json. |
No | url |
| size | imageSize | Storleken på de genererade bilderna. | No | auto |
| style | imageStyle | Stilen på de genererade bilderna. Stöds endast för DALL-e-3. | No | vivid |
| user | string | En unik identifierare som representerar din slutanvändare, vilket kan hjälpa till att övervaka och upptäcka missbruk. | No |
Responses
Statuskod: 200
Description: Ok
| Content-Type | Type | Description |
|---|---|---|
| application/json | generateImagesResponse |
Statuskod: standard
Beskrivning: Ett fel uppstod.
| Content-Type | Type | Description |
|---|---|---|
| application/json | dalleErrorResponse |
Examples
Example
Skapar bilder med en prompt.
POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-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
}
}
}
]
}
}
Bildgenereringar - Redigera
POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview
Redigerar en bild från en texttext på en given gpt-image-1-modelldistribution
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| deployment-id | path | Yes | string | |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: multipart/form-data
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| image | Sträng eller array | Bilden/bilderna att redigera. Det måste vara en stödd bildfil eller en array av bilder. Varje bild bör vara en png- eller jpg-fil mindre än 50MB. | Yes | |
| input_fidelity | string | Kontrollera hur mycket ansträngning modellen lägger ner för att matcha stilen och dragen, särskilt ansiktsdragen, i inmatade bilder. Denna parameter stöds endast för modeller i GPT-image-1-serien. Stöd high och low. |
no |
low. |
| mask | string | En extra bild vars helt transparenta områden (t.ex. där alfa är noll) anger var bilden ska redigeras. Om det finns flera bilder som tillhandahålls, appliceras masken på den första bilden. Det måste vara en giltig PNG-fil, mindre än 4MB, och ha samma dimensioner som bilden. | No | |
| n | integer | Antalet bilder som ska genereras. Det måste vara mellan 1 och 10. | No | 1 |
| prompt | string | En textbeskrivning av den önskade bilden/bilderna. Den maximala längden är 32 000 tecken. | Yes | |
| quality | imageQuality | Bildkvaliteten som kommer att genereras. | No | auto |
| partial_images | Antalet delvisa bilder som ska genereras. Denna parameter används för strömmande svar som returnerar delvisa bilder. Värdet måste vara mellan 0 och 3. När det sätts till 0 kommer svaret att vara en enda bild som skickas i en strömningshändelse. Observera att den slutgiltiga bilden kan skickas innan hela antalet delvisa bilder genereras om hela bilden genereras snabbare. | |||
| stream | boolean | Redigera bilden i streamingläge. | no | false |
| response_format | imagesResponseFormat | Formatet i vilket de genererade bilderna returneras. | No | url |
| size | imageSize | Storleken på de genererade bilderna. | No | auto |
| user | string | En unik identifierare som representerar din slutanvändare, vilket kan hjälpa till att övervaka och upptäcka missbruk. | No |
Responses
Statuskod: 200
Description: Ok
| Content-Type | Type | Description |
|---|---|---|
| application/json | generateImagesResponse |
Statuskod: standard
Beskrivning: Ett fel uppstod.
| Content-Type | Type | Description |
|---|---|---|
| application/json | dalleErrorResponse |
Lista - Assisterande
Note
Assistants API är föråldrat och kommer att tas ur bruk den 26 augusti 2026. Använd den allmänt tillgängliga tjänsten Microsoft Foundry Agents. Följ migreringsguiden för att uppdatera dina arbetsbelastningar. Learn more.
GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview
Lämnar tillbaka en lista över assistenter.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| limit | query | No | integer | En gräns för antalet objekt som ska returneras. Gränsen kan ligga mellan 1 och 100, och standardvärdet är 20. |
| order | query | No | string Möjliga värden: asc, desc |
Sortera ordning efter created_at objektens tidsstämpel.
asc för stigande ordning och desc för fallande ordning. |
| after | query | No | string | En markör för användning i paginering.
after är ett objekt-ID som definierar din plats i listan. Till exempel, om du gör en listförfrågan och tar emot 100 objekt som slutar på obj_foo, kan ditt efterföljande anrop inkludera efter=obj_foo för att hämta nästa sida i listan. |
| before | query | No | string | En markör för användning i paginering.
before är ett objekt-ID som definierar din plats i listan. Till exempel, om du gör en listförfrågan och tar emot 100 objekt, med start från obj_foo, kan ditt efterföljande anrop inkludera before=obj_foo för att hämta föregående sida i listan. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | listAssistantsResponse |
Examples
Example
Lämnar tillbaka en lista över assistenter.
GET https://{endpoint}/openai/assistants?api-version=2025-04-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=2025-04-01-preview
Skapa en assistent med en modell och instruktioner.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | Beskrivningen av assistenten. Den maximala längden är 512 tecken. |
No | |
| instructions | string | Systeminstruktionerna som assistenten använder. Den maximala längden är 256 000 tecken. |
No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| model | string | Yes | ||
| name | string | Assistentens namn. Den maximala längden är 256 tecken. |
No | |
| response_format | assistantsApiResponseFormatOption | Specificerar formatet som modellen måste skriva ut. Kompatibel med GPT-4o, GPT-4 Turbo och alla GPT-3.5 Turbo-modeller sedan dess.gpt-3.5-turbo-1106Inställning till { "type": "json_schema", "json_schema": {...} } aktiverar strukturerade utdata som säkerställer att modellen matchar ditt tillhandahållna JSON-schema. Läs mer i guiden för strukturerade utdata.Att sätta på { "type": "json_object" } aktiverar JSON-läge, vilket säkerställer att meddelandet modellen genererar är giltigt JSON.Viktigt: när du använder JSON-läge måste du också instruera modellen att själv producera JSON via ett system- eller användarmeddelande. Utan detta kan modellen generera en oändlig ström av whitespace tills genereringen når tokengränsen, vilket resulterar i en långvarig och till synes "fastkilad" förfrågan. Observera också att meddelandeinnehållet kan vara delvis avskuret om finish_reason="length", vilket indikerar att genereringen överskridits max_tokens eller att konversationen överskred maxkontextlängden. |
No | |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. |
No | 1 |
| tool_resources | object | En uppsättning resurser som används av assistentens verktyg. Resurserna är specifika för typen av verktyg. Till exempel code_interpreter kräver verktyget en lista med fil-ID:n, medan verktyget file_search kräver en lista med vektorlagre-ID:n. |
No | |
| └─ code_interpreter | object | No | ||
| └─ file_ids | array | En lista över fil-ID:n som görs tillgängliga för verktyget code_interpreter . Det kan finnas maximalt 20 filer kopplade till verktyget. |
No | [] |
| └─ file_search | object | No | ||
| └─ vector_store_ids | array | Vektorlagret är kopplat till denna assistent. Det kan vara maximalt 1 vektorlager kopplat till assistenten. |
No | |
| └─ vector_stores | array | En hjälpare för att skapa en vektorlagring med file_ids och koppla den till denna assistent. Det kan vara maximalt 1 vektorlager kopplat till assistenten. |
No | |
| tools | array | En lista över verktyg aktiverade på assistenten. Det kan vara maximalt 128 verktyg per assistent. Verktyg kan vara av typ code_interpreter, retrieval, eller function. |
No | [] |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperaturen men inte båda. |
No | 1 |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | assistantObject |
Examples
Example
Skapa en assistent med en modell och instruktioner.
POST https://{endpoint}/openai/assistants?api-version=2025-04-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"
}
}
Få - Assistent
GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview
Hämtar en assistent.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| assistant_id | path | Yes | string | ID:t på assistenten som ska hämtas. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | assistantObject |
Examples
Example
Hämtar en assistent.
GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-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"
}
}
Modify - Assistent
POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview
Modifierar en assistent.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| assistant_id | path | Yes | string | Assistentens ID för att modifiera. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | Beskrivningen av assistenten. Den maximala längden är 512 tecken. |
No | |
| instructions | string | Systeminstruktionerna som assistenten använder. Den maximala längden är 32 768 tecken. |
No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| model | string | No | ||
| name | string | Assistentens namn. Den maximala längden är 256 tecken. |
No | |
| response_format | assistantsApiResponseFormatOption | Specificerar formatet som modellen måste skriva ut. Kompatibel med GPT-4o, GPT-4 Turbo och alla GPT-3.5 Turbo-modeller sedan dess.gpt-3.5-turbo-1106Inställning till { "type": "json_schema", "json_schema": {...} } aktiverar strukturerade utdata som säkerställer att modellen matchar ditt tillhandahållna JSON-schema. Läs mer i guiden för strukturerade utdata.Att sätta på { "type": "json_object" } aktiverar JSON-läge, vilket säkerställer att meddelandet modellen genererar är giltigt JSON.Viktigt: när du använder JSON-läge måste du också instruera modellen att själv producera JSON via ett system- eller användarmeddelande. Utan detta kan modellen generera en oändlig ström av whitespace tills genereringen når tokengränsen, vilket resulterar i en långvarig och till synes "fastkilad" förfrågan. Observera också att meddelandeinnehållet kan vara delvis avskuret om finish_reason="length", vilket indikerar att genereringen överskridits max_tokens eller att konversationen överskred maxkontextlängden. |
No | |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. |
No | 1 |
| tool_resources | object | En uppsättning resurser som används av assistentens verktyg. Resurserna är specifika för typen av verktyg. Till exempel code_interpreter kräver verktyget en lista med fil-ID:n, medan verktyget file_search kräver en lista med vektorlagre-ID:n. |
No | |
| └─ code_interpreter | object | No | ||
| └─ file_ids | array | Åsidosätter listan över fil-ID:n som görs tillgängliga för verktyget code_interpreter . Det kan finnas maximalt 20 filer kopplade till verktyget. |
No | [] |
| └─ file_search | object | No | ||
| └─ vector_store_ids | array | Överskriver vektorlagret som är kopplat till denna assistent. Det kan vara maximalt 1 vektorlager kopplat till assistenten. |
No | |
| tools | array | En lista över verktyg aktiverade på assistenten. Det kan vara maximalt 128 verktyg per assistent. Verktyg kan vara av typ code_interpreter, retrieval, eller function. |
No | [] |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperaturen men inte båda. |
No | 1 |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | assistantObject |
Examples
Example
Modifierar en assistent.
POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-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"
}
}
Radera - Assistent
DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview
Ta bort en assistent.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| assistant_id | path | Yes | string | Assistentens ID att radera. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | deleteAssistantResponse |
Examples
Example
Tar bort en assistent.
DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview
Svar: Statuskod: 200
{
"body": {
"id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
"object": "assistant.deleted",
"deleted": true
}
}
Skapa - Tråd
Note
Assistants API är föråldrat och kommer att tas ur bruk den 26 augusti 2026. Använd den allmänt tillgängliga tjänsten Microsoft Foundry Agents. Följ migreringsguiden för att uppdatera dina arbetsbelastningar. Learn more.
POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview
Skapa en tråd.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| messages | array | En lista med meddelanden att starta tråden med. | No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| tool_resources | object | En uppsättning resurser som görs tillgängliga för assistentens verktyg i denna tråd. Resurserna är specifika för typen av verktyg. Till exempel code_interpreter kräver verktyget en lista med fil-ID:n, medan verktyget file_search kräver en lista med vektorlagre-ID:n. |
No | |
| └─ code_interpreter | object | No | ||
| └─ file_ids | array | En lista över fil-ID:n som görs tillgängliga för verktyget code_interpreter . Det kan finnas maximalt 20 filer kopplade till verktyget. |
No | [] |
| └─ file_search | object | No | ||
| └─ vector_store_ids | array | Vektorlagret som är kopplat till denna tråd. Det kan vara maximalt 1 vektorlagring kopplad till tråden. |
No | |
| └─ vector_stores | array | En hjälpare för att skapa en vektorlagring med file_ids och koppla den till denna tråd. Det kan vara maximalt 1 vektorlagring kopplad till tråden. |
No |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | threadObject |
Examples
Example
Skapar en tråd.
POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview
Svar: Statuskod: 200
{
"body": {
"id": "thread_v7V4csrNOxtNmgcwGg496Smx",
"object": "thread",
"created_at": 1707297136,
"metadata": {}
}
}
Få - Tråd
GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview
Hämtar en tråd.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för tråden att hämta. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | threadObject |
Examples
Example
Hämtar en tråd.
GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview
Svar: Statuskod: 200
{
"body": {
"id": "thread_v7V4csrNOxtNmgcwGg496Smx",
"object": "thread",
"created_at": 1707297136,
"metadata": {},
"tool_resources": {
"code_interpreter": {
"file_ids": []
}
}
}
}
Modifiera - Tråd
POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview
Ändrar en tråd.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för tråden som ska ändras. Endast kan metadata modifieras. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| tool_resources | object | En uppsättning resurser som görs tillgängliga för assistentens verktyg i denna tråd. Resurserna är specifika för typen av verktyg. Till exempel code_interpreter kräver verktyget en lista med fil-ID:n, medan verktyget file_search kräver en lista med vektorlagre-ID:n. |
No | |
| └─ code_interpreter | object | No | ||
| └─ file_ids | array | En lista över fil-ID:n som görs tillgängliga för verktyget code_interpreter . Det kan finnas maximalt 20 filer kopplade till verktyget. |
No | [] |
| └─ file_search | object | No | ||
| └─ vector_store_ids | array | Vektorlagret som är kopplat till denna tråd. Det kan vara maximalt 1 vektorlagring kopplad till tråden. |
No |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | threadObject |
Examples
Example
Ändrar en tråd.
POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-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": {}
}
}
Radera - Tråd
DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview
Radera en tråd.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för tråden som ska tas bort. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | deleteThreadResponse |
Examples
Example
Raderar en tråd.
DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview
Svar: Statuskod: 200
{
"body": {
"id": "thread_v7V4csrNOxtNmgcwGg496Smx",
"object": "thread.deleted",
"deleted": true
}
}
Lista - Meddelanden
Note
Assistants API är föråldrat och kommer att tas ur bruk den 26 augusti 2026. Använd den allmänt tillgängliga tjänsten Microsoft Foundry Agents. Följ migreringsguiden för att uppdatera dina arbetsbelastningar. Learn more.
GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview
Returnerar en lista med meddelanden för en given tråd.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för trådarna som meddelandena tillhör. |
| limit | query | No | integer | En gräns för antalet objekt som ska returneras. Gränsen kan ligga mellan 1 och 100, och standardvärdet är 20. |
| order | query | No | string Möjliga värden: asc, desc |
Sortera ordning efter created_at objektens tidsstämpel.
asc för stigande ordning och desc för fallande ordning. |
| after | query | No | string | En markör för användning i paginering.
after är ett objekt-ID som definierar din plats i listan. Till exempel, om du gör en listförfrågan och tar emot 100 objekt som slutar på obj_foo, kan ditt efterföljande anrop inkludera efter=obj_foo för att hämta nästa sida i listan. |
| before | query | No | string | En markör för användning i paginering.
before är ett objekt-ID som definierar din plats i listan. Till exempel, om du gör en listförfrågan och tar emot 100 objekt, med start från obj_foo, kan ditt efterföljande anrop inkludera before=obj_foo för att hämta föregående sida i listan. |
| run_id | query | No | string | Filtrera meddelanden efter det kör-ID som genererade dem. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | listMessagesResponse |
Examples
Example
List Messages
GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-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=2025-04-01-preview
Skapa ett budskap.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för trådarna för att skapa ett meddelande för. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| attachments | array | En lista över filer som är bifogade meddelandet, och vilka verktyg de ska läggas till i. | No | |
| content | string | Innehållet i meddelandet. | Yes | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| role | string | Rollen för den entitet som skapar meddelandet. Tillåtna värden inkluderar: - user: Indikerar 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: Indikerar att meddelandet genereras av assistenten. Använd detta värde för att infoga meddelanden från assistenten i konversationen. |
Yes |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | messageObject |
Examples
Example
Skapa ett budskap.
POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-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": {}
}
}
Få - Meddelande
GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview
Hämta ett meddelande.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för trådarna som detta meddelande tillhör. |
| message_id | path | Yes | string | ID:t på meddelandet som ska hämtas. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | messageObject |
Examples
Example
Hämta ett meddelande.
GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-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": {}
}
}
Modifiera - Meddelande
POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview
Ändrar ett meddelande.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för tråden som detta meddelande tillhör. |
| message_id | path | Yes | string | ID:t för meddelandet att ändra. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | messageObject |
Examples
Example
Ändra ett meddelande.
POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-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åd och kör
Note
Assistants API är föråldrat och kommer att tas ur bruk den 26 augusti 2026. Använd den allmänt tillgängliga tjänsten Microsoft Foundry Agents. Följ migreringsguiden för att uppdatera dina arbetsbelastningar. Learn more.
POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview
Skapa en tråd och kör den i en enda förfrågan.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| assistant_id | string | ID:t på assistenten som ska användas för att utföra denna runda. | Yes | |
| instructions | string | Åsidosätt assistentens standardsystemmeddelande. Detta är användbart för att modifiera beteendet per körning. | No | |
| max_completion_tokens | integer | Det maximala antalet kompletteringstokens som kan användas under körningens gång. Körningen gör sitt bästa för att använda endast det antal fullbordande-tokens som anges över flera turer av rundan. Om körningen överstiger det angivna antalet kompletteringstokens avslutas körningen med status incomplete. Se incomplete_details för mer information. |
No | |
| max_prompt_tokens | integer | Det maximala antalet prompt-tokens som kan användas under loppets gång. Runen gör sitt bästa för att använda endast det antal prompttokens som angivits, över flera turer av runet. Om körningen överstiger antalet prompt-tokens som anges avslutas med status incomplete. Se incomplete_details för mer information. |
No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| model | string | ID:t för modellerna som ska användas för att köra denna körning. Om ett värde anges här kommer det att åsidosätta modellen som är kopplad till assistenten. Om inte, kommer modellen som är kopplad till assistenten att användas. | No | |
| parallel_tool_calls | ParallelToolCalls | Om man ska aktivera parallell funktionsanrop under verktygsanvändning. | No | True |
| response_format | assistantsApiResponseFormatOption | Specificerar formatet som modellen måste skriva ut. Kompatibel med GPT-4o, GPT-4 Turbo och alla GPT-3.5 Turbo-modeller sedan dess.gpt-3.5-turbo-1106Inställning till { "type": "json_schema", "json_schema": {...} } aktiverar strukturerade utdata som säkerställer att modellen matchar ditt tillhandahållna JSON-schema. Läs mer i guiden för strukturerade utdata.Att sätta på { "type": "json_object" } aktiverar JSON-läge, vilket säkerställer att meddelandet modellen genererar är giltigt JSON.Viktigt: när du använder JSON-läge måste du också instruera modellen att själv producera JSON via ett system- eller användarmeddelande. Utan detta kan modellen generera en oändlig ström av whitespace tills genereringen når tokengränsen, vilket resulterar i en långvarig och till synes "fastkilad" förfrågan. Observera också att meddelandeinnehållet kan vara delvis avskuret om finish_reason="length", vilket indikerar att genereringen överskridits max_tokens eller att konversationen överskred maxkontextlängden. |
No | |
| stream | boolean | Om true, returnerar en ström av händelser som sker under Körningen som serverskickade händelser, och avslutas när Körningen går in i ett terminalläge med ett data: [DONE] meddelande. |
No | |
| stream_options | chatCompletionStreamOptions | Alternativ för streaming-respons. Ställ in detta först när du sätter stream: true. |
No | None |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. |
No | 1 |
| thread | createThreadRequest | No | ||
| tool_choice | assistantsApiToolChoiceOption | Styr vilket (om något) verktyg som anropas av modellen.none Det betyder att modellen inte anropar några verktyg utan istä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.Att specificera ett särskilt verktyg som {"type": "file_search"} eller {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa det verktyget. |
No | |
| tool_resources | object | En uppsättning resurser som används av assistentens verktyg. Resurserna är specifika för typen av verktyg. Till exempel code_interpreter kräver verktyget en lista med fil-ID:n, medan verktyget file_search kräver en lista med vektorlagre-ID:n. |
No | |
| └─ code_interpreter | object | No | ||
| └─ file_ids | array | En lista över fil-ID:n som görs tillgängliga för verktyget code_interpreter . Det kan finnas maximalt 20 filer kopplade till verktyget. |
No | [] |
| └─ file_search | object | No | ||
| └─ vector_store_ids | array | ID:t för vektorlagret är kopplat till denna assistent. Det kan vara maximalt 1 vektorlager kopplat till assistenten. |
No | |
| tools | array | Överstyr verktygen som assistenten kan använda för denna genomspelning. Detta är användbart för att modifiera beteendet per körning. | No | |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperaturen men inte båda. |
No | 1 |
| truncation_strategy | truncationObject | Kontroller för hur en tråd kommer att förkortas innan körningen. Använd detta för att styra det initiala kontextfönstret för körningen. | No |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | runObject |
Examples
Example
Skapa en tråd och kör den i en enda förfrågan.
POST https://{endpoint}/openai/threads/runs?api-version=2025-04-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 - Runs
GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview
Returnerar en lista över körningar som tillhör en tråd.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för tråden som körningen tillhör. |
| limit | query | No | integer | En gräns för antalet objekt som ska returneras. Gränsen kan ligga mellan 1 och 100, och standardvärdet är 20. |
| order | query | No | string Möjliga värden: asc, desc |
Sortera ordning efter created_at objektens tidsstämpel.
asc för stigande ordning och desc för fallande ordning. |
| after | query | No | string | En markör för användning i paginering.
after är ett objekt-ID som definierar din plats i listan. Till exempel, om du gör en listförfrågan och tar emot 100 objekt som slutar på obj_foo, kan ditt efterföljande anrop inkludera efter=obj_foo för att hämta nästa sida i listan. |
| before | query | No | string | En markör för användning i paginering.
before är ett objekt-ID som definierar din plats i listan. Till exempel, om du gör en listförfrågan och tar emot 100 objekt, med start från obj_foo, kan ditt efterföljande anrop inkludera before=obj_foo för att hämta föregående sida i listan. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | listRunsResponse |
Examples
Example
Returnerar en lista över körningar som tillhör en tråd.
GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-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=2025-04-01-preview
Skapa en run.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för tråden som ska köras. |
| include[] | query | No | array | En lista med ytterligare fält att inkludera i svaret. För närvarande är step_details.tool_calls[*].file_search.results[*].content det enda stödda värdet att hämta filens sökresultatinnehåll. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| additional_instructions | string | Bifogar ytterligare instruktioner i slutet av instruktionerna för körningen. Detta är användbart för att modifiera beteendet per körning utan att åsidosätta andra instruktioner. | No | |
| additional_messages | array | Lägger till ytterligare meddelanden i tråden innan körningen skapas. | No | |
| assistant_id | string | ID:t på assistenten som ska användas för att utföra denna runda. | Yes | |
| instructions | string | Åsidosätt assistentens standardsystemmeddelande. Detta är användbart för att modifiera beteendet per körning. | No | |
| max_completion_tokens | integer | Det maximala antalet kompletteringstokens som kan användas under körningens gång. Körningen gör sitt bästa för att använda endast det antal fullbordande-tokens som anges över flera turer av rundan. Om körningen överstiger det angivna antalet kompletteringstokens avslutas körningen med status incomplete. Se incomplete_details för mer information. |
No | |
| max_prompt_tokens | integer | Det maximala antalet prompt-tokens som kan användas under loppets gång. Runen gör sitt bästa för att använda endast det antal prompttokens som angivits, över flera turer av runet. Om körningen överstiger antalet prompt-tokens som anges avslutas med status incomplete. Se incomplete_details för mer information. |
No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| model | string | ID:t för modellen som ska användas för att utföra denna körning. Om ett värde anges här kommer det att åsidosätta modellen som är kopplad till assistenten. Om inte, kommer modellen som är kopplad till assistenten att användas. | No | |
| parallel_tool_calls | ParallelToolCalls | Om man ska aktivera parallell funktionsanrop under verktygsanvändning. | No | True |
| response_format | assistantsApiResponseFormatOption | Specificerar formatet som modellen måste skriva ut. Kompatibel med GPT-4o, GPT-4 Turbo och alla GPT-3.5 Turbo-modeller sedan dess.gpt-3.5-turbo-1106Inställning till { "type": "json_schema", "json_schema": {...} } aktiverar strukturerade utdata som säkerställer att modellen matchar ditt tillhandahållna JSON-schema. Läs mer i guiden för strukturerade utdata.Att sätta på { "type": "json_object" } aktiverar JSON-läge, vilket säkerställer att meddelandet modellen genererar är giltigt JSON.Viktigt: när du använder JSON-läge måste du också instruera modellen att själv producera JSON via ett system- eller användarmeddelande. Utan detta kan modellen generera en oändlig ström av whitespace tills genereringen når tokengränsen, vilket resulterar i en långvarig och till synes "fastkilad" förfrågan. Observera också att meddelandeinnehållet kan vara delvis avskuret om finish_reason="length", vilket indikerar att genereringen överskridits max_tokens eller att konversationen överskred maxkontextlängden. |
No | |
| stream | boolean | Om true, returnerar en ström av händelser som sker under Körningen som serverskickade händelser, och avslutas när Körningen går in i ett terminalläge med ett data: [DONE] meddelande. |
No | |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. |
No | 1 |
| tool_choice | assistantsApiToolChoiceOption | Styr vilket (om något) verktyg som anropas av modellen.none Det betyder att modellen inte anropar några verktyg utan istä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.Att specificera ett särskilt verktyg som {"type": "file_search"} eller {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa det verktyget. |
No | |
| tools | array | Överstyr verktygen som assistenten kan använda för denna genomspelning. Detta är användbart för att modifiera beteendet per körning. | No | |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperaturen men inte båda. |
No | 1 |
| truncation_strategy | truncationObject | Kontroller för hur en tråd kommer att förkortas innan körningen. Använd detta för att styra det initiala kontextfönstret för körningen. | No |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | runObject |
Examples
Example
Skapa en run.
POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-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"
}
}
Spring – Spring
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview
Hämtar en löpning.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för trådarna som kördes. |
| run_id | path | Yes | string | ID:t för den som skulle hämta den. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | runObject |
Examples
Example
Får en löpning.
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-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": {}
}
}
Modifiera - Kör
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview
Modifierar en genomspelning.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för trådarna som kördes. |
| run_id | path | Yes | string | ID:t för den körning som ska ändras. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | runObject |
Examples
Example
Modifierar en genomspelning.
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-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 in - Verktygsutdata att köra
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview
När en körning har status: "requires_action" och required_action.type är submit_tool_outputs, kan denna endpoint användas för att skicka utdata från verktygsanropen när de är klara. Alla utdata måste skickas in i en enda begäran.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för trådarna som denna löpning tillhör. |
| run_id | path | Yes | string | ID:t för körningen som kräver verktygsutdelningen. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| stream | boolean | Om true, returnerar en ström av händelser som sker under Körningen som serverskickade händelser, och avslutas när Körningen går in i ett terminalläge med ett data: [DONE] meddelande. |
No | |
| tool_outputs | array | En lista över verktyg för vilka utdata skickas in. | Yes |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | runObject |
Examples
Example
När en körning har status: "requires_action" och required_action.type är submit_tool_outputs, kan denna endpoint användas för att skicka utdata från verktygsanropen när de är klara. Alla utdata måste skickas in i en enda begäran.
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-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=2025-04-01-preview
Avbryter en körning som är in_progress.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för tråden som denna sekvens tillhör. |
| run_id | path | Yes | string | ID:t för löpningen för att ställa in. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | runObject |
Examples
Example
Avbryter en körning som är in_progress.
POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-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örsteg
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview
Returnerar en lista över körsteg som tillhör en körning.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för tråden som kör- och körstegen tillhör. |
| run_id | path | Yes | string | ID:t för körningen som körstegen tillhör. |
| limit | query | No | integer | En gräns för antalet objekt som ska returneras. Gränsen kan ligga mellan 1 och 100, och standardvärdet är 20. |
| order | query | No | string Möjliga värden: asc, desc |
Sortera ordning efter created_at objektens tidsstämpel.
asc för stigande ordning och desc för fallande ordning. |
| after | query | No | string | En markör för användning i paginering.
after är ett objekt-ID som definierar din plats i listan. Till exempel, om du gör en listförfrågan och tar emot 100 objekt som slutar på obj_foo, kan ditt efterföljande anrop inkludera efter=obj_foo för att hämta nästa sida i listan. |
| before | query | No | string | En markör för användning i paginering.
before är ett objekt-ID som definierar din plats i listan. Till exempel, om du gör en listförfrågan och tar emot 100 objekt, med start från obj_foo, kan ditt efterföljande anrop inkludera before=obj_foo för att hämta föregående sida i listan. |
| api-version | query | Yes | string | |
| include[] | query | No | array | En lista med ytterligare fält att inkludera i svaret. För närvarande är step_details.tool_calls[*].file_search.results[*].content det enda stödda värdet att hämta filens sökresultatinnehåll. |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | listRunStepsResponse |
Examples
Example
Returnerar en lista över körsteg som tillhör en körning.
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-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
}
}
Få - Spring steg
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview
Hämtar ett springsteg.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| thread_id | path | Yes | string | ID:t för tråden som kör- och kör-steget tillhör. |
| run_id | path | Yes | string | ID:t för den körning som löpsteget tillhör. |
| step_id | path | Yes | string | ID:t för det steg som kör för att hämta in. |
| include[] | query | No | array | En lista med ytterligare fält att inkludera i svaret. För närvarande är step_details.tool_calls[*].file_search.results[*].content det enda stödda värdet att hämta filens sökresultatinnehåll. |
| api-version | query | Yes | string |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | runStepObject |
Examples
Example
Hämtar ett springsteg.
GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-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 - Vektorbutiker
GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview
Returnerar en lista över vektorlagre.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| limit | query | No | integer | En gräns för antalet objekt som ska returneras. Gränsen kan ligga mellan 1 och 100, och standardvärdet är 20. |
| order | query | No | string Möjliga värden: asc, desc |
Sortera ordning efter created_at objektens tidsstämpel.
asc för stigande ordning och desc för fallande ordning. |
| after | query | No | string | En markör för användning i paginering.
after är ett objekt-ID som definierar din plats i listan. Till exempel, om du gör en listförfrågan och tar emot 100 objekt som slutar på obj_foo, kan ditt efterföljande anrop inkludera efter=obj_foo för att hämta nästa sida i listan. |
| before | query | No | string | En markör för användning i paginering.
before är ett objekt-ID som definierar din plats i listan. Till exempel, om du gör en listförfrågan och tar emot 100 objekt, med start från obj_foo, kan ditt efterföljande anrop inkludera before=obj_foo för att hämta föregående sida i listan. |
| api-version | query | Yes | string | api version |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | listVectorStoresResponse |
Examples
Example
Returnerar en lista över vektorlagre.
GET https://{endpoint}/openai/vector_stores?api-version=2025-04-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 - Vektorlagring
POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview
Skapa en vektorlagring.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| api-version | query | Yes | string | api version |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| chunking_strategy | autoChunkingStrategyRequestParam eller staticChunkingStrategyRequestParam | Chunking-strategin används för att chunka filen/filerna. Om det inte är satt, kommer jag att använda strategin auto . Endast tillämplig om file_ids är icke-tom. |
No | |
| expires_after | vectorStoreExpirationAfter | Utgångspolicyn för en vektorlagring. | No | |
| file_ids | array | En lista över fil-ID:n som vektorlagringen bör använda. Användbart för sådana file_search verktyg som kan komma åt filer. |
No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| name | string | Namnet på vektorlagret. | No |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | vectorStoreObject |
Examples
Example
Skapar en vektorlagring.
POST https://{endpoint}/openai/vector_stores?api-version=2025-04-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 - Vektor Store
GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview
Hämtar en vektorlagring.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| vector_store_id | path | Yes | string | ID:t för vektorlagret som ska hämtas. |
| api-version | query | Yes | string | api version |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | vectorStoreObject |
Examples
Example
Hämtar en vektorlagring.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview
Svar: Statuskod: 200
{
"body": {
"id": "vs_abc123",
"object": "vector_store",
"created_at": 1699061776
}
}
Modify - Vektorlagring
POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview
Modifierar en vektorlagring.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| vector_store_id | path | Yes | string | ID:t för vektorlagret att modifiera. |
| api-version | query | Yes | string | api version |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| expires_after | vectorStoreExpirationAfter | Utgångspolicyn för en vektorlagring. | No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| name | string | Namnet på vektorlagret. | No |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | vectorStoreObject |
Examples
Example
Modifierar en vektorlagring.
POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-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 - Vektorlagring
DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview
Ta bort en vektorlagring.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| vector_store_id | path | Yes | string | ID:t för vektorlagret att ta bort. |
| api-version | query | Yes | string | api version |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | deleteVectorStoreResponse |
Examples
Example
Tar bort en vektorlagring.
DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-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=2025-04-01-preview
Returnerar en lista över vektorlagrefiler.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| vector_store_id | path | Yes | string | ID:t för vektorlagringen som filerna tillhör. |
| limit | query | No | integer | En gräns för antalet objekt som ska returneras. Gränsen kan ligga mellan 1 och 100, och standardvärdet är 20. |
| order | query | No | string Möjliga värden: asc, desc |
Sortera ordning efter created_at objektens tidsstämpel.
asc för stigande ordning och desc för fallande ordning. |
| after | query | No | string | En markör för användning i paginering.
after är ett objekt-ID som definierar din plats i listan. Till exempel, om du gör en listförfrågan och tar emot 100 objekt som slutar på obj_foo, kan ditt efterföljande anrop inkludera efter=obj_foo för att hämta nästa sida i listan. |
| before | query | No | string | En markör för användning i paginering.
before är ett objekt-ID som definierar din plats i listan. Till exempel, om du gör en listförfrågan och tar emot 100 objekt, med start från obj_foo, kan ditt efterföljande anrop inkludera before=obj_foo för att hämta föregående sida i listan. |
| filter | query | No | string Möjliga värden: in_progress, completed, failed, cancelled |
Filtrera efter filstatus. En av in_progress, completed, failed, . cancelled |
| api-version | query | Yes | string | api version |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | listVectorStoreFilesResponse |
Examples
Example
Returnerar en lista över vektorlagrefiler.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-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=2025-04-01-preview
Skapa en vektorlagringsfil genom att bifoga en fil till en vektorlagring.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| vector_store_id | path | Yes | string | ID:t för vektorlagringen för vilken en fil ska skapas. |
| api-version | query | Yes | string | api version |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| chunking_strategy | chunkingStrategyRequestParam | Chunking-strategin används för att chunka filen/filerna. Om det inte är satt, kommer jag att använda strategin auto . |
No | |
| file_id | string | Ett fil-ID som vektorlagret bör använda. Användbart för sådana file_search verktyg som kan komma åt filer. |
Yes |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | vectorStoreFileObject |
Examples
Example
Skapa en vektorlagringsfil genom att bifoga en fil till en vektorlagring.
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-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=2025-04-01-preview
Hämtar en vektorlagringsfil.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| vector_store_id | path | Yes | string | ID:t för vektorlagringen som filen tillhör. |
| file_id | path | Yes | string | ID:t på filen som hämtas. |
| api-version | query | Yes | string | api version |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | vectorStoreFileObject |
Examples
Example
Hämtar en vektorlagringsfil.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-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=2025-04-01-preview
Ta bort en vektorlagerfil. Detta tar bort filen från vektorlagret men själva filen raderas inte. För att ta bort filen, använd delete-fil-endpointen.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| vector_store_id | path | Yes | string | ID:t för vektorlagringen som filen tillhör. |
| file_id | path | Yes | string | ID:t för filen som ska tas bort. |
| api-version | query | Yes | string | api version |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | deleteVectorStoreFileResponse |
Examples
Example
Ta bort en vektorlagerfil. Detta tar bort filen från vektorlagret men själva filen raderas inte. För att ta bort filen, använd delete-fil-endpointen.
DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview
Svar: Statuskod: 200
{
"body": {
"id": "file_abc123",
"object": "vector_store.file.deleted",
"deleted": true
}
}
Updatevectorstorefileattributes
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview
Uppdatera attribut i en vektorlagringsfil.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| vector_store_id | path | Yes | string | ID:t för vektorlagret som filen tillhör. |
| file_id | path | Yes | string | Filens ID för att uppdatera attributen. |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| attributes | VectorStoreFileAttributes | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och för att söka objekt via API eller instrumentpanelen. Tangenter är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken, booleaner eller tal. |
Yes |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | vectorStoreFileObject |
Hämta innehåll från vektorlagrefilerna
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview
Hämta det parsade innehållet i en vektorfil.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| vector_store_id | path | Yes | string | ID:t för vektorlagringen. |
| file_id | path | Yes | string | ID:t för filen i vektorlagringen. |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | VectorStoreFileContentResponse |
Sökvektorlagring
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview
Sök i en vektorlagring efter relevanta chunks baserat på ett filter för frågor och filattribut.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| vector_store_id | path | Yes | string | ID:t för vektorlagret att söka i. |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| filters | ComparisonFilter eller CompoundFilter | Ett filter att applicera baserat på filattribut. | No | |
| max_num_results | integer | Det maximala antalet resultat att returnera. Detta antal bör ligga mellan 1 och 50 inklusive. | No | 10 |
| query | Sträng eller array | En frågesträng för en sökning | Yes | |
| ranking_options | object | Rankningsalternativ för sökning. | No | |
| └─ ranker | enum | Möjliga värden: auto, default-2024-11-15 |
No | |
| └─ score_threshold | number | No | 0 | |
| rewrite_query | boolean | Om man ska skriva om den naturliga språkfrågan för vektorsökning. | No | False |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | VectorStoreSearchResultsPage |
Skapa - Vektorlagringsfilbatch
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview
Skapa en vektorlagringsfilbatch.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| vector_store_id | path | Yes | string | ID:t för vektorlagringen för vilken en filbatch ska skapas. |
| api-version | query | Yes | string | api version |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| chunking_strategy | chunkingStrategyRequestParam | Chunking-strategin används för att chunka filen/filerna. Om det inte är satt, kommer jag att använda strategin auto . |
No | |
| file_ids | array | En lista över fil-ID:n som vektorlagret bör använda. Användbart för sådana file_search verktyg som kan komma åt filer. |
Yes |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | vectorStoreFileBatchObject |
Examples
Example
Skapa en vektorlagringsfilbatch.
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-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
}
}
Hämta - Vektorlagringsfilbatch
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview
Hämtar en vektorlagringsfilbatch.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| vector_store_id | path | Yes | string | ID:t för vektorlagret som filbatchen tillhör. |
| batch_id | path | Yes | string | ID:t för filbatchen som hämtas. |
| api-version | query | Yes | string | api version |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | vectorStoreFileBatchObject |
Examples
Example
Hämtar en vektorlagringsfilbatch.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-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 - Vektorlagringsfilbatch
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview
Avbryt en batch av vektorlagringsfiler. Detta försöker avbryta bearbetningen av filer i denna batch så snart som möjligt.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| vector_store_id | path | Yes | string | ID:t för vektorlagret som filbatchen tillhör. |
| batch_id | path | Yes | string | ID:t för filbatchen för att avbryta. |
| api-version | query | Yes | string | api version |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | vectorStoreFileBatchObject |
Examples
Example
Avbryt en batch av vektorlagringsfiler. Detta försöker avbryta bearbetningen av filer i denna batch så snart som möjligt.
POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-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 - Vektorlagringsfiler för batchfiler
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview
Returnerar en lista med vektorlagrefiler i en batch.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| vector_store_id | path | Yes | string | ID:t för vektorlagringen som filerna tillhör. |
| batch_id | path | Yes | string | ID:t för filbatchen som filerna tillhör. |
| limit | query | No | integer | En gräns för antalet objekt som ska returneras. Gränsen kan ligga mellan 1 och 100, och standardvärdet är 20. |
| order | query | No | string Möjliga värden: asc, desc |
Sortera ordning efter created_at objektens tidsstämpel.
asc för stigande ordning och desc för fallande ordning. |
| after | query | No | string | En markör för användning i paginering.
after är ett objekt-ID som definierar din plats i listan. Till exempel, om du gör en listförfrågan och tar emot 100 objekt som slutar på obj_foo, kan ditt efterföljande anrop inkludera efter=obj_foo för att hämta nästa sida i listan. |
| before | query | No | string | En markör för användning i paginering.
before är ett objekt-ID som definierar din plats i listan. Till exempel, om du gör en listförfrågan och tar emot 100 objekt, med start från obj_foo, kan ditt efterföljande anrop inkludera before=obj_foo för att hämta föregående sida i listan. |
| filter | query | No | string Möjliga värden: in_progress, completed, failed, cancelled |
Filtrera efter filstatus. En av in_progress, completed, failed, . cancelled |
| api-version | query | Yes | string | api version |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | listVectorStoreFilesResponse |
Examples
Example
Returnerar en lista över vektorlagrefiler.
GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-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
}
}
Create - Realtimesession
POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview
Skapa en efemär API-token för användning i klientapplikationer med Realtime API:et. Kan konfigureras med samma sessionsparametrar som session.update klienthändelsen.
Den svarar med ett sessionsobjekt samt en client_secret nyckel som innehåller en användbar kortvarig API-token som kan användas för att autentisera webbläsarklienter för Realtime API:et.
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input_audio_format | enum | Formatet för inmatningsljud. Alternativen är pcm16, g711_ulaw, eller g711_alaw.För pcm16, måste indataljudet vara 16-bitars PCM med en samplingsfrekvens på 24 kHz, enkelkanalig (mono) och little-endian byte-ordning.Möjliga värden: pcm16, g711_ulaw, g711_alaw |
No | |
| input_audio_noise_reduction | object | Konfiguration för inmatningsljudbrusreducering. Den kan ställas in på null att stänga av.Brusreducering filtrerar ljud som läggs till i ingångsljudbufferten innan det skickas till VAD och modellen. Filtrering av ljudet kan förbättra noggrannheten för VAD och vändningsdetektering (minska falska positiva) samt modellera prestandan genom att förbättra uppfattningen av inmatningsljudet. |
No | |
| └─ type | enum | Typ av brusreducering.
near_field är för närtalande mikrofoner som hörlurar, far_field är för fjärrfältsmikrofoner såsom laptop- eller konferensrumsmikrofoner.Möjliga värden: near_field, far_field |
No | |
| input_audio_transcription | object | Konfigurationen för ingångsljudtranskribering är som standard avstängd och kan ställas in för null att stängas av när den är på. Inmatad ljudtranskribering är inte inbyggd i modellen, eftersom modellen konsumerar ljud direkt. Transkribering körs asynkront genom Transkriberingsändpunkten och bör behandlas som vägledning av inmatat ljudinnehåll snarare än exakt vad modellen hörde. Klienten kan valfritt ställa in språk och prompt för transkribering, dessa ger ytterligare vägledning till transkriberingstjänsten. |
No | |
| └─ language | string | Språket för inmatningsljudet. Att tillhandahålla inmatningsspråket i ISO-639-1 (t.ex. en) format förbättrar noggrannhet och latens. |
No | |
| └─ model | string | Modellen för transkription, nuvarande alternativ är gpt-4o-transcribe, gpt-4o-transcribe-diarize, , gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15och whisper-1. |
No | |
| └─ prompt | string | En valfri text för att styra modellens stil eller fortsätta ett tidigare ljudsegment. För whisper-1, är prompten en lista med nyckelord.För gpt-4o-transcribe modeller är prompten en fri textsträng, till exempel "förvänta dig ord relaterade till teknik". |
No | |
| instructions | string | Standardinstruktionerna för systemet (dvs. systemmeddelandet) föregick modelleringsanrop. Detta fält gör det möjligt för klienten att styra modellen på önskade svar. Modellen kan instrueras om svarsinnehåll och format (t.ex. "var extremt kortfattad", "agera vänlig", "här är exempel på bra svar") och om ljudbeteende (t.ex. "prata snabbt", "injicera känsla i din röst", "skratta ofta"). Instruktionerna är inte garanterade att följa av modellen, men de ger vägledning till modellen om önskat beteende. Observera att servern sätter standardinstruktioner som kommer att användas om detta fält inte är inställt och är synliga i händelsen session.created i början av sessionen. |
No | |
| max_response_output_tokens | Heltal eller sträng | Maximalt antal utmatningstoken för ett enda assistentsvar, inklusive verktygsanrop. Ange ett heltal mellan 1 och 4096 för att begränsa utmatningstoken, eller inf för det maximalt tillgängliga tokens för en given modell. Går som standard till inf. |
No | |
| modalities | Den mängd modaliteter som modellen kan svara med. För att inaktivera ljudet, ställ in detta på ["text"]. |
No | ||
| model | string | Namnet på den utplacering som användes för denna session. |
No | |
| output_audio_format | enum | Formatet för utgående ljud. Alternativen är pcm16, g711_ulaw, eller g711_alaw.För pcm16, samplas utgångsljudet med en hastighet av 24 kHz.Möjliga värden: pcm16, g711_ulaw, g711_alaw |
No | |
| temperature | number | Provtagningstemperatur för modellen, begränsad till [0,6, 1,2]. För ljudmodeller rekommenderas en temperatur på 0,8 starkt för bästa prestanda. |
No | 0.8 |
| tool_choice | string | Hur modellen väljer verktyg. Alternativen är auto, none, , requiredeller specificera en funktion. |
No | auto |
| tools | array | Verktyg (funktioner) tillgängliga för modellen. | No | |
| turn_detection | object | Konfiguration för turdetektion, antingen server-VAD eller semantisk VAD. Detta kan ställas in på null att stängas av, i vilket fall klienten manuellt måste trigga modellrespons.Server-VAD innebär att modellen kommer att upptäcka början och slutet av tal baserat på ljudvolym och svara i slutet av användarens tal. Semantisk VAD är mer avancerad och använder en modell för svängdetektering (i kombination med VAD) för att semantiskt uppskatta om användaren har talat klart, och sätter sedan dynamiskt en timeout baserat på denna sannolikhet. Till exempel, om användarljudet tonar ut med uhhm, kommer modellen att ge låg sannolikhet att turen slutar och vänta längre på att användaren ska fortsätta tala. Detta kan vara användbart för mer naturliga samtal, men kan ha högre latens. |
No | |
| └─ create_response | boolean | Om man automatiskt ska generera ett svar när en VAD-stopphändelse inträffar. |
No | True |
| └─ eagerness | enum | Används endast för semantic_vad läge. Modellens iver att svara.
low Väntar längre på att användaren ska fortsätta prata, high svarar snabbare.
auto är standarden och är ekvivalent med medium.Möjliga värden: low, medium, high, auto |
No | |
| └─ interrupt_response | boolean | Om man automatiskt ska avbryta ett pågående svar med utgång till standardkonversationen (dvs. conversation av auto) när en VAD-starthändelse inträffar. |
No | True |
| └─ prefix_padding_ms | integer | Används endast för server_vad läge. Mängden ljud som ska inkluderas innan VAD upptäckte tal (i millisekunder). Standardinställningen är 300 ms. |
No | |
| └─ silence_duration_ms | integer | Används endast för server_vad läge. Tystnadens längd för att upptäcka talstopp (i millisekunder). Standardinställningen är 500 ms. Med kortare värden svarar modellen snabbare, men kan hoppa in vid korta pauser från användaren. |
No | |
| └─ threshold | number | Används endast för server_vad läge. Aktiveringsgränsen för VAD (0,0 till 1,0), detta är standardvärdet 0,5. En högre tröskel kräver högre ljud för att aktivera modellen, och kan därför prestera bättre i bullriga miljöer. |
No | |
| └─ type | enum | Typ av svängdetektion. Möjliga värden: server_vad, semantic_vad |
No | |
| voice | VoiceIdsShared | No |
Responses
Statuskod: 200
Beskrivning: Sessionen skapades framgångsrikt.
| Content-Type | Type | Description |
|---|---|---|
| application/json | RealtimeSessionCreateResponse |
Skapa - Transkriberanderealtidssession
POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview
Skapa en efemär API-token för användning i klientapplikationer med Realtime API:et, specifikt för realtidstranskriptioner.
Kan konfigureras med samma sessionsparametrar som transcription_session.update klienthändelsen.
Den svarar med ett sessionsobjekt samt en client_secret nyckel som innehåller en användbar kortvarig API-token som kan användas för att autentisera webbläsarklienter för Realtime API:et.
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| include | array | Uppsättningen av objekt som ska ingå i transkriptionen. Nuvarande tillgängliga föremål är: - item.input_audio_transcription.logprobs |
No | |
| input_audio_format | enum | Formatet för inmatningsljud. Alternativen är pcm16, g711_ulaw, eller g711_alaw.För pcm16, måste indataljudet vara 16-bitars PCM med en samplingsfrekvens på 24 kHz, enkelkanalig (mono) och little-endian byte-ordning.Möjliga värden: pcm16, g711_ulaw, g711_alaw |
No | |
| input_audio_noise_reduction | object | Konfiguration för inmatningsljudbrusreducering. Den kan ställas in på null att stänga av.Brusreducering filtrerar ljud som läggs till i ingångsljudbufferten innan det skickas till VAD och modellen. Filtrering av ljudet kan förbättra noggrannheten för VAD och vändningsdetektering (minska falska positiva) samt modellera prestandan genom att förbättra uppfattningen av inmatningsljudet. |
No | |
| └─ type | enum | Typ av brusreducering.
near_field är för närtalande mikrofoner som hörlurar, far_field är för fjärrfältsmikrofoner såsom laptop- eller konferensrumsmikrofoner.Möjliga värden: near_field, far_field |
No | |
| input_audio_transcription | object | Konfiguration för indata-ljudtranskription. Klienten kan valfritt ställa in språk och prompt för transkribering, dessa ger ytterligare vägledning till transkriberingstjänsten. |
No | |
| └─ language | string | Språket för inmatningsljudet. Att tillhandahålla inmatningsspråket i ISO-639-1 (t.ex. en) format förbättrar noggrannhet och latens. |
No | |
| └─ model | enum | Modellen som används för transkription, nuvarande alternativ är gpt-4o-transcribe, gpt-4o-mini-transcribe, , gpt-4o-mini-transcribe-2025-12-15och whisper-1.Möjliga värden: gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, whisper-1 |
No | |
| └─ prompt | string | En valfri text för att styra modellens stil eller fortsätta ett tidigare ljudsegment. För whisper-1, är prompten en lista med nyckelord.För gpt-4o-transcribe modeller är prompten en fri textsträng, till exempel "förvänta dig ord relaterade till teknik". |
No | |
| modalities | Den mängd modaliteter som modellen kan svara med. För att inaktivera ljudet, ställ in detta på ["text"]. |
No | ||
| turn_detection | object | Konfiguration för turdetektion, antingen server-VAD eller semantisk VAD. Detta kan ställas in på null att stängas av, i vilket fall klienten manuellt måste trigga modellrespons.Server-VAD innebär att modellen kommer att upptäcka början och slutet av tal baserat på ljudvolym och svara i slutet av användarens tal. Semantisk VAD är mer avancerad och använder en modell för svängdetektering (i kombination med VAD) för att semantiskt uppskatta om användaren har talat klart, och sätter sedan dynamiskt en timeout baserat på denna sannolikhet. Till exempel, om användarljudet tonar ut med uhhm, kommer modellen att ge låg sannolikhet att turen slutar och vänta längre på att användaren ska fortsätta tala. Detta kan vara användbart för mer naturliga samtal, men kan ha högre latens. |
No | |
| └─ create_response | boolean | Om man automatiskt ska generera ett svar när en VAD-stopphändelse inträffar. Inte tillgänglig för transkriptionssessioner. |
No | True |
| └─ eagerness | enum | Används endast för semantic_vad läge. Modellens iver att svara.
low Väntar längre på att användaren ska fortsätta prata, high svarar snabbare.
auto är standarden och är ekvivalent med medium.Möjliga värden: low, medium, high, auto |
No | |
| └─ interrupt_response | boolean | Om man automatiskt ska avbryta ett pågående svar med utgång till standardkonversationen (dvs. conversation av auto) när en VAD-starthändelse inträffar. Inte tillgänglig för transkriptionssessioner. |
No | True |
| └─ prefix_padding_ms | integer | Används endast för server_vad läge. Mängden ljud som ska inkluderas innan VAD upptäckte tal (i millisekunder). Standardinställningen är 300 ms. |
No | |
| └─ silence_duration_ms | integer | Används endast för server_vad läge. Tystnadens längd för att upptäcka talstopp (i millisekunder). Standardinställningen är 500 ms. Med kortare värden svarar modellen snabbare, men kan hoppa in vid korta pauser från användaren. |
No | |
| └─ threshold | number | Används endast för server_vad läge. Aktiveringsgränsen för VAD (0,0 till 1,0), detta är standardvärdet 0,5. En högre tröskel kräver högre ljud för att aktivera modellen, och kan därför prestera bättre i bullriga miljöer. |
No | |
| └─ type | enum | Typ av svängdetektion. Möjliga värden: server_vad, semantic_vad |
No |
Responses
Statuskod: 200
Beskrivning: Sessionen skapades framgångsrikt.
| Content-Type | Type | Description |
|---|---|---|
| application/json | RealtimeTranscriptionSessionCreateResponse |
Responses
POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview
Skapar ett modellsvar.
Request Body
Content-Type: application/json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| include | array | No | ||
| input | Sträng eller array | Model inputs | Yes | |
| instructions | string | Infogar ett system- (eller utvecklar-) meddelande som första objekt i modellens kontext. När man använder tillsammans med previous_response_id, kommer instruktionerna från ett tidigare svar inte att föras över till nästa svar. Detta gör det enkelt att byta ut system- (eller utvecklar-) meddelanden i nya svar. |
No | |
| max_output_tokens | integer | En övre gräns för antalet tokens som kan genereras för ett svar, inklusive synliga utdatatoken och konversationstillstånd. |
No | |
| parallel_tool_calls | boolean | Om modellen ska köras parallellt. |
No | True |
| previous_response_id | string | Det unika ID:t för det tidigare svaret på modellen. Använd detta för att skapa konversationer med flera turer. Lär dig mer om samtalstillstånd. |
No | |
| reasoning | Reasoning | Konfigurationsalternativ för resonemangsmodeller. | No | |
| store | boolean | Om det genererade modellsvaret ska lagras för senare hämtning via API. |
No | True |
| stream | boolean | Om den sätts till true strömmas modellens svarsdata till klienten när den genereras med hjälp av serverskickade händelser. Se avsnittet Streaming nedan för mer information. |
No | False |
| text | object | Konfigurationsalternativ för ett textsvar från modellen. Det kan vara ren text eller strukturerad JSON-data. Learn more: - Textinmatningar och utdata - Strukturerade utdata |
No | |
| └─ format | TextResponseFormatConfiguration | Ett objekt som specificerar formatet som modellen måste ge utmatning. Konfiguration { "type": "json_schema" } aktiverar strukturerade utdata, vilket säkerställer att modellen matchar ditt tillhandahållna JSON-schema.Standardformatet är { "type": "text" } utan några extra alternativ.Rekommenderas inte för GPT-4o och nyare modeller: Att sätta på { "type": "json_object" } aktiverar det äldre JSON-läget, vilket säkerställer att meddelandet modellen genererar är giltigt JSON. Att använda är att föredra json_schema för modeller som stödjer det. |
No | |
| tool_choice | VerktygvalVal eller VerktygValTyper eller VerktygValFunktion | Hur modellen ska välja vilket verktyg (eller vilka verktyg) som ska användas när de genererar ett svar. Se parametern tools för att se hur man specificerar vilka verktyg modellen kan anropa. |
No | |
| tools | array | En uppsättning verktyg som modellen kan anropa samtidigt som den genererar ett svar. Du kan ange vilket verktyg du ska använda genom att ställa in parametern tool_choice .De två kategorierna av verktyg du kan tillhandahålla modellen är: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI och som utvidgar model's capabilities |
No | |
| truncation | enum | Strategin för trunkering att använda för modellens svar. - auto: Om kontexten för detta svar och tidigare överstiger modellens kontextfönsterstorlek, kommer modellen att förkorta svaret för att passa kontextfönstret genom att lägga till inmatningsobjekt mitt i samtalet. - disabled (standard): Om ett modellsvar överstiger kontextfönstret för en modell, kommer förfrågan att misslyckas med ett felmeddelande på 400.Möjliga värden: auto, disabled |
No |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | response | |
| text/event-stream | responseStreamEvent |
Statuskod: standard
Beskrivning: Tjänsten är inte tillgänglig
| Content-Type | Type | Description |
|---|---|---|
| application/json | errorResponse |
Respons-API - inmatningsobjekt
GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview
Hämtar ett modellsvar med det givna ID:t.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| response_id | path | Yes | string | ID:t på svaret för att hämta. |
| include | query | No | array | Ytterligare fält att inkludera i svaret. Se parametern include för Responsskapande ovan för mer information. |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | response |
Statuskod: standard
Beskrivning: Tjänsten är inte tillgänglig
| Content-Type | Type | Description |
|---|---|---|
| application/json | errorResponse |
Delete response
DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview
Tar bort ett modellsvar med det givna ID:t.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| response_id | path | Yes | string | ID:t för svaret att ta bort. |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
Statuskod: 404
Beskrivning: Ej hittad
| Content-Type | Type | Description |
|---|---|---|
| application/json | error |
Statuskod: standard
Beskrivning: Tjänsten är inte tillgänglig
| Content-Type | Type | Description |
|---|---|---|
| application/json | errorResponse |
Responses API - lista över svarsobjekt
GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview
Returnerar en lista med indata för ett givet svar.
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| endpoint | path | Yes | string url | Stödd Azure OpenAI-endpoints (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Byt ut "aoairesource" mot ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com |
| response_id | path | Yes | string | ID:t för svaret för att hämta inmatningsobjekt för. |
| limit | query | No | integer | En gräns för antalet objekt som ska returneras. Gränsen kan ligga mellan 1 och 100, och standardvärdet är 20. |
| order | query | No | string Möjliga värden: asc, desc |
Ordningen för att returnera inmatningsobjekten. Standard är asc.- asc: Returnera inmatningsobjekten i stigande ordning.- desc: Returnera inmatningsobjekten i fallande ordning. |
| after | query | No | string | Ett objekt-ID att lista objekt efter, som används i paginering. |
| before | query | No | string | Ett objekt-ID för att lista objekt tidigare, använt i paginering. |
Request Header
Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True | string |
Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}För att generera en autentiseringstoken med hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comType: oauth2 Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeOmfattning: https://ai.azure.com/.default |
| api-key | True | string | Tillhandahåll Azure OpenAI API-nyckel här |
Responses
Statuskod: 200
Description: OK
| Content-Type | Type | Description |
|---|---|---|
| application/json | responseItemList |
Components
errorResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| error | error | No |
errorBase
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string | No | ||
| message | string | No |
error
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| inner_error | innerError | Inre fel med ytterligare detaljer. | No | |
| param | string | No | ||
| type | string | No |
innerError
Inre fel med ytterligare detaljer.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | innerErrorCode | Felkoder för det inre felobjektet. | No | |
| content_filter_results | contentFilterPromptResults | Information om innehållsfiltreringskategorin (hat, sexuell, våld, self_harm), om den har upptäckts, samt allvarlighetsgraden (very_low, låg, medel, 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 upptäckts och om det har filtrerats eller inte. Och information om kundblockeringslistan, om den har filtrerats och dess ID. | No |
innerErrorCode
Felkoder för det inre felobjektet.
| Property | Value |
|---|---|
| Description | Felkoder för det inre felobjektet. |
| Type | string |
| Values | ResponsibleAIPolicyViolation |
dalleErrorResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| error | dalleError | No |
dalleError
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| inner_error | dalleInnerError | Inre fel med ytterligare detaljer. | No | |
| param | string | No | ||
| type | string | No |
dalleInnerError
Inre fel med ytterligare detaljer.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | innerErrorCode | Felkoder för det inre felobjektet. | No | |
| content_filter_results | dalleFilterResults | Information om innehållsfiltreringskategorin (hat, sexuell, våld, self_harm), om den har upptäckts, samt allvarlighetsgraden (very_low, låg, medel, 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 upptäckts och om det har filtrerats eller inte. Och information om kundblockeringslistan, om den har filtrerats och dess ID. | No | |
| revised_prompt | string | Prompten som användes för att generera bilden, om det fanns någon revidering av prompten. | No |
contentFilterCompletionTextSpan
Beskriver ett spann inom genererad kompletteringstext. Offset 0 är den första UTF32-kodpunkten i fullbordningstexten.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| completion_end_offset | integer | Offset av den första UTF32-kodpunkten som är utesluten från spannet. Detta fält är alltid lika med completion_start_offset för tomma spann. Detta fält är alltid större än completion_start_offset för icke-tomma spann. | Yes | |
| completion_start_offset | integer | Förskjutning av UTF32-kodpunkten som börjar spannet. | Yes |
contentFilterResultBase
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| filtered | boolean | Yes |
contentFilterSeverityResult
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| filtered | boolean | Yes | ||
| severity | string | No |
contentFilterDetectedResult
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| detected | boolean | No | ||
| filtered | boolean | Yes |
contentFilterDetectedWithCitationResult
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| citation | object | No | ||
| └─ URL | string | No | ||
| └─ license | string | No |
contentFilterDetectedWithCompletionTextSpansResult
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| details | array | No |
contentFilterIdResult
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| filtered | boolean | Yes | ||
| id | string | No |
contentFilterResultsBase
Information om innehållet filtreringsresultat.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| custom_blocklists | contentFilterDetailedResults | Innehållsfiltrering ger en detalj av innehållsfilter-id:n för de filtrerade segmenten. | No | |
| error | errorBase | No | ||
| hate | contentFilterSeverityResult | No | ||
| profanity | contentFilterDetectedResult | No | ||
| self_harm | contentFilterSeverityResult | No | ||
| sexual | contentFilterSeverityResult | No | ||
| violence | contentFilterSeverityResult | No |
contentFilterPromptResults
Information om innehållsfiltreringskategorin (hat, sexuell, våld, self_harm), om den har upptäckts, samt allvarlighetsgraden (very_low, låg, medel, 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 upptäckts och om det har filtrerats eller inte. Och information om kundblockeringslistan, om den har filtrerats och dess ID.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| custom_blocklists | contentFilterDetailedResults | Innehållsfiltrering ger en detalj av innehållsfilter-id:n för de filtrerade segmenten. | No | |
| error | errorBase | No | ||
| hate | contentFilterSeverityResult | No | ||
| indirect_attack | contentFilterDetectedResult | No | ||
| jailbreak | contentFilterDetectedResult | No | ||
| profanity | contentFilterDetectedResult | No | ||
| self_harm | contentFilterSeverityResult | No | ||
| sexual | contentFilterSeverityResult | No | ||
| violence | contentFilterSeverityResult | No |
contentFilterChoiceResults
Information om innehållsfiltreringskategorin (hat, sexuell, våld, self_harm), om den har upptäckts, samt allvarlighetsgraden (very_low, låg, medel, hög skala som avgör intensiteten och risknivån för skadligt innehåll) och om den har filtrerats eller inte. Information om tredjepartstext och svordomar, om det har upptäckts och om det har filtrerats eller inte. Och information om kundblockeringslistan, om den har filtrerats och dess ID.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| custom_blocklists | contentFilterDetailedResults | Innehållsfiltrering ger en detalj av innehållsfilter-id:n för de filtrerade segmenten. | No | |
| error | errorBase | No | ||
| hate | contentFilterSeverityResult | No | ||
| profanity | contentFilterDetectedResult | No | ||
| protected_material_code | contentFilterDetectedWithCitationResult | No | ||
| protected_material_text | contentFilterDetectedResult | No | ||
| self_harm | contentFilterSeverityResult | No | ||
| sexual | contentFilterSeverityResult | No | ||
| ungrounded_material | contentFilterDetectedWithCompletionTextSpansResult | No | ||
| violence | contentFilterSeverityResult | No |
contentFilterDetailedResults
Innehållsfiltrering ger en detalj av innehållsfilter-id:n för de filtrerade segmenten.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| details | array | No | ||
| filtered | boolean | Yes |
promptFilterResult
Innehållsfiltrering resulterar för en enda prompt i förfrågan.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_filter_results | contentFilterPromptResults | Information om innehållsfiltreringskategorin (hat, sexuell, våld, self_harm), om den har upptäckts, samt allvarlighetsgraden (very_low, låg, medel, 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 upptäckts och om det har filtrerats eller inte. Och information om kundblockeringslistan, om den har filtrerats och dess ID. | No | |
| prompt_index | integer | No |
promptFilterResults
Innehållsfiltrering ger noll eller fler promptar i förfrågan. I en streamingförfrågan kan resultaten för olika prompts komma vid olika tidpunkter eller i olika ordning.
Inga egenskaper definierade för denna komponent.
dalleContentFilterResults
Information om innehållet filtreringsresultat.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| hate | contentFilterSeverityResult | No | ||
| self_harm | contentFilterSeverityResult | No | ||
| sexual | contentFilterSeverityResult | No | ||
| violence | contentFilterSeverityResult | No |
dalleFilterResults
Information om innehållsfiltreringskategorin (hat, sexuell, våld, self_harm), om den har upptäckts, samt allvarlighetsgraden (very_low, låg, medel, 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 upptäckts och om det har filtrerats eller inte. Och information om kundblockeringslistan, om den har filtrerats och dess ID.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| custom_blocklists | contentFilterDetailedResults | Innehållsfiltrering ger en detalj av innehållsfilter-id:n för de filtrerade segmenten. | No | |
| hate | contentFilterSeverityResult | No | ||
| jailbreak | contentFilterDetectedResult | No | ||
| profanity | contentFilterDetectedResult | No | ||
| self_harm | contentFilterSeverityResult | No | ||
| sexual | contentFilterSeverityResult | No | ||
| violence | contentFilterSeverityResult | No |
chatCompletionsRequestCommon
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| frequency_penalty | number | Siffran mellan -2,0 och 2,0. Positiva värden straffar nya tokens baserat på deras befintliga frekvens i texten hittills, vilket minskar modellens sannolikhet att upprepa samma rad ordagrant. | No | 0 |
| logit_bias | object | Ändra sannolikheten för att specificerade tokens ska dyka upp i slutförandet. Accepterar ett json-objekt som mappar tokens (specificerat av deras token-ID i tokenizern) till ett associerat biasvärde från -100 till 100. Matematiskt läggs biasen till de logits som genereras av modellen före urvalet. Den exakta effekten varierar mellan modellen, men värden mellan -1 och 1 bör minska eller öka sannolikheten för urval; Värden som -100 eller 100 bör leda till avstängning eller exklusivt val av relevant token. | No | |
| max_completion_tokens | integer | En övre gräns för antalet tokens som kan genereras för en fullbordan, inklusive synliga utdatatokens och resonemangstokens. | No | |
| max_tokens | integer | Det maximala antalet tokens tillät det genererade svaret. Som standard kommer antalet tokens modellen kan returnera vara (4096 - prompt-tokens). Detta är inte kompatibelt med O1-seriens modeller. | No | 4096 |
| metadata | object | Utvecklardefinierade taggar och värden som används för att filtrera färdigställanden i den lagrade fullföljandeinstrumentpanelen. | No | |
| presence_penalty | number | Siffran mellan -2,0 och 2,0. Positiva värden straffar nya tokens baserat på om de hittills förekommer i texten, vilket ökar modellens sannolikhet att tala om nya ämnen. | No | 0 |
| stop | Sträng eller array | Upp till 4 sekvenser där API:et slutar generera ytterligare tokens. | No | |
| store | boolean | Om vi ska lagra resultatet från denna chattförfrågan för användning i våra modelldestillations- eller utvärderingsprodukter. | No | |
| stream | boolean | Om det är satt skickas partiella meddelandedeltas, som i ChatGPT. Tokens skickas som data-enbart serverskickade händelser när de blir tillgängliga, och strömmen avslutas med ett data: [DONE] meddelande. |
No | False |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar generellt att ändra detta eller top_p båda. |
No | 1 |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperature båda. |
No | 1 |
| user | string | En unik identifierare som representerar din slutanvändare, vilket kan hjälpa Azure OpenAI att övervaka och upptäcka missbruk. | No |
createCompletionRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| best_of | integer | Genererar best_of fullbordanden serversidan och returnerar "bäst" (den med högst loggsannolikhet per token). Resultaten kan inte strömmas.När den används med nstyrs best_of antalet kandidatfullbordandes och n anges hur många som ska returneras.
best_of måste vara större än n.Notera: Eftersom denna parameter genererar många kompletteringar kan den snabbt förbruka din tokenkvot. Använd noggrant och se till att du har rimliga inställningar för max_tokens och stop. |
No | 1 |
| echo | boolean | Echo tillbaka prompten utöver slutförandet |
No | False |
| frequency_penalty | number | Siffran mellan -2,0 och 2,0. Positiva värden straffar nya tokens baserat på deras befintliga frekvens i texten hittills, vilket minskar modellens sannolikhet att upprepa samma rad ordagrant. |
No | 0 |
| logit_bias | object | Ändra sannolikheten för att specificerade tokens ska dyka upp i slutförandet. Accepterar ett JSON-objekt som mappar tokens (specificerade av deras token-ID i GPT-tokenizern) till ett associerat biasvärde från -100 till 100. Matematiskt läggs biasen till de logits som genereras av modellen före urvalet. Den exakta effekten varierar mellan modellen, men värden mellan -1 och 1 bör minska eller öka sannolikheten för urval; Värden som -100 eller 100 bör leda till avstängning eller exklusivt val av relevant token. Som exempel kan du passa {"50256": -100} för att förhindra <att |endoftext|> token genereras. |
No | None |
| logprobs | integer | Inkludera logsannolikheterna på de logprobs mest sannolika utdatatokenen, samt de valda tokens. Till exempel, om logprobs är 5, kommer API:et att returnera en lista över de 5 mest sannolika tokens. API:et kommer alltid att returnera den provtagna token, logprob så det kan finnas upp till element logprobs+1 i svaret.Maxvärdet för logprobs är 5. |
No | None |
| max_tokens | integer | Det maximala antalet tokens som kan genereras i slutförandet. Token-antalet för din prompt plus max_tokens får inte överstiga modellens kontextlängd. |
No | 16 |
| n | integer | Hur många kompletteringar som ska genereras för varje prompt. Notera: Eftersom denna parameter genererar många kompletteringar kan den snabbt förbruka din tokenkvot. Använd noggrant och se till att du har rimliga inställningar för max_tokens och stop. |
No | 1 |
| presence_penalty | number | Siffran mellan -2,0 och 2,0. Positiva värden straffar nya tokens baserat på om de hittills förekommer i texten, vilket ökar modellens sannolikhet att tala om nya ämnen. |
No | 0 |
| prompt | Sträng eller array | Prompten/promptarna för att generera kompletteringar för, kodade som en sträng, array av strängar, array av tokens eller array av token-arrayer. Observera att <|endoftext|> är dokumentseparatorn som modellen ser under träningen, så om en prompt inte anges kommer modellen att generera som om det vore från början av ett nytt dokument. |
Yes | |
| seed | integer | Om det specificeras gör vårt system sitt bästa för att provta deterministiskt, så att upprepade förfrågningar med samma seed och parametrar ska ge samma resultat.Determinism är inte garanterad, och du bör använda responsparametern system_fingerprint för att övervaka förändringar i backend. |
No | |
| stop | Sträng eller array | Upp till 4 sekvenser där API:et slutar generera ytterligare tokens. Den returnerade texten kommer inte att innehålla stoppsekvensen. |
No | |
| stream | boolean | Om man ska streama tillbaka delvis framsteg. Om de är satta skickas tokens som data-enbart serverskickade händelser när de blir tillgängliga, och strömmen avslutas med ett data: [DONE] meddelande.
Exempel Python kod. |
No | False |
| suffix | string | Suffixet som kommer efter att den insatta texten har slutförts. Denna parameter stöds endast för gpt-3.5-turbo-instruct. |
No | None |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar generellt att ändra detta eller top_p båda. |
No | 1 |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperature båda. |
No | 1 |
| user | string | En unik identifierare som representerar din slutanvändare, vilket kan hjälpa till att övervaka och upptäcka missbruk. |
No |
createCompletionResponse
Representerar ett fullbordandesvar från API:et. Observera: både de strömmade och icke-strömmade svarsobjekten har samma form (till skillnad från chattändpunkten).
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| choices | array | Listan över kompletteringsval som modellen genererade för inmatningsprompten. | Yes | |
| created | integer | Unix-tidsstämpeln (i sekunder) för när fullbordandet skapades. | Yes | |
| id | string | En unik identifierare för fullföljelsen. | Yes | |
| model | string | Modellen som används för fullbordan. | Yes | |
| object | enum | Objekttypen, som alltid är "text_completion" Möjliga värden: text_completion |
Yes | |
| prompt_filter_results | promptFilterResults | Innehållsfiltrering ger noll eller fler promptar i förfrågan. I en streamingförfrågan kan resultaten för olika prompts komma vid olika tidpunkter eller i olika ordning. | No | |
| system_fingerprint | string | Detta fingeravtryck representerar backend-konfigurationen som modellen körs med. Kan användas tillsammans med begäranparametern seed för att förstå när backend-ändringar har gjorts som kan påverka determinismen. |
No | |
| usage | completionUsage | Användningsstatistik för förfrågan om fullbordan. | No |
createChatCompletionRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| audio | object | Parametrar för ljudutgång. Krävs när ljudutgång begärs med modalities: ["audio"]. |
No | |
| └─ format | enum | Specificerar utgångsljudformatet. Måste vara en av wav, mp3, , flac, opus, eller pcm16. Möjliga värden: wav, mp3, flac, opus, pcm16 |
No | |
| └─ voice | enum | Specificerar rösttypen. Stödda röster är alloy, echo, , fable, onyx, novaoch shimmer.Möjliga värden: alloy, echo, fable, onyx, nova, shimmer |
No | |
| data_sources | array | Konfigurationsposterna för Azure OpenAI-chatttillägg som använder dem. Denna tilläggsspecifikation är endast kompatibel med Azure OpenAI. |
No | |
| frequency_penalty | number | Siffran mellan -2,0 och 2,0. Positiva värden straffar nya tokens baserat på deras befintliga frekvens i texten hittills, vilket minskar modellens sannolikhet att upprepa samma rad ordagrant. |
No | 0 |
| function_call | sträng eller chatCompletionFunctionCallOption | Föråldrad till förmån för tool_choice.Styr vilken (om någon) funktion som anropas av modellen. none betyder att modellen inte anropar en funktion utan istället genererar ett meddelande.auto innebär att modellen kan välja mellan att generera ett meddelande eller anropa en funktion.Att specificera en viss funktion via {"name": "my_function"} tvingar modellen att anropa den funktionen.none är standarden när inga funktioner finns.
auto är standard om funktioner finns. |
No | |
| functions | array | Föråldrad till förmån för tools.En lista över funktioner som modellen kan generera JSON-indata för. |
No | |
| logit_bias | object | Ändra sannolikheten för att specificerade tokens ska dyka upp i slutförandet. Accepterar ett JSON-objekt som mappar tokens (specificerade av deras token-ID i tokenizern) till ett associerat biasvärde från -100 till 100. Matematiskt läggs biasen till de logits som genereras av modellen före urvalet. Den exakta effekten varierar mellan modellen, men värden mellan -1 och 1 bör minska eller öka sannolikheten för urval; Värden som -100 eller 100 bör leda till avstängning eller exklusivt val av relevant token. |
No | None |
| logprobs | boolean | Om man ska returnera loggsannolikheter för utdatatokens eller inte. Om sann, returnerar logsannolikheterna för varje utdata som returnerats i av contentmessage. |
No | False |
| max_completion_tokens | integer | En övre gräns för antalet tokens som kan genereras för en fullbordan, inklusive synliga utdatatokens och resonemangstokens. | No | |
| max_tokens | integer | Det maximala antalet tokens som kan genereras i chatten. Den totala längden på inmatningstokens och genererade tokens begränsas av modellens kontextlängd. |
No | |
| messages | array | En lista med meddelanden som utgör konversationen hittills. Exempel Python kod. | Yes | |
| metadata | object | Utvecklardefinierade taggar och värden som används för att filtrera färdigställanden i den lagrade fullföljandeinstrumentpanelen. | No | |
| modalities | ChatCompletionModalities | Utdatatyper som du vill att modellen ska generera för denna förfrågan. De flesta modeller kan generera text, vilket är standard: ["text"]Modellen gpt-4o-audio-preview kan också användas för att generera ljud. För att begära att denna modell genererar både text- och ljudsvar kan du använda:["text", "audio"] |
No | |
| n | integer | Hur många chattfullbordandeval som ska genereras för varje inmatningsmeddelande. Observera att du kommer att debiteras baserat på antalet genererade tokens i alla val. Se n till att 1 minimera kostnaderna. |
No | 1 |
| parallel_tool_calls | ParallelToolCalls | Om man ska aktivera parallell funktionsanrop under verktygsanvändning. | No | True |
| prediction | PredictionContent | Konfiguration för en förutsagd utgång, vilket kan förbättra responstiderna avsevärt när stora delar av modellens respons är kända i förväg. Detta är vanligast när du regenererar en fil med endast mindre ändringar i det mesta av innehållet. | No | |
| presence_penalty | number | Siffran mellan -2,0 och 2,0. Positiva värden straffar nya tokens baserat på om de hittills förekommer i texten, vilket ökar modellens sannolikhet att tala om nya ämnen. |
No | 0 |
| reasoning_effort | enum |
Endast O1-modeller Begränsar ansträngningen i resonemanget för resonemangsmodeller. För närvarande stödda värden är low, medium, och high. Att minska resonemangsansträngningen kan leda till snabbare svar och färre tokens som används på resonemang i ett svar.Möjliga värden: low, medium, high |
No | |
| response_format | ResponseFormatText eller ResponseFormatJsonObject eller ResponseFormatJsonSchema | Ett objekt som specificerar formatet som modellen måste ge utmatning. Kompatibel med GPT-4o, GPT-4o mini, GPT-4 Turbo och alla GPT-3.5 Turbo-modeller nyare än gpt-3.5-turbo-1106.Att sätta till { "type": "json_schema", "json_schema": {...} } aktiverar strukturerade utdata som garanterar att modellen matchar ditt tillhandahållna JSON-schema.Att sätta på { "type": "json_object" } aktiverar 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 själv producera JSON via ett system- eller användarmeddelande. Utan detta kan modellen generera en oändlig ström av whitespace tills genereringen når tokengränsen, vilket resulterar i en långvarig och till synes "fastkilad" förfrågan. Observera också att meddelandeinnehållet kan vara delvis avskuret om finish_reason="length", vilket indikerar att genereringen överskridits max_tokens eller att konversationen överskred maxkontextlängden. |
No | |
| seed | integer | Denna funktion är i beta. Om det specificeras gör vårt system sitt bästa för att provta deterministiskt, så att upprepade förfrågningar med samma seed och parametrar ska ge samma resultat.Determinism är inte garanterad, och du bör använda responsparametern system_fingerprint för att övervaka förändringar i backend. |
No | |
| stop | Sträng eller array | Upp till 4 sekvenser där API:et slutar generera ytterligare tokens. |
No | |
| store | boolean | Om vi ska lagra resultatet från denna chattförfrågan för användning i våra modelldestillations- eller utvärderingsprodukter. | No | |
| stream | boolean | Om det är satt skickas partiella meddelandedeltas, som i ChatGPT. Tokens skickas som data-enbart serverskickade händelser när de blir tillgängliga, och strömmen avslutas med ett data: [DONE] meddelande.
Exempel Python kod. |
No | False |
| stream_options | chatCompletionStreamOptions | Alternativ för streaming-respons. Ställ in detta först när du sätter stream: true. |
No | None |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar generellt att ändra detta eller top_p båda. |
No | 1 |
| tool_choice | chatCompletionToolChoiceOption | Styr vilket (om något) verktyg som anropas av modellen.
none betyder att modellen inte anropar något verktyg utan istället genererar ett meddelande.
auto Det innebär att modellen kan välja mellan att generera ett meddelande eller att anropa ett eller flera verktyg.
required betyder att modellen måste anropa ett eller flera verktyg. Att specificera ett visst verktyg via {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa det verktyget.
none är standarden när inga verktyg finns.
auto är standarden om verktyg finns. |
No | |
| tools | array | En lista över verktyg som modellen kan anropa. För närvarande stöds endast funktioner som verktyg. Använd detta för att tillhandahålla en lista över funktioner som modellen kan generera JSON-indata för. Maximalt 128 funktioner stöds. |
No | |
| top_logprobs | integer | Ett heltal mellan 0 och 20 som anger antalet mest sannolika tokens att returnera vid varje tokenposition, var och en med tillhörande log-sannolikhet.
logprobs måste sättas till true om denna parameter används. |
No | |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperature båda. |
No | 1 |
| user | string | En unik identifierare som representerar din slutanvändare, vilket kan hjälpa till att övervaka och upptäcka missbruk. |
No | |
| user_security_context | userSecurityContext | Användarsäkerhetskontexten innehåller flera parametrar som beskriver själva AI-applikationen och slutanvändaren som interagerar med AI-applikationen. Dessa områden hjälper dina säkerhetsteam att undersöka och mildra säkerhetsincidenter genom att erbjuda ett heltäckande tillvägagångssätt för att skydda dina AI-applikationer. Lär dig mer om att skydda AI-applikationer med hjälp av Microsoft Defender för molnet. | No |
userSecurityContext
Användarsäkerhetskontexten innehåller flera parametrar som beskriver själva AI-applikationen och slutanvändaren som interagerar med AI-applikationen. Dessa områden hjälper dina säkerhetsteam att undersöka och mildra säkerhetsincidenter genom att erbjuda ett heltäckande tillvägagångssätt för att skydda dina AI-applikationer. Lär dig mer om att skydda AI-applikationer med hjälp av Microsoft Defender för molnet.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| application_name | string | Namnet på applikationen. Känslig personlig information bör inte inkluderas i detta fält. | No | |
| end_user_id | string | Denna identifierare är Microsoft Entra ID (tidigare Azure Active Directory) användarobjekt-ID som används för att autentisera slutanvändare inom den generativa AI-applikationen. Känslig personlig information bör inte inkluderas i detta fält. | No | |
| end_user_tenant_id | string | Microsoft 365-tenant-ID:t som slutanvändaren tillhör. Det krävs när den generativa AI-applikationen är multi-tenant. | No | |
| source_ip | string | Fångar den ursprungliga klientens IP-adress och accepterar både IPv4- och IPv6-format. | No |
chatCompletionFunctions
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | En beskrivning av vad funktionen gör, använd av modellen för att välja när och hur funktionen ska anropas. | No | |
| name | string | Namnet på funktionen som ska anropas. Måste vara a-z, A-Z, 0-9, eller innehålla understreck och streck, med en maximal längd på 64. | Yes | |
| parameters | FunctionParameters | De parametrar som funktionen accepterar, beskrivs som ett JSON-schemaobjekt.
Se guiden för exempel och JSON Schema-referensen för dokumentation om formatet. Att parameters utelämna definierar en funktion med en tom parameterlista. |
No |
chatCompletionFunctionCallOption
Att specificera en viss funktion via {"name": "my_function"} tvingar modellen att anropa den funktionen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| name | string | Namnet på funktionen att anropa. | Yes |
chatCompletionFunctionParameters
De parametrar som funktionen accepterar, beskrivs som ett JSON-schemaobjekt. Se guiden/ exemplen och JSON-schemareferensen för dokumentation om formatet.
Inga egenskaper definierade för denna komponent.
chatCompletionRequestMessage
Denna komponent kan vara en av följande:
- ChatCompletionRequestDeveloperMessage
- chatCompletionRequestSystemMessage
- chatCompletionRequestUserMessage
- chatCompletionRequestAssistantMessage
- chatCompletionRequestToolMessage
- chatCompletionRequestFunctionMessage
ChatCompletionRequestDeveloperMessage
Utvecklarens instruktioner som modellen ska följa, oavsett vilka meddelanden användaren skickat.
Med o1-modeller och nyare developer ersätter meddelanden de tidigare system meddelandena.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | Sträng eller array | Innehållet i utvecklarmeddelandet. | Yes | |
| name | string | Ett valfritt namn för deltagaren. Tillhandahåller modellinformation för att skilja deltagare i samma roll. | No | |
| role | enum | Meddelandeförfattarens roll, i detta fall developer.Möjliga värden: developer |
Yes |
chatCompletionRequestSystemMessage
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | Sträng eller array | Innehållet i systemmeddelandet. | Yes | |
| name | string | Ett valfritt namn för deltagaren. Tillhandahåller modellinformation för att skilja deltagare i samma roll. | No | |
| role | enum | Meddelandeförfattarens roll, i detta fall system.Möjliga värden: system |
Yes |
chatCompletionRequestUserMessage
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | Sträng eller array | Innehållet i användarmeddelandet. |
Yes | |
| name | string | Ett valfritt namn för deltagaren. Tillhandahåller modellinformation för att skilja deltagare i samma roll. | No | |
| role | enum | Meddelandeförfattarens roll, i detta fall user.Möjliga värden: user |
Yes |
chatCompletionRequestAssistantMessage
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | Sträng eller array | Innehållet i assistentmeddelandet. Obligatoriskt om tool_calls inte eller function_call är specificerat. |
No | |
| function_call | object | Föråldrad och ersatt av tool_calls. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen. |
No | |
| └─ arguments | string | Argumenten för att anropa funktionen med, som genereras av modellen i JSON-format. Observera att modellen inte alltid genererar giltig JSON och kan hallucinera parametrar som inte definieras av ditt funktionsschema. Validera argumenten i din kod innan du anropar din funktion. | No | |
| └─ name | string | Namnet på funktionen att anropa. | No | |
| name | string | Ett valfritt namn för deltagaren. Tillhandahåller modellinformation för att skilja deltagare i samma roll. | No | |
| refusal | string | Avslagsmeddelandet från assistenten. | No | |
| role | enum | Meddelandeförfattarens roll, i detta fall assistant.Möjliga värden: assistant |
Yes | |
| tool_calls | chatCompletionMessageToolCalls | Verktygsanropen som genereras av modellen, såsom funktionsanrop. | No |
chatCompletionRequestToolMessage
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | Sträng eller array | Innehållet i verktygsmeddelandet. | Yes | |
| role | enum | Meddelandeförfattarens roll, i detta fall tool.Möjliga värden: tool |
Yes | |
| tool_call_id | string | Verktygssamtal som detta meddelande svarar på. | Yes |
chatCompletionRequestFunctionMessage
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | string | Innehållet i funktionsmeddelandet. | Yes | |
| name | string | Namnet på funktionen att anropa. | Yes | |
| role | enum | Meddelandeförfattarens roll, i detta fall function.Möjliga värden: function |
Yes |
chatCompletionRequestDeveloperMessageContentPart
Denna komponent kan vara en av följande:
chatCompletionRequestSystemMessageContentPart
Denna komponent kan vara en av följande:
chatCompletionRequestUserMessageContentPart
Denna komponent kan vara en av följande:
- chatCompletionRequestMessageContentPartText
- chatCompletionRequestMessageContentPartImage
- chatCompletionRequestMessageContentPartAudio
chatCompletionRequestAssistantMessageContentPart
Denna komponent kan vara en av följande:
chatCompletionRequestToolMessageContentPart
Denna komponent kan vara en av följande:
chatCompletionRequestMessageContentPartText
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | Textinnehållet. | Yes | |
| type | enum | Typen av innehållsdelen. Möjliga värden: text |
Yes |
chatCompletionRequestMessageContentPartAudio
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input_audio | object | Yes | ||
| └─ data | string | Base64-kodad ljuddata. | No | |
| └─ format | enum | Formatet för den kodade ljuddatan. Stöder för närvarande "wav" och "mp3". Möjliga värden: wav, mp3 |
No | |
| type | enum | Typen av innehållsdelen. Alltid input_audio.Möjliga värden: input_audio |
Yes |
chatCompletionRequestMessageContentPartImage
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| image_url | object | Yes | ||
| └─ detail | enum | Specificerar detaljnivån på bilden. Läs mer i Vision-guiden. Möjliga värden: auto, low, high |
No | |
| └─ url | string | Antingen en URL till bilden eller base64-kodade bilddata. | No | |
| type | enum | Typen av innehållsdelen. Möjliga värden: image_url |
Yes |
chatCompletionRequestMessageContentPartRefusal
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| refusal | string | Avvisningsmeddelandet som genereras av modellen. | Yes | |
| type | enum | Typen av innehållsdelen. Möjliga värden: refusal |
Yes |
azureChatExtensionConfiguration
En representation av konfigurationsdata för en enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chattkompletteringsförfrågan som bör använda Azure OpenAI-chatttillägg för att förstärka svarsbeteendet. Användningen av denna konfiguration är endast kompatibel med Azure OpenAI.
###Discriminator för azureChatExtensionConfiguration
Denna komponent använder egenskapen type för att skilja mellan olika typer:
| Type Value | Schema |
|---|---|
azure_search |
azureSearchChatExtensionConfiguration |
azure_cosmos_db |
azureCosmosDBChatExtensionConfiguration |
elasticsearch |
elasticsearchChatExtensionConfiguration |
mongo_db |
mongoDBChatExtensionConfiguration |
pinecone |
pineconeChatExtensionConfiguration |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | azureChatExtensionType | En representation av konfigurationsdata för en enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chattkompletteringsförfrågan som bör använda Azure OpenAI-chatttillägg för att förstärka svarsbeteendet. Användningen av denna konfiguration är endast kompatibel med Azure OpenAI. |
Yes |
azureChatExtensionType
En representation av konfigurationsdata för en enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chattkompletteringsförfrågan som bör använda Azure OpenAI-chatttillägg för att förstärka svarsbeteendet. Användningen av denna konfiguration är endast kompatibel med Azure OpenAI.
| Property | Value |
|---|---|
| Description | En representation av konfigurationsdata för en enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chattkompletteringsförfrågan som bör använda Azure OpenAI-chatttillägg för att förstärka svarsbeteendet. Användningen av denna konfiguration är endast kompatibel med Azure OpenAI. |
| Type | string |
| Values | azure_searchazure_cosmos_dbelasticsearchmongo_dbpinecone |
azureSearchChatExtensionConfiguration
En specifik representation av konfigurerbara alternativ för Azure Search när man använder det som en Azure OpenAI-chatttillägg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| parameters | azureSearchChatExtensionParameters | Parametrar för Azure Search när de används som en Azure OpenAI-chatttillägg. | No | |
| type | azureChatExtensionType | En representation av konfigurationsdata för en enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chattkompletteringsförfrågan som bör använda Azure OpenAI-chatttillägg för att förstärka svarsbeteendet. Användningen av denna konfiguration är endast kompatibel med Azure OpenAI. |
Yes |
azureSearchChatExtensionParameters
Parametrar för Azure Search när de används som en Azure OpenAI-chatttillägg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| 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 den inte specificeras, eller anges som falsk, kommer förfrågan att misslyckas om någon sökfråga misslyckas. | No | False |
| authentication | onYourDataApiNyckelautentiseringOptions eller onYourDataSystemAssignedManagedIdentityAuthenticationOptions eller onYourDataUserAssignedIdentityAuthenticationOptions eller onYourDataAccessTokenAuthenticationOptions | Yes | ||
| embedding_dependency | onYourDataEndpointVectorizationSource eller onYourDataDeploymentNameVectorizationSource eller onYourDataIntegratedVectorizationSource | No | ||
| endpoint | string | Den absoluta slutpunktsvägen för Azure Search-resursen att använda. | Yes | |
| fields_mapping | azureSearchIndexFieldMappingOptions | Valfria inställningar för att styra hur fält bearbetas när man använder en konfigurerad Azure Search-resurs. | No | |
| filter | string | Search filter. | No | |
| in_scope | boolean | Om frågor bör begränsas till användning av indexerad data. | No | |
| include_contexts | array | De inkluderade egenskaperna hos utdatakontexten. Om det inte specificeras är citations standardvärdet och intent. |
No | |
| index_name | string | Namnet på indexet som ska användas som tillgängligt i den refererade Azure Search-resursen. | Yes | |
| max_search_queries | integer | Maxantalet omskrivna frågor bör skickas till sökleverantören för ett användarmeddelande. Om det inte specificeras bestämmer systemet hur många frågor som ska skickas. | No | |
| query_type | azureSearchQueryType | Den typ av Azure Search-sökning som ska utföras när den används som en Azure OpenAI-chatttillägg. | No | |
| semantic_configuration | string | Den ytterligare semantiska konfigurationen för frågan. | No | |
| strictness | integer | Den konfigurerade striktheten i sökrelevansfiltreringen. Ju högre strikthet, desto högre precision men lägre minne av svaret. | No | |
| top_n_documents | integer | Det konfigurerade översta antalet dokument att använda för den konfigurerade frågan. | No |
azureSearchIndexFieldMappingOptions
Valfria inställningar för att styra hur fält bearbetas när man använder en konfigurerad Azure Search-resurs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_fields | array | Namnen på indexfält som bör behandlas som innehåll. | No | |
| content_fields_separator | string | Det separatormönster som innehållsfälten bör använda. | No | |
| filepath_field | string | Namnet på indexfältet som ska användas som filsökväg. | No | |
| image_vector_fields | array | Namnen på fält som representerar bildvektordata. | No | |
| title_field | string | Namnet på indexfältet som ska användas som titel. | No | |
| url_field | string | Namnet på indexfältet som ska användas som URL. | No | |
| vector_fields | array | Namnen på fält som representerar vektordata. | No |
azureSearchQueryType
Den typ av Azure Search-sökning som ska utföras när den används som en Azure OpenAI-chatttillägg.
| Property | Value |
|---|---|
| Description | Den typ av Azure Search-sökning som ska utföras när den används som en Azure OpenAI-chatttillägg. |
| Type | string |
| Values | simplesemanticvectorvector_simple_hybridvector_semantic_hybrid |
azureCosmosDBChatExtensionConfiguration
En specifik representation av konfigurerbara alternativ för Azure Cosmos DB när man använder det som en Azure OpenAI-chatttillägg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| parameters | azureCosmosDBChatExtensionParameters | Parametrar att använda när man konfigurerar Azure OpenAI On Your Data chatttillägg när man använder Azure Cosmos DB för MongoDB vCore. | No | |
| type | azureChatExtensionType | En representation av konfigurationsdata för en enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chattkompletteringsförfrågan som bör använda Azure OpenAI-chatttillägg för att förstärka svarsbeteendet. Användningen av denna konfiguration är endast kompatibel med Azure OpenAI. |
Yes |
azureCosmosDBChatExtensionParameters
Parametrar att använda när man konfigurerar Azure OpenAI On Your Data chatttillägg när man använder Azure Cosmos DB för MongoDB vCore.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| 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 den inte specificeras, eller anges som falsk, kommer förfrågan att misslyckas om någon sökfråga misslyckas. | No | False |
| authentication | onYourDataConnectionStringAuthenticationOptions | Autentiseringsalternativen för Azure OpenAI On Your Data när man använder en reťazec pripojenia. | Yes | |
| container_name | string | Namnet på Azure Cosmos DB resource container. | Yes | |
| database_name | string | Namnet på MongoDB vCore-databasen för användning med Azure Cosmos DB. | Yes | |
| embedding_dependency | onYourDataEndpointVectorizationSource eller onYourDataDeploymentNameVectorizationSource | Yes | ||
| fields_mapping | azureCosmosDBFieldMappingOptions | Valfria inställningar för att styra hur fält bearbetas när man använder en konfigurerad Azure Cosmos DB-resurs. | Yes | |
| in_scope | boolean | Om frågor bör begränsas till användning av indexerad data. | No | |
| include_contexts | array | De inkluderade egenskaperna hos utdatakontexten. Om det inte specificeras är citations standardvärdet och intent. |
No | |
| index_name | string | MongoDB vCore-indexnamnet för användning med Azure Cosmos DB. | Yes | |
| max_search_queries | integer | Maxantalet omskrivna frågor bör skickas till sökleverantören för ett användarmeddelande. Om det inte specificeras bestämmer systemet hur många frågor som ska skickas. | No | |
| strictness | integer | Den konfigurerade striktheten i sökrelevansfiltreringen. Ju högre strikthet, desto högre precision men lägre minne av svaret. | No | |
| top_n_documents | integer | Det konfigurerade översta antalet dokument att använda för den konfigurerade frågan. | No |
azureCosmosDBFieldMappingOptions
Valfria inställningar för att styra hur fält bearbetas när man använder en konfigurerad Azure Cosmos DB-resurs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_fields | array | Namnen på indexfält som bör behandlas som innehåll. | Yes | |
| content_fields_separator | string | Det separatormönster som innehållsfälten bör använda. | No | |
| filepath_field | string | Namnet på indexfältet som ska användas som filsökväg. | No | |
| title_field | string | Namnet på indexfältet som ska användas som titel. | No | |
| url_field | string | Namnet på indexfältet som ska användas som URL. | No | |
| vector_fields | array | Namnen på fält som representerar vektordata. | Yes |
elasticsearchChatExtensionConfiguration
En specifik representation av konfigurerbara alternativ för Elasticsearch när man använder det som en Azure OpenAI-chatttillägg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| parameters | elasticsearchChatExtensionParameters | Parametrar att använda när man konfigurerar Elasticsearch® som en Azure OpenAI-chatttillägg. | No | |
| type | azureChatExtensionType | En representation av konfigurationsdata för en enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chattkompletteringsförfrågan som bör använda Azure OpenAI-chatttillägg för att förstärka svarsbeteendet. Användningen av denna konfiguration är endast kompatibel med Azure OpenAI. |
Yes |
elasticsearchChatExtensionParameters
Parametrar att använda när man konfigurerar Elasticsearch® som en Azure OpenAI-chatttillägg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| 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 den inte specificeras, eller anges som falsk, kommer förfrågan att misslyckas om någon sökfråga misslyckas. | No | False |
| authentication | onYourDataKeyOchKeyIdAuthenticationOptions eller onYourDataEncodedApiKey AuthenticationOptions | Yes | ||
| embedding_dependency | onYourDataEndpointVectorizationSource eller onYourDataDeploymentNameVectorizationSource eller onYourDataModelIdVectorizationSource | No | ||
| endpoint | string | Slutpunkten för Elasticsearch.® | Yes | |
| fields_mapping | elasticsearchIndexFieldMappingOptions | Valfria inställningar för att styra hur fält bearbetas när man använder en konfigurerad Elasticsearch-resurs®. | No | |
| in_scope | boolean | Om frågor bör begränsas till användning av indexerad data. | No | |
| include_contexts | array | De inkluderade egenskaperna hos utdatakontexten. Om det inte specificeras är citations standardvärdet och intent. |
No | |
| index_name | string | Indexnamnet Elasticsearch.® | Yes | |
| max_search_queries | integer | Maxantalet omskrivna frågor bör skickas till sökleverantören för ett användarmeddelande. Om det inte specificeras bestämmer systemet hur många frågor som ska skickas. | No | |
| query_type | elasticsearchQueryType | Den typ av Elasticsearch-sökning® som ska utföras när man använder den som en Azure OpenAI-chatttillägg. | No | |
| strictness | integer | Den konfigurerade striktheten i sökrelevansfiltreringen. Ju högre strikthet, desto högre precision men lägre minne av svaret. | No | |
| top_n_documents | integer | Det konfigurerade översta antalet dokument att använda för den konfigurerade frågan. | No |
elasticsearchIndexFieldMappingOptions
Valfria inställningar för att styra hur fält bearbetas när man använder en konfigurerad Elasticsearch-resurs®.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_fields | array | Namnen på indexfält som bör behandlas som innehåll. | No | |
| content_fields_separator | string | Det separatormönster som innehållsfälten bör använda. | No | |
| filepath_field | string | Namnet på indexfältet som ska användas som filsökväg. | No | |
| title_field | string | Namnet på indexfältet som ska användas som titel. | No | |
| url_field | string | Namnet på indexfältet som ska användas som URL. | No | |
| vector_fields | array | Namnen på fält som representerar vektordata. | No |
elasticsearchQueryType
Den typ av Elasticsearch-sökning® som ska utföras när man använder den som en Azure OpenAI-chatttillägg.
| Property | Value |
|---|---|
| Description | Den typ av Elasticsearch-sökning® som ska utföras när man använder den som en Azure OpenAI-chatttillägg. |
| Type | string |
| Values | simplevector |
mongoDBChatExtensionConfiguration
En specifik representation av konfigurerbara alternativ för Mongo DB när man använder det som en Azure OpenAI-chatttillägg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| parameters | mongoDBChatExtensionParameters | Parametrar att använda när man konfigurerar Azure OpenAI On Your Data chatttillägg när man använder Mongo DB. | No | |
| type | azureChatExtensionType | En representation av konfigurationsdata för en enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chattkompletteringsförfrågan som bör använda Azure OpenAI-chatttillägg för att förstärka svarsbeteendet. Användningen av denna konfiguration är endast kompatibel med Azure OpenAI. |
Yes |
mongoDBChatExtensionParameters
Parametrar att använda när man konfigurerar Azure OpenAI On Your Data chatttillägg när man använder Mongo DB.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| 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 den inte specificeras, eller anges som falsk, kommer förfrågan att misslyckas om någon sökfråga misslyckas. | No | False |
| app_name | string | Namnet på Mongo DB-applikationen. | Yes | |
| authentication | onYourDataUsernameAndPasswordAuthenticationOptions | Autentiseringsalternativen för Azure OpenAI på din data när du använder användarnamn och lösenord. | Yes | |
| collection_name | string | Namnet på Mongo DB-samlingen. | Yes | |
| database_name | string | Namnet på Mongo DB-databasen. | Yes | |
| embedding_dependency | onYourDataEndpointVectorizationSource eller onYourDataDeploymentNameVectorizationSource | Yes | ||
| endpoint | string | Namnet på Mongo DB-klustrets endpoint. | Yes | |
| fields_mapping | mongoDBFieldMappingOptions | Valfria inställningar för att styra hur fält bearbetas när man använder en konfigurerad Mongo DB-resurs. | Yes | |
| in_scope | boolean | Om frågor bör begränsas till användning av indexerad data. | No | |
| include_contexts | array | De inkluderade egenskaperna hos utdatakontexten. Om det inte specificeras är citations standardvärdet och intent. |
No | |
| index_name | string | Namnet på Mongo DB-indexet. | Yes | |
| max_search_queries | integer | Maxantalet omskrivna frågor bör skickas till sökleverantören för ett användarmeddelande. Om det inte specificeras bestämmer systemet hur många frågor som ska skickas. | No | |
| strictness | integer | Den konfigurerade striktheten i sökrelevansfiltreringen. Ju högre strikthet, desto högre precision men lägre minne av svaret. | No | |
| top_n_documents | integer | Det konfigurerade översta antalet dokument att använda för den konfigurerade frågan. | No |
mongoDBFieldMappingOptions
Valfria inställningar för att styra hur fält bearbetas när man använder en konfigurerad Mongo DB-resurs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_fields | array | Namnen på indexfält som bör behandlas som innehåll. | Yes | |
| content_fields_separator | string | Det separatormönster som innehållsfälten bör använda. | No | |
| filepath_field | string | Namnet på indexfältet som ska användas som filsökväg. | No | |
| title_field | string | Namnet på indexfältet som ska användas som titel. | No | |
| url_field | string | Namnet på indexfältet som ska användas som URL. | No | |
| vector_fields | array | Namnen på fält som representerar vektordata. | Yes |
pineconeChatExtensionConfiguration
En specifik representation av konfigurerbara alternativ för Pinecone när man använder det som en Azure OpenAI-chatttillägg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| parameters | pineconeChatExtensionParameters | Parametrar för att konfigurera Azure OpenAI Pinecone chat-tillägg. | No | |
| type | azureChatExtensionType | En representation av konfigurationsdata för en enda Azure OpenAI-chatttillägg. Detta kommer att användas av en chattkompletteringsförfrågan som bör använda Azure OpenAI-chatttillägg för att förstärka svarsbeteendet. Användningen av denna konfiguration är endast kompatibel med Azure OpenAI. |
Yes |
pineconeChatExtensionParameters
Parametrar för att konfigurera Azure OpenAI Pinecone chat-tillägg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| 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 den inte specificeras, eller anges som falsk, kommer förfrågan att misslyckas om någon sökfråga misslyckas. | No | False |
| authentication | onYourDataApiKeyAuthenticationOptions | Autentiseringsalternativen för Azure OpenAI på dina data när du använder en API-nyckel. | Yes | |
| embedding_dependency | onYourDataDeploymentNameVectorizationSource | Detaljerna i en vektoriseringskälla, som används av Azure OpenAI On Your Data vid tillämpning av vektorsökning, som baseras på ett internt embeddingsmodell-distributionsnamn i samma Azure OpenAI-resurs. | Yes | |
| environment | string | Miljönamnet Pinecone. | Yes | |
| fields_mapping | pineconeFieldMappingOptions | Valfria inställningar för att styra hur fält bearbetas när man använder en konfigurerad Pinecone-resurs. | Yes | |
| in_scope | boolean | Om frågor bör begränsas till användning av indexerad data. | No | |
| include_contexts | array | De inkluderade egenskaperna hos utdatakontexten. Om det inte specificeras är citations standardvärdet och intent. |
No | |
| index_name | string | Namnet på Pinecone-databasindexet. | Yes | |
| max_search_queries | integer | Maxantalet omskrivna frågor bör skickas till sökleverantören för ett användarmeddelande. Om det inte specificeras bestämmer systemet hur många frågor som ska skickas. | No | |
| strictness | integer | Den konfigurerade striktheten i sökrelevansfiltreringen. Ju högre strikthet, desto högre precision men lägre minne av svaret. | No | |
| top_n_documents | integer | Det konfigurerade översta antalet dokument att använda för den konfigurerade frågan. | No |
pineconeFieldMappingOptions
Valfria inställningar för att styra hur fält bearbetas när man använder en konfigurerad Pinecone-resurs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_fields | array | Namnen på indexfält som bör behandlas som innehåll. | Yes | |
| content_fields_separator | string | Det separatormönster som innehållsfälten bör använda. | No | |
| filepath_field | string | Namnet på indexfältet som ska användas som filsökväg. | No | |
| title_field | string | Namnet på indexfältet som ska användas som titel. | No | |
| url_field | string | Namnet på indexfältet som ska användas som URL. | No |
onYourDataAuthenticationOptions
Autentiseringsalternativen för Azure OpenAI On Your Data.
Diskriminator för onYourDataAuthenticationOptions
Denna komponent använder egenskapen type för att skilja mellan olika typer:
| Type Value | Schema |
|---|---|
api_key |
onYourDataApiKeyAuthenticationOptions |
connection_string |
onYourDataConnectionStringAuthenticationOptions |
key_and_key_id |
onYourDataKeyAndKeyIdAuthenticationOptions |
encoded_api_key |
onYourDataEncodedApiKeyAuthenticationOptions |
access_token |
onYourDataAccessTokenAuthenticationOptions |
system_assigned_managed_identity |
onYourDataSystemAssignedManagedIdentityAuthenticationOptions |
user_assigned_managed_identity |
onYourDataUserAssignedManagedIdentityAuthenticationOptions |
username_and_password |
onYourDataUsernameAndPasswordAuthenticationOptions |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | onYourDataAuthenticationType | De autentiseringstyper som stöds med Azure OpenAI On Your Data. | Yes |
onYourDataContextProperty
Kontextegenskapen.
| Property | Value |
|---|---|
| Description | Kontextegenskapen. |
| Type | string |
| Values | citationsintentall_retrieved_documents |
onYourDataAuthenticationType
De autentiseringstyper som stöds med Azure OpenAI On Your Data.
| Property | Value |
|---|---|
| Description | De autentiseringstyper som stöds med Azure OpenAI On Your Data. |
| Type | string |
| Values | api_keyconnection_stringkey_and_key_idencoded_api_keyaccess_tokensystem_assigned_managed_identityuser_assigned_managed_identityusername_and_password |
onYourDataApiKeyAuthenticationOptions
Autentiseringsalternativen för Azure OpenAI på dina data när du använder en API-nyckel.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| key | string | API-nyckeln att använda för autentisering. | No | |
| type | onYourDataAuthenticationType | De autentiseringstyper som stöds med Azure OpenAI On Your Data. | Yes |
onYourDataConnectionStringAuthenticationOptions
Autentiseringsalternativen för Azure OpenAI On Your Data när man använder en reťazec pripojenia.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| connection_string | string | reťazec pripojenia som ska användas för autentisering. | No | |
| type | onYourDataAuthenticationType | De autentiseringstyper som stöds med Azure OpenAI On Your Data. | Yes |
onYourDataKeyAndKeyIdAuthenticationOptions
Autentiseringsalternativen för Azure OpenAI On Your Data när man använder ett Elasticsearch-nyckel- och nyckel-ID-par.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| key | string | Elasticsearch-nyckeln att använda för autentisering. | No | |
| key_id | string | Elasticsearch-nyckel-ID:t att använda för autentisering. | No | |
| type | onYourDataAuthenticationType | De autentiseringstyper som stöds med Azure OpenAI On Your Data. | Yes |
onYourDataEncodedApiKeyAuthenticationOptions
Autentiseringsalternativen för Azure OpenAI On Your Data när man använder en Elasticsearch-kodad API-nyckel.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| encoded_api_key | string | Elasticsearch kodade API-nyckeln för autentisering. | No | |
| type | onYourDataAuthenticationType | De autentiseringstyper som stöds med Azure OpenAI On Your Data. | Yes |
onYourDataAccessTokenAuthenticationOptions
Autentiseringsalternativen för Azure OpenAI på dina data när du använder åtkomsttoken.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| access_token | string | Åtkomsttoken att använda för autentisering. | No | |
| type | onYourDataAuthenticationType | De autentiseringstyper som stöds med Azure OpenAI On Your Data. | Yes |
onYourDataSystemAssignedManagedIdentityAuthenticationOptions
Autentiseringsalternativen för Azure OpenAI på dina data när du använder en systemtilldelad hanterad identitet.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | onYourDataAuthenticationType | De autentiseringstyper som stöds med Azure OpenAI On Your Data. | Yes |
onYourDataUserAssignedManagedIdentityAuthenticationOptions
Autentiseringsalternativen för Azure OpenAI On Your Data när man använder en användartilldelad hanterad identitet.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| managed_identity_resource_id | string | Resurs-ID:t för den användartilldelade hanterade identiteten att använda för autentisering. | No | |
| type | onYourDataAuthenticationType | De autentiseringstyper som stöds med Azure OpenAI On Your Data. | Yes |
onYourDataUsernameAndPasswordAuthenticationOptions
Autentiseringsalternativen för Azure OpenAI på din data när du använder användarnamn och lösenord.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| password | string | The password. för att använda för autentisering. | No | |
| type | onYourDataAuthenticationType | De autentiseringstyper som stöds med Azure OpenAI On Your Data. | Yes | |
| username | string | Användarnamnet att använda för autentisering. | No |
onYourDataVectorizationSource
En abstrakt representation av en vektoriseringskällkod för Azure OpenAI On Your Data med vektorsökning.
Denna komponent använder egenskapen type för att skilja mellan olika typer:
| Type Value | Schema |
|---|---|
endpoint |
onYourDataEndpointVectorizationSource |
deployment_name |
onYourDataDeploymentNameVectorizationSource |
integrated |
onYourDataIntegratedVectorizationSource |
model_id |
onYourDataModelIdVectorizationSource |
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | 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. | Yes |
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.
| Property | Value |
|---|---|
| Description | 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. |
| Type | string |
| Values | endpointdeployment_nameintegratedmodel_id |
onYourDataEndpointVectorizationSource
Detaljerna i en vektoriseringskälla, som används av Azure OpenAI On Your Data vid tillämpning av vektorsökning, som baseras på ett offentligt Azure OpenAI-slutpunktsanrop för inbäddningar.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| authentication | onYourDataApiNyckelAutentiseringOptions eller onYourDataAccessTokenAuthenticationOptions | No | ||
| dimensions | integer | Antalet dimensioner som inbäddningarna bör ha. Endast stödd i text-embedding-3 och senare modeller. |
No | |
| endpoint | string | Specificerar resursändpunktens URL från vilken inbäddningar ska hämtas. Den bör vara i formatet .https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings API-versionens frågeparameter är inte tillåten. |
No | |
| type | 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. | Yes |
onYourDataDeploymentNameVectorizationSource
Detaljerna i en vektoriseringskälla, som används av Azure OpenAI On Your Data vid tillämpning av vektorsökning, som baseras på ett internt inbäddningsmodell-distributionsnamn i samma Azure OpenAI-resurs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deployment_name | string | Specificerar namnet på modellutplaceringen som ska användas för vektorisering. Denna modelldistribution måste ske i samma Azure OpenAI-resurs, men On Your Data kommer att använda denna modelldistribution via ett internt anrop istället för ett publikt, vilket möjliggör vektorsökning även i privata nätverk. | No | |
| dimensions | integer | Antalet dimensioner som inbäddningarna bör ha. Endast stödd i text-embedding-3 och senare modeller. |
No | |
| type | 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. | Yes |
onYourDataIntegratedVectorizationSource
Representerar den integrerade vektoriseraren som definieras inom sökresursen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | 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. | Yes |
onYourDataModelIdVectorizationSource
Detaljerna i en vektoriseringskälla, som används av Azure OpenAI On Your Data vid tillämpning av vektorsökning, som baseras på en söktjänstmodell-ID. För närvarande stöds endast av Elasticsearch.®
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| model_id | string | Specificerar modell-ID som ska användas för vektorisering. Denna modell-ID måste definieras i söktjänsten. | No | |
| type | 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. | Yes |
azureChatExtensionsMessageContext
En representation av den ytterligare kontextinformation som finns tillgänglig när Azure OpenAI-chatttillägg är involverade i genereringen av ett motsvarande svar på chattkompletteringar. Denna kontextinformation fylls endast i när man använder en Azure OpenAI-förfrågan konfigurerad för att använda en matchande tillägg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| all_retrieved_documents | array | Alla återfunna dokument. | No | |
| citations | array | Resultatet av datakällshämtning, som används för att generera assistentmeddelandet i svaret. | No | |
| intent | string | Den upptäckta avsikten från chatthistoriken användes för att föra vidare till nästa tur för att föra över kontexten. | No |
citation
Källhänvisningsinformation för ett svar på chattfullföljningar.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| chunk_id | string | Bit-ID:t i boten. | No | |
| content | string | Innehållet i citatet. | Yes | |
| filepath | string | Filvägen för källhänvisningen. | No | |
| rerank_score | number | Rerank-poängen för det återfunna dokumentet. | No | |
| title | string | Titeln på motiveringen. | No | |
| url | string | URL:en till citatet. | No |
retrievedDocument
Det återfunna dokumentet.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| chunk_id | string | Bit-ID:t i boten. | No | |
| content | string | Innehållet i citatet. | Yes | |
| data_source_index | integer | Indexet för datakällan. | No | |
| filepath | string | Filvägen för källhänvisningen. | No | |
| filter_reason | filterReason | Filtreringsorsaken till det återfunna dokumentet. | No | |
| original_search_score | number | Det ursprungliga sökresultatet för det återfunna dokumentet. | No | |
| rerank_score | number | Rerank-poängen för det återfunna dokumentet. | No | |
| search_queries | array | Sökfrågorna används för att hämta dokumentet. | No | |
| title | string | Titeln på motiveringen. | No | |
| url | string | URL:en till citatet. | No |
filterReason
Filtreringsorsaken till det återfunna dokumentet.
| Property | Value |
|---|---|
| Description | Filtreringsorsaken till det återfunna dokumentet. |
| Type | string |
| Values | scorererank |
chatCompletionMessageToolCall
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| function | object | Funktionen som modellen kallade på. | Yes | |
| └─ arguments | string | Argumenten för att anropa funktionen med, som genereras av modellen i JSON-format. Observera att modellen inte alltid genererar giltig JSON och kan hallucinera parametrar som inte definieras av ditt funktionsschema. Validera argumenten i din kod innan du anropar din funktion. | No | |
| └─ name | string | Namnet på funktionen att anropa. | No | |
| id | string | ID:t på verktygsanropet. | Yes | |
| type | toolCallType | Typen av verktygskall, i detta fall function. |
Yes |
toolCallType
Typen av verktygskall, i detta fall function.
| Property | Value |
|---|---|
| Description | Typen av verktygskall, i detta fall function. |
| Type | string |
| Values | function |
chatCompletionRequestMessageTool
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | string | Innehållet i meddelandet. | No | |
| tool_call_id | string | Verktygssamtal som detta meddelande svarar på. | No |
chatCompletionRequestMessageFunction
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | string | Innehållet i meddelandet. | No | |
| name | string | Innehållet i meddelandet. | No | |
| role | enum | Meddelandeförfattarens roll, i detta fall function.Möjliga värden: function |
No |
createChatCompletionResponse
Representerar ett chattfullbordandesvar som returneras av modellen, baserat på den tillhandahållna indatan.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| choices | array | En lista med chattfullföljandealternativ. Kan vara mer än ett om n är större än 1. |
Yes | |
| created | integer | Unix-tidsstämpeln (i sekunder) för när chatten slutfördes skapades. | Yes | |
| id | string | En unik identifierare för chattens fullföljelse. | Yes | |
| model | string | Modellen som används för chattfullföljandet. | Yes | |
| object | enum | Objekttypen, som alltid chat.completionär .Möjliga värden: chat.completion |
Yes | |
| prompt_filter_results | promptFilterResults | Innehållsfiltrering ger noll eller fler promptar i förfrågan. I en streamingförfrågan kan resultaten för olika prompts komma vid olika tidpunkter eller i olika ordning. | No | |
| system_fingerprint | string | Detta fingeravtryck representerar backend-konfigurationen som modellen körs med. Kan användas tillsammans med begäranparametern seed för att förstå när backend-ändringar har gjorts som kan påverka determinismen. |
No | |
| usage | completionUsage | Användningsstatistik för förfrågan om fullbordan. | No |
createChatCompletionStreamResponse
Representerar en strömmad del av ett chattfullbordande svar som returneras av modellen, baserat på den tillhandahållna inmatningen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| choices | array | En lista med chattfullföljandealternativ. Kan innehålla mer än ett element om n är större än 1. |
Yes | |
| created | integer | Unix-tidsstämpeln (i sekunder) för när chatten slutfördes skapades. Varje chunk har samma tidsstämpel. | Yes | |
| id | string | En unik identifierare för chattens fullföljelse. Varje chunk har samma ID. | Yes | |
| model | string | Modellen för att generera fullbordan. | Yes | |
| object | enum | Objekttypen, som alltid chat.completion.chunkär .Möjliga värden: chat.completion.chunk |
Yes | |
| system_fingerprint | string | Detta fingeravtryck representerar backend-konfigurationen som modellen körs med. Kan användas tillsammans med begäranparametern seed för att förstå när backend-ändringar har gjorts som kan påverka determinismen. |
No |
chatCompletionStreamResponseDelta
En chattfullbordandedelta som genereras av strömmade modellsvar.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | string | Innehållet i meddelandet i biten. | No | |
| function_call | object | Föråldrad och ersatt av tool_calls. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen. |
No | |
| └─ arguments | string | Argumenten för att anropa funktionen med, som genereras av modellen i JSON-format. Observera att modellen inte alltid genererar giltig JSON och kan hallucinera parametrar som inte definieras av ditt funktionsschema. Validera argumenten i din kod innan du anropar din funktion. | No | |
| └─ name | string | Namnet på funktionen att anropa. | No | |
| refusal | string | Avvisningsmeddelandet som genereras av modellen. | No | |
| role | enum | Författarens roll för detta meddelande. Möjliga värden: system, user, assistant, tool |
No | |
| tool_calls | array | No |
chatCompletionMessageToolCallChunk
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| function | object | No | ||
| └─ arguments | string | Argumenten för att anropa funktionen med, som genereras av modellen i JSON-format. Observera att modellen inte alltid genererar giltig JSON och kan hallucinera parametrar som inte definieras av ditt funktionsschema. Validera argumenten i din kod innan du anropar din funktion. | No | |
| └─ name | string | Namnet på funktionen att anropa. | No | |
| id | string | ID:t på verktygsanropet. | No | |
| index | integer | Yes | ||
| type | enum | Typen av verktyg. För närvarande stöds endast function det.Möjliga värden: function |
No |
chatCompletionStreamOptions
Alternativ för streaming-respons. Ställ in detta först när du sätter stream: true.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| include_usage | boolean | Om det är satt kommer en extra chunk att strömmas innan meddelandet data: [DONE] . Fältet usage i denna chunk visar tokenanvändningsstatistiken för hela förfrågan, och choices fältet kommer alltid att vara en tom array. Alla andra chunks kommer också att inkludera ett usage fält, men med ett nollvärde. |
No |
chatCompletionChoiceLogProbs
Logga sannolikhetsinformation för valet.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | array | En lista över meddelandeinnehållstokens med loggsannolikhetsinformation. | Yes | |
| refusal | array | En lista över meddelandeavvisningstoken med loggsannolikhetsinformation. | No |
chatCompletionTokenLogprob
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| bytes | array | En lista över heltal som representerar UTF-8 bytes-representationen av token. Användbart i fall där tecken representeras av flera tokens och deras byterepresentationer måste kombineras för att generera korrekt textrepresentation. Det kan vara om null det inte finns någon bytesrepresentation för token. |
Yes | |
| logprob | number | Logsannolikheten för denna token. | Yes | |
| token | string | The token. | Yes | |
| top_logprobs | array | Lista över de mest sannolika tokens och deras logaritmiska sannolikhet, vid denna tokenposition. I sällsynta fall kan det vara färre än det begärda antalet returnerade top_logprobs . |
Yes |
chatCompletionResponseMessage
Ett meddelande om chattkomplettering genererat av modellen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| audio | object | Om ljudutgångsmodaliteten efterfrågas innehåller detta objekt data om ljudresponsen från modellen. | No | |
| └─ data | string | Base64 kodade ljudbyte genererade av modellen, i det format som specificerades i förfrågan. |
No | |
| └─ expires_at | integer | Unix-tidsstämpeln (i sekunder) för när detta ljudsvar inte längre kommer att vara tillgängligt på servern för användning i konversationer över flera turer. |
No | |
| └─ id | string | Unik identifierare för detta ljudsvar. | No | |
| └─ transcript | string | Transkription av ljudet som genereras av modellen. | No | |
| content | string | Innehållet i meddelandet. | Yes | |
| context | azureChatExtensionsMessageContext | En representation av den ytterligare kontextinformation som finns tillgänglig när Azure OpenAI-chatttillägg är involverade i genereringen av ett motsvarande svar på chattkompletteringar. Denna kontextinformation fylls endast i när man använder en Azure OpenAI-förfrågan konfigurerad för att använda en matchande tillägg. | No | |
| function_call | chatCompletionFunctionCall | Föråldrad och ersatt av tool_calls. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen. |
No | |
| refusal | string | Avvisningsmeddelandet som genereras av modellen. | Yes | |
| role | chatCompletionResponseMessageRole | Författarens roll för svarsmeddelandet. | Yes | |
| tool_calls | array | Verktygsanropen som genereras av modellen, såsom funktionsanrop. | No |
chatCompletionResponseMessageRole
Författarens roll för svarsmeddelandet.
| Property | Value |
|---|---|
| Description | Författarens roll för svarsmeddelandet. |
| Type | string |
| Values | assistant |
chatCompletionToolChoiceOption
Styr vilket (om något) verktyg som anropas av modellen.
none betyder att modellen inte anropar något verktyg utan istället genererar ett meddelande.
auto Det innebär att modellen kan välja mellan att generera ett meddelande eller att anropa ett eller flera verktyg.
required betyder att modellen måste anropa ett eller flera verktyg. Att specificera ett visst verktyg via {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa det verktyget.
none är standarden när inga verktyg finns.
auto är standarden om verktyg finns.
Denna komponent kan vara en av följande:
chatCompletionNamedToolChoice
Specificerar ett verktyg som modellen ska använda. Använd för att tvinga modellen att anropa en specifik funktion.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| function | object | Yes | ||
| └─ name | string | Namnet på funktionen att anropa. | No | |
| type | enum | Typen av verktyg. För närvarande stöds endast function det.Möjliga värden: function |
Yes |
ParallelToolCalls
Om man ska aktivera parallell funktionsanrop under verktygsanvändning.
Inga egenskaper definierade för denna komponent.
PredictionContent
Statiskt förutsagt utdatainnehåll, såsom innehållet i en textfil som återskapas.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | Sträng eller array | Innehållet som bör matchas när man genererar ett modellsvar. Om genererade tokens skulle matcha detta innehåll kan hela modellens svar returneras mycket snabbare. | Yes | |
| type | enum | Vilken typ av förväntat innehåll du vill tillhandahålla. Denna typ är för närvarande alltid content.Möjliga värden: content |
Yes |
chatCompletionMessageToolCalls
Verktygsanropen som genereras av modellen, såsom funktionsanrop.
Inga egenskaper definierade för denna komponent.
ChatCompletionModalities
Utdatatyper som du vill att modellen ska generera för denna förfrågan. De flesta modeller kan generera text, vilket är standard:
["text"]
Modellen gpt-4o-audio-preview kan också användas för att generera ljud. För att begära att denna modell genererar både text- och ljudsvar kan du använda:
["text", "audio"]
Inga egenskaper definierade för denna komponent.
chatCompletionFunctionCall
Föråldrad och ersatt av tool_calls. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| arguments | string | Argumenten för att anropa funktionen med, som genereras av modellen i JSON-format. Observera att modellen inte alltid genererar giltig JSON och kan hallucinera parametrar som inte definieras av ditt funktionsschema. Validera argumenten i din kod innan du anropar din funktion. | Yes | |
| name | string | Namnet på funktionen att anropa. | Yes |
completionUsage
Användningsstatistik för förfrågan om fullbordan.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| completion_tokens | integer | Antal tokens i den genererade fullföljandet. | Yes | |
| completion_tokens_details | object | Uppdelning av tokens som används i en fullbordan. | No | |
| └─ accepted_prediction_tokens | integer | När man använder Predicted Outputs, antalet tokens i prediktionen som förekom i slutförandet. | No | |
| └─ audio_tokens | integer | Ljudingångstokens genererade av modellen. | No | |
| └─ reasoning_tokens | integer | Tokens genererade av modellen för resonemang. | No | |
| └─ rejected_prediction_tokens | integer | När man använder Predicted Outputs, antalet tokens i prediktionen som inte förekom i slutförandet. Men precis som resonemangstoken räknas dessa token fortfarande i de totala kompletteringstokens för fakturering, utdata och kontextfönsterbegränsningar. | No | |
| prompt_tokens | integer | Antal tokens i prompten. | Yes | |
| prompt_tokens_details | object | Detaljer om prompttokens. | No | |
| └─ audio_tokens | integer | Ljudinmatningstokens finns i prompten. | No | |
| └─ cached_tokens | integer | Antalet cachade prompttokens. | No | |
| total_tokens | integer | Totalt antal tokens som används i förfrågan (prompt + fullföljande). | Yes |
chatCompletionTool
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| function | FunctionObject | Yes | ||
| type | enum | Typen av verktyg. För närvarande stöds endast function det.Möjliga värden: function |
Yes |
FunctionParameters
De parametrar som funktionen accepterar, beskrivs som ett JSON-schemaobjekt. Se guiden för exempel och JSON Schema-referensen för dokumentation om formatet.
Att parameters utelämna definierar en funktion med en tom parameterlista.
Inga egenskaper definierade för denna komponent.
FunctionObject
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | En beskrivning av vad funktionen gör, använd av modellen för att välja när och hur funktionen ska anropas. | No | |
| name | string | Namnet på funktionen som ska anropas. Måste vara a-z, A-Z, 0-9, eller innehålla understreck och streck, med en maximal längd på 64. | Yes | |
| parameters | FunctionParameters | De parametrar som funktionen accepterar, beskrivs som ett JSON-schemaobjekt.
Se guiden för exempel och JSON Schema-referensen för dokumentation om formatet. Att parameters utelämna definierar en funktion med en tom parameterlista. |
No | |
| strict | boolean | Om man ska aktivera strikt schema-följsamhet vid generering av funktionsanropet. Om den sätts till sant kommer modellen att följa det exakta schemat definierat i parameters fältet. Endast en delmängd av JSON-schemat stöds när strict är true. |
No | False |
ResponseFormatText
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Typen av svarsformat som definieras: textMöjliga värden: text |
Yes |
ResponseFormatJsonObject
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Typen av svarsformat som definieras: json_objectMöjliga värden: json_object |
Yes |
ResponseFormatJsonSchemaSchema
Schemat för svarsformatet, beskrivet som ett JSON Schema-objekt.
Inga egenskaper definierade för denna komponent.
ResponseFormatJsonSchema
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| json_schema | object | Yes | ||
| └─ description | string | En beskrivning av vad svarsformatet är till för, som används av modellen för att avgöra hur man ska svara i formatet. | No | |
| └─ name | string | Namnet på svarsformatet. Måste vara a-z, A-Z, 0-9, eller innehålla understreck och streck, med en maximal längd på 64. | No | |
| └─ schema | ResponseFormatJsonSchemaSchema | Schemat för svarsformatet, beskrivet som ett JSON Schema-objekt. | No | |
| └─ strict | boolean | Om man ska aktivera strikt schema-följsamhet vid generering av utdata. Om den sätts till sann kommer modellen alltid att följa det exakta schemat som definierats schema i fältet. Endast en delmängd av JSON-schemat stöds när strict är true. |
No | False |
| type | enum | Typen av svarsformat som definieras: json_schemaMöjliga värden: json_schema |
Yes |
chatCompletionChoiceCommon
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| finish_reason | string | No | ||
| index | integer | No |
createTranslationRequest
Translation request.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file | string | Ljudfilen att översätta. | Yes | |
| prompt | string | En valfri text för att styra modellens stil eller fortsätta ett tidigare ljudsegment. Uppgiften ska vara på engelska. | No | |
| response_format | audioResponseFormat | Definierar formatet på utdatan. | No | |
| temperature | number | Provtagningstemperaturen, mellan 0 och 1. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Om den sätts till 0 använder modellen logaritmisk sannolikhet för att automatiskt öka temperaturen tills vissa tröskelvärden nås. | No | 0 |
audioResponse
Översättnings- eller transkriptionssvar när response_format var json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | Översatt eller transkriberad text. | Yes |
audioVerboseResponse
Översättnings- eller transkriptionssvar när response_format var verbose_json
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| duration | number | Duration. | No | |
| language | string | Language. | No | |
| segments | array | No | ||
| task | string | Typ av ljuduppgift. | No | |
| text | string | Översatt eller transkriberad text. | Yes | |
| words | array | No |
audioResponseFormat
Definierar formatet på utdatan.
| Property | Value |
|---|---|
| Description | Definierar formatet på utdatan. |
| Type | string |
| Values | jsontextsrtverbose_jsonvtt |
createTranscriptionRequest
Transcription request.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file | string | Ljudfilobjektet att transkribera. | Yes | |
| language | string | Språket för inmatningsljudet. Att tillhandahålla inmatningsspråket i ISO-639-1-format förbättrar noggrannhet och latens. | No | |
| prompt | string | En valfri text för att styra modellens stil eller fortsätta ett tidigare ljudsegment. Prompten ska matcha ljudspråket. | No | |
| response_format | audioResponseFormat | Definierar formatet på utdatan. | No | |
| temperature | number | Provtagningstemperaturen, mellan 0 och 1. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Om den sätts till 0 använder modellen logaritmisk sannolikhet för att automatiskt öka temperaturen tills vissa tröskelvärden nås. | No | 0 |
| timestamp_granularities[] | array | Tidsstämpelns granulariteter för denna transkription.
response_format måste vara inställd verbose_json på att använda tidsstämpelgranulariteter. Antingen eller båda dessa alternativ stöds: word, eller segment. Observera: Det finns ingen extra latens för segmenttidsstämplar, men generering av ordtidsstämplar medför ytterligare latens. |
No | ['segment'] |
audioSegment
Transkriberings- eller översättningssegment.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| avg_logprob | number | Genomsnittlig sannolikhet för logaritm. | No | |
| compression_ratio | number | Compression ratio. | No | |
| end | number | Segmentändens förskjutning. | No | |
| id | integer | Segment identifier. | No | |
| no_speech_prob | number | Sannolikhet för 'ingen tal'. | No | |
| seek | number | Förskjutning av segmentet. | No | |
| start | number | Segmentstart-förskjutning. | No | |
| temperature | number | Temperature. | No | |
| text | string | Segment text. | No | |
| tokens | array | Symboler av texten. | No |
audioWord
Transkriberings- eller översättningsord.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| end | number | Word end offset. | No | |
| start | number | Word start offset. | No | |
| word | string | Word | No |
createSpeechRequest
Speech request.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input | string | Texten för att syntetisera ljud för. Den maximala längden är 4 096 tecken. | Yes | |
| response_format | enum | Formatet för att syntetisera ljudet i. Möjliga värden: mp3, opus, aac, flac, wav, pcm |
No | |
| speed | number | Hastigheten på det syntetiserade ljudet. Välj ett värde från 0.25 till 4.0.
1.0 är standard. |
No | 1.0 |
| voice | enum | Rösten att använda för talsyntes. Möjliga värden: alloy, echo, fable, onyx, nova, shimmer |
Yes |
imageQuality
Bildkvaliteten som kommer att genereras.
| Property | Value |
|---|---|
| Description | Bildkvaliteten som kommer att genereras. |
| Type | string |
| Default | auto |
| Values | autohighmediumlowhdstandard |
imagesResponseFormat
Formatet i vilket de genererade bilderna returneras.
| Property | Value |
|---|---|
| Description | Formatet i vilket de genererade bilderna returneras. |
| Type | string |
| Default | url |
| Values | urlb64_json |
imagesOutputFormat
Filformatet i vilket de genererade bilderna returneras. Stöds endast för seriemodeller.
| Property | Value |
|---|---|
| Description | Filformatet i vilket de genererade bilderna returneras. Stöds endast för GPT-image-1-seriens modeller. |
| Type | string |
| Default | png |
| Values | pngjpeg |
imageSize
Storleken på de genererade bilderna.
| Property | Value |
|---|---|
| Description | Storleken på de genererade bilderna. |
| Type | string |
| Default | auto |
| Values | auto1792x10241024x17921024x10241024x15361536x1024 |
imageStyle
Stilen på de genererade bilderna. Stöds endast för DALL-e-3.
| Property | Value |
|---|---|
| Description | Stilen på de genererade bilderna. Stöds endast för DALL-e-3. |
| Type | string |
| Default | vivid |
| Values | vividnatural |
imageBackground
Tillåter att ställa in transparens för bakgrunden i den genererade bilden/bilderna. Denna parameter stöds endast för modeller i GPT-image-1-serien.
| Property | Value |
|---|---|
| Description | Tillåter att ställa in transparens för bakgrunden i den genererade bilden/bilderna. Denna parameter stöds endast för modeller i GPT-image-1-serien. |
| Type | string |
| Default | auto |
| Values | transparentopaqueauto |
imageGenerationsRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| background | imageBackground | Tillåter att ställa in transparens för bakgrunden i den genererade bilden/bilderna. Denna parameter stöds endast för modeller i GPT-image-1-serien. | No | auto |
| n | integer | Antalet bilder som ska genereras. För dall-e-3 stöds endast n=1. | No | 1 |
| output_compression | integer | Kompressionsnivån (0–100%) för de genererade bilderna. Denna parameter stöds endast för gpt-image-1-seriemodeller med jpeg-utdataformat. | No | 100 |
| output_format | imagesOutputFormat | Filformatet i vilket de genererade bilderna returneras. Stöds endast för GPT-image-1-seriens modeller. | No | png |
| prompt | string | En textbeskrivning av den önskade bilden/bilderna. Maxlängden är 32 000 tecken för modeller i GPT-image-1-serien och 4 000 tecken för dall-e-3 | Yes | |
| quality | imageQuality | Bildkvaliteten som kommer att genereras. | No | auto |
| response_format | imagesResponseFormat | Formatet i vilket de genererade bilderna returneras. Stöds endast för DALL-e-3. | No | url |
| size | imageSize | Storleken på de genererade bilderna. | No | auto |
| style | imageStyle | Stilen på de genererade bilderna. Stöds endast för DALL-e-3. | No | vivid |
| user | string | En unik identifierare som representerar din slutanvändare, vilket kan hjälpa till att övervaka och upptäcka missbruk. | No |
imageEditsRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| image | Sträng eller array | Bilden/bilderna att redigera. Det måste vara en stödd bildfil eller en array av bilder. Varje bild bör vara en png- eller jpg-fil mindre än 25MB. | Yes | |
| mask | string | En extra bild vars helt transparenta områden (t.ex. där alfa är noll) anger var bilden ska redigeras. Om det finns flera bilder som tillhandahålls, appliceras masken på den första bilden. Det måste vara en giltig PNG-fil, mindre än 4MB, och ha samma dimensioner som bilden. | No | |
| n | integer | Antalet bilder som ska genereras. | No | 1 |
| prompt | string | En textbeskrivning av den önskade bilden/bilderna. Den maximala längden är 32 000 tecken. | Yes | |
| quality | imageQuality | Bildkvaliteten som kommer att genereras. | No | auto |
| response_format | imagesResponseFormat | Formatet i vilket de genererade bilderna returneras. | No | url |
| size | imageSize | Storleken på de genererade bilderna. | No | auto |
| user | string | En unik identifierare som representerar din slutanvändare, vilket kan hjälpa till att övervaka och upptäcka missbruk. | No |
generateImagesResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created | integer | Unix-tidsstämpeln när operationen skapades. | Yes | |
| data | array | Resultatdata för operationen, om den lyckas | Yes | |
| usage | imageGenerationsUsage | Representerar tokenanvändningsdetaljer för bildgenereringsförfrågningar. Endast för GPT-image-1-seriens modeller. | No |
imageResult
Bild-url:en eller kodad bild om den lyckas, och ett fel annars.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| b64_json | string | Den base64-kodade bilden | No | |
| content_filter_results | dalleContentFilterResults | Information om innehållet filtreringsresultat. | No | |
| prompt_filter_results | dalleFilterResults | Information om innehållsfiltreringskategorin (hat, sexuell, våld, self_harm), om den har upptäckts, samt allvarlighetsgraden (very_low, låg, medel, 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 upptäckts och om det har filtrerats eller inte. Och information om kundblockeringslistan, om den har filtrerats och dess ID. | No | |
| revised_prompt | string | Prompten som användes för att generera bilden, om det fanns någon revidering av prompten. | No | |
| url | string | Bild-URL:en. | No |
imageGenerationsUsage
Representerar tokenanvändningsdetaljer för bildgenereringsförfrågningar. Endast för GPT-image-1-seriens modeller.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input_tokens | integer | Antalet inmatningstokens. | No | |
| input_tokens_details | object | En detaljerad genomgång av inmatningstokens. | No | |
| └─ image_tokens | integer | Antalet bildtokens. | No | |
| └─ text_tokens | integer | Antalet texttokens. | No | |
| output_tokens | integer | Antalet utmatningstokens. | No | |
| total_tokens | integer | Det totala antalet använda tokens. | No |
line
Ett innehållsradsobjekt bestående av en intilliggande sekvens av innehållselement, såsom ord och urvalsmarkeringar.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| spans | array | En array av spann som representerar upptäckta objekt och deras information om begränsningsboxen. | Yes | |
| text | string | Yes |
span
Ett spännobjekt som representerar ett upptäckt objekt och dess information om begränsningsboxen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| length | integer | Längden på spannet i tecken, mätt i Unicode-kodpunkter. | Yes | |
| offset | integer | Teckenförskjutningen inom texten där spannet börjar. Denna offset definieras som positionen för det första tecknet i spannet, och räknas från början av texten som Unicode-kodpunkter. | Yes | |
| polygon | array | En array av objekt som representerar punkter i polygonen som omsluter det upptäckta objektet. | Yes | |
| text | string | Textinnehållet i spannet som representerar det upptäckta objektet. | Yes |
runCompletionUsage
Användningsstatistik relaterad till runen. Detta värde gäller null om körningen inte är i ett terminalt tillstånd (dvs. in_progress, queued, osv.).
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| completion_tokens | integer | Antal fullbordandetokens som används under körningen. | Yes | |
| prompt_tokens | integer | Antal prompt-tokens som används under loppet. | Yes | |
| total_tokens | integer | Totalt antal tokens som används (prompt + fullföljande). | Yes |
runStepCompletionUsage
Användningsstatistik relaterade till run step. Detta värde kommer att vara null medan körstegets status är in_progress.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| completion_tokens | integer | Antal kompletteringstokens som används under körsteget. | Yes | |
| prompt_tokens | integer | Antal prompt-tokens som används under körsteget. | Yes | |
| total_tokens | integer | Totalt antal tokens som används (prompt + fullföljande). | Yes |
assistantsApiResponseFormatOption
Specificerar formatet som modellen måste skriva ut. Kompatibel med GPT-4o, GPT-4 Turbo och alla GPT-3.5 Turbo-modeller sedan dess.gpt-3.5-turbo-1106
Inställning till { "type": "json_schema", "json_schema": {...} } aktiverar strukturerade utdata som säkerställer att modellen matchar ditt tillhandahållna JSON-schema. Läs mer i guiden för strukturerade utdata.
Att sätta på { "type": "json_object" } aktiverar JSON-läge, vilket säkerställer att meddelandet modellen genererar är giltigt JSON.
Viktigt: när du använder JSON-läge måste du också instruera modellen att själv producera JSON via ett system- eller användarmeddelande. Utan detta kan modellen generera en oändlig ström av whitespace tills genereringen når tokengränsen, vilket resulterar i en långvarig och till synes "fastkilad" förfrågan. Observera också att meddelandeinnehållet kan vara delvis avskuret om finish_reason="length", vilket indikerar att genereringen överskridits max_tokens eller att konversationen överskred maxkontextlängden.
Denna komponent kan vara en av följande:
assistantsApiResponseFormat
Ett objekt som beskriver den förväntade utdatan från modellen. Om json_object endast function typtyper tools tillåts skickas till Run. Om text modellen kan returnera text eller något värde som behövs.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | string | Måste vara en av text eller json_object. |
No | text |
typ Enum: AssistantsApiResponseFormat
| Value | Description |
|---|---|
| text | |
| json_object |
assistantObject
Representerar en assistant som kan anropa modellen och använda verktyg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | integer | Unix-tidsstämpeln (i sekunder) för när assistenten skapades. | Yes | |
| description | string | Beskrivningen av assistenten. Den maximala längden är 512 tecken. |
Yes | |
| id | string | Identifieraren, som kan refereras i API-endpoints. | Yes | |
| instructions | string | Systeminstruktionerna som assistenten använder. Den maximala längden är 256 000 tecken. |
Yes | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
Yes | |
| model | string | ID på modellen att använda. | Yes | |
| name | string | Assistentens namn. Den maximala längden är 256 tecken. |
Yes | |
| object | string | Objekttypen, som alltid assistantär . |
Yes | |
| response_format | assistantsApiResponseFormatOption | Specificerar formatet som modellen måste skriva ut. Kompatibel med GPT-4o, GPT-4 Turbo och alla GPT-3.5 Turbo-modeller sedan dess.gpt-3.5-turbo-1106Inställning till { "type": "json_schema", "json_schema": {...} } aktiverar strukturerade utdata som säkerställer att modellen matchar ditt tillhandahållna JSON-schema. Läs mer i guiden för strukturerade utdata.Att sätta på { "type": "json_object" } aktiverar JSON-läge, vilket säkerställer att meddelandet modellen genererar är giltigt JSON.Viktigt: när du använder JSON-läge måste du också instruera modellen att själv producera JSON via ett system- eller användarmeddelande. Utan detta kan modellen generera en oändlig ström av whitespace tills genereringen når tokengränsen, vilket resulterar i en långvarig och till synes "fastkilad" förfrågan. Observera också att meddelandeinnehållet kan vara delvis avskuret om finish_reason="length", vilket indikerar att genereringen överskridits max_tokens eller att konversationen överskred maxkontextlängden. |
No | |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. |
No | 1 |
| tool_resources | object | En uppsättning resurser som används av assistentens verktyg. Resurserna är specifika för typen av verktyg. Till exempel code_interpreter kräver verktyget en lista med fil-ID:n, medan verktyget file_search kräver en lista med vektorlagre-ID:n. |
No | |
| └─ code_interpreter | object | No | ||
| └─ file_ids | array | En lista över fil-ID:n som görs tillgängliga för verktyget code_interpreter . Det kan finnas maximalt 20 filer kopplade till verktyget. |
No | [] |
| └─ file_search | object | No | ||
| └─ vector_store_ids | array | ID:t för vektorlagret är kopplat till denna assistent. Det kan vara maximalt 1 vektorlager kopplat till assistenten. |
No | |
| tools | array | En lista över verktyg aktiverade på assistenten. Det kan vara maximalt 128 verktyg per assistent. Verktyg kan vara av typ code_interpreter, file_search, eller function. |
Yes | [] |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperaturen men inte båda. |
No | 1 |
objekt Enum: AssistentObjektType
| Value | Description |
|---|---|
| assistant | Objekttypen, som alltid är assistent |
createAssistantRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | Beskrivningen av assistenten. Den maximala längden är 512 tecken. |
No | |
| instructions | string | Systeminstruktionerna som assistenten använder. Den maximala längden är 256 000 tecken. |
No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| model | string | Yes | ||
| name | string | Assistentens namn. Den maximala längden är 256 tecken. |
No | |
| response_format | assistantsApiResponseFormatOption | Specificerar formatet som modellen måste skriva ut. Kompatibel med GPT-4o, GPT-4 Turbo och alla GPT-3.5 Turbo-modeller sedan dess.gpt-3.5-turbo-1106Inställning till { "type": "json_schema", "json_schema": {...} } aktiverar strukturerade utdata som säkerställer att modellen matchar ditt tillhandahållna JSON-schema. Läs mer i guiden för strukturerade utdata.Att sätta på { "type": "json_object" } aktiverar JSON-läge, vilket säkerställer att meddelandet modellen genererar är giltigt JSON.Viktigt: när du använder JSON-läge måste du också instruera modellen att själv producera JSON via ett system- eller användarmeddelande. Utan detta kan modellen generera en oändlig ström av whitespace tills genereringen når tokengränsen, vilket resulterar i en långvarig och till synes "fastkilad" förfrågan. Observera också att meddelandeinnehållet kan vara delvis avskuret om finish_reason="length", vilket indikerar att genereringen överskridits max_tokens eller att konversationen överskred maxkontextlängden. |
No | |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. |
No | 1 |
| tool_resources | object | En uppsättning resurser som används av assistentens verktyg. Resurserna är specifika för typen av verktyg. Till exempel code_interpreter kräver verktyget en lista med fil-ID:n, medan verktyget file_search kräver en lista med vektorlagre-ID:n. |
No | |
| └─ code_interpreter | object | No | ||
| └─ file_ids | array | En lista över fil-ID:n som görs tillgängliga för verktyget code_interpreter . Det kan finnas maximalt 20 filer kopplade till verktyget. |
No | [] |
| └─ file_search | object | No | ||
| └─ vector_store_ids | array | Vektorlagret är kopplat till denna assistent. Det kan vara maximalt 1 vektorlager kopplat till assistenten. |
No | |
| └─ vector_stores | array | En hjälpare för att skapa en vektorlagring med file_ids och koppla den till denna assistent. Det kan vara maximalt 1 vektorlager kopplat till assistenten. |
No | |
| tools | array | En lista över verktyg aktiverade på assistenten. Det kan vara maximalt 128 verktyg per assistent. Verktyg kan vara av typ code_interpreter, retrieval, eller function. |
No | [] |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperaturen men inte båda. |
No | 1 |
modifyAssistantRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | Beskrivningen av assistenten. Den maximala längden är 512 tecken. |
No | |
| instructions | string | Systeminstruktionerna som assistenten använder. Den maximala längden är 32 768 tecken. |
No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| model | string | No | ||
| name | string | Assistentens namn. Den maximala längden är 256 tecken. |
No | |
| response_format | assistantsApiResponseFormatOption | Specificerar formatet som modellen måste skriva ut. Kompatibel med GPT-4o, GPT-4 Turbo och alla GPT-3.5 Turbo-modeller sedan dess.gpt-3.5-turbo-1106Inställning till { "type": "json_schema", "json_schema": {...} } aktiverar strukturerade utdata som säkerställer att modellen matchar ditt tillhandahållna JSON-schema. Läs mer i guiden för strukturerade utdata.Att sätta på { "type": "json_object" } aktiverar JSON-läge, vilket säkerställer att meddelandet modellen genererar är giltigt JSON.Viktigt: när du använder JSON-läge måste du också instruera modellen att själv producera JSON via ett system- eller användarmeddelande. Utan detta kan modellen generera en oändlig ström av whitespace tills genereringen når tokengränsen, vilket resulterar i en långvarig och till synes "fastkilad" förfrågan. Observera också att meddelandeinnehållet kan vara delvis avskuret om finish_reason="length", vilket indikerar att genereringen överskridits max_tokens eller att konversationen överskred maxkontextlängden. |
No | |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. |
No | 1 |
| tool_resources | object | En uppsättning resurser som används av assistentens verktyg. Resurserna är specifika för typen av verktyg. Till exempel code_interpreter kräver verktyget en lista med fil-ID:n, medan verktyget file_search kräver en lista med vektorlagre-ID:n. |
No | |
| └─ code_interpreter | object | No | ||
| └─ file_ids | array | Åsidosätter listan över fil-ID:n som görs tillgängliga för verktyget code_interpreter . Det kan finnas maximalt 20 filer kopplade till verktyget. |
No | [] |
| └─ file_search | object | No | ||
| └─ vector_store_ids | array | Överskriver vektorlagret som är kopplat till denna assistent. Det kan vara maximalt 1 vektorlager kopplat till assistenten. |
No | |
| tools | array | En lista över verktyg aktiverade på assistenten. Det kan vara maximalt 128 verktyg per assistent. Verktyg kan vara av typ code_interpreter, retrieval, eller function. |
No | [] |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperaturen men inte båda. |
No | 1 |
deleteAssistantResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deleted | boolean | Yes | ||
| id | string | Yes | ||
| object | string | Yes |
objekt Enum: DeleteAssistantResponseState
| Value | Description |
|---|---|
| assistant.deleted |
listAssistantsResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | array | Yes | ||
| first_id | string | Yes | ||
| has_more | boolean | Yes | ||
| last_id | string | Yes | ||
| object | string | Yes |
assistantToolsCode
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | string | Typen av verktyg som definieras: code_interpreter |
Yes |
typ Enum: assistantToolsCodeType
| Value | Description |
|---|---|
| code_interpreter |
assistantToolsFileSearch
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_search | object | Överskrider filsökverktyget. | No | |
| └─ max_num_results | integer | Det maximala antalet resultat som filsökverktyget bör ge. Standardvärdet är 20 för GPT-4*-modeller och 5 för GPT-3.5-turbo. Detta antal bör ligga mellan 1 och 50 inklusive. Observera att filsökverktyget kan ge färre resultat max_num_results . |
No | |
| type | string | Typen av verktyg som definieras: file_search |
Yes |
typ Enum: assistantToolsFileSearchType
| Value | Description |
|---|---|
| file_search |
assistantToolsFileSearchTypeOnly
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | string | Typen av verktyg som definieras: file_search |
Yes |
typ Enum: assistantToolsFileSearchType
| Value | Description |
|---|---|
| file_search |
assistantToolsFunction
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| function | object | Funktionsdefinitionen. | Yes | |
| └─ description | string | En beskrivning av vad funktionen gör, använd av modellen för att välja när och hur funktionen ska anropas. | No | |
| └─ name | string | Namnet på funktionen som ska anropas. Måste vara a-z, A-Z, 0-9, eller innehålla understreck och streck, med en maximal längd på 64. | No | |
| └─ parameters | chatCompletionFunctionParameters | De parametrar som funktionen accepterar, beskrivs som ett JSON-schemaobjekt. Se guiden/ exemplen och JSON-schemareferensen för dokumentation om formatet. | No | |
| type | string | Typen av verktyg som definieras: function |
Yes |
typ Enum: assistantToolsFunction
| Value | Description |
|---|---|
| function |
truncationObject
Kontroller för hur en tråd kommer att förkortas innan körningen. Använd detta för att styra det initiala kontextfönstret för körningen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| last_messages | integer | Antalet senaste meddelanden från tråden när kontexten för körningen byggs. | No | |
| type | string | Förkortningsstrategin att använda för tråden. Standardvärdet är auto. Om den sätts till last_messages, kommer tråden att trunkeras till de n senaste meddelandena i tråden. När det sätts till auto, kommer meddelanden i mitten av tråden att släppas för att passa modellens kontextlängd, max_prompt_tokens. |
Yes |
typ Enum: Trunkeringstyp
| Value | Description |
|---|---|
| auto | |
| last_messages |
assistantsApiToolChoiceOption
Styr vilket (om något) verktyg som anropas av modellen.
none betyder att modellen inte anropar några verktyg utan istä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.
Att specificera ett särskilt verktyg som {"type": "file_search"} eller {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa det verktyget.
Denna komponent kan vara en av följande:
assistantsNamedToolChoice
Specificerar ett verktyg som modellen ska använda. Använd för att tvinga modellen att anropa ett specifikt verktyg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| function | object | No | ||
| └─ name | string | Namnet på funktionen att anropa. | No | |
| type | string | Typen av verktyg. Om typen är function, måste funktionsnamnet sättas |
Yes |
typ Enum: AssistenterNamngivetVerktygValTyp
| Value | Description |
|---|---|
| function | |
| code_interpreter | |
| file_search |
runObject
Representerar en exekvering som körs på en tråd.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| assistant_id | string | ID:t på assistenten som användes för utförandet av denna körning. | Yes | |
| cancelled_at | integer | Unix-tidsstämpeln (i sekunder) för när körningen avbröts. | Yes | |
| completed_at | integer | Unix-tidsstämpeln (i sekunder) för när körningen var avslutad. | Yes | |
| created_at | integer | Unix-tidsstämpeln (i sekunder) för när körningen skapades. | Yes | |
| expires_at | integer | Unix-tidsstämpeln (i sekunder) för när runen går ut. | Yes | |
| failed_at | integer | Unix-tidsstämpeln (i sekunder) för när körningen misslyckades. | Yes | |
| id | string | Identifieraren, som kan refereras i API-endpoints. | Yes | |
| incomplete_details | object | Detaljer om varför genomspelningen är ofullständig. Det kommer det att bli null om genomspelningen inte är ofullständig. |
Yes | |
| └─ reason | string | Anledningen till att genomspelningen är ofullständig. Detta pekar på vilken specifik tokengräns som nåddes under runningen. | No | |
| instructions | string | Instruktionerna som assistenten använde för denna runda. | Yes | |
| last_error | object | Det sista felet kopplat till denna körning. Det kommer att bli om null det inte finns några fel. |
Yes | |
| └─ code | string | En av server_error eller rate_limit_exceeded. |
No | |
| └─ message | string | En mänskligt läsbar beskrivning av felet. | No | |
| max_completion_tokens | integer | Det maximala antalet fullbordandetokens som specificerats ha använts under loppet. |
Yes | |
| max_prompt_tokens | integer | Det maximala antalet prompt-tokens som anges ha använts under runningen. |
Yes | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
Yes | |
| model | string | Modellen som assistenten använde för denna körning. | Yes | |
| object | string | Objekttypen, som alltid thread.runär . |
Yes | |
| parallel_tool_calls | ParallelToolCalls | Om man ska aktivera parallell funktionsanrop under verktygsanvändning. | No | True |
| required_action | object | Detaljer om vad som krävs för att fortsätta körningen. Det kommer det att bli om null ingen åtgärd krävs. |
Yes | |
| └─ submit_tool_outputs | object | Detaljer om verktygsutdata som behövs för att denna körning ska fortsätta. | No | |
| └─ tool_calls | array | En lista över relevanta verktygsanrop. | No | |
| └─ type | enum | För tillfället är detta alltid submit_tool_outputsså här.Möjliga värden: submit_tool_outputs |
No | |
| response_format | assistantsApiResponseFormatOption | Specificerar formatet som modellen måste skriva ut. Kompatibel med GPT-4o, GPT-4 Turbo och alla GPT-3.5 Turbo-modeller sedan dess.gpt-3.5-turbo-1106Inställning till { "type": "json_schema", "json_schema": {...} } aktiverar strukturerade utdata som säkerställer att modellen matchar ditt tillhandahållna JSON-schema. Läs mer i guiden för strukturerade utdata.Att sätta på { "type": "json_object" } aktiverar JSON-läge, vilket säkerställer att meddelandet modellen genererar är giltigt JSON.Viktigt: när du använder JSON-läge måste du också instruera modellen att själv producera JSON via ett system- eller användarmeddelande. Utan detta kan modellen generera en oändlig ström av whitespace tills genereringen når tokengränsen, vilket resulterar i en långvarig och till synes "fastkilad" förfrågan. Observera också att meddelandeinnehållet kan vara delvis avskuret om finish_reason="length", vilket indikerar att genereringen överskridits max_tokens eller att konversationen överskred maxkontextlängden. |
Yes | |
| started_at | integer | Unix-tidsstämpeln (i sekunder) för när körningen startades. | Yes | |
| status | string | Statusen för körningen, som kan vara antingen , , , , cancellingcancelled, failed, completed, eller expired. requires_actionin_progressqueued |
Yes | |
| temperature | number | Provtagningstemperaturen som användes för denna körning. Om det inte är satt, är standardvärdet 1. | No | |
| thread_id | string | ID:t för trådarna som kördes på som en del av denna körning. | Yes | |
| tool_choice | assistantsApiToolChoiceOption | Styr vilket (om något) verktyg som anropas av modellen.none betyder att modellen inte anropar några verktyg utan istä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.Att specificera ett särskilt verktyg som {"type": "file_search"} eller {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa det verktyget. |
Yes | |
| tools | array | Listan på verktyg som assistenten använde för denna runda. | Yes | [] |
| top_p | number | Kärnprovtagningsvärdet som används för denna körning. Om det inte är satt, är standardvärdet 1. | No | |
| truncation_strategy | truncationObject | Kontroller för hur en tråd kommer att förkortas innan körningen. Använd detta för att styra det initiala kontextfönstret för körningen. | Yes | |
| usage | runCompletionUsage | Användningsstatistik relaterad till runen. Detta värde gäller null om körningen inte är i ett terminalt tillstånd (dvs. in_progress, queued, osv.). |
Yes |
objekt Enum: runObjectType
| Value | Description |
|---|---|
| thread.run | Run-objekttypen som alltid är thread.run |
status Enum: RunObjectStatus
| Value | Description |
|---|---|
| queued | Det köade tillståndet |
| in_progress | Den in_progress delstaten |
| requires_action | Den required_action delstaten |
| cancelling | Det upphävande tillståndet |
| cancelled | Den inställda delstaten |
| failed | Den misslyckade staten |
| completed | Den färdiga staten |
| expired | Den utgångna delstaten |
createRunRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| additional_instructions | string | Bifogar ytterligare instruktioner i slutet av instruktionerna för körningen. Detta är användbart för att modifiera beteendet per körning utan att åsidosätta andra instruktioner. | No | |
| additional_messages | array | Lägger till ytterligare meddelanden i tråden innan körningen skapas. | No | |
| assistant_id | string | ID:t på assistenten som ska användas för att utföra denna runda. | Yes | |
| instructions | string | Åsidosätt assistentens standardsystemmeddelande. Detta är användbart för att modifiera beteendet per körning. | No | |
| max_completion_tokens | integer | Det maximala antalet kompletteringstokens som kan användas under körningens gång. Körningen gör sitt bästa för att använda endast det antal fullbordande-tokens som anges över flera turer av rundan. Om körningen överstiger det angivna antalet kompletteringstokens avslutas körningen med status incomplete. Se incomplete_details för mer information. |
No | |
| max_prompt_tokens | integer | Det maximala antalet prompt-tokens som kan användas under loppets gång. Runen gör sitt bästa för att använda endast det antal prompttokens som angivits, över flera turer av runet. Om körningen överstiger antalet prompt-tokens som anges avslutas med status incomplete. Se incomplete_details för mer information. |
No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| model | string | ID:t för modellen som ska användas för att utföra denna körning. Om ett värde anges här kommer det att åsidosätta modellen som är kopplad till assistenten. Om inte, kommer modellen som är kopplad till assistenten att användas. | No | |
| parallel_tool_calls | ParallelToolCalls | Om man ska aktivera parallell funktionsanrop under verktygsanvändning. | No | True |
| response_format | assistantsApiResponseFormatOption | Specificerar formatet som modellen måste skriva ut. Kompatibel med GPT-4o, GPT-4 Turbo och alla GPT-3.5 Turbo-modeller sedan dess.gpt-3.5-turbo-1106Inställning till { "type": "json_schema", "json_schema": {...} } aktiverar strukturerade utdata som säkerställer att modellen matchar ditt tillhandahållna JSON-schema. Läs mer i guiden för strukturerade utdata.Att sätta på { "type": "json_object" } aktiverar JSON-läge, vilket säkerställer att meddelandet modellen genererar är giltigt JSON.Viktigt: när du använder JSON-läge måste du också instruera modellen att själv producera JSON via ett system- eller användarmeddelande. Utan detta kan modellen generera en oändlig ström av whitespace tills genereringen når tokengränsen, vilket resulterar i en långvarig och till synes "fastkilad" förfrågan. Observera också att meddelandeinnehållet kan vara delvis avskuret om finish_reason="length", vilket indikerar att genereringen överskridits max_tokens eller att konversationen överskred maxkontextlängden. |
No | |
| stream | boolean | Om true, returnerar en ström av händelser som sker under Körningen som serverskickade händelser, och avslutas när Körningen går in i ett terminalläge med ett data: [DONE] meddelande. |
No | |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. |
No | 1 |
| tool_choice | assistantsApiToolChoiceOption | Styr vilket (om något) verktyg som anropas av modellen.none betyder att modellen inte anropar några verktyg utan istä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.Att specificera ett särskilt verktyg som {"type": "file_search"} eller {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa det verktyget. |
No | |
| tools | array | Överstyr verktygen som assistenten kan använda för denna genomspelning. Detta är användbart för att modifiera beteendet per körning. | No | |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperaturen men inte båda. |
No | 1 |
| truncation_strategy | truncationObject | Kontroller för hur en tråd kommer att förkortas innan körningen. Använd detta för att styra det initiala kontextfönstret för körningen. | No |
listRunsResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | array | Yes | ||
| first_id | string | Yes | ||
| has_more | boolean | Yes | ||
| last_id | string | Yes | ||
| object | string | Yes |
modifyRunRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No |
submitToolOutputsRunRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| stream | boolean | Om true, returnerar en ström av händelser som sker under Körningen som serverskickade händelser, och avslutas när Körningen går in i ett terminalläge med ett data: [DONE] meddelande. |
No | |
| tool_outputs | array | En lista över verktyg för vilka utdata skickas in. | Yes |
runToolCallObject
Verktygsanropsobjekt
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| function | object | Funktionsdefinitionen. | Yes | |
| └─ arguments | string | Argumenten som modellen förväntar sig att du ska vidarebefordra till funktionen. | No | |
| └─ name | string | Namnet på funktionen. | No | |
| id | string | ID:t på verktygsanropet. Detta ID måste refereras till när du skickar in verktygsutdata med hjälp av att skicka verktygsutdata för att köra endpointendpoint. | Yes | |
| type | string | Den typ av verktyg som utgången krävs för. För tillfället är detta alltid functionså här. |
Yes |
typ Enum: RunToolCallObjectType
| Value | Description |
|---|---|
| function |
createThreadAndRunRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| assistant_id | string | ID:t på assistenten som ska användas för att utföra denna runda. | Yes | |
| instructions | string | Åsidosätt assistentens standardsystemmeddelande. Detta är användbart för att modifiera beteendet per körning. | No | |
| max_completion_tokens | integer | Det maximala antalet kompletteringstokens som kan användas under körningens gång. Körningen gör sitt bästa för att använda endast det antal fullbordande-tokens som anges över flera turer av rundan. Om körningen överstiger det angivna antalet kompletteringstokens avslutas körningen med status incomplete. Se incomplete_details för mer information. |
No | |
| max_prompt_tokens | integer | Det maximala antalet prompt-tokens som kan användas under loppets gång. Runen gör sitt bästa för att använda endast det antal prompttokens som angivits, över flera turer av runet. Om körningen överstiger antalet prompt-tokens som anges avslutas med status incomplete. Se incomplete_details för mer information. |
No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| model | string | ID:t för modellerna som ska användas för att köra denna körning. Om ett värde anges här kommer det att åsidosätta modellen som är kopplad till assistenten. Om inte, kommer modellen som är kopplad till assistenten att användas. | No | |
| parallel_tool_calls | ParallelToolCalls | Om man ska aktivera parallell funktionsanrop under verktygsanvändning. | No | True |
| response_format | assistantsApiResponseFormatOption | Specificerar formatet som modellen måste skriva ut. Kompatibel med GPT-4o, GPT-4 Turbo och alla GPT-3.5 Turbo-modeller sedan dess.gpt-3.5-turbo-1106Inställning till { "type": "json_schema", "json_schema": {...} } aktiverar strukturerade utdata som säkerställer att modellen matchar ditt tillhandahållna JSON-schema. Läs mer i guiden för strukturerade utdata.Att sätta på { "type": "json_object" } aktiverar JSON-läge, vilket säkerställer att meddelandet modellen genererar är giltigt JSON.Viktigt: när du använder JSON-läge måste du också instruera modellen att själv producera JSON via ett system- eller användarmeddelande. Utan detta kan modellen generera en oändlig ström av whitespace tills genereringen når tokengränsen, vilket resulterar i en långvarig och till synes "fastkilad" förfrågan. Observera också att meddelandeinnehållet kan vara delvis avskuret om finish_reason="length", vilket indikerar att genereringen överskridits max_tokens eller att konversationen överskred maxkontextlängden. |
No | |
| stream | boolean | Om true, returnerar en ström av händelser som sker under Körningen som serverskickade händelser, och avslutas när Körningen går in i ett terminalläge med ett data: [DONE] meddelande. |
No | |
| stream_options | chatCompletionStreamOptions | Alternativ för streaming-respons. Ställ in detta först när du sätter stream: true. |
No | None |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. |
No | 1 |
| thread | createThreadRequest | No | ||
| tool_choice | assistantsApiToolChoiceOption | Styr vilket (om något) verktyg som anropas av modellen.none betyder att modellen inte anropar några verktyg utan istä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.Att specificera ett särskilt verktyg som {"type": "file_search"} eller {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa det verktyget. |
No | |
| tool_resources | object | En uppsättning resurser som används av assistentens verktyg. Resurserna är specifika för typen av verktyg. Till exempel code_interpreter kräver verktyget en lista med fil-ID:n, medan verktyget file_search kräver en lista med vektorlagre-ID:n. |
No | |
| └─ code_interpreter | object | No | ||
| └─ file_ids | array | En lista över fil-ID:n som görs tillgängliga för verktyget code_interpreter . Det kan finnas maximalt 20 filer kopplade till verktyget. |
No | [] |
| └─ file_search | object | No | ||
| └─ vector_store_ids | array | ID:t för vektorlagret är kopplat till denna assistent. Det kan vara maximalt 1 vektorlager kopplat till assistenten. |
No | |
| tools | array | Överstyr verktygen som assistenten kan använda för denna genomspelning. Detta är användbart för att modifiera beteendet per körning. | No | |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperaturen men inte båda. |
No | 1 |
| truncation_strategy | truncationObject | Kontroller för hur en tråd kommer att förkortas innan körningen. Använd detta för att styra det initiala kontextfönstret för körningen. | No |
threadObject
Representerar en tråd som innehåller meddelanden.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | integer | Unix-tidsstämpeln (i sekunder) för när tråden skapades. | Yes | |
| id | string | Identifieraren, som kan refereras i API-endpoints. | Yes | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
Yes | |
| object | string | Objekttypen, som alltid threadär . |
Yes | |
| tool_resources | object | En uppsättning resurser som görs tillgängliga för assistentens verktyg i denna tråd. Resurserna är specifika för typen av verktyg. Till exempel code_interpreter kräver verktyget en lista med fil-ID:n, medan verktyget file_search kräver en lista med vektorlagre-ID:n. |
Yes | |
| └─ code_interpreter | object | No | ||
| └─ file_ids | array | En lista över fil-ID:n som görs tillgängliga för verktyget code_interpreter . Det kan finnas maximalt 20 filer kopplade till verktyget. |
No | [] |
| └─ file_search | object | No | ||
| └─ vector_store_ids | array | Vektorlagret som är kopplat till denna tråd. Det kan vara maximalt 1 vektorlagring kopplad till tråden. |
No |
objekt Enum: ThreadObjectType
| Value | Description |
|---|---|
| thread | Typen av trådobjekt som alltid är thread |
createThreadRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| messages | array | En lista med meddelanden att starta tråden med. | No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| tool_resources | object | En uppsättning resurser som görs tillgängliga för assistentens verktyg i denna tråd. Resurserna är specifika för typen av verktyg. Till exempel code_interpreter kräver verktyget en lista med fil-ID:n, medan verktyget file_search kräver en lista med vektorlagre-ID:n. |
No | |
| └─ code_interpreter | object | No | ||
| └─ file_ids | array | En lista över fil-ID:n som görs tillgängliga för verktyget code_interpreter . Det kan finnas maximalt 20 filer kopplade till verktyget. |
No | [] |
| └─ file_search | object | No | ||
| └─ vector_store_ids | array | Vektorlagret som är kopplat till denna tråd. Det kan vara maximalt 1 vektorlagring kopplad till tråden. |
No | |
| └─ vector_stores | array | En hjälpare för att skapa en vektorlagring med file_ids och koppla den till denna tråd. Det kan vara maximalt 1 vektorlagring kopplad till tråden. |
No |
modifyThreadRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| tool_resources | object | En uppsättning resurser som görs tillgängliga för assistentens verktyg i denna tråd. Resurserna är specifika för typen av verktyg. Till exempel code_interpreter kräver verktyget en lista med fil-ID:n, medan verktyget file_search kräver en lista med vektorlagre-ID:n. |
No | |
| └─ code_interpreter | object | No | ||
| └─ file_ids | array | En lista över fil-ID:n som görs tillgängliga för verktyget code_interpreter . Det kan finnas maximalt 20 filer kopplade till verktyget. |
No | [] |
| └─ file_search | object | No | ||
| └─ vector_store_ids | array | Vektorlagret som är kopplat till denna tråd. Det kan vara maximalt 1 vektorlagring kopplad till tråden. |
No |
deleteThreadResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deleted | boolean | Yes | ||
| id | string | Yes | ||
| object | string | Yes |
objekt Enum: DeleteThreadResponseObjectState
| Value | Description |
|---|---|
| thread.deleted | Delete-trådens svarsobjektstatus som är thread.deleted |
listThreadsResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | array | Yes | ||
| first_id | string | Yes | ||
| has_more | boolean | Yes | ||
| last_id | string | Yes | ||
| object | string | Yes |
messageObject
Representerar ett meddelande inom en tråd.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| assistant_id | string | Om tillämpligt, ID:t på assistenten som skrev detta meddelande. | Yes | |
| attachments | array | En lista över filer som var bifogade meddelandet och vilka verktyg de lades till i. | Yes | |
| completed_at | integer | Unix-tidsstämpeln (i sekunder) för när meddelandet var slutfört. | Yes | |
| content | array | Innehållet i meddelandet i en array av text och/eller bilder. | Yes | |
| created_at | integer | Unix-tidsstämpeln (i sekunder) för när meddelandet skapades. | Yes | |
| id | string | Identifieraren, som kan refereras i API-endpoints. | Yes | |
| incomplete_at | integer | Unix-tidsstämpeln (i sekunder) för när meddelandet markerades som ofullständigt. | Yes | |
| incomplete_details | object | På ett ofullständigt meddelande, detaljer om varför meddelandet är ofullständigt. | Yes | |
| └─ reason | string | Anledningen till att meddelandet är ofullständigt. | No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
Yes | |
| object | string | Objekttypen, som alltid thread.messageär . |
Yes | |
| role | string | Entiteten som producerade meddelandet. En av user eller assistant. |
Yes | |
| run_id | string | Om tillämpligt, ID:t för den körning som är kopplad till skapandet av detta meddelande. | Yes | |
| status | string | Meddelandets status, som kan vara antingen in_progress, incomplete, eller completed. |
Yes | |
| thread_id | string | Tråd-ID:t som detta meddelande tillhör. | Yes |
objekt Enum: MessageObjectType
| Value | Description |
|---|---|
| thread.message | Meddelandeobjekttypen som är thread.message |
status Enum: MessageObjectStatus
| Value | Description |
|---|---|
| in_progress | |
| incomplete | |
| completed |
roll: MessageObjectRole
| Value | Description |
|---|---|
| user | |
| assistant |
messageDeltaObject
Representerar ett meddelandedelta, dvs. alla ändrade fält i ett meddelande under streaming.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| delta | object | Deltat som innehåller fälten som har ändrats på meddelandet. | Yes | |
| └─ content | array | Innehållet i meddelandet i en array av text och/eller bilder. | No | |
| └─ role | string | Entiteten som producerade meddelandet. En av user eller assistant. |
No | |
| id | string | Identifieraren för meddelandet, som kan refereras i API-endpoints. | Yes | |
| object | string | Objekttypen, som alltid thread.message.deltaär . |
Yes |
objekt-Enum: MessageDeltaObjectType
| Value | Description |
|---|---|
| thread.message.delta |
createMessageRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| attachments | array | En lista över filer som är bifogade meddelandet, och vilka verktyg de ska läggas till i. | No | |
| content | string | Innehållet i meddelandet. | Yes | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| role | string | Rollen för den entitet som skapar meddelandet. Tillåtna värden inkluderar: - user: Indikerar 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: Indikerar att meddelandet genereras av assistenten. Använd detta värde för att infoga meddelanden från assistenten i konversationen. |
Yes |
rollenum: SkapaMeddelandeBegäranRoll
| Value | Description |
|---|---|
| user | |
| assistant |
modifyMessageRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No |
deleteMessageResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deleted | boolean | Yes | ||
| id | string | Yes | ||
| object | string | Yes |
objekt Enum: DeleteMessageResponseObject
| Value | Description |
|---|---|
| thread.message.deleted | Tillståndet för att ta bort meddelandets svar |
listMessagesResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | array | Yes | ||
| first_id | string | Yes | ||
| has_more | boolean | Yes | ||
| last_id | string | Yes | ||
| object | string | Yes |
messageContentImageFileObject
Refererar till en bildfil i innehållet i ett meddelande.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| image_file | object | Yes | ||
| └─ file_id | string | Fil-ID:t för bilden i meddelandeinnehållet. | No | |
| type | string | Alltid image_file. |
Yes |
typ Enum: MessageContentImageFileObjectType
| Value | Description |
|---|---|
| image_file | Meddelandeinnehållets bildfiltyp |
messageContentTextObject
Textinnehållet som är en del av ett meddelande.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | object | Yes | ||
| └─ annotations | array | No | ||
| └─ value | string | Datan som utgör texten. | No | |
| type | string | Alltid text. |
Yes |
typ Enum: messageContentTextObjectType
| Value | Description |
|---|---|
| text | Meddelandets innehållstext Objekttyp |
messageContentTextAnnotationsFileCitationObject
En källa i meddelandet som pekar på ett specifikt citat från en specifik fil kopplad till assistenten eller meddelandet. Genereras när assistenten använder verktyget "hämta" för att söka i filer.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| end_index | integer | Yes | ||
| file_citation | object | Yes | ||
| └─ file_id | string | ID:t för den specifika fil som citationen kommer ifrån. | No | |
| start_index | integer | Yes | ||
| text | string | Texten i meddelandet som behöver ersättas. | Yes | |
| type | string | Alltid file_citation. |
Yes |
typ Enum: FileCitationObjectType
| Value | Description |
|---|---|
| file_citation | Filen citation objekttyp |
messageContentTextAnnotationsFilePathObject
En URL för filen som genereras när assistenten använde code_interpreter verktyget för att skapa en fil.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| end_index | integer | Yes | ||
| file_path | object | Yes | ||
| └─ file_id | string | ID:t för filen som genererades. | No | |
| start_index | integer | Yes | ||
| text | string | Texten i meddelandet som behöver ersättas. | Yes | |
| type | string | Alltid file_path. |
Yes |
typ Enum: FilePathObjectType
| Value | Description |
|---|---|
| file_path | Objekttypen av filväg |
messageDeltaContentImageFileObject
Refererar till en bildfil i innehållet i ett meddelande.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| image_file | object | No | ||
| └─ file_id | string | Fil-ID:t för bilden i meddelandeinnehållet. | No | |
| index | integer | Innehållsindexet i meddelandet. | Yes | |
| type | string | Alltid image_file. |
Yes |
typ Enum: MessageDeltaContentImageFileObjectType
| Value | Description |
|---|---|
| image_file |
messageDeltaContentTextObject
Textinnehållet som är en del av ett meddelande.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| index | integer | Innehållsindexet i meddelandet. | Yes | |
| text | object | No | ||
| └─ annotations | array | No | ||
| └─ value | string | Datan som utgör texten. | No | |
| type | string | Alltid text. |
Yes |
typ Enum: MessageDeltaContentTextObjectType
| Value | Description |
|---|---|
| text |
messageDeltaContentTextAnnotationsFileCitationObject
En källa i meddelandet som pekar på ett specifikt citat från en specifik fil kopplad till assistenten eller meddelandet. Genereras när assistenten använder verktyget "file_search" för att söka i filer.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| end_index | integer | No | ||
| file_citation | object | No | ||
| └─ file_id | string | ID:t för den specifika fil som citationen kommer ifrån. | No | |
| └─ quote | string | Det specifika citatet i filen. | No | |
| index | integer | Indexet för anteckningen i textinnehållsdelen. | Yes | |
| start_index | integer | No | ||
| text | string | Texten i meddelandet som behöver ersättas. | No | |
| type | string | Alltid file_citation. |
Yes |
typ Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType
| Value | Description |
|---|---|
| file_citation |
messageDeltaContentTextAnnotationsFilePathObject
En URL för filen som genereras när assistenten använde code_interpreter verktyget för att skapa en fil.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| end_index | integer | No | ||
| file_path | object | No | ||
| └─ file_id | string | ID:t för filen som genererades. | No | |
| index | integer | Indexet för anteckningen i textinnehållsdelen. | Yes | |
| start_index | integer | No | ||
| text | string | Texten i meddelandet som behöver ersättas. | No | |
| type | string | Alltid file_path. |
Yes |
type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType
| Value | Description |
|---|---|
| file_path |
runStepObject
Representerar ett steg i utförandet av en körning.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| assistant_id | string | ID:t för assistenten som är kopplat till körsteget. | Yes | |
| cancelled_at | integer | Unix-tidsstämpeln (i sekunder) för när körsteget avbröts. | Yes | |
| completed_at | integer | Unix-tidsstämpeln (i sekunder) för när körsteget slutfördes. | Yes | |
| created_at | integer | Unix-tidsstämpeln (i sekunder) för när körsteget skapades. | Yes | |
| expired_at | integer | Unix-tidsstämpeln (i sekunder) för när körsteget löpte ut. Ett steg anses vara utgånget om föräldrakörningen är utgången. | Yes | |
| failed_at | integer | Unix-tidsstämpeln (i sekunder) för när körsteget misslyckades. | Yes | |
| id | string | Identifieraren för körsteget, som kan refereras i API-endpoints. | Yes | |
| last_error | object | Det sista felet kopplat till detta körsteg. Det kommer att bli om null det inte finns några fel. |
Yes | |
| └─ code | string | En av server_error eller rate_limit_exceeded. |
No | |
| └─ message | string | En mänskligt läsbar beskrivning av felet. | No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
Yes | |
| object | string | Objekttypen, som alltid assistant.run.stepär . |
Yes | |
| run_id | string | ID:t för körningen som detta körsteg är en del av. | Yes | |
| status | string | Statusen för körningen, som kan vara antingen in_progress, cancelled, , failed, completedeller expired. |
Yes | |
| step_details | runStepDetailsMessageCreationObject eller runStepDetailsToolCallsObject | Detaljerna kring löpsteget. | Yes | |
| thread_id | string | ID:t för trådarna som kördes. | Yes | |
| type | string | Typen av körsteg, som kan vara antingen message_creation eller tool_calls. |
Yes |
objekt Enum: RunStepObjectType
| Value | Description |
|---|---|
| assistant.run.step | Objekttypen, som alltid är assistant.run.step |
typ Enum: RunStepObjectType
| Value | Description |
|---|---|
| message_creation | Det message_creation löpsteget |
| tool_calls | Det tool_calls löpsteget |
status Enum: RunStepObjectStatus
| Value | Description |
|---|---|
| in_progress | Statusen för in_progress run |
| cancelled | Status för inställd körning |
| failed | Status för inställd körning |
| completed | Status för inställd körning |
| expired | Status för inställd körning |
runStepDeltaObject
Representerar ett körstegsdelta, dvs. alla ändrade fält på ett körsteg under streaming.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| delta | object | Deltat som innehåller fälten som har ändrats under körsteget. | Yes | |
| └─ step_details | runStepDeltaStepDetailsMessageCreationObject eller runStepDeltaStepDetailsToolCallsObject | Detaljerna kring löpsteget. | No | |
| id | string | Identifieraren för körsteget, som kan refereras i API-endpoints. | Yes | |
| object | string | Objekttypen, som alltid thread.run.step.deltaär . |
Yes |
objekt-enum: RunStepDeltaObjectType
| Value | Description |
|---|---|
| thread.run.step.delta |
listRunStepsResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | array | Yes | ||
| first_id | string | Yes | ||
| has_more | boolean | Yes | ||
| last_id | string | Yes | ||
| object | string | Yes |
runStepDetailsMessageCreationObject
Detaljer om meddelandeskapandet per körsteg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| message_creation | object | Yes | ||
| └─ message_id | string | ID:t för meddelandet som skapades av detta körsteg. | No | |
| type | string | Alltid message_creation. |
Yes |
typ Enum: RunStepDetailsMessageCreationObjectType
| Value | Description |
|---|---|
| message_creation |
runStepDeltaStepDetailsMessageCreationObject
Detaljer om meddelandeskapandet per körsteg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| message_creation | object | No | ||
| └─ message_id | string | ID:t för meddelandet som skapades av detta körsteg. | No | |
| type | string | Alltid message_creation. |
Yes |
typ Enum: RunStepDeltaStepDetailsMessageCreationObjectType
| Value | Description |
|---|---|
| message_creation |
runStepDetailsToolCallsObject
Detaljer om verktygssamtalet.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| tool_calls | array | En rad verktygsrop som körsteget var involverat i. Dessa kan kopplas till en av tre typer av verktyg: code_interpreter, retrieval eller function. |
Yes | |
| type | string | Alltid tool_calls. |
Yes |
typ Enum: RunStepDetailsToolCallsObjectType
| Value | Description |
|---|---|
| tool_calls |
runStepDeltaStepDetailsToolCallsObject
Detaljer om verktygssamtalet.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| tool_calls | array | En rad verktygsrop som körsteget var involverat i. Dessa kan kopplas till en av tre typer av verktyg: code_interpreter, file_search eller function. |
No | |
| type | string | Alltid tool_calls. |
Yes |
typ Enum: RunStepDeltaStepDetailsToolCallsObjectType
| Value | Description |
|---|---|
| tool_calls |
runStepDetailsToolCallsCodeObject
Detaljer om kodtolkar-verktygsanropet som körstegen var involverat i.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code_interpreter | object | Code Interpreter-verktygets anropsdefinition. | Yes | |
| └─ input | string | Inmatningen till Code Interpreter-verktygsanropet. | No | |
| └─ outputs | array | Utdata från Code Interpreter-verktygsanropet. Kodtolk kan skriva ut ett eller flera objekt, inklusive text (logs) eller bilder (image). Var och en av dessa representeras av en annan objekttyp. |
No | |
| id | string | ID:t på verktygsanropet. | Yes | |
| type | string | Typen av verktygskall. Detta gäller code_interpreter alltid för den här typen av verktygssamtal. |
Yes |
typ Enum: RunStepDetailsToolCallsCodeObjectType
| Value | Description |
|---|---|
| code_interpreter |
runStepDeltaStepDetailsToolCallsCodeObject
Detaljer om kodtolkar-verktygsanropet som körstegen var involverat i.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code_interpreter | object | Code Interpreter-verktygets anropsdefinition. | No | |
| └─ input | string | Inmatningen till Code Interpreter-verktygsanropet. | No | |
| └─ outputs | array | Utdata från Code Interpreter-verktygsanropet. Kodtolk kan skriva ut ett eller flera objekt, inklusive text (logs) eller bilder (image). Var och en av dessa representeras av en annan objekttyp. |
No | |
| id | string | ID:t på verktygsanropet. | No | |
| index | integer | Indexet för verktygsanropet i verktygsarrayen anropar. | Yes | |
| type | string | Typen av verktygskall. Detta gäller code_interpreter alltid för den här typen av verktygssamtal. |
Yes |
typ Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType
| Value | Description |
|---|---|
| code_interpreter |
runStepDetailsToolCallsCodeOutputLogsObject
Textutdata från Code Interpreter-verktygsanropet som en del av ett körsteg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| logs | string | Textutmatningen från Code Interpreter-verktygsanropet. | Yes | |
| type | string | Alltid logs. |
Yes |
typ Enum: RunStepDetailsToolCallsCodeOutputLogsObjectType
| Value | Description |
|---|---|
| logs |
runStepDeltaStepDetailsToolCallsCodeOutputLogsObject
Textutdata från Code Interpreter-verktygsanropet som en del av ett körsteg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| index | integer | Indexet för utdata i utgångsarrayen. | Yes | |
| logs | string | Textutmatningen från Code Interpreter-verktygsanropet. | No | |
| type | string | Alltid logs. |
Yes |
typ Enum: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType
| Value | Description |
|---|---|
| logs |
runStepDetailsToolCallsCodeOutputImageObject
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| image | object | Yes | ||
| └─ file_id | string | Fil-ID:t för bilden. | No | |
| type | string | Alltid image. |
Yes |
typ Enum: RunStepDetailsToolCallsCodeOutputImageObjectType
| Value | Description |
|---|---|
| image |
runStepDeltaStepDetailsToolCallsCodeOutputImageObject
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| image | object | No | ||
| └─ file_id | string | Fil-ID:t för bilden. | No | |
| index | integer | Indexet för utdata i utgångsarrayen. | Yes | |
| type | string | Alltid image. |
Yes |
typ Enum: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject
| Value | Description |
|---|---|
| image |
runStepDetailsToolCallsFileSearchObject
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_search | object | För tillfället kommer detta alltid att vara ett tomt objekt. | Yes | |
| └─ results | array | Resultaten av filsökningen. | No | |
| id | string | ID:t för verktygsanropsobjektet. | Yes | |
| type | string | Typen av verktygskall. Detta gäller file_search alltid för den här typen av verktygssamtal. |
Yes |
typ Enum: RunStepDetailsToolCallsFileSearchObjectType
| Value | Description |
|---|---|
| file_search |
runStepDetailsToolCallsFileSearchResultObject
En resultatinstans av filsökningen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | array | Innehållet i det resultat som hittades. Innehållet inkluderas endast om det begärs via include-frågeparametern. | No | |
| file_id | string | ID:t på filen där resultatet hittades. | Yes | |
| file_name | string | Namnet på filen där resultatet hittades. | Yes | |
| score | number | Resultatet är resultatet. Alla värden måste vara flyttal mellan 0 och 1. | Yes |
runStepDeltaStepDetailsToolCallsFileSearchObject
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_search | object | För tillfället kommer detta alltid att vara ett tomt objekt. | Yes | |
| id | string | ID:t för verktygsanropsobjektet. | No | |
| index | integer | Indexet för verktygsanropet i verktygsarrayen anropar. | Yes | |
| type | string | Typen av verktygskall. Detta gäller retrieval alltid för den här typen av verktygssamtal. |
Yes |
typ Enum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType
| Value | Description |
|---|---|
| file_search |
runStepDetailsToolCallsFunctionObject
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| function | object | Definitionen av funktionen som kallades. | Yes | |
| └─ arguments | string | Argumenten överfördes till funktionen. | No | |
| └─ name | string | Namnet på funktionen. | No | |
| └─ output | string | Funktionens utdata. Detta gäller null om resultaten ännu inte har lämnats in. |
No | |
| id | string | ID:t för verktygsanropsobjektet. | Yes | |
| type | string | Typen av verktygskall. Detta gäller function alltid för den här typen av verktygssamtal. |
Yes |
typ Enum: RunStepDetailsToolCallsFunctionObjectType
| Value | Description |
|---|---|
| function |
runStepDeltaStepDetailsToolCallsFunctionObject
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| function | object | Definitionen av funktionen som kallades. | No | |
| └─ arguments | string | Argumenten överfördes till funktionen. | No | |
| └─ name | string | Namnet på funktionen. | No | |
| └─ output | string | Funktionens utdata. Detta gäller null om resultaten ännu inte har lämnats in. |
No | |
| id | string | ID:t för verktygsanropsobjektet. | No | |
| index | integer | Indexet för verktygsanropet i verktygsarrayen anropar. | Yes | |
| type | string | Typen av verktygskall. Detta gäller function alltid för den här typen av verktygssamtal. |
Yes |
typ Enum: RunStepDetailsToolCallsFunctionObjectType
| Value | Description |
|---|---|
| function |
vectorStoreExpirationAfter
Utgångspolicyn för en vektorlagring.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| anchor | string | Ankartidsstämpel varefter utgångspolicyn gäller. Stödda ankare: last_active_at. |
Yes | |
| days | integer | Antalet dagar efter ankartiden som vektorlagret går ut. | Yes |
ankar Enum: VectorStoreExpirationAfterAnchor
| Value | Description |
|---|---|
| last_active_at | Ankartidsstämpeln efter vilken utgångspolicyn gäller. |
vectorStoreObject
Ett vektorlager är en samling bearbetade filer som verktyget kan använda file_search .
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | integer | Unix-tidsstämpeln (i sekunder) för när vektorlagringen skapades. | Yes | |
| expires_after | vectorStoreExpirationAfter | Utgångspolicyn för en vektorlagring. | No | |
| expires_at | integer | Unix-tidsstämpeln (i sekunder) för när vektorlagringen går ut. | No | |
| file_counts | object | Yes | ||
| └─ cancelled | integer | Antalet filer som avbokades. | No | |
| └─ completed | integer | Antalet filer som har behandlats framgångsrikt. | No | |
| └─ failed | integer | Antalet filer som inte har behandlats. | No | |
| └─ in_progress | integer | Antalet filer som för närvarande behandlas. | No | |
| └─ total | integer | Det totala antalet filer. | No | |
| id | string | Identifieraren, som kan refereras i API-endpoints. | Yes | |
| last_active_at | integer | Unix-tidsstämpeln (i sekunder) för när vektorlagret senast var aktivt. | Yes | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
Yes | |
| name | string | Namnet på vektorlagret. | Yes | |
| object | enum | Objekttypen, som alltid vector_storeär .Möjliga värden: vector_store |
Yes | |
| status | string | Status för vektorlagringen, som kan vara antingen expired, in_progress, eller completed. En status på completed indikerar att vektorlagringen är redo att användas. |
Yes | |
| usage_bytes | integer | Det totala antalet bytes som används av filerna i vektorlagret. | Yes |
status Enum: VectorStoreObjectStatus
| Value | Description |
|---|---|
| expired | |
| in_progress | |
| completed |
createVectorStoreRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| chunking_strategy | autoChunkingStrategyRequestParam eller staticChunkingStrategyRequestParam | Chunking-strategin används för att chunka filen/filerna. Om det inte är satt, kommer jag att använda strategin auto . Endast tillämplig om file_ids är icke-tom. |
No | |
| expires_after | vectorStoreExpirationAfter | Utgångspolicyn för en vektorlagring. | No | |
| file_ids | array | En lista över fil-ID:n som vektorlagringen bör använda. Användbart för sådana file_search verktyg som kan komma åt filer. |
No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| name | string | Namnet på vektorlagret. | No |
updateVectorStoreRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| expires_after | vectorStoreExpirationAfter | Utgångspolicyn för en vektorlagring. | No | |
| metadata | object | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format. Nycklar kan vara maximalt 64 tecken långa och värden kan vara maximalt 512 tecken långa. |
No | |
| name | string | Namnet på vektorlagret. | No |
listVectorStoresResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | array | Yes | ||
| first_id | string | Yes | ||
| has_more | boolean | Yes | ||
| last_id | string | Yes | ||
| object | string | Yes |
deleteVectorStoreResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deleted | boolean | Yes | ||
| id | string | Yes | ||
| object | string | Yes |
objekt Enum: DeleteVectorStoreResponseObject
| Value | Description |
|---|---|
| vector_store.deleted | Tillståndet för delete-vektorlagre-svarobjektet |
vectorStoreFileObject
En lista över filer kopplade till en vektorlagring.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| chunking_strategy | autoChunkingStrategyRequestParam eller staticChunkingStrategyRequestParam | Chunking-strategin används för att chunka filen/filerna. Om det inte är satt, kommer jag att använda strategin auto . Endast tillämplig om file_ids är icke-tom. |
No | |
| created_at | integer | Unix-tidsstämpeln (i sekunder) för när vektorlagringsfilen skapades. | Yes | |
| id | string | Identifieraren, som kan refereras i API-endpoints. | Yes | |
| last_error | object | Det sista felet som är kopplat till denna vektorlagringsfil. Det kommer att bli om null det inte finns några fel. |
Yes | |
| └─ code | string | En av server_error eller invalid_file eller unsupported_file. |
No | |
| └─ message | string | En mänskligt läsbar beskrivning av felet. | No | |
| object | string | Objekttypen, som alltid vector_store.fileär . |
Yes | |
| status | string | Status för vektorlagringsfilen, som kan vara antingen in_progress, completed, , cancelledeller failed. Status completed indikerar att vektorlagringsfilen är redo att användas. |
Yes | |
| usage_bytes | integer | Den totala vektorlagringsanvändningen i bytes. Observera att detta kan skilja sig från den ursprungliga filstorleken. | Yes | |
| vector_store_id | string | ID:t för vektorlagret som filen är kopplad till. | Yes |
objekt Enum: VectorStoreFileObjectType
| Value | Description |
|---|---|
| vector_store.file |
status Enum: VectorStoreFileObjectStatus
| Value | Description |
|---|---|
| in_progress | |
| completed | |
| cancelled | |
| failed |
otherChunkingStrategyResponseParam
Detta återges när chunking-strategin är okänd. Vanligtvis beror detta på att filen indexerades innan konceptet chunking_strategy introducerades i API:et.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | string | Alltid other. |
Yes |
typ Enum: OtherChunkingStrategyResponseParamType
| Value | Description |
|---|---|
| other |
staticChunkingStrategyResponseParam
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| static | staticChunkingStrategy | Yes | ||
| type | string | Alltid static. |
Yes |
typ Enum: StaticChunkingStrategyResponseParamType
| Value | Description |
|---|---|
| static |
staticChunkingStrategy
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| chunk_overlap_tokens | integer | Antalet tokens som överlappar mellan chunks. Standardvärdet är 400.Observera att överlappningen inte får överstiga hälften av max_chunk_size_tokens. |
Yes | |
| max_chunk_size_tokens | integer | Det maximala antalet tokens i varje chunk. Standardvärdet är 800. Minimivärdet är 100 och maximumvärdet är 4096. |
Yes |
autoChunkingStrategyRequestParam
Standardstrategin. Denna strategi använder för närvarande a max_chunk_size_tokens av 800 och chunk_overlap_tokens av 400.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Alltid auto.Möjliga värden: auto |
Yes |
staticChunkingStrategyRequestParam
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| static | staticChunkingStrategy | Yes | ||
| type | enum | Alltid static.Möjliga värden: static |
Yes |
chunkingStrategyRequestParam
Chunking-strategin används för att chunka filen/filerna. Om det inte är satt, kommer jag att använda strategin auto .
Denna komponent kan vara en av följande:
createVectorStoreFileRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| chunking_strategy | chunkingStrategyRequestParam | Chunking-strategin används för att chunka filen/filerna. Om det inte är satt, kommer jag att använda strategin auto . |
No | |
| file_id | string | Ett fil-ID som vektorlagret bör använda. Användbart för sådana file_search verktyg som kan komma åt filer. |
Yes |
listVectorStoreFilesResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | array | Yes | ||
| first_id | string | Yes | ||
| has_more | boolean | Yes | ||
| last_id | string | Yes | ||
| object | string | Yes |
deleteVectorStoreFileResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| deleted | boolean | Yes | ||
| id | string | Yes | ||
| object | string | Yes |
objekt Enum: DeleteVectorStoreFileResponseObject
| Value | Description |
|---|---|
| vector_store.file.deleted |
vectorStoreFileBatchObject
En bunt filer kopplade till en vektorlagring.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | integer | Unix-tidsstämpeln (i sekunder) för när vektorlagringsfilerna batchskapades. | Yes | |
| file_counts | object | Yes | ||
| └─ cancelled | integer | Antalet filer som avbokades. | No | |
| └─ completed | integer | Antalet filer som har behandlats. | No | |
| └─ failed | integer | Antalet filer som inte har behandlats. | No | |
| └─ in_progress | integer | Antalet filer som för närvarande behandlas. | No | |
| └─ total | integer | Det totala antalet filer. | No | |
| id | string | Identifieraren, som kan refereras i API-endpoints. | Yes | |
| object | string | Objekttypen, som alltid vector_store.file_batchär . |
Yes | |
| status | string | Status för vektorlagringsfilens batch, som kan vara antingen in_progress, completed, cancelled eller failed. |
Yes | |
| vector_store_id | string | ID:t för vektorlagret som filen är kopplad till. | Yes |
objekt Enum: VectorStoreFileBatchObjectType
| Value | Description |
|---|---|
| vector_store.files_batch |
status Enum: VectorStoreFileBatchObjectStatus
| Value | Description |
|---|---|
| in_progress | |
| completed | |
| cancelled | |
| failed |
createVectorStoreFileBatchRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| chunking_strategy | chunkingStrategyRequestParam | Chunking-strategin används för att chunka filen/filerna. Om det inte är satt, kommer jag att använda strategin auto . |
No | |
| file_ids | array | En lista över fil-ID:n som vektorlagret bör använda. Användbart för sådana file_search verktyg som kan komma åt filer. |
Yes |
assistantStreamEvent
Representerar en händelse som sänds ut när en Run streamas.
Varje händelse i en serverskickad händelseström har en event egenskap och data och:
event: thread.created
data: {"id": "thread_123", "object": "thread", ...}
Vi sänder ut händelser varje gång ett nytt objekt skapas, övergår till ett nytt tillstånd eller strömmas i delar (deltas). Till exempel sänder thread.run.created vi när en ny körning skapas, thread.run.completed när en körning slutförs, och så vidare. När en assistent väljer att skapa ett meddelande under en löpning sänder vi ut 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 fler händelser över tid, så vi rekommenderar att okända händelser hanteras smidigt i din kod.
Denna komponent kan vara en av följande:
threadStreamEvent
Denna komponent kan vara en av följande:
thread.created
Uppstår när en ny tråd skapas.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | threadObject | Representerar en tråd som innehåller meddelanden. | Yes | |
| event | string | Yes |
Data: threadObject
Evenemangsenum: ThreadStreamEventEnum
| Value | Description |
|---|---|
| thread.created | Händelsen som skapades av tråden |
runStreamEvent
Denna komponent kan vara en av följande:
thread.run.created
Uppstår när en ny serie skapas.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runObject | Representerar en exekvering som körs på en tråd. | Yes | |
| event | string | Yes |
Data: runObject
Händelseenum: RunStreamEventCreated
| Value | Description |
|---|---|
| thread.run.created |
thread.run.queued
Uppstår när en sekvens går till en queued status.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runObject | Representerar en exekvering som körs på en tråd. | Yes | |
| event | string | Yes |
Data: runObject
Händelseinnehåll: RunStreamEventQueued
| Value | Description |
|---|---|
| thread.run.queued |
thread.run.in_progress
Inträffar när en sekvens går till en in_progress status.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runObject | Representerar en exekvering som körs på en tråd. | Yes | |
| event | string | Yes |
Data: runObject
Evenemangsenum: RunStreamEventInProgress
| Value | Description |
|---|---|
| thread.run.in_progress |
thread.run.requires_action
Uppstår när en sekvens går till en requires_action status.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runObject | Representerar en exekvering som körs på en tråd. | Yes | |
| event | string | Yes |
Data: runObject
Händelseenum: RunStreamEventRequiresAction
| Value | Description |
|---|---|
| thread.run.requires_action |
thread.run.completed
Inträffar när en körning är avslutad.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runObject | Representerar en exekvering som körs på en tråd. | Yes | |
| event | string | Yes |
Data: runObject
Evenemangsenum: RunStreamEventCompleted
| Value | Description |
|---|---|
| thread.run.completed |
thread.run.failed
Uppstår när en körning misslyckas.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runObject | Representerar en exekvering som körs på en tråd. | Yes | |
| event | string | Yes |
Data: runObject
Händelseenum: RunStreamEventFailed
| Value | Description |
|---|---|
| thread.run.failed |
thread.run.cancelling
Uppstår när en sekvens går till en cancelling status.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runObject | Representerar en exekvering som körs på en tråd. | Yes | |
| event | string | Yes |
Data: runObject
Händelseenum: RunStreamEventCancelling
| Value | Description |
|---|---|
| thread.run.cancelling |
thread.run.cancelled
Inträffar när en omgång ställs in.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runObject | Representerar en exekvering som körs på en tråd. | Yes | |
| event | string | Yes |
Data: runObject
Evenemangsöversikt: RunStreamEventCancelled
| Value | Description |
|---|---|
| thread.run.cancelled |
thread.run.expired
Inträffar när en run går ut.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runObject | Representerar en exekvering som körs på en tråd. | Yes | |
| event | string | Yes |
Data: runObject
Evenemangsöversikt: RunStreamEventExpired
| Value | Description |
|---|---|
| thread.run.expired |
runStepStreamEvent
Denna komponent kan vara en av följande:
thread.run.step.created
Uppstår när ett körsteg skapas.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runStepObject | Representerar ett steg i utförandet av en körning. |
Yes | |
| event | string | Yes |
Data: runStepObject
Evenemangsenum: RunStepStreamEventCreated
| Value | Description |
|---|---|
| thread.run.step.created |
thread.run.step.in_progress
Uppstår när ett körsteg går till ett in_progress tillstånd.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runStepObject | Representerar ett steg i utförandet av en körning. |
Yes | |
| event | string | Yes |
Data: runStepObject
Evenemangsenum: RunStepStreamEventInProgress
| Value | Description |
|---|---|
| thread.run.step.in_progress |
thread.run.step.delta
Uppstår när delar av ett körsteg strömmas.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runStepDeltaObject | Representerar ett körstegsdelta, dvs. alla ändrade fält på ett körsteg under streaming. |
Yes | |
| event | string | Yes |
Data: runStepDeltaObject
Evenemangsenum: RunStepStreamEventDelta
| Value | Description |
|---|---|
| thread.run.step.delta |
thread.run.step.completed
Uppstår när ett körsteg är slutfört.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runStepObject | Representerar ett steg i utförandet av en körning. |
Yes | |
| event | string | Yes |
Data: runStepObject
Evenemangsenum: RunStepStreamEventCompletedCompleted
| Value | Description |
|---|---|
| thread.run.step.completed |
thread.run.step.failed
Uppstår när ett körsteg misslyckas.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runStepObject | Representerar ett steg i utförandet av en körning. |
Yes | |
| event | string | Yes |
Data: runStepObject
Händelseenum: RunStepStreamEventFailed
| Value | Description |
|---|---|
| thread.run.step.failed |
thread.run.step.cancelled
Inträffar när ett körsteg avbryts.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runStepObject | Representerar ett steg i utförandet av en körning. |
Yes | |
| event | string | Yes |
Data: runStepObject
Evenemangsenum: RunStepStreamEventCancelled
| Value | Description |
|---|---|
| thread.run.step.cancelled |
thread.run.step.expired
Inträffar när ett körsteg går ut.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | runStepObject | Representerar ett steg i utförandet av en körning. |
Yes | |
| event | string | Yes |
Data: runStepObject
Evenemangsenum: RunStepStreamEventExpired
| Value | Description |
|---|---|
| thread.run.step.expired |
messageStreamEvent
Denna komponent kan vara en av följande:
thread.message.created
Uppstår när ett meddelande skapas.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | messageObject | Representerar ett meddelande inom en tråd. | Yes | |
| event | string | Yes |
Data: messageObject
Händelseenum: MessageStreamEventCreated
| Value | Description |
|---|---|
| thread.message.created |
thread.message.in_progress
Uppstår när ett meddelande flyttas till ett in_progress tillstånd.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | messageObject | Representerar ett meddelande inom en tråd. | Yes | |
| event | string | Yes |
Data: messageObject
Händelseum: MessageStreamEventInProgress
| Value | Description |
|---|---|
| thread.message.in_progress |
thread.message.delta
Uppstår när delar av ett meddelande strömmas.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | messageDeltaObject | Representerar ett meddelandedelta, dvs. alla ändrade fält i ett meddelande under streaming. |
Yes | |
| event | string | Yes |
Data: messageDeltaObject
Händelseenum: MessageStreamEventDelta
| Value | Description |
|---|---|
| thread.message.delta |
thread.message.completed
Inträffar när ett meddelande är slutfört.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | messageObject | Representerar ett meddelande inom en tråd. | Yes | |
| event | string | Yes |
Data: messageObject
Händelseenum: MessageStreamEventCompleted
| Value | Description |
|---|---|
| thread.message.completed |
thread.message.incomplete
Uppstår när ett meddelande avslutas innan det är klart.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | messageObject | Representerar ett meddelande inom en tråd. | Yes | |
| event | string | Yes |
Data: messageObject
Händelseenum: MessageStreamEventIncomplete
| Value | Description |
|---|---|
| thread.message.incomplete |
Annotation
Denna komponent kan vara en av följande:
Click
En klickåtgärd.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| button | enum | Indikerar vilken musknapp som trycktes under klicket. En av , , , , back, eller forward. wheelrightleftMöjliga värden: left, right, wheel, back, forward |
Yes | |
| type | enum | Specificerar händelsetypen. För en klickåtgärd är denna egenskap alltid satt till click.Möjliga värden: click |
Yes | |
| x | integer | X-koordinaten där klicket skedde. |
Yes | |
| y | integer | Y-koordinaten där klicket inträffade. |
Yes |
CodeInterpreterFileOutput
Utdatan från ett kodtolkarverktyg som anropas är en fil.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| files | array | Yes | ||
| type | enum | Typen av kodtolkarfilens utdata. Alltid files.Möjliga värden: files |
Yes |
CodeInterpreterTextOutput
Utdata från ett kodtolkarverktyg som är text.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| logs | string | Loggarna för kodtolkarverktyget anropar. |
Yes | |
| type | enum | Typen av kodtolkarens textutmatning. Alltid logs.Möjliga värden: logs |
Yes |
CodeInterpreterTool
Ett verktyg som kör kod.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_ids | array | ID:n för filerna som ska köras på. |
Yes | |
| type | enum | Typen av kodtolkarverktyg. Alltid code_interpreter.Möjliga värden: code_interpreter |
Yes |
CodeInterpreterToolCall
Ett verktygsanrop för att köra kod.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string | Koden för att köra. |
Yes | |
| id | string | Det unika ID:t för kodtolkarverktygsanropet. |
Yes | |
| results | array | Resultatet av kodtolkarverktygsanropet. |
Yes | |
| status | enum | Status för kodtolkarens verktygsanrop. Möjliga värden: in_progress, interpreting, completed |
Yes | |
| type | enum | Typen av kodtolkarverktygsanrop. Alltid code_interpreter_call.Möjliga värden: code_interpreter_call |
Yes |
CodeInterpreterToolOutput
Denna komponent kan vara en av följande:
ComparisonFilter
Ett filter som används för att jämföra en specificerad attributnyckel med ett givet värde med hjälp av en definierad jämförelseoperation.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| key | string | Nyckeln är att jämföra med värdet. | Yes | |
| type | enum | Specificerar jämförelseoperatorn: eq, ne, , gt, gte, lt, . lte- eq: är lika med- ne: inte lika- gt: större än- gte: större än eller lika- lt: mindre än- lte: mindre än eller likaMöjliga värden: eq, ne, gt, gte, lt, lte |
Yes | |
| value | sträng eller tal eller boolesk | Värdet att jämföra med attributnyckeln; stöder sträng-, tal- eller booleska typer. | Yes |
CompoundFilter
Kombinera flera filter med eller andor.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| filters | array | Ett array av filter att kombinera. Föremål kan vara ComparisonFilter eller CompoundFilter. |
Yes | |
| type | enum | Typ av operation: and eller or.Möjliga värden: and, or |
Yes |
ComputerAction
Denna komponent kan vara en av följande:
ComputerScreenshotImage
En datorskärmdump som används med datorverktyget.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_id | string | Identifieraren för en uppladdad fil som innehåller skärmdumpen. | No | |
| image_url | string | URL:en till skärmdumpsbilden. | No | |
| type | enum | Specificerar händelsetypen. För en datorskärmdump är denna egenskap alltid inställd på computer_screenshot.Möjliga värden: computer_screenshot |
Yes |
ComputerTool
Ett verktyg som styr en virtuell dator.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| display_height | number | Höjden på datorskärmen. |
Yes | |
| display_width | number | Bredden på datorskärmen. |
Yes | |
| environment | enum | Vilken typ av datormiljö som ska kontrolleras. Möjliga värden: mac, windows, ubuntu, browser |
Yes | |
| type | enum | Typen av datoranvändningsverktyg. Alltid computer_use_preview.Möjliga värden: computer-use-preview |
Yes |
ComputerToolCall
Ett verktygsanrop till ett datorverktyg.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | ComputerAction | Yes | ||
| call_id | string | En identifierare som används när man svarar på verktygsanropet med utdata. |
Yes | |
| id | string | Det unika ID:t för datorsamtalet. | Yes | |
| pending_safety_checks | array | De pågående säkerhetskontrollerna för datorsamtalet. |
Yes | |
| status | enum | Statusen på föremålet. En av in_progress, completed, eller incomplete. Fylls när objekt returneras via API.Möjliga värden: in_progress, completed, incomplete |
Yes | |
| type | enum | Typen av datorsamtal. Alltid computer_call.Möjliga värden: computer_call |
Yes |
ComputerToolCallOutput
Resultatet av ett datorverktygssamtal.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| acknowledged_safety_checks | array | De säkerhetskontroller som rapporteras av API:et har bekräftats av utvecklaren. |
No | |
| call_id | string | ID:t för det datorverktygsanrop som producerade utdatan. |
Yes | |
| id | string | ID:t för datorverktygets anrop output. |
No | |
| output | ComputerScreenshotImage | En datorskärmdump som används med datorverktyget. |
Yes | |
| status | enum | Status för meddelandeinmatningen. En av in_progress, completed, eller incomplete. Fylls i när inmatningsobjekt returneras via API.Möjliga värden: in_progress, completed, incomplete |
No | |
| type | enum | Typen av datorverktyg anropar utdata. Alltid computer_call_output.Möjliga värden: computer_call_output |
Yes |
ComputerToolCallOutputResource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| acknowledged_safety_checks | array | De säkerhetskontroller som rapporteras av API:et har bekräftats av utvecklaren. |
No | |
| call_id | string | ID:t för det datorverktygsanrop som producerade utdatan. |
Yes | |
| id | string | Det unika ID:t för datorns anropsverktygsutdata. |
Yes | |
| output | ComputerScreenshotImage | En datorskärmdump som används med datorverktyget. |
Yes | |
| status | enum | Status för meddelandeinmatningen. En av in_progress, completed, eller incomplete. Fylls i när inmatningsobjekt returneras via API.Möjliga värden: in_progress, completed, incomplete |
No | |
| type | enum | Typen av datorverktyg anropar utdata. Alltid computer_call_output.Möjliga värden: computer_call_output |
Yes |
ComputerToolCallSafetyCheck
En pågående säkerhetskontroll inför datorsamtalet.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string | Typen av den pågående säkerhetskontrollen. | Yes | |
| id | string | ID:t för den pågående säkerhetskontrollen. | Yes | |
| message | string | Detaljer om den pågående säkerhetskontrollen. | Yes |
Content
Multimodalt in- och utmatningsinnehåll.
Denna komponent kan vara en av följande:
Coordinate
Ett x/y-koordinatpar, t.ex. { x: 100, y: 200 }.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| x | integer | The x-coordinate. |
Yes | |
| y | integer | The y-coordinate. |
Yes |
CreateModelResponseProperties
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| metadata | Metadata | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och för att söka objekt via API eller instrumentpanelen. Tangenter är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken. |
No | |
| model | string | Modellen som används för att generera svaren. | No | |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar generellt att ändra detta eller top_p båda. |
No | 1 |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperature båda. |
No | 1 |
| user | string | En unik identifierare som representerar din slutanvändare, vilket kan hjälpa OpenAI att övervaka och upptäcka missbruk. . |
No |
createResponse
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| include | array | {"$ref": "#/components/schemas/includable/description"} | No | |
| input | Sträng eller array | Text-, bild- eller filindata till modellen, som används för att generera ett svar. | Yes | |
| instructions | string | Infogar ett system- (eller utvecklar-) meddelande som första objekt i modellens kontext. När man använder tillsammans med previous_response_id, kommer instruktionerna från ett tidigare svar inte att föras över till nästa svar. Detta gör det enkelt att byta ut system- (eller utvecklar-) meddelanden i nya svar. |
No | |
| max_output_tokens | integer | En övre gräns för antalet tokens som kan genereras för ett svar, inklusive synliga utdatatoken och resonemangstokens. |
No | |
| parallel_tool_calls | boolean | Om modellen ska köras parallellt. |
No | True |
| previous_response_id | string | Det unika ID:t för det tidigare svaret på modellen. Använd detta för att skapa konversationer med flera turer. | No | |
| reasoning | Reasoning | Konfigurationsalternativ för resonemangsmodeller. | No | |
| store | boolean | Om det genererade modellsvaret ska lagras för senare hämtning via API. |
No | True |
| stream | boolean | Om den sätts till true strömmas modellens svarsdata till klienten när den genereras med hjälp av serverskickade händelser. | No | False |
| text | object | Konfigurationsalternativ för ett textsvar från modellen. Det kan vara ren text eller strukturerad JSON-data. Learn more: - textinmatningar och utdata - Strukturerade utdata |
No | |
| └─ format | TextResponseFormatConfiguration | Ett objekt som specificerar formatet som modellen måste ge utmatning. Konfiguration { "type": "json_schema" } aktiverar strukturerade utdata, vilket säkerställer att modellen matchar ditt tillhandahållna JSON-schema. Standardformatet är { "type": "text" } utan några extra alternativ.Rekommenderas inte för GPT-4o och nyare modeller: Att sätta på { "type": "json_object" } aktiverar det äldre JSON-läget, vilket säkerställer att meddelandet modellen genererar är giltigt JSON. Att använda är att föredra json_schema för modeller som stödjer det. |
No | |
| tool_choice | VerktygvalVal eller VerktygValTyper eller VerktygValFunktion | Hur modellen ska välja vilket verktyg (eller vilka verktyg) som ska användas när de genererar ett svar. Se parametern tools för att se hur man specificerar vilka verktyg modellen kan anropa. |
No | |
| tools | array | En uppsättning verktyg som modellen kan anropa samtidigt som den genererar ett svar. Du kan ange vilket verktyg du ska använda genom att ställa in parametern tool_choice .De två kategorierna av verktyg du kan tillhandahålla modellen är: - Inbyggda verktyg |
No | |
| truncation | enum | Strategin för trunkering att använda för modellens svar. - auto: Om kontexten för detta svar och tidigare överstiger modellens kontextfönsterstorlek, kommer modellen att trunkera svara för att passa kontextfönstret genom att lägga in inmatningspunkter mitt i konversationen. - disabled (standard): Om ett modellsvar överstiger kontextfönstret för en modell, kommer förfrågan att misslyckas med ett felmeddelande på 400.Möjliga värden: auto, disabled |
No |
DoubleClick
En dubbelklicksåtgärd.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Specificerar händelsetypen. För en dubbelklicksåtgärd är denna egenskap alltid satt till double_click.Möjliga värden: double_click |
Yes | |
| x | integer | X-koordinaten där dubbelklicket ägde rum. |
Yes | |
| y | integer | Y-koordinaten där dubbelklicket skedde. |
Yes |
Drag
En drag-action.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| path | array | En array av koordinater som representerar dragaktionens bana. Koordinater kommer att visas som en array av objekt, t.ex.[{ x: 100, y: 200 }, { x: 200, y: 300 }] |
Yes | |
| type | enum | Specificerar händelsetypen. För en dragaktion är denna egenskap alltid satt till drag.Möjliga värden: drag |
Yes |
EasyInputMessage
Ett meddelande som matas in i modellen med en roll som anger instruktion som följer hierarkin. Instruktioner som ges med developer rollen system har företräde framför instruktioner som ges med user rollen. Meddelanden med rollen assistant antas ha genererats av modellen i tidigare interaktioner.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | sträng eller InputMessageContentList | Text, bild eller ljudinmatning till modellen, som används för att generera ett svar. Kan också innehålla tidigare assistentsvar. |
Yes | |
| role | enum | Meddelandets roll. En av user, assistant, , systemeller developer.Möjliga värden: user, assistant, system, developer |
Yes | |
| type | enum | Typen av meddelandeinmatning. Alltid message.Möjliga värden: message |
No |
FileCitation
En hänvisning till en fil.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_id | string | ID:t på filen. |
Yes | |
| index | integer | Indexet för filen i listan över filer. |
Yes | |
| type | enum | Typen av filens källhänvisning. Alltid file_citation.Möjliga värden: file_citation |
Yes |
FilePath
En väg till en fil.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_id | string | ID:t på filen. |
Yes | |
| index | integer | Indexet för filen i listan över filer. |
Yes | |
| type | enum | Typen av filväg. Alltid file_path.Möjliga värden: file_path |
Yes |
FileSearchRanker
Rankern att använda för filsökningen. Om det inte specificeras kommer jag att använda auto rankern.
| Property | Value |
|---|---|
| Description | Rankern att använda för filsökningen. Om det inte specificeras kommer jag att använda auto rankern. |
| Type | string |
| Values | autodefault_2024_08_21 |
FileSearchTool
Ett verktyg som söker efter relevant innehåll från uppladdade filer.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| filters | ComparisonFilter eller CompoundFilter | Ett filter att applicera baserat på filattribut. | No | |
| max_num_results | integer | Det maximala antalet resultat att returnera. Detta antal bör ligga mellan 1 och 50 inklusive. |
No | |
| ranking_options | object | Rankningsalternativ för sökning. | No | |
| └─ ranker | enum | Rankern att använda för filsökningen. Möjliga värden: auto, default-2024-11-15 |
No | |
| └─ score_threshold | number | Poängtröskeln för filsökningen, ett tal mellan 0 och 1. Nummer närmare 1 försöker bara returnera de mest relevanta resultaten, men kan ge färre resultat. |
No | 0 |
| type | enum | Typen av filsökarverktyg. Alltid file_search.Möjliga värden: file_search |
Yes | |
| vector_store_ids | array | ID:n för vektorerna lagrar att söka i. |
Yes |
FileSearchToolCall
Resultatet av ett filsökverktyg anropar.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | Det unika ID:t för filsöksverktyget anrop. |
Yes | |
| queries | array | Frågorna som används för att söka efter filer. |
Yes | |
| results | array | Resultaten från filsökningsverktyget anropar. |
No | |
| status | enum | Status för filsökningsverktygets anrop. En av in_progress, searching, incomplete eller failed,Möjliga värden: in_progress, searching, completed, incomplete, failed |
Yes | |
| type | enum | Typen av filsökverktygsanrop. Alltid file_search_call.Möjliga värden: file_search_call |
Yes |
FunctionTool
Definierar en funktion i din egen kod som modellen kan välja att anropa.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | En beskrivning av funktionen. Används av modellen för att avgöra om funktionen ska anropas eller inte. |
No | |
| name | string | Namnet på funktionen att anropa. |
Yes | |
| parameters | object | Ett JSON-schemaobjekt som beskriver parametrarna för funktionen. |
Yes | |
| strict | boolean | Om man ska upprätthålla strikt parametervalidering. Standard true. |
Yes | |
| type | enum | Typen av funktionsverktyg. Alltid function.Möjliga värden: function |
Yes |
FunctionToolCall
Ett verktygsanrop för att köra en funktion.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| arguments | string | En JSON-sträng av argumenten som ska skickas till funktionen. |
Yes | |
| call_id | string | Det unika ID:t för funktionsverktygsanropet som genereras av modellen. |
Yes | |
| id | string | Det unika ID:t för funktionsverktygsanropet. |
Yes | |
| name | string | Namnet på funktionen som ska köras. |
Yes | |
| status | enum | Statusen på föremålet. En av in_progress, completed, eller incomplete. Fylls när objekt returneras via API.Möjliga värden: in_progress, completed, incomplete |
No | |
| type | enum | Typen av funktionsverktygsanrop. Alltid function_call.Möjliga värden: function_call |
Yes |
FunctionToolCallOutput
Resultatet av ett funktionsverktygsanrop.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | Det unika ID:t för funktionsverktygsanropet som genereras av modellen. |
Yes | |
| id | string | Det unika ID:t för funktionsverktygets anropsutdata. Fylls när detta objekt returneras via API. |
No | |
| output | string | En JSON-sträng av utdata från funktionsverktygsanropet. |
Yes | |
| status | enum | Statusen på föremålet. En av in_progress, completed, eller incomplete. Fylls när objekt returneras via API.Möjliga värden: in_progress, completed, incomplete |
No | |
| type | enum | Typen av funktionsverktyget anropar utdata. Alltid function_call_output.Möjliga värden: function_call_output |
Yes |
FunctionToolCallOutputResource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| call_id | string | Det unika ID:t för funktionsverktygsanropet som genereras av modellen. |
Yes | |
| id | string | Det unika ID:t för funktionsanropsverktyget utdata. |
Yes | |
| output | string | En JSON-sträng av utdata från funktionsverktygsanropet. |
Yes | |
| status | enum | Statusen på föremålet. En av in_progress, completed, eller incomplete. Fylls när objekt returneras via API.Möjliga värden: in_progress, completed, incomplete |
No | |
| type | enum | Typen av funktionsverktyget anropar utdata. Alltid function_call_output.Möjliga värden: function_call_output |
Yes |
includable
Specificera ytterligare utdata att inkludera i modellens svar. För närvarande stödda värden är:
-
file_search_call.results: Inkludera sökresultaten från filsökningsverktygsanropet. -
message.input_image.image_url: Inkludera bild-URL:er från inmatningsmeddelandet. -
computer_call_output.output.image_url: Inkludera bild-URL:er från datorns samtalsutdata.
| Property | Value |
|---|---|
| Description | Specificera ytterligare utdata att inkludera i modellens svar. För närvarande stödda värden är: - file_search_call.results: Inkludera sökresultaten från filsökningsverktygsanropet.- message.input_image.image_url: Inkludera bild-URL:er från inmatningsmeddelandet.- computer_call_output.output.image_url: Inkludera bild-URL:er från datorns samtalsutdata. |
| Type | string |
| Values | file_search_call.resultsmessage.input_image.image_urlcomputer_call_output.output.image_url |
InputAudio
En ljudingång till modellen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | string | Base64-kodad ljuddata. |
Yes | |
| format | enum | Formatet på ljuddatan. För närvarande stödda format är mp3 och wav.Möjliga värden: mp3, wav |
Yes | |
| type | enum | Typen av inmatningsobjektet. Alltid input_audio.Möjliga värden: input_audio |
Yes |
InputContent
Denna komponent kan vara en av följande:
InputFile
En filinmatning till modellen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| file_data | string | Innehållet i filen som ska skickas till modellen. |
No | |
| file_id | string | ID:t för filen som ska skickas till modellen. |
No | |
| filename | string | Namnet på filen som ska skickas till modellen. |
No | |
| type | enum | Typen av inmatningsobjektet. Alltid input_file.Möjliga värden: input_file |
Yes |
InputImage
En bildinmatning till modellen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| detail | enum | Detaljnivån på bilden som ska skickas till modellen. En av high, low, eller auto. Går som standard till auto.Möjliga värden: high, low, auto |
Yes | |
| file_id | string | ID:t för filen som ska skickas till modellen. |
No | |
| image_url | string | URL:en till bilden som ska skickas till modellen. En fullt kvalificerad URL eller base64-kodad bild i en data-URL. |
No | |
| type | enum | Typen av inmatningsobjektet. Alltid input_image.Möjliga värden: input_image |
Yes |
InputItem
Denna komponent kan vara en av följande:
InputMessage
Ett meddelande som matas in i modellen med en roll som anger instruktion som följer hierarkin. Instruktioner som ges med developer rollen system har företräde framför instruktioner som ges med user rollen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | InputMessageContentList | En lista med en eller flera indata till modellen, innehållande olika innehåll types. |
Yes | |
| role | enum | Meddelandets roll. En av user, system, eller developer.Möjliga värden: user, system, developer |
Yes | |
| status | enum | Status på varan. En av in_progress, completed, eller incomplete. Fylls när objekt returneras via API.Möjliga värden: in_progress, completed, incomplete |
No | |
| type | enum | Typen av meddelandeinmatning. Alltid inställd på message.Möjliga värden: message |
No |
InputMessageContentList
En lista med en eller flera indata till modellen, som innehåller olika innehållstyper.
Inga egenskaper definierade för denna komponent.
InputMessageResource
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | InputMessageContentList | En lista med en eller flera indata till modellen, innehållande olika innehåll types. |
Yes | |
| id | string | Det unika ID:t för meddelandeinmatningen. |
Yes | |
| role | enum | Meddelandets roll. En av user, system, eller developer.Möjliga värden: user, system, developer |
Yes | |
| status | enum | Status på varan. En av in_progress, completed, eller incomplete. Fylls när objekt returneras via API.Möjliga värden: in_progress, completed, incomplete |
No | |
| type | enum | Typen av meddelandeinmatning. Alltid inställd på message.Möjliga värden: message |
No |
InputText
En textinmatning till modellen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | Textinmatningen till modellen. |
Yes | |
| type | enum | Typen av inmatningsobjektet. Alltid input_text.Möjliga värden: input_text |
Yes |
Item
Innehållselement som används för att generera ett svar.
Denna komponent kan vara en av följande:
- InputMessage
- OutputMessage
- FileSearchToolCall
- ComputerToolCall
- ComputerToolCallOutput
- FunctionToolCall
- FunctionToolCallOutput
- ReasoningItem
ItemReference
En intern identifierare för ett objekt att referera till.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| id | string | Föremålets ID att referera till. |
Yes | |
| type | enum | Vilken typ av objekt man ska referera till. Alltid item_reference.Möjliga värden: item_reference |
Yes |
ItemResource
Innehållselement som används för att generera ett svar.
Denna komponent kan vara en av följande:
- InputMessageResource
- OutputMessage
- FileSearchToolCall
- ComputerToolCall
- ComputerToolCallOutputResource
- FunctionToolCall
- FunctionToolCallOutputResource
KeyPress
En samling tangenttryckningar som modellen vill utföra.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| keys | array | Kombinationen av tangenter som modellen begär att ska tryckas på. Detta är en array av strängar, där varje sträng representerar en nyckel. |
Yes | |
| type | enum | Specificerar händelsetypen. För en tangenttrycksåtgärd sätts denna egenskap alltid till keypress.Möjliga värden: keypress |
Yes |
Metadata
Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och för att söka objekt via API eller instrumentpanelen.
Tangenter är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken.
Inga egenskaper definierade för denna komponent.
ModelResponseProperties
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| metadata | Metadata | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och för att söka objekt via API eller instrumentpanelen. Tangenter är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken. |
No | |
| model | string | Modellen som används för att generera svaren. | No | |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar generellt att ändra detta eller top_p båda. |
No | 1 |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperature båda. |
No | 1 |
| user | string | En unik identifierare som representerar din slutanvändare, vilket kan hjälpa OpenAI att övervaka och upptäcka missbruk. . |
No |
Move
En musrörelse.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Specificerar händelsetypen. För en flyttåtgärd sätts denna egenskap alltid till move.Möjliga värden: move |
Yes | |
| x | integer | X-koordinaten att gå till. |
Yes | |
| y | integer | Y-koordinaten att gå till. |
Yes |
OutputAudio
En ljudutgång från modellen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | string | Base64-kodad ljuddata från modellen. |
Yes | |
| transcript | string | Utskriften av ljuddata från modellen. |
Yes | |
| type | enum | Typen av utgångsljud. Alltid output_audio.Möjliga värden: output_audio |
Yes |
OutputContent
Denna komponent kan vara en av följande:
OutputItem
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| action | ComputerAction | Yes | ||
| arguments | string | En JSON-sträng av argumenten som ska skickas till funktionen. |
Yes | |
| call_id | string | En identifierare som används när man svarar på verktygsanropet med utdata. |
Yes | |
| content | array | Resonerande textinnehåll. |
Yes | |
| id | string | Den unika identifieraren av resonemanginnehållet. |
Yes | |
| name | string | Namnet på funktionen som ska köras. |
Yes | |
| pending_safety_checks | array | De pågående säkerhetskontrollerna för datorsamtalet. |
Yes | |
| queries | array | Frågorna som används för att söka efter filer. |
Yes | |
| results | array | Resultaten från filsökningsverktyget anropar. |
No | |
| role | enum | Utgångsmeddelandets roll. Alltid assistant.Möjliga värden: assistant |
Yes | |
| status | enum | Statusen på föremålet. En av in_progress, completed, eller incomplete. Fylls när objekt returneras via API.Möjliga värden: in_progress, completed, incomplete |
Yes | |
| type | enum | Typen av föremål. Alltid reasoning.Möjliga värden: reasoning |
Yes |
OutputMessage
Ett utdatameddelande från modellen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | array | Innehållet i utdatameddelandet. |
Yes | |
| id | string | Det unika ID:t för utdatameddelandet. |
Yes | |
| role | enum | Utgångsmeddelandets roll. Alltid assistant.Möjliga värden: assistant |
Yes | |
| status | enum | Status för meddelandeinmatningen. En av in_progress, completed, eller incomplete. Fylls i när inmatningsobjekt returneras via API.Möjliga värden: in_progress, completed, incomplete |
Yes | |
| type | enum | Typen av utdatameddelandet. Alltid message.Möjliga värden: message |
Yes |
OutputText
En textutdata från modellen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| annotations | array | Annotationerna av textutmatningen. |
Yes | |
| text | string | Textutmatningen från modellen. |
Yes | |
| type | enum | Typen av utmatningstexten. Alltid output_text.Möjliga värden: output_text |
Yes |
RealtimeSessionCreateRequest
Konfiguration av sessionsobjekt i realtid.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input_audio_format | enum | Formatet för inmatningsljud. Alternativen är pcm16, g711_ulaw, eller g711_alaw.För pcm16, måste indataljudet vara 16-bitars PCM med en samplingsfrekvens på 24 kHz, enkelkanalig (mono) och little-endian byte-ordning.Möjliga värden: pcm16, g711_ulaw, g711_alaw |
No | |
| input_audio_noise_reduction | object | Konfiguration för inmatningsljudbrusreducering. Den kan ställas in på null att stänga av.Brusreducering filtrerar ljud som läggs till i ingångsljudbufferten innan det skickas till VAD och modellen. Filtrering av ljudet kan förbättra noggrannheten för VAD och vändningsdetektering (minska falska positiva) samt modellera prestandan genom att förbättra uppfattningen av inmatningsljudet. |
No | |
| └─ type | enum | Typ av brusreducering.
near_field är för närtalande mikrofoner som hörlurar, far_field är för fjärrfältsmikrofoner såsom laptop- eller konferensrumsmikrofoner.Möjliga värden: near_field, far_field |
No | |
| input_audio_transcription | object | Konfigurationen för ingångsljudtranskribering är som standard avstängd och kan ställas in för null att stängas av när den är på. Inmatad ljudtranskribering är inte inbyggd i modellen, eftersom modellen konsumerar ljud direkt. Transkribering körs asynkront genom Transkriberingsändpunkten och bör behandlas som vägledning av inmatat ljudinnehåll snarare än exakt vad modellen hörde. Klienten kan valfritt ställa in språk och prompt för transkribering, dessa ger ytterligare vägledning till transkriberingstjänsten. |
No | |
| └─ language | string | Språket för inmatningsljudet. Att tillhandahålla inmatningsspråket i ISO-639-1 (t.ex. en) format förbättrar noggrannhet och latens. |
No | |
| └─ model | string | Modellen som används för transkription, nuvarande alternativ är gpt-4o-transcribe, gpt-4o-mini-transcribe, , gpt-4o-mini-transcribe-2025-12-15och whisper-1. |
No | |
| └─ prompt | string | En valfri text för att styra modellens stil eller fortsätta ett tidigare ljudsegment. För whisper-1, är prompten en lista med nyckelord.För gpt-4o-transcribe modeller är prompten en fri textsträng, till exempel "förvänta dig ord relaterade till teknik". |
No | |
| instructions | string | Standardinstruktionerna för systemet (dvs. systemmeddelandet) föregick modelleringsanrop. Detta fält gör det möjligt för klienten att styra modellen på önskade svar. Modellen kan instrueras om svarsinnehåll och format (t.ex. "var extremt kortfattad", "agera vänlig", "här är exempel på bra svar") och om ljudbeteende (t.ex. "prata snabbt", "injicera känsla i din röst", "skratta ofta"). Instruktionerna är inte garanterade att följa av modellen, men de ger vägledning till modellen om önskat beteende. Observera att servern sätter standardinstruktioner som kommer att användas om detta fält inte är inställt och är synliga i händelsen session.created i början av sessionen. |
No | |
| max_response_output_tokens | Heltal eller sträng | Maximalt antal utmatningstoken för ett enda assistentsvar, inklusive verktygsanrop. Ange ett heltal mellan 1 och 4096 för att begränsa utmatningstoken, eller inf för det maximalt tillgängliga tokens för en given modell. Går som standard till inf. |
No | |
| modalities | Den mängd modaliteter som modellen kan svara med. För att inaktivera ljudet, ställ in detta på ["text"]. |
No | ||
| model | string | Namnet på den utplacering som användes för denna session. |
No | |
| output_audio_format | enum | Formatet för utgående ljud. Alternativen är pcm16, g711_ulaw, eller g711_alaw.För pcm16, samplas utgångsljudet med en hastighet av 24 kHz.Möjliga värden: pcm16, g711_ulaw, g711_alaw |
No | |
| temperature | number | Provtagningstemperatur för modellen, begränsad till [0,6, 1,2]. För ljudmodeller rekommenderas en temperatur på 0,8 starkt för bästa prestanda. |
No | 0.8 |
| tool_choice | string | Hur modellen väljer verktyg. Alternativen är auto, none, , requiredeller specificera en funktion. |
No | auto |
| tools | array | Verktyg (funktioner) tillgängliga för modellen. | No | |
| turn_detection | object | Konfiguration för turdetektion, antingen server-VAD eller semantisk VAD. Detta kan ställas in på null att stängas av, i vilket fall klienten manuellt måste trigga modellrespons.Server-VAD innebär att modellen kommer att upptäcka början och slutet av tal baserat på ljudvolym och svara i slutet av användarens tal. Semantisk VAD är mer avancerad och använder en modell för svängdetektering (i kombination med VAD) för att semantiskt uppskatta om användaren har talat klart, och sätter sedan dynamiskt en timeout baserat på denna sannolikhet. Till exempel, om användarljudet tonar ut med uhhm, kommer modellen att ge låg sannolikhet att turen slutar och vänta längre på att användaren ska fortsätta tala. Detta kan vara användbart för mer naturliga samtal, men kan ha högre latens. |
No | |
| └─ create_response | boolean | Om man automatiskt ska generera ett svar när en VAD-stopphändelse inträffar. |
No | True |
| └─ eagerness | enum | Används endast för semantic_vad läge. Modellens iver att svara.
low Väntar längre på att användaren ska fortsätta prata, high svarar snabbare.
auto är standarden och är ekvivalent med medium.Möjliga värden: low, medium, high, auto |
No | |
| └─ interrupt_response | boolean | Om man automatiskt ska avbryta ett pågående svar med utgång till standardkonversationen (dvs. conversation av auto) när en VAD-starthändelse inträffar. |
No | True |
| └─ prefix_padding_ms | integer | Används endast för server_vad läge. Mängden ljud som ska inkluderas innan VAD upptäckte tal (i millisekunder). Standardinställningen är 300 ms. |
No | |
| └─ silence_duration_ms | integer | Används endast för server_vad läge. Tystnadens längd för att upptäcka talstopp (i millisekunder). Standardinställningen är 500 ms. Med kortare värden svarar modellen snabbare, men kan hoppa in vid korta pauser från användaren. |
No | |
| └─ threshold | number | Används endast för server_vad läge. Aktiveringsgränsen för VAD (0,0 till 1,0), detta är standardvärdet 0,5. En högre tröskel kräver högre ljud för att aktivera modellen, och kan därför prestera bättre i bullriga miljöer. |
No | |
| └─ type | enum | Typ av svängdetektion. Möjliga värden: server_vad, semantic_vad |
No | |
| voice | VoiceIdsShared | No |
RealtimeSessionCreateResponse
En ny realtidssessionskonfiguration, med en flyktig nyckel. Standard TTL för tangenter är en minut.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| client_secret | object | Ephemeral nyckel som returneras av API:et. | Yes | |
| └─ expires_at | integer | Tidsstämpel för när tokenen går ut. För närvarande går alla tokens ut efter en minut. |
No | |
| └─ value | string | Ephemeral nyckel som kan användas i klientmiljöer för att autentisera anslutningar till Realtime API:et. Använd detta i klient-sida miljöer istället för en standard API-token, som endast bör användas på serversidan. |
No | |
| input_audio_format | string | Formatet för inmatningsljud. Alternativen är pcm16, g711_ulaw, eller g711_alaw. |
No | |
| input_audio_transcription | object | Konfigurationen för ingångsljudtranskribering är som standard avstängd och kan ställas in för null att stängas av när den är på. Inmatad ljudtranskribering är inte inbyggd i modellen, eftersom modellen konsumerar ljud direkt. Transkription sker asynkront via Whisper och bör behandlas som en grov vägledning snarare än den representation som modellen förstår. |
No | |
| └─ model | string | Modellen som används för transkription whisper-1 är den enda modellen som stöds för tillfället. |
No | |
| instructions | string | Standardinstruktionerna för systemet (dvs. systemmeddelandet) föregick modelleringsanrop. Detta fält gör det möjligt för klienten att styra modellen på önskade svar. Modellen kan instrueras om svarsinnehåll och format (t.ex. "var extremt kortfattad", "ageravänlig", "här är exempel på bra svar") och om ljudbeteende (t.ex. "prata snabbt", "injicera känsla i din röst", "skratta ofta"). Instruktionerna är inte garanterade att följa av modellen, men de ger vägledning till modellen om önskat beteende. Observera att servern sätter standardinstruktioner som kommer att användas om detta fält inte är inställt och är synliga i händelsen session.created i början av sessionen. |
No | |
| max_response_output_tokens | Heltal eller sträng | Maximalt antal utmatningstoken för ett enda assistentsvar, inklusive verktygsanrop. Ange ett heltal mellan 1 och 4096 för att begränsa utmatningstoken, eller inf för det maximalt tillgängliga tokens för en given modell. Går som standard till inf. |
No | |
| modalities | Den mängd modaliteter som modellen kan svara med. För att inaktivera ljudet, ställ in detta på ["text"]. |
No | ||
| output_audio_format | string | Formatet för utgående ljud. Alternativen är pcm16, g711_ulaw, eller g711_alaw. |
No | |
| temperature | number | Provtagningstemperatur för modellen, begränsad till [0,6, 1,2]. Standardinställningen är 0,8. |
No | |
| tool_choice | string | Hur modellen väljer verktyg. Alternativen är auto, none, , requiredeller specificera en funktion. |
No | |
| tools | array | Verktyg (funktioner) tillgängliga för modellen. | No | |
| turn_detection | object | Konfiguration för svängdetektion. Kan ställas in på null att stänga av. Server-VAD innebär att modellen kommer att upptäcka början och slutet av tal baserat på ljudvolym och svara i slutet av användarens tal. |
No | |
| └─ prefix_padding_ms | integer | Mängden ljud som ska inkluderas innan VAD upptäckte tal (i millisekunder). Standardinställningen är 300 ms. |
No | |
| └─ silence_duration_ms | integer | Tystnadens längd för att upptäcka talstopp (i millisekunder). Standardinställningen är 500 ms. Med kortare värden svarar modellen snabbare, men kan hoppa in vid korta pauser från användaren. |
No | |
| └─ threshold | number | Aktiveringsgränsen för VAD (0,0 till 1,0), detta är standardvärdet 0,5. En högre tröskel kräver högre ljud för att aktivera modellen, och kan därför prestera bättre i bullriga miljöer. |
No | |
| └─ type | string | Typ av svängdetektering stöds för server_vad närvarande endast för tillfället. |
No | |
| voice | VoiceIdsShared | No |
RealtimeTranscriptionSessionCreateRequest
Konfiguration av realtidstranskribering av sessionsobjekt.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| include | array | Uppsättningen av objekt som ska ingå i transkriptionen. Nuvarande tillgängliga föremål är: - item.input_audio_transcription.logprobs |
No | |
| input_audio_format | enum | Formatet för inmatningsljud. Alternativen är pcm16, g711_ulaw, eller g711_alaw.För pcm16, måste indataljudet vara 16-bitars PCM med en samplingsfrekvens på 24 kHz, enkelkanalig (mono) och little-endian byte-ordning.Möjliga värden: pcm16, g711_ulaw, g711_alaw |
No | |
| input_audio_noise_reduction | object | Konfiguration för inmatningsljudbrusreducering. Den kan ställas in på null att stänga av.Brusreducering filtrerar ljud som läggs till i ingångsljudbufferten innan det skickas till VAD och modellen. Filtrering av ljudet kan förbättra noggrannheten för VAD och vändningsdetektering (minska falska positiva) samt modellera prestandan genom att förbättra uppfattningen av inmatningsljudet. |
No | |
| └─ type | enum | Typ av brusreducering.
near_field är för närtalande mikrofoner som hörlurar, far_field är för fjärrfältsmikrofoner såsom laptop- eller konferensrumsmikrofoner.Möjliga värden: near_field, far_field |
No | |
| input_audio_transcription | object | Konfiguration för indata-ljudtranskription. Klienten kan valfritt ställa in språk och prompt för transkribering, dessa ger ytterligare vägledning till transkriberingstjänsten. |
No | |
| └─ language | string | Språket för inmatningsljudet. Att tillhandahålla inmatningsspråket i ISO-639-1 (t.ex. en) format förbättrar noggrannhet och latens. |
No | |
| └─ model | enum | Modellen för transkription, nuvarande alternativ är gpt-4o-transcribe, gpt-4o-transcribe-diarize, , gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15och whisper-1.Möjliga värden: gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, whisper-1 |
No | |
| └─ prompt | string | En valfri text för att styra modellens stil eller fortsätta ett tidigare ljudsegment. För whisper-1, är prompten en lista med nyckelord.För gpt-4o-transcribe modeller är prompten en fri textsträng, till exempel "förvänta dig ord relaterade till teknik". |
No | |
| modalities | Den mängd modaliteter som modellen kan svara med. För att inaktivera ljudet, ställ in detta på ["text"]. |
No | ||
| turn_detection | object | Konfiguration för turdetektion, antingen server-VAD eller semantisk VAD. Detta kan ställas in på null att stängas av, i vilket fall klienten manuellt måste trigga modellrespons.Server-VAD innebär att modellen kommer att upptäcka början och slutet av tal baserat på ljudvolym och svara i slutet av användarens tal. Semantisk VAD är mer avancerad och använder en modell för svängdetektering (i kombination med VAD) för att semantiskt uppskatta om användaren har talat klart, och sätter sedan dynamiskt en timeout baserat på denna sannolikhet. Till exempel, om användarljudet tonar ut med uhhm, kommer modellen att ge låg sannolikhet att turen slutar och vänta längre på att användaren ska fortsätta tala. Detta kan vara användbart för mer naturliga samtal, men kan ha högre latens. |
No | |
| └─ create_response | boolean | Om man automatiskt ska generera ett svar när en VAD-stopphändelse inträffar. Inte tillgänglig för transkriptionssessioner. |
No | True |
| └─ eagerness | enum | Används endast för semantic_vad läge. Modellens iver att svara.
low Väntar längre på att användaren ska fortsätta prata, high svarar snabbare.
auto är standarden och är ekvivalent med medium.Möjliga värden: low, medium, high, auto |
No | |
| └─ interrupt_response | boolean | Om man automatiskt ska avbryta ett pågående svar med utgång till standardkonversationen (dvs. conversation av auto) när en VAD-starthändelse inträffar. Inte tillgänglig för transkriptionssessioner. |
No | True |
| └─ prefix_padding_ms | integer | Används endast för server_vad läge. Mängden ljud som ska inkluderas innan VAD upptäckte tal (i millisekunder). Standardinställningen är 300 ms. |
No | |
| └─ silence_duration_ms | integer | Används endast för server_vad läge. Tystnadens längd för att upptäcka talstopp (i millisekunder). Standardinställningen är 500 ms. Med kortare värden svarar modellen snabbare, men kan hoppa in vid korta pauser från användaren. |
No | |
| └─ threshold | number | Används endast för server_vad läge. Aktiveringsgränsen för VAD (0,0 till 1,0), detta är standardvärdet 0,5. En högre tröskel kräver högre ljud för att aktivera modellen, och kan därför prestera bättre i bullriga miljöer. |
No | |
| └─ type | enum | Typ av svängdetektion. Möjliga värden: server_vad, semantic_vad |
No |
RealtimeTranscriptionSessionCreateResponse
En ny konfiguration för realtidstranskriberingssessioner.
När en session skapas på servern via REST API innehåller sessionsobjektet också en tillfällig nyckel. Standard TTL för tangenter är en minut. Denna egenskap finns inte när en session uppdateras via WebSocket API.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| client_secret | object | Ephemeral nyckel som returneras av API:et. Endast närvarande när sessionen skapas på servern via REST API. |
Yes | |
| └─ expires_at | integer | Tidsstämpel för när tokenen går ut. För närvarande går alla tokens ut efter en minut. |
No | |
| └─ value | string | Ephemeral nyckel som kan användas i klientmiljöer för att autentisera anslutningar till Realtime API:et. Använd detta i klient-sida miljöer istället för en standard API-token, som endast bör användas på serversidan. |
No | |
| input_audio_format | string | Formatet för inmatningsljud. Alternativen är pcm16, g711_ulaw, eller g711_alaw. |
No | |
| input_audio_transcription | object | Konfiguration av transkriptionsmodellen. |
No | |
| └─ language | string | Språket för inmatningsljudet. Att tillhandahålla inmatningsspråket i ISO-639-1 (t.ex. en) format förbättrar noggrannhet och latens. |
No | |
| └─ model | enum | Modellen att använda för transkription. Kan vara gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, eller whisper-1.Möjliga värden: gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, whisper-1 |
No | |
| └─ prompt | string | En valfri text för att styra modellens stil eller fortsätta ett tidigare ljudsegment. Prompten ska matcha ljudspråket. |
No | |
| modalities | Den mängd modaliteter som modellen kan svara med. För att inaktivera ljudet, ställ in detta på ["text"]. |
No | ||
| turn_detection | object | Konfiguration för svängdetektion. Kan ställas in på null att stänga av. Server-VAD innebär att modellen kommer att upptäcka början och slutet av tal baserat på ljudvolym och svara i slutet av användarens tal. |
No | |
| └─ prefix_padding_ms | integer | Mängden ljud som ska inkluderas innan VAD upptäckte tal (i millisekunder). Standardinställningen är 300 ms. |
No | |
| └─ silence_duration_ms | integer | Tystnadens längd för att upptäcka talstopp (i millisekunder). Standardinställningen är 500 ms. Med kortare värden svarar modellen snabbare, men kan hoppa in vid korta pauser från användaren. |
No | |
| └─ threshold | number | Aktiveringsgränsen för VAD (0,0 till 1,0), detta är standardvärdet 0,5. En högre tröskel kräver högre ljud för att aktivera modellen, och kan därför prestera bättre i bullriga miljöer. |
No | |
| └─ type | string | Typ av svängdetektering stöds för server_vad närvarande endast för tillfället. |
No |
Reasoning
Konfigurationsalternativ för resonemangsmodeller.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| effort | ReasoningEffort | Begränsar ansträngningen i resonemanget för resonemangsmodeller. För närvarande stödda värden är low, medium, och high. Att minska resonemangsansträngningen kan leda till snabbare svar och färre tokens som används på resonemang i ett svar. |
Yes | medium |
| summary | enum | En sammanfattning av resonemanget som utförs av modellen. Detta kan vara användbart för felsökning och förståelse av modellens resonemangsprocess. En av concise eller detailed.Möjliga värden: concise, detailed |
No |
ReasoningItem
En beskrivning av tankekedjan som används av en resonemangsmodell när den genererar ett svar.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content | array | Resonerande textinnehåll. |
Yes | |
| id | string | Den unika identifieraren av resonemanginnehållet. |
Yes | |
| status | enum | Statusen på föremålet. En av in_progress, completed, eller incomplete. Fylls när objekt returneras via API.Möjliga värden: in_progress, completed, incomplete |
No | |
| type | enum | Typen av föremål. Alltid reasoning.Möjliga värden: reasoning |
Yes |
Refusal
Ett avslag från modellen.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| refusal | string | Förklaringen om vägran från modellen. |
Yes | |
| type | enum | Typen av vägran. Alltid refusal.Möjliga värden: refusal |
Yes |
response
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| created_at | number | Unix-tidsstämpel (i sekunder) för när detta svar skapades. |
Yes | |
| error | ResponseError | Ett felobjekt returnerades när modellen misslyckades med att generera ett svar. |
Yes | |
| id | string | Unik identifierare för detta svar. |
Yes | |
| incomplete_details | object | Detaljer om varför svaret är ofullständigt. |
Yes | |
| └─ reason | enum | Anledningen till att svaret är ofullständigt. Möjliga värden: max_output_tokens, content_filter |
No | |
| instructions | string | Infogar ett system- (eller utvecklar-) meddelande som första objekt i modellens kontext. När man använder tillsammans med previous_response_id, kommer instruktionerna från ett tidigare svar inte att föras över till nästa svar. Detta gör det enkelt att byta ut system- (eller utvecklar-) meddelanden i nya svar. |
Yes | |
| max_output_tokens | integer | En övre gräns för antalet tokens som kan genereras för ett svar, inklusive synliga utdatatoken och konversationstillstånd. |
No | |
| metadata | Metadata | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och för att söka objekt via API eller instrumentpanelen. Tangenter är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken. |
Yes | |
| model | string | Modellen som används för att generera svaren. | Yes | |
| object | enum | Objekttypen för denna resurs – alltid satt till response.Möjliga värden: response |
Yes | |
| output | array | En uppsättning innehållsobjekt genererade av modellen. - Längden och ordningen på objekten i output matrisen beror på modellens respons.- Istället för att komma åt det första objektet i arrayen output och anta att det är ett assistant meddelande med innehållet som genereras av modellen, kan du överväga att använda egenskapen output_text där det stöds i SDK:er. |
Yes | |
| output_text | string | SDK-endast bekvämlighetsegenskap som innehåller den aggregerade textutmatningen från alla output_text objekt i arrayen output , om sådana finns. Stöds i Python- och JavaScript-SDK:erna. |
No | |
| parallel_tool_calls | boolean | Om modellen ska köras parallellt. |
Yes | True |
| previous_response_id | string | Det unika ID:t för det tidigare svaret på modellen. Använd detta för att skapa konversationer med flera turer. | No | |
| reasoning | Reasoning | Konfigurationsalternativ för resonemangsmodeller. |
No | |
| status | enum | Statusen för responsgenereringen. En av completed, failed, , in_progresseller incomplete.Möjliga värden: completed, failed, in_progress, incomplete |
No | |
| temperature | number | Vilken provtagningstemperatur ska användas, mellan 0 och 2. Högre värden som 0,8 gör resultatet mer slumpmässigt, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar generellt att ändra detta eller top_p båda. |
Yes | 1 |
| text | object | Konfigurationsalternativ för ett textsvar från modellen. Det kan vara ren text eller strukturerad JSON-data. Learn more: - textinmatningar och utdata - Strukturerade utdata |
No | |
| └─ format | TextResponseFormatConfiguration | Ett objekt som specificerar formatet som modellen måste ge utmatning. Konfiguration { "type": "json_schema" } aktiverar strukturerade utdata, vilket säkerställer att modellen matchar ditt tillhandahållna JSON-schema. Standardformatet är { "type": "text" } utan några extra alternativ.Rekommenderas inte för GPT-4o och nyare modeller: Att sätta på { "type": "json_object" } aktiverar det äldre JSON-läget, vilket säkerställer att meddelandet modellen genererar är giltigt JSON. Att använda är att föredra json_schema för modeller som stödjer det. |
No | |
| tool_choice | VerktygvalVal eller VerktygValTyper eller VerktygValFunktion | Hur modellen ska välja vilket verktyg (eller vilka verktyg) som ska användas när de genererar ett svar. Se parametern tools för att se hur man specificerar vilka verktyg modellen kan anropa. |
Yes | |
| tools | array | En uppsättning verktyg som modellen kan anropa samtidigt som den genererar ett svar. Du kan ange vilket verktyg du ska använda genom att ställa in parametern tool_choice .De två kategorierna av verktyg du kan tillhandahålla modellen är: - Inbyggda verktyg |
Yes | |
| top_p | number | Ett alternativ till provtagning med temperatur, kallat kärnprovtagning, där modellen beaktar resultaten från tokens med top_p sannolikhetsmassa. Så 0,1 betyder att endast tokens som utgör de 10 främsta% sannolikhetsmassan beaktas. Vi rekommenderar generellt att ändra detta eller temperature båda. |
Yes | 1 |
| truncation | enum | Strategin för trunkering att använda för modellens svar. - auto: Om kontexten för detta svar och tidigare överstiger modellens kontextfönsterstorlek, kommer modellen att förkorta svaret för att passa kontextfönstret genom att lägga till inmatningsobjekt mitt i samtalet. - disabled (standard): Om ett modellsvar överstiger kontextfönstret för en modell, kommer förfrågan att misslyckas med ett felmeddelande på 400.Möjliga värden: auto, disabled |
No | |
| usage | ResponseUsage | Representerar detaljer om tokenanvändning, inklusive indatatokens, utdatatokens, en uppdelning av utdatatokens och det totala antalet använda tokens. |
No | |
| user | string | En unik identifierare som representerar din slutanvändare, vilket kan hjälpa OpenAI att övervaka och upptäcka missbruk. . |
No |
ResponseAudioDeltaEvent
Sänds ut när det finns en partiell ljudrespons.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| delta | string | En bit av Base64-kodade svarsljudbyte. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.audio.delta.Möjliga värden: response.audio.delta |
Yes |
ResponseAudioDoneEvent
Sänds ut när ljudresponsen är klar.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Typen av evenemang. Alltid response.audio.done.Möjliga värden: response.audio.done |
Yes |
ResponseAudioTranscriptDeltaEvent
Sänds ut när det finns en delvis transkription av ljudet.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| delta | string | Den delvisa transkriptionen av ljudsvaret. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.audio.transcript.delta.Möjliga värden: response.audio.transcript.delta |
Yes |
ResponseAudioTranscriptDoneEvent
Sänds ut när hela ljudutskriften är klar.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Typen av evenemang. Alltid response.audio.transcript.done.Möjliga värden: response.audio.transcript.done |
Yes |
ResponseCodeInterpreterCallCodeDeltaEvent
Sänds ut när en delvis kodsnipt läggs till av kodtolkaren.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| delta | string | Den delvisa kodbiten som kodtolkaren lägger till. |
Yes | |
| output_index | integer | Indexet för utdataobjektet som kodtolkaren anropar pågår. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.code_interpreter_call.code.delta.Möjliga värden: response.code_interpreter_call.code.delta |
Yes |
ResponseCodeInterpreterCallCodeDoneEvent
Sänds ut när kodsnippet-utdata slutförs av kodtolkaren.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string | Den slutliga kodbiten som kodtolkaren utfärdar. |
Yes | |
| output_index | integer | Indexet för utdataobjektet som kodtolkaren anropar pågår. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.code_interpreter_call.code.done.Möjliga värden: response.code_interpreter_call.code.done |
Yes |
ResponseCodeInterpreterCallCompletedEvent
Sänds ut när kodtolkaranropet är slutfört.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code_interpreter_call | CodeInterpreterToolCall | Ett verktygsanrop för att köra kod. |
Yes | |
| output_index | integer | Indexet för utdataobjektet som kodtolkaren anropar pågår. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.code_interpreter_call.completed.Möjliga värden: response.code_interpreter_call.completed |
Yes |
ResponseCodeInterpreterCallInProgressEvent
Sänds ut när ett kodtolkaranrop pågår.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code_interpreter_call | CodeInterpreterToolCall | Ett verktygsanrop för att köra kod. |
Yes | |
| output_index | integer | Indexet för utdataobjektet som kodtolkaren anropar pågår. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.code_interpreter_call.in_progress.Möjliga värden: response.code_interpreter_call.in_progress |
Yes |
ResponseCodeInterpreterCallInterpretingEvent
Sänds ut när kodtolkaren aktivt tolkar kodutsnittet.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code_interpreter_call | CodeInterpreterToolCall | Ett verktygsanrop för att köra kod. |
Yes | |
| output_index | integer | Indexet för utdataobjektet som kodtolkaren anropar pågår. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.code_interpreter_call.interpreting.Möjliga värden: response.code_interpreter_call.interpreting |
Yes |
ResponseCompletedEvent
Sänds ut när modellresponsen är klar.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| response | response | Yes | ||
| type | enum | Typen av evenemang. Alltid response.completed.Möjliga värden: response.completed |
Yes |
ResponseContentPartAddedEvent
Emitteras när en ny innehållsdel läggs till.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_index | integer | Innehållsindexet som lades till. |
Yes | |
| item_id | string | ID:t för utdataobjektet som innehållsdelen lades till i. |
Yes | |
| output_index | integer | Indexet för den utdata som innehållsdelen lades till i. |
Yes | |
| part | OutputContent | Yes | ||
| type | enum | Typen av evenemang. Alltid response.content_part.added.Möjliga värden: response.content_part.added |
Yes |
ResponseContentPartDoneEvent
Emitteras när en innehållsdel är klar.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_index | integer | Indexet över innehållet som är gjort. |
Yes | |
| item_id | string | ID:t för utdataobjektet som innehållsdelen lades till i. |
Yes | |
| output_index | integer | Indexet för den utdata som innehållsdelen lades till i. |
Yes | |
| part | OutputContent | Yes | ||
| type | enum | Typen av evenemang. Alltid response.content_part.done.Möjliga värden: response.content_part.done |
Yes |
ResponseCreatedEvent
En händelse som sänds ut när ett svar skapas.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| response | response | Yes | ||
| type | enum | Typen av evenemang. Alltid response.created.Möjliga värden: response.created |
Yes |
ResponseError
Ett felobjekt returnerades när modellen misslyckades med att generera ett svar.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | ResponseErrorCode | Felkoden för svaret. |
Yes | |
| message | string | En mänskligt läsbar beskrivning av felet. |
Yes |
ResponseErrorCode
Felkoden för svaret.
| Property | Value |
|---|---|
| Description | Felkoden för svaret. |
| Type | string |
| Values | server_errorrate_limit_exceededinvalid_promptvector_store_timeoutinvalid_imageinvalid_image_formatinvalid_base64_imageinvalid_image_urlimage_too_largeimage_too_smallimage_parse_errorimage_content_policy_violationinvalid_image_modeimage_file_too_largeunsupported_image_media_typeempty_image_filefailed_to_download_imageimage_file_not_found |
ResponseErrorEvent
Sänds ut när ett fel uppstår.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| code | string | Felkoden. |
Yes | |
| message | string | Felmeddelandet. |
Yes | |
| param | string | Felparametern. |
Yes | |
| type | enum | Typen av evenemang. Alltid error.Möjliga värden: error |
Yes |
ResponseFailedEvent
En händelse som utlöses när ett svar misslyckas.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| response | response | Yes | ||
| type | enum | Typen av evenemang. Alltid response.failed.Möjliga värden: response.failed |
Yes |
ResponseFileSearchCallCompletedEvent
Skickas ut när ett filsökningsanrop är klart (resultat hittades).
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | ID:t för utdataobjektet som filsökningsanropet initieras. |
Yes | |
| output_index | integer | Indexet för utdataobjektet som filsökningen anropar initieras. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.file_search_call.completed.Möjliga värden: response.file_search_call.completed |
Yes |
ResponseFileSearchCallInProgressEvent
Sänds ut när ett filsökningsanrop initieras.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | ID:t för utdataobjektet som filsökningsanropet initieras. |
Yes | |
| output_index | integer | Indexet för utdataobjektet som filsökningen anropar initieras. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.file_search_call.in_progress.Möjliga värden: response.file_search_call.in_progress |
Yes |
ResponseFileSearchCallSearchingEvent
Aktiveras när en filsökning för närvarande söker.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item_id | string | ID:t för utdataobjektet som filsökningsanropet initieras. |
Yes | |
| output_index | integer | Indexet för det utdata som filsökningen anropar söker i. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.file_search_call.searching.Möjliga värden: response.file_search_call.searching |
Yes |
ResponseFunctionCallArgumentsDeltaEvent
Emitteras när det finns en partiell funktionsanrops-delta i argument.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| delta | string | Funktionsanropsargumenten deltar som tillagas. |
Yes | |
| item_id | string | ID:t för utdataobjektet som funktionsanropsargumenten delta läggs till i. |
Yes | |
| output_index | integer | Indexet för utdataobjektet som funktionsanropsargumenten deltar till. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.function_call_arguments.delta.Möjliga värden: response.function_call_arguments.delta |
Yes |
ResponseFunctionCallArgumentsDoneEvent
Sänds ut när funktionsanropsargument är färdigställda.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| arguments | string | Funktionsanropsargumenten. | Yes | |
| item_id | string | Föremålets ID. | Yes | |
| output_index | integer | Indexet för utgångsobjektet. | Yes | |
| type | enum | Möjliga värden: response.function_call_arguments.done |
Yes |
ResponseInProgressEvent
Sänds ut när responsen pågår.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| response | response | Yes | ||
| type | enum | Typen av evenemang. Alltid response.in_progress.Möjliga värden: response.in_progress |
Yes |
ResponseIncompleteEvent
En händelse som sänds ut när ett svar avslutas som ofullständigt.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| response | response | Yes | ||
| type | enum | Typen av evenemang. Alltid response.incomplete.Möjliga värden: response.incomplete |
Yes |
responseItemList
En lista över svarspunkter.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | array | En lista över punkter som användes för att generera detta svar. | Yes | |
| first_id | string | ID:t för det första objektet på listan. | Yes | |
| has_more | boolean | Om det finns fler saker tillgängliga. | Yes | |
| last_id | string | ID:t för den sista punkten på listan. | Yes | |
| object | enum | Typen av objekt som returneras måste vara list.Möjliga värden: list |
Yes |
ResponseModalities
Utdatatyper som du vill att modellen ska generera. De flesta modeller kan generera text, vilket är standard:
["text"]
Modellen gpt-4o-audio-preview kan också användas för att generera ljud. För att begära att denna modell genererar både text- och ljudsvar kan du använda:
["text", "audio"]
Inga egenskaper definierade för denna komponent.
ResponseModalitiesTextOnly
Utdatatyper som du vill att modellen ska generera. De flesta modeller kan generera text, vilket är standard:
["text"]
Detta API kommer snart att stödja andra utmatningsmodaliteter, inklusive ljud och bilder.
Inga egenskaper definierade för denna komponent.
ResponseOutputItemAddedEvent
Emitteras när en ny utgångspost läggs till.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item | OutputItem | Yes | ||
| output_index | integer | Indexet för den utgående post som lades till. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.output_item.added.Möjliga värden: response.output_item.added |
Yes |
ResponseOutputItemDoneEvent
Emitteras när en utgångspunkt markeras som slutförd.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| item | OutputItem | Yes | ||
| output_index | integer | Indexet för den utgående punkt som markerades som klar. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.output_item.done.Möjliga värden: response.output_item.done |
Yes |
ResponseProperties
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| instructions | string | Infogar ett system- (eller utvecklar-) meddelande som första objekt i modellens kontext. När man använder tillsammans med previous_response_id, kommer instruktionerna från ett tidigare svar inte att föras över till nästa svar. Detta gör det enkelt att byta ut system- (eller utvecklar-) meddelanden i nya svar. |
No | |
| max_output_tokens | integer | En övre gräns för antalet tokens som kan genereras för ett svar, inklusive synliga utdatatoken och konversationstillstånd. |
No | |
| previous_response_id | string | Det unika ID:t för det tidigare svaret på modellen. Använd detta för att skapa konversationer med flera turer. | No | |
| reasoning | Reasoning | Konfigurationsalternativ för resonemangsmodeller. |
No | |
| text | object | Konfigurationsalternativ för ett textsvar från modellen. Det kan vara ren text eller strukturerad JSON-data. Learn more: - textinmatningar och utdata - Strukturerade utdata |
No | |
| └─ format | TextResponseFormatConfiguration | Ett objekt som specificerar formatet som modellen måste ge utmatning. Konfiguration { "type": "json_schema" } aktiverar strukturerade utdata, vilket säkerställer att modellen matchar ditt tillhandahållna JSON-schema. Standardformatet är { "type": "text" } utan några extra alternativ.Rekommenderas inte för GPT-4o och nyare modeller: Att sätta på { "type": "json_object" } aktiverar det äldre JSON-läget, vilket säkerställer att meddelandet modellen genererar är giltigt JSON. Att använda är att föredra json_schema för modeller som stödjer det. |
No | |
| tool_choice | VerktygvalVal eller VerktygValTyper eller VerktygValFunktion | Hur modellen ska välja vilket verktyg (eller vilka verktyg) som ska användas när de genererar ett svar. Se parametern tools för att se hur man specificerar vilka verktyg modellen kan anropa. |
No | |
| tools | array | En uppsättning verktyg som modellen kan anropa samtidigt som den genererar ett svar. Du kan ange vilket verktyg du ska använda genom att ställa in parametern tool_choice .De två kategorierna av verktyg du kan tillhandahålla modellen är: - Inbyggda verktyg |
No | |
| truncation | enum | Strategin för trunkering att använda för modellens svar. - auto: Om kontexten för detta svar och tidigare överstiger modellens kontextfönsterstorlek, kommer modellen att förkorta svaret för att passa kontextfönstret genom att lägga till inmatningsobjekt mitt i samtalet. - disabled (standard): Om ett modellsvar överstiger kontextfönstret för en modell, kommer förfrågan att misslyckas med ett felmeddelande på 400.Möjliga värden: auto, disabled |
No |
ResponseRefusalDeltaEvent
Sänds ut när det finns ett delvis avvisningsmeddelande.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_index | integer | Innehållsindexet som avslagstexten läggs till i. |
Yes | |
| delta | string | Det avslagsbesked som läggs till. |
Yes | |
| item_id | string | ID:t för utdataobjektet som avvisningstexten läggs till i. |
Yes | |
| output_index | integer | Indexet för utdataobjektet som avvisningstexten läggs till i. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.refusal.delta.Möjliga värden: response.refusal.delta |
Yes |
ResponseRefusalDoneEvent
Sänds ut när avslagstexten är färdigställd.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_index | integer | Innehållet innehåller att avslagstexten är färdigställd. |
Yes | |
| item_id | string | ID:t för utdataobjektet där avvisningstexten är slutgiltigt. |
Yes | |
| output_index | integer | Indexet för utdataobjektet där avvisningstexten är färdigställd. |
Yes | |
| refusal | string | Det avslagsbesked som är färdigställt. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.refusal.done.Möjliga värden: response.refusal.done |
Yes |
responseStreamEvent
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| annotation | Annotation | Yes | ||
| annotation_index | integer | Indexet över den anteckning som lades till. |
Yes | |
| arguments | string | Funktionsanropsargumenten. | Yes | |
| code | string | Felkoden. |
Yes | |
| code_interpreter_call | CodeInterpreterToolCall | Ett verktygsanrop för att köra kod. |
Yes | |
| content_index | integer | Innehållet är tydligt att textinnehållet är färdigställt. |
Yes | |
| delta | string | Text-deltat som lades till. |
Yes | |
| item | OutputItem | Utgångspunkten som markerades som klar. |
Yes | |
| item_id | string | ID:t för det utdata som textinnehållet har är slutgiltigt. |
Yes | |
| message | string | Felmeddelandet. |
Yes | |
| output_index | integer | Indexet för det utdata som textinnehållet innebär, är färdigställt. |
Yes | |
| param | string | Felparametern. |
Yes | |
| part | OutputContent | Innehållsdelen som är klar. |
Yes | |
| refusal | string | Det avslagsbesked som är färdigställt. |
Yes | |
| response | response | Svaret som var ofullständigt. |
Yes | |
| text | string | Textinnehållet som är färdigställt. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.output_text.done.Möjliga värden: response.output_text.done |
Yes |
ResponseTextAnnotationDeltaEvent
Emitteras när en textannotering läggs till.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| annotation | Annotation | Yes | ||
| annotation_index | integer | Indexet över den anteckning som lades till. |
Yes | |
| content_index | integer | Indexet över innehållsdelen som textannotationen lades till i. |
Yes | |
| item_id | string | ID:t för utdataobjektet som textannotationen lades till i. |
Yes | |
| output_index | integer | Indexet för det utdata som textannoteringen lades till i. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.output_text.annotation.added.Möjliga värden: response.output_text.annotation.added |
Yes |
ResponseTextDeltaEvent
Sänds ut när det finns en ytterligare textdelta.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_index | integer | Innehållsindexet där textdeltat lades till. |
Yes | |
| delta | string | Text-deltat som lades till. |
Yes | |
| item_id | string | ID:t för utdataobjektet som textdeltat lades till i. |
Yes | |
| output_index | integer | Indexet för det utdata som textdeltat lades till i. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.output_text.delta.Möjliga värden: response.output_text.delta |
Yes |
ResponseTextDoneEvent
Sänds ut när textinnehållet är färdigställt.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| content_index | integer | Innehållet är tydligt att textinnehållet är färdigställt. |
Yes | |
| item_id | string | ID:t för det utdata som textinnehållet har är slutgiltigt. |
Yes | |
| output_index | integer | Indexet för det utdata som textinnehållet innebär, är färdigställt. |
Yes | |
| text | string | Textinnehållet som är färdigställt. |
Yes | |
| type | enum | Typen av evenemang. Alltid response.output_text.done.Möjliga värden: response.output_text.done |
Yes |
ResponseUsage
Representerar detaljer om tokenanvändning, inklusive indatatokens, utdatatokens, en uppdelning av utdatatokens och det totala antalet använda tokens.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| input_tokens | integer | Antalet inmatningstokens. | Yes | |
| output_tokens | integer | Antalet utmatningstokens. | Yes | |
| output_tokens_details | object | En detaljerad genomgång av utdatatokens. | Yes | |
| └─ reasoning_tokens | integer | Antalet resonemangstoken. | No | |
| total_tokens | integer | Det totala antalet använda tokens. | Yes |
Screenshot
En skärmdumpsåtgärd.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Specificerar händelsetypen. För en skärmdumpsåtgärd är denna egenskap alltid inställd på screenshot.Möjliga värden: screenshot |
Yes |
Scroll
En scroll-handling.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| scroll_x | integer | Det horisontella scrollavståndet. |
Yes | |
| scroll_y | integer | Det vertikala scrollavståndet. |
Yes | |
| type | enum | Specificerar händelsetypen. För en rullningsåtgärd sätts denna egenskap alltid till scroll.Möjliga värden: scroll |
Yes | |
| x | integer | X-koordinaten där rullen inträffade. |
Yes | |
| y | integer | Y-koordinaten där rullen ägde rum. |
Yes |
StopConfiguration
Upp till 4 sekvenser där API:et slutar generera ytterligare tokens. Den returnerade texten kommer inte att innehålla stoppsekvensen.
Denna komponent kan vara en av följande:
TextResponseFormatConfiguration
Ett objekt som specificerar formatet som modellen måste ge utmatning.
Konfiguration { "type": "json_schema" } aktiverar strukturerade utdata, som säkerställer att modellen matchar ditt tillhandahållna JSON-schema.
Standardformatet är { "type": "text" } utan några extra alternativ.
Rekommenderas inte för GPT-4o och nyare modeller:
Att sätta på { "type": "json_object" } aktiverar det äldre JSON-läget, vilket säkerställer att meddelandet modellen genererar är giltigt JSON. Att använda är att föredra json_schema för modeller som stödjer det.
Denna komponent kan vara en av följande:
TextResponseFormatJsonSchema
JSON Schema svarformat. Används för att generera strukturerade JSON-svar. Läs mer om strukturerade utdata.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| description | string | En beskrivning av vad svarsformatet är till för, som används av modellen för att avgöra hur man ska svara i formatet. |
No | |
| name | string | Namnet på svarsformatet. Måste vara a-z, A-Z, 0-9, eller innehålla understreck och streck, med en maximal längd på 64. |
No | |
| schema | ResponseFormatJsonSchemaSchema | Schemat för svarsformatet, beskrivet som ett JSON Schema-objekt. | Yes | |
| strict | boolean | Om man ska aktivera strikt schema-följsamhet vid generering av utdata. Om den sätts till sann kommer modellen alltid att följa det exakta schemat som definierats schema i fältet. Endast en delmängd av JSON-schemat stöds när strict är true. |
No | False |
| type | enum | Typen av svarsformat som definieras. Alltid json_schema.Möjliga värden: json_schema |
Yes |
Tool
Denna komponent kan vara en av följande:
ToolChoiceFunction
Använd detta alternativ för att tvinga modellen att anropa en specifik funktion.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| name | string | Namnet på funktionen att anropa. | Yes | |
| type | enum | För funktionsanrop är typen alltid function.Möjliga värden: function |
Yes |
ToolChoiceOptions
Styr vilket (om något) verktyg som anropas av modellen.
none betyder att modellen inte anropar något verktyg utan istället genererar ett meddelande.
auto Det innebär att modellen kan välja mellan att generera ett meddelande eller att anropa ett eller flera verktyg.
required betyder att modellen måste anropa ett eller flera verktyg.
| Property | Value |
|---|---|
| Description | Styr vilket (om något) verktyg som anropas av modellen.none betyder att modellen inte anropar något verktyg utan istället genererar ett meddelande.auto Det innebär att modellen kan välja mellan att generera ett meddelande eller att anropa ett eller flera verktyg.required betyder att modellen måste anropa ett eller flera verktyg. |
| Type | string |
| Values | noneautorequired |
ToolChoiceTypes
Indikerar att modellen bör använda ett inbyggt verktyg för att generera ett svar.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Vilken typ av hostat verktyg modellen bör använda. Tillåtna värden är: - file_search- computer_use_previewMöjliga värden: file_search, computer_use_preview |
Yes |
Type
En handling för att skriva in text.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | Texten att skriva. |
Yes | |
| type | enum | Specificerar händelsetypen. För en typåtgärd är denna egenskap alltid satt till type.Möjliga värden: type |
Yes |
UpdateVectorStoreFileAttributesRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| attributes | VectorStoreFileAttributes | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och för att söka objekt via API eller instrumentpanelen. Tangenter är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken, booleaner eller tal. |
Yes |
UrlCitation
En referens till en webbresurs som används för att generera ett modellsvar.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| end_index | integer | Indexet för den sista tecknet i URL-citeringen i meddelandet. |
Yes | |
| start_index | integer | Indexet för det första tecknet i URL-citeringen i meddelandet. |
Yes | |
| title | string | Namnet på webbresursen. |
Yes | |
| type | enum | Typen av URL-citering. Alltid url_citation.Möjliga värden: url_citation |
Yes | |
| url | string | URL:en till webbresursen. |
Yes |
VectorStoreFileAttributes
Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och för att söka objekt via API eller instrumentpanelen. Tangenter är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken, booleaner eller tal.
Inga egenskaper definierade för denna komponent.
VectorStoreFileContentResponse
Representerar det parsade innehållet i en vektorlagringsfil.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | array | Analyserade innehållet i filen. | Yes | |
| has_more | boolean | Indikerar om det finns fler innehållssidor att hämta. | Yes | |
| next_page | string | Tokenen för nästa sida, om någon. | Yes | |
| object | enum | Objekttypen, som alltid är vector_store.file_content.pageMöjliga värden: vector_store.file_content.page |
Yes |
VectorStoreSearchRequest
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| filters | ComparisonFilter eller CompoundFilter | Ett filter att applicera baserat på filattribut. | No | |
| max_num_results | integer | Det maximala antalet resultat att returnera. Detta antal bör ligga mellan 1 och 50 inklusive. | No | 10 |
| query | Sträng eller array | En frågesträng för en sökning | Yes | |
| ranking_options | object | Rankningsalternativ för sökning. | No | |
| └─ ranker | enum | Möjliga värden: auto, default-2024-11-15 |
No | |
| └─ score_threshold | number | No | 0 | |
| rewrite_query | boolean | Om man ska skriva om den naturliga språkfrågan för vektorsökning. | No | False |
VectorStoreSearchResultContentObject
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| text | string | Textinnehållet återkom från sökningen. | Yes | |
| type | enum | Typen av innehåll. Möjliga värden: text |
Yes |
VectorStoreSearchResultItem
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| attributes | VectorStoreFileAttributes | Set av 16 nyckel-värdespar som kan fästas vid ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och för att söka objekt via API eller instrumentpanelen. Tangenter är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken, booleaner eller tal. |
Yes | |
| content | array | Innehållsdelar från filen. | Yes | |
| file_id | string | ID:t för vektorlagringsfilen. | Yes | |
| filename | string | Namnet på vektorlagringsfilen. | Yes | |
| score | number | Likhetspoängen för resultatet. | Yes |
VectorStoreSearchResultsPage
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | array | Listan över sökresultat. | Yes | |
| has_more | boolean | Indikerar om det finns fler resultat att hämta. | Yes | |
| next_page | string | Tokenen för nästa sida, om någon. | Yes | |
| object | enum | Objekttypen, som alltid är vector_store.search_results.pageMöjliga värden: vector_store.search_results.page |
Yes | |
| search_query | array | Yes |
VoiceIdsShared
Inga egenskaper definierade för denna komponent.
Wait
En vänta-handling.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | enum | Specificerar händelsetypen. För en väntaåtgärd sätts denna egenskap alltid till wait.Möjliga värden: wait |
Yes |
ReasoningEffort
Begränsar ansträngningen i resonemanget för resonemangsmodeller. För närvarande stödda värden är low, medium, och high. Att minska resonemangsansträngningen kan leda till snabbare svar och färre tokens som används på resonemang i ett svar.
| Property | Value |
|---|---|
| Description | Begränsar ansträngningen i resonemanget för resonemangsmodeller. För närvarande stödda värden är low, medium, och high. Att minska resonemangsansträngningen kan leda till snabbare svar och färre tokens som används på resonemang i ett svar. |
| Type | string |
| Default | medium |
| Values | lowmediumhigh |
errorEvent
Uppstår när ett fel uppstår. Detta kan hända på grund av ett internt serverfel eller en timeout.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | error | Yes | ||
| event | string | Yes |
event Enum: ErrorEventEnum
| Value | Description |
|---|---|
| error |
doneEvent
Inträffar när en ström slutar.
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| data | string | Yes | ||
| event | string | Yes |
evenemang Enum: DoneEventEnum
| Value | Description |
|---|---|
| done |
data-enum: DoneEventDataEnum
| Value | Description |
|---|---|
| [DONE] |
Next steps
Lär dig om modeller och finjustering med REST API. Läs mer om underlying modeller som driver Azure OpenAI.