Dela via

Förhandsversionsreferens för Azure OpenAI i Azure AI Foundry Models REST API v1

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

Slutsatsdragning av dataplan

Resten av artikeln täcker vår nya v1-förhandsrelease av API:et för inferensspecifikationen för dataplattformen Azure OpenAI. Läs mer i vår livscykelguide för API.

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

Skapa tal

POST {endpoint}/openai/v1/audio/speech?api-version=preview

Genererar text-till-tal-ljud från indatatexten.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: flera delar/formulärdata

Name Type Description Required Default
input string Texten som ljud ska genereras för. Den maximala längden är 4 096 tecken. Yes
instructions string Kontrollera rösten för ditt genererade ljud med ytterligare instruktioner. Fungerar inte med tts-1 eller tts-1-hd. No
model string Den modell som ska användas för den här text-till-tal-begäran. Yes
response_format object De ljudutdataformat som stöds för text till tal. No
speed number Talhastigheten för genererat ljud. Värdena är giltiga i intervallet från 0,25 till 4,0, med 1,0 standardvärden och högre värden som motsvarar snabbare tal. No 1
stream_format enum Formatet för att strömma ljudet i. Format som stöds är sse och audio. sse stöds inte för tts-1 eller tts-1-hd.
Möjliga värden: sse, audio		 No
voice object Yes

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/octet-stream string

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

Syntetiserar ljud från den angivna texten.

POST {endpoint}/openai/v1/audio/speech?api-version=preview

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

Svar: Statuskod: 200

{
  "body": "101010101"
}

Skapa transkription

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

Transkriberar ljud till indataspråket.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: flera delar/formulärdata

Name Type Description Required Default
chunking_strategy object No
└– prefix_padding_ms integer Mängden ljud som ska inkluderas innan detekteringen av VAD-tal (i sekunder)
millisekunder).		 No 300
└ silence_duration_ms integer Varaktighet för tystnad för att identifiera talstopp (i millisekunder).
Med kortare värden svarar modellen snabbare.
men kan hoppa in under korta pauser från användaren.		 No 200
└– tröskelvärde number Känslighetströskel (0,0 till 1,0) för identifiering av röstaktivitet. A
högre tröskelvärde kräver högre ljud för att aktivera modellen, och
kan därför fungera bättre i bullriga miljöer.		 No 0.5
└– typ enum Måste anges till server_vad för att aktivera manuell segmentering med hjälp av VAD på serversidan.
Möjliga värden: server_vad		 No
file string Yes
filename string Det valfria filnamnet eller den beskrivande identifieraren som ska associeras med ljuddata. No
include[] array Ytterligare information som ska ingå i transkriptionssvaret.
logprobs returnerar loggannolikorna för token i
svar för att förstå modellens förtroende för transkriptionen.
logprobs fungerar endast med response_format inställt på json och endast med
modellerna gpt-4o-transcribe, gpt-4o-transcribe-diarize, och gpt-4o-mini-transcribe.		 No
language string Språket för indataljudet. Om du anger indataspråket i FORMATET ISO-639-1 (t.ex. en) förbättras noggrannheten och svarstiden. No
model string Den modell som ska användas för den här transkriptionsbegäran. No
prompt string En valfri text som vägleder modellens formatmall eller fortsätter med ett tidigare ljudsegment. Uppmaningen ska matcha ljudspråket. No
response_format object No
stream boolean Om värdet är true strömmas modellsvarsdata till klienten
eftersom det genereras med hjälp av server-skickade händelser. Obs! Direktuppspelning stöds inte för whisper-1 modellen och ignoreras.		 No False
temperature number Provtagningstemperaturen, mellan 0 och 1. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Om värdet är 0 använder modellen loggsannolikhet för att automatiskt öka temperaturen tills vissa tröskelvärden uppnås. No 0
timestamp_granularities[] array Tidsstämpelkornigheterna som ska fyllas i för den här transkriptionen. response_format måste anges verbose_json för att använda tidsstämpelkornigheter. Något av eller båda alternativen stöds: word, eller segment. Obs! Det finns ingen ytterligare svarstid för segmenttidsstämplar, men att generera ordtidsstämplar medför ytterligare svarstid. No ['segment']

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json AzureAudioTranscriptionResponse
text/plain string

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

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

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Svar: Statuskod: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Skapa översättning

POST {endpoint}/openai/v1/audio/translations?api-version=preview

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

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: flera delar/formulärdata

Name Type Description Required Default
file string Yes
filename string Det valfria filnamnet eller den beskrivande identifieraren som ska associeras med ljuddata No
model string Den modell som ska användas för den här översättningsbegäran. No
prompt string En valfri text som vägleder modellens formatmall eller fortsätter med ett tidigare ljudsegment. Uppmaningen ska vara på engelska. No
response_format object No
temperature number Provtagningstemperaturen, mellan 0 och 1. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Om värdet är 0 använder modellen loggsannolikhet för att automatiskt öka temperaturen tills vissa tröskelvärden uppnås. No 0

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json AzureAudioTranslationResponse
text/plain string

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

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

POST {endpoint}/openai/v1/audio/translations?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Svar: Statuskod: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Skapa chatcompletion

POST {endpoint}/openai/v1/chat/completions?api-version=preview

Skapar en chattavslutning.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
audio object Parametrar för ljudutdata. Krävs när ljudutdata begärs med
modalities: ["audio"].		 No
└– format enum Anger utdataljudformatet. Måste vara en av wav, mp3, flac,
opus, eller pcm16.
Möjliga värden: wav, aac, mp3, flac, , opuspcm16		 No
└– röst object No
data_sources array De datakällor som ska användas för funktionen 'On Your Data', exklusivt i Azure OpenAI. No
frequency_penalty number Tal mellan -2.0 och 2.0. Positiva värden straffar nya tokens baserat på
den befintliga frekvensen i texten hittills, vilket resulterar i att modellens frekvens minskas
sannolikhet att upprepa samma rad ordagrant.		 No 0
function_call enum Om du anger en viss funktion via {"name": "my_function"} tvingar modellen att anropa den funktionen.
Möjliga värden: none, auto		 No
functions array Inaktuell 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 angivna token visas i slutförandet.

Accepterar ett JSON-objekt som mappar token (anges av deras token-ID i
tokenizer) till ett associerat bias-värde från -100 till 100. Matematiskt
bias läggs till i de logits som genereras av modellen före sampling.
Den exakta effekten varierar per modell, men värden mellan -1 och 1 bör
minska eller öka sannolikheten för urval. värden som -100 eller 100
bör leda till ett förbud eller ett specifikt val av relevant markör.		 No None
logprobs boolean Om du vill returnera loggannolikheter för utdatatoken eller inte. Om sant,
returnerar de logaritmiska sannolikheterna för varje utdatatoken som returneras i
content av message.		 No False
max_completion_tokens integer En övre gräns för antalet token som kan genereras för en
komplettering, inklusive synliga utdatatoken och slutledningstoken.		 No
max_tokens integer Det maximala antalet token som kan genereras i chattens slutförande.
Det här värdet kan användas för att styra kostnader för text som genereras via API.

Det här värdet är nu inaktuellt till förmån för max_completion_tokens, och det är
inte kompatibel med o1-seriemodeller.		 No
messages array En lista över meddelanden som består av konversationen hittills. Beroende på vilken
Olika meddelandetyper (modaliteter) stöds beroende på vilken modell du använder.
som text, bilder och ljud.		 Yes
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
modalities object 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. Så här begär du att den här modellen ska generera
både text- och ljudsvar kan du använda:

["text", "audio"]		 No
model string Modellimplementeringsidentifikatorn som ska användas för begäran om slutförande av chatten. Yes
n integer Hur många alternativ för chattavslut som ska genereras för varje indatameddelande. Observera att du debiteras baserat på antalet genererade token för alla alternativ. Behåll n för 1 att minimera kostnaderna. No 1
parallel_tool_calls object Om du vill aktivera parallell funktionsanrop under verktygsanvändning. No
prediction object Basrepresentation av förutsagda utdata från en modell. No
└– typ OpenAI.ChatOutputPredictionType No
presence_penalty number Tal mellan -2.0 och 2.0. Positiva värden straffar nya tokens baserat på
om de visas i texten hittills, vilket ökar modellens sannolikhet
för att prata om nya ämnen.		 No 0
reasoning_effort object Endast o-seriemodeller

Begränsar arbetet med resonemang för resonemangsmodeller.
Värden som stöds för närvarande är low, mediumoch high. Minska
Ansträngning i resonemang kan leda till snabbare svar och färre token som används
om resonemang i ett svar.		 No
response_format object No
└– typ enum
Möjliga värden: text, json_object, json_schema		 No
seed integer Den här funktionen finns i Beta.
Om det anges gör vårt system bästa för att sampla deterministiskt, så att upprepade begäranden med samma seed och parametrar ska returnera samma resultat.
Determinism är inte garanterad och du bör referera till parametern system_fingerprint svar för att övervaka ändringar i serverdelen.		 No
stop object Stöds inte med de senaste resonemangsmodellerna o3 och o4-mini.

Upp till 4 sekvenser där API:et slutar generera ytterligare token. Filtypen
returnerad text innehåller inte stoppsekvensen.		 No
store boolean Om man ska lagra utdata från denna chattens slutförandebegäran eller inte
användning i modelldestillation eller utvärderingsprodukter.		 No False
stream boolean Om värdet är true strömmas modellsvarsdata till klienten
eftersom det genereras med hjälp av server-skickade händelser.		 No False
stream_options object Alternativ för strömningssvar. Ange endast detta när du anger stream: true. No
└– inkludera_användning boolean Om det anges strömmas ytterligare ett segment före data: [DONE]
-meddelande. Fältet usage i det här segmentet visar tokenanvändningsstatistiken
för hela begäran, och fältet choices kommer alltid att vara tomt
samling.

Alla andra segment kommer också att innehålla ett usage fält, men med en null
värde. NOTERA: Om strömningen avbryts kanske du inte får
slutligt användningssegment som innehåller den totala tokenanvändningen för begäran.		 No
temperature number Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt.
Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.		 No 1
tool_choice OpenAI.ChatCompletionToolChoiceOption Styr vilket (om något) verktyg som anropas av modellen.
none innebär att modellen inte anropar något verktyg och i stället genererar ett meddelande.
auto innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett eller flera verktyg.
required innebär att modellen måste anropa ett eller flera verktyg.
Att ange ett visst verktyg via {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa verktyget.

none är standard när inga verktyg finns. auto är standardvärdet om det finns verktyg.		 No
tools array En lista över verktyg som modellen kan anropa. För närvarande stöds endast funktioner som ett verktyg. Använd detta för att ange en lista över funktioner som modellen kan generera JSON-indata för. Högst 128 funktioner stöds. No
top_logprobs integer Ett heltal mellan 0 och 20 som anger antalet mest sannolika token som ska returneras vid varje tokenposition, var och en med en associerad loggsannolikhet. No
top_p number Ett alternativ till provtagning med temperatur, som kallas kärnsampling,
där modellen tar hänsyn till resultatet av token med top_p sannolikhet
massa. Så 0,1 innebär endast de token som omfattar de 10 främsta i%:s sannolikhetsmassa.
övervägs.

Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.		 No 1
user string En unik identifierare som representerar slutanvändaren, vilket kan hjälpa dig att
övervaka och upptäcka missbruk.		 No
user_security_context AzureUserSecurityContext Användarsäkerhetskontexten innehåller flera parametrar som beskriver själva programmet och slutanvändaren som interagerar med programmet. De här fälten hjälper dina säkerhetsteam att undersöka och minimera säkerhetsincidenter genom att tillhandahålla en omfattande metod för att skydda dina AI-program. Läs mer om att skydda AI-program med hjälp av Microsoft Defender för molnet. No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json AzureCreateChatCompletionResponse
text/event-stream AzureCreateChatCompletionStreamResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

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

POST {endpoint}/openai/v1/chat/completions?api-version=preview

{
 "model": "gpt-4o-mini",
 "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?..."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Skapa inbäddning

POST {endpoint}/openai/v1/embeddings?api-version=preview

Skapar en inbäddningsvektor som representerar indatatexten.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
dimensions integer Antalet dimensioner som resulterande inbäddningar av utdata ska ha. Stöds endast i text-embedding-3 och senare modeller. No
encoding_format enum Formatet för att returnera inbäddningarna i. Kan vara antingen float eller base64.
Möjliga värden: float, base64		 No
input sträng eller matris Yes
model string Den modell som ska användas för inbäddningsbegäran. Yes
user string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.CreateEmbeddingResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

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

POST {endpoint}/openai/v1/embeddings?api-version=preview

{
 "model": "text-embedding-ada-002",
 "input": [
  "this is a test"
 ]
}

Svar: Statuskod: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05,
          0.0032178196,
          -0.020365695,
          -0.009631885,
          -0.007647093,
          0.0033837722,
          -0.026764825,
          -0.010501476,
          0.020219658,
          0.024640633,
          -0.0066912062,
          -0.036456455,
          -0.0040923897,
          -0.013966565,
          0.017816665,
          0.005366905,
          0.022835068,
          0.0103488,
          -0.0010811808,
          -0.028942121,
          0.0074280356,
          -0.017033368,
          0.0074877786,
          0.021640211,
          0.002499245,
          0.013316032,
          0.0021524043,
          0.010129742,
          0.0054731146,
          0.03143805,
          0.014856071,
          0.0023366117,
          -0.0008243692,
          0.022781964,
          0.003038591,
          -0.017617522,
          0.0013309394,
          0.0022154662,
          0.00097414135,
          0.012041516,
          -0.027906578,
          -0.023817508,
          0.013302756,
          -0.003003741,
          -0.006890349,
          0.0016744611
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Lista evals

GET {endpoint}/openai/v1/evals?api-version=preview

Lista utvärderingar för ett projekt.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
aoai-evals header Yes string
Möjliga värden: preview		 Ger åtkomst till AOAI Evals, en förhandsversionsfunktion.
Den här funktionen kräver att rubriken "aoai-evals" anges till "förhandsversion".
after query No string Identifierare för den senaste utvärderingen från föregående begäran om sidnumrering.
limit query No integer En gräns för antalet eval som ska returneras i ett enda sidnumreringssvar.
order query No string
Möjliga värden: asc, desc		 Sorteringsordningen för utvärderingar efter tidsstämpel. Använd asc för stigande ordning eller
desc för fallande ordning.
sortera_efter query No string
Möjliga värden: created_at, updated_at		 Evals kan ordnas efter skapandetid eller senast uppdaterad tid. Använd
created_at för skapandetid eller updated_at för senast uppdaterad
Tid.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.EvalList

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Createeval

POST {endpoint}/openai/v1/evals?api-version=preview

Skapa strukturen för en utvärdering som kan användas för att testa en modells prestanda.

En utvärdering är en uppsättning testkriterier och en datakälla. När du har skapat en utvärdering kan du köra den på olika modeller och modellparametrar. Vi stöder flera typer av graderare och datakällor.

Obs! Det här Azure OpenAI-API:et är i förhandsversion och kan komma att ändras.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
aoai-evals header Yes string
Möjliga värden: preview		 Ger åtkomst till AOAI Evals, en förhandsversionsfunktion.
Den här funktionen kräver att rubriken "aoai-evals" anges till "förhandsversion".

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
datakällkonfiguration object Yes
└– typ OpenAI.EvalDataSourceConfigType No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
name string Namnet på utvärderingen. No
statuskod enum
Möjliga värden: 201		 Yes
testkriterier array En lista över bedömare för alla utvärderingskörningar i den här gruppen. Graders kan referera till variabler i datakällan med hjälp av dubbla klammerparenteser, till exempel {{item.variable_name}}. Om du vill referera till modellens utdata använder du sample namnområdet (dvs. {{sample.output_text}}). Yes

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.Eval

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Hämta eval

GET {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Hämta en utvärdering med dess ID. Hämtar en utvärdering med sitt ID.

Obs! Det här Azure OpenAI-API:et är i förhandsversion och kan komma att ändras.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
aoai-evals header Yes string
Möjliga värden: preview		 Ger åtkomst till AOAI Evals, en förhandsversionsfunktion.
Den här funktionen kräver att rubriken "aoai-evals" anges till "förhandsversion".
eval_id path Yes string

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.Eval

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Uppdatera eval

POST {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Uppdateringsval, föränderliga egenskaper för en angiven utvärdering.

Obs! Det här Azure OpenAI-API:et är i förhandsversion och kan komma att ändras.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
aoai-evals header Yes string
Möjliga värden: preview		 Ger åtkomst till AOAI Evals, en förhandsversionsfunktion.
Den här funktionen kräver att rubriken "aoai-evals" anges till "förhandsversion".
eval_id path Yes string

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
metadata OpenAI.MetadataPropertyForRequest Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
name string No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.Eval

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Ta bort eval

DELETE {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Ta bort en angiven utvärdering.

Obs! Det här Azure OpenAI-API:et är i förhandsversion och kan komma att ändras.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
aoai-evals header Yes string
Möjliga värden: preview		 Ger åtkomst till AOAI Evals, en förhandsversionsfunktion.
Den här funktionen kräver att rubriken "aoai-evals" anges till "förhandsversion".
eval_id path Yes string

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json object

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Hämta eval-körningar

GET {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

Hämta en lista över körningar för en angiven utvärdering.

Obs! Det här Azure OpenAI-API:et är i förhandsversion och kan komma att ändras.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
aoai-evals header Yes string
Möjliga värden: preview		 Ger åtkomst till AOAI Evals, en förhandsversionsfunktion.
Den här funktionen kräver att rubriken "aoai-evals" anges till "förhandsversion".
eval_id path Yes string
after query No string
limit query No integer
order query No string
Möjliga värden: asc, desc
status query No string
Möjliga värden: queued, in_progress, completed, , canceledfailed

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.EvalRunList

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Skapa eval-körning

POST {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

Skapa en ny utvärderingskörning som påbörjar bedömningsprocessen.

Obs! Det här Azure OpenAI-API:et är i förhandsversion och kan komma att ändras.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
aoai-evals header Yes string
Möjliga värden: preview		 Ger åtkomst till AOAI Evals, en förhandsversionsfunktion.
Den här funktionen kräver att rubriken "aoai-evals" anges till "förhandsversion".
eval_id path Yes string

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
datakälla object Yes
└– typ OpenAI.EvalRunDataSourceType No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
name string Namnet på körningen. No

Responses

Statuskod: 201

Beskrivning: Begäran har slutförts och en ny resurs har skapats som ett resultat.

Content-Type Type Description
application/json OpenAI.EvalRun

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Hämta eval-körning

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

Hämta en specifik utvärdering som körs med dess ID.

Obs! Det här Azure OpenAI-API:et är i förhandsversion och kan komma att ändras.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
aoai-evals header Yes string
Möjliga värden: preview		 Ger åtkomst till AOAI Evals, en förhandsversionsfunktion.
Den här funktionen kräver att rubriken "aoai-evals" anges till "förhandsversion".
eval_id path Yes string
run_id path Yes string

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.EvalRun

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Avbryt eval-körning

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

Avbryt en specifik utvärderingskörning med dess ID.

Obs! Det här Azure OpenAI-API:et är i förhandsversion och kan komma att ändras.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
aoai-evals header Yes string
Möjliga värden: preview		 Ger åtkomst till AOAI Evals, en förhandsversionsfunktion.
Den här funktionen kräver att rubriken "aoai-evals" anges till "förhandsversion".
eval_id path Yes string
run_id path Yes string

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.EvalRun

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Deleteevalrun

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

Ta bort en specifik utvärdering som körs med dess ID.

Obs! Det här Azure OpenAI-API:et är i förhandsversion och kan komma att ändras.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
aoai-evals header Yes string
Möjliga värden: preview		 Ger åtkomst till AOAI Evals, en förhandsversionsfunktion.
Den här funktionen kräver att rubriken "aoai-evals" anges till "förhandsversion".
eval_id path Yes string
run_id path Yes string

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json object

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Hämta utdataobjekt för eval-körning

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items?api-version=preview

Hämta en lista över utdataobjekt för en angiven utvärderingskörning.

Obs! Det här Azure OpenAI-API:et är i förhandsversion och kan komma att ändras.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
aoai-evals header Yes string
Möjliga värden: preview		 Ger åtkomst till AOAI Evals, en förhandsversionsfunktion.
Den här funktionen kräver att rubriken "aoai-evals" anges till "förhandsversion".
eval_id path Yes string
run_id path Yes string
after query No string
limit query No integer
status query No string
Möjliga värden: fail, pass
order query No string
Möjliga värden: asc, desc

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.EvalRunOutputItemList

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Hämta utdataobjekt för eval-körning

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=preview

Hämta ett specifikt utdataobjekt från en utvärdering som körs av dess ID.

Obs! Det här Azure OpenAI-API:et är i förhandsversion och kan komma att ändras.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
aoai-evals header Yes string
Möjliga värden: preview		 Ger åtkomst till AOAI Evals, en förhandsversionsfunktion.
Den här funktionen kräver att rubriken "aoai-evals" anges till "förhandsversion".
eval_id path Yes string
run_id path Yes string
output_item_id path Yes string

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.EvalRunOutputItem

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Skapa fil

POST {endpoint}/openai/v1/files?api-version=preview

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: flera delar/formulärdata

Name Type Description Required Default
går ut efter object Yes
└– fästpunkt AzureFileExpiryAnchor No
└– sekunder integer No
file string Yes
avsikt enum Det avsedda syftet med den uppladdade filen. En av: - assistants: Används i API:et Assistants – batch: Används i Batch-API:et – fine-tune: Används för finjustering – evals: Används för eval-datauppsättningar
Möjliga värden: assistants, batch, fine-tune, evals		 Yes

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json AzureOpenAIFile

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

POST {endpoint}/openai/v1/files?api-version=preview

Visa filerna

GET {endpoint}/openai/v1/files?api-version=preview

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
avsikt query No string

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json AzureListFilesResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Hämta fil

GET {endpoint}/openai/v1/files/{file_id}?api-version=preview

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
file_id path Yes string ID:t för filen som ska användas för den här begäran.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json AzureOpenAIFile

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Ta bort fil

DELETE {endpoint}/openai/v1/files/{file_id}?api-version=preview

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
file_id path Yes string ID:t för filen som ska användas för den här begäran.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.DeleteFileResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Ladda ned fil

GET {endpoint}/openai/v1/files/{file_id}/content?api-version=preview

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
file_id path Yes string ID:t för filen som ska användas för den här begäran.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/octet-stream string

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Rungrader

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run?api-version=preview

Kör en väghyvel.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
väghyvel object Ett StringCheckGrader-objekt som utför en strängjämförelse mellan indata och referens med en angiven åtgärd. Yes
└– calculate_output string En formel för att beräkna utdata baserat på graderresultat. No
└– evaluation_metric enum Det utvärderingsmått som ska användas. En av fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5eller rouge_l.
Möjliga värden: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , , rouge_5rouge_l		 No
└– väghyvlar object No
└image_tag string Avbildningstaggen som ska användas för Python-skriptet. No
└– indata array Inmatningstexten. Detta kan innehålla mallsträngar. No
└– modell string Den modell som ska användas för utvärderingen. No
└— namn string Namnet på bedömaren. No
└— åtgärd enum Strängkontrollprocessen som ska utföras. En av eq, ne, likeeller ilike.
Möjliga värden: eq, ne, like, ilike		 No
└– intervall array Poängintervallet. Standardinställningen är [0, 1]. No
└– referens string Texten som betygsätts och jämförs med. No
└– sampling_params Samplingsparametrarna för modellen. No
└– källa string Källkoden för Python-skriptet. No
└– typ enum Objekttypen, som alltid multiär .
Möjliga värden: multi		 No
item Datamängdsobjektet som tillhandahålls till väghyveln. Detta används för att fylla i
namnområdet item .		 No
model_sample string Modellexemplet som ska utvärderas. Det här värdet används för att fylla i
namnområdet sample .
Variabeln output_json fylls i om modellexemplet är en
giltig JSON-sträng.		 Yes

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.RunGraderResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Validera väghyvel

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate?api-version=preview

Verifiera en väghyvel.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
väghyvel object Ett StringCheckGrader-objekt som utför en strängjämförelse mellan indata och referens med en angiven åtgärd. Yes
└– calculate_output string En formel för att beräkna utdata baserat på graderresultat. No
└– evaluation_metric enum Det utvärderingsmått som ska användas. En av fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5eller rouge_l.
Möjliga värden: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , , rouge_5rouge_l		 No
└– väghyvlar object No
└image_tag string Avbildningstaggen som ska användas för Python-skriptet. No
└– indata array Inmatningstexten. Detta kan innehålla mallsträngar. No
└– modell string Den modell som ska användas för utvärderingen. No
└— namn string Namnet på bedömaren. No
└— åtgärd enum Strängkontrollprocessen som ska utföras. En av eq, ne, likeeller ilike.
Möjliga värden: eq, ne, like, ilike		 No
└– intervall array Poängintervallet. Standardinställningen är [0, 1]. No
└– referens string Texten som betygsätts och jämförs med. No
└– sampling_params Samplingsparametrarna för modellen. No
└– källa string Källkoden för Python-skriptet. No
└– typ enum Objekttypen, som alltid multiär .
Möjliga värden: multi		 No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.ValidateGraderResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Skapa finjusteringsjobb

POST {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

Skapar ett finjusteringsjobb som påbörjar processen med att skapa en ny modell från en viss datauppsättning.

Svaret innehåller information om det köade jobbet, inklusive jobbstatus och namnet på de finjusterade modellerna när det är klart.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
hyperparametrar object De hyperparametrar som används för finjusteringsjobbet.
Det här värdet är nu inaktuellt till förmån för methodoch bör skickas under parametern method .		 No
└– batch_size enum
Möjliga värden: auto		 No
└– learning_rate_multiplier enum
Möjliga värden: auto		 No
└– n_epochs enum
Möjliga värden: auto		 No
Integrationer array En lista över integreringar som ska aktiveras för ditt finjusteringsjobb. No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
metod OpenAI.FineTuneMethod Metoden som används för finjustering. No
model sträng (se giltiga modeller nedan) Namnet på modellen som ska finjusteras. Yes
seed integer Fröet styr reproducerbarheten för uppgiften. Att skicka in samma parametrar för start- och jobb bör ge samma resultat, men kan skilja sig i sällsynta fall.
Om ett frö inte har angetts genereras ett för dig.		 No
suffix string En sträng på upp till 64 tecken som läggs till i ditt finjusterade modellnamn.

Till exempel skulle en suffix av "custom-model-name" generera ett modellnamn som ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.		 No None
utbildningsfil string ID för en uppladdad fil som innehåller träningsdata. Datamängden måste formateras som en JSONL-fil. Dessutom måste du ladda upp filen med syftet fine-tune.

Innehållet i filen bör variera beroende på om modellen använder chattformatet, slutförandeformatet eller om finjusteringsmetoden använder inställningsformatet.		 Yes
validation_file string ID för en uppladdad fil som innehåller valideringsdata.

Om du anger den här filen används data för att generera validering
mått regelbundet under finjustering. Dessa mått kan visas i
finjusteringsresultatfilen.
Samma data bör inte finnas i både tränings- och valideringsfiler.

Datamängden måste formateras som en JSONL-fil. Du måste ladda upp filen med syftet fine-tune.		 No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.FineTuningJob

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Lista sidnumrerade finjusteringsjobb

GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

Visa en lista över organisationens finjusteringsjobb

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
after query No string Identifierare för det senaste jobbet från föregående sidnumreringsbegäran.
limit query No integer Antal finjusteringsjobb som ska hämtas.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.ListPaginatedFineTuningJobsResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Hämta finjusteringsjobb

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=preview

Få information om ett finjusteringsjobb.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
finjusteringsjobb_id path Yes string ID för finjusteringsjobbet.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.FineTuningJob

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Avbryt finjusteringsjobb

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=preview

Avbryt omedelbart ett finjusterat jobb.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
finjusteringsjobb_id path Yes string ID:t för det finjusteringsjobb som ska avbrytas.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.FineTuningJob

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Visa en lista över finjusteringsjobbkontrollpunkter

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=preview

Visa en lista över kontrollpunkter för ett finjusteringsjobb.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
finjusteringsjobb_id path Yes string ID:t för det finjusteringsjobb som du vill hämta kontrollpunkter för.
after query No string Identifierare för det senaste kontrollpunkts-ID:t från föregående sidnumreringsbegäran.
limit query No integer Antal kontrollpunkter som ska hämtas.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.ListFineTuningJobCheckpointsResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Visa en lista över finjusterande händelser

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=preview

Hämta statusuppdateringar för ett finjusteringsjobb.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
finjusteringsjobb_id path Yes string ID:t för det finjusteringsjobb som händelser ska hämtas för.
after query No string Identifierare för den senaste händelsen från föregående sidnumreringsbegäran.
limit query No integer Antal händelser som ska hämtas.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.ListFineTuningJobEventsResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Pausa finjusteringsjobb

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=preview

Pausa ett finjusterat jobb.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
finjusteringsjobb_id path Yes string ID för det finjusteringsjobb som ska pausas.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.FineTuningJob

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Återuppta finjusteringsjobb

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=preview

Återuppta ett pausat finjusterat jobb.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
finjusteringsjobb_id path Yes string ID:t för det finjusteringsjobb som ska återupptas.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.FineTuningJob

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Skapa bildredigering

POST {endpoint}/openai/v1/images/edits?api-version=preview

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: flera delar/formulärdata

Name Type Description Required Default
background enum Gör att du kan ange transparens för bakgrunden för de genererade avbildningarna.
Den här parametern stöds endast för gpt-image-1. Måste vara en av
transparent, opaque eller auto (standardvärde). När auto används
kommer modellen automatiskt att fastställa den bästa bakgrunden för bilden.

Om transparentmåste utdataformatet ha stöd för transparens, så det
ska anges till antingen png (standardvärde) eller webp.
Möjliga värden: transparent, opaque, auto		 No
image sträng eller matris Yes
mask string No
model string Modellimplementeringen att använda för bildredigeringsoperationen. Yes
n integer Antalet bilder som ska genereras. Måste vara mellan 1 och 10. No 1
output_compression integer Komprimeringsnivån (0–100%) för de genererade bilderna. Den här parametern
stöds endast för gpt-image-1 med webp eller jpeg utdata
format och standardvärdet är 100.		 No 100
output_format enum Formatet där de genererade bilderna returneras. Den här parametern är
stöds endast för gpt-image-1. Måste vara en av png, jpegeller webp.
Standardvärdet är png.
Möjliga värden: png, jpeg, webp		 No
prompt string En textbeskrivning av de önskade bilderna. Den maximala längden är 1 000 tecken för dall-e-2och 32 000 tecken för gpt-image-1. Yes
quality enum Kvaliteten på den bild som ska genereras. highoch mediumlow stöds endast för gpt-image-1. dall-e-2 stöder endast standard-kvalitet. Standardinställningen är auto.
Möjliga värden: standard, low, medium, , highauto		 No
response_format enum Formatet där de genererade bilderna returneras. Måste vara en av url eller b64_json. URL:er är endast giltiga i 60 minuter efter att avbildningen har genererats. Den här parametern stöds bara för dall-e-2, vilket gpt-image-1 alltid returnerar base64-kodade bilder.
Möjliga värden: url, b64_json		 No
size enum Storleken på de genererade bilderna. Måste vara ett av 1024x1024, 1536x1024 (liggande), 1024x1536 (stående) eller auto (standardvärde) för gpt-image-1, och ett av 256x256, 512x512eller 1024x1024 för dall-e-2.
Möjliga värden: 256x256, 512x512, 1024x1024, 1536x1024, , 1024x1536auto		 No
user string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json AzureImagesResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Skapaimage

POST {endpoint}/openai/v1/images/generations?api-version=preview

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
background enum Gör att du kan ange transparens för bakgrunden för de genererade avbildningarna.
Den här parametern stöds endast för gpt-image-1. Måste vara en av
transparent, opaque eller auto (standardvärde). När auto används
kommer modellen automatiskt att fastställa den bästa bakgrunden för bilden.

Om transparentmåste utdataformatet ha stöd för transparens, så det
ska anges till antingen png (standardvärde) eller webp.
Möjliga värden: transparent, opaque, auto		 No
model string Den valda modellen som ska användas för att generera bilder. Yes
moderation enum Kontrollera innehållsmodereringsnivån för bilder som genereras av gpt-image-1. Måste vara antingen low för mindre restriktiv filtrering eller auto (standardvärde).
Möjliga värden: low, auto		 No
n integer Antalet bilder som ska genereras. Måste vara mellan 1 och 10. För dall-e-3stöds endast n=1 . No 1
output_compression integer Komprimeringsnivån (0–100%) för de genererade bilderna. Den här parametern stöds endast för gpt-image-1 med utdataformaten webp eller jpeg och är som standard 100. No 100
output_format enum Formatet där de genererade bilderna returneras. Den här parametern stöds endast för gpt-image-1. Måste vara en av png, jpegeller webp.
Möjliga värden: png, jpeg, webp		 No
prompt string En textbeskrivning av de önskade bilderna. Den maximala längden är 32 000 tecken för gpt-image-1, 1 000 tecken för dall-e-2 och 4 000 tecken för dall-e-3. Yes
quality enum Kvaliteten på den bild som ska genereras.

- auto (standardvärde) väljer automatiskt den bästa kvaliteten för den angivna modellen.
- highoch mediumlow stöds för gpt-image-1.
- hd och standard stöds för dall-e-3.
- standard är det enda alternativet för dall-e-2.
Möjliga värden: standard, hd, low, medium, , highauto		 No
response_format enum Formatet där genererade bilder med dall-e-2 och dall-e-3 returneras. Måste vara en av url eller b64_json. URL:er är endast giltiga i 60 minuter efter att avbildningen har genererats. Den här parametern stöds inte som gpt-image-1 alltid returnerar base64-kodade bilder.
Möjliga värden: url, b64_json		 No
size enum Storleken på de genererade bilderna. Måste vara en av 1024x1024, 1536x1024 (liggande), 1024x1536 (stående) eller auto (standardvärde) för gpt-image-1, en av 256x256, 512x512, eller 1024x1024 för dall-e-2, och en av 1024x1024, 1792x1024eller 1024x1792 för dall-e-3.
Möjliga värden: auto, 1024x1024, 1536x1024, 1024x1536, 256x256, 512x512, , , 1792x10241024x1792		 No
style enum Formatmallen för de genererade bilderna. Den här parametern stöds endast för dall-e-3. Måste vara en av vivid eller natural. Livfullhet gör att modellen tenderar att generera hyperreella och dramatiska bilder. Naturlighet gör att modellen producerar mer naturliga och mindre hyperrealistiska bilder.
Möjliga värden: vivid, natural		 No
user string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json AzureImagesResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

Skapar avbildningar med en uppmaning.

POST {endpoint}/openai/v1/images/generations?api-version=preview

{
 "model": "dall-e-3",
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Svar: Statuskod: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Lista modeller

GET {endpoint}/openai/v1/models?api-version=preview

Visar en lista över tillgängliga modeller och innehåller grundläggande information om var och en, till exempel ägare och tillgänglighet.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.ListModelsResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Hämta modell

GET {endpoint}/openai/v1/models/{model}?api-version=preview

Hämtar en modellinstans med grundläggande information om modellen, till exempel ägare och behörighet.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
model path Yes string ID:t för modellen som ska användas för den här begäran.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.Model

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Skapa svar

POST {endpoint}/openai/v1/responses?api-version=preview

Skapar ett modellsvar.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
background boolean Om modellsvaret ska köras i bakgrunden. No False
include array Ange ytterligare utdata som ska inkluderas i modellsvaret. För närvarande
värden som stöds är:
- code_interpreter_call.outputs: Innehåller utdata från python-kodkörning
i kodtolkarverktyget anropar objekt.
- computer_call_output.output.image_url: Inkludera bild-URL:er från datorns anropsresultat.
- file_search_call.results: Inkludera sökresultaten för
anropet till filsökningsverktyget.
- message.input_image.image_url: Inkludera bild-URL:er från indatameddelandet.
- message.output_text.logprobs: Inkludera logprobs med assistentmeddelanden.
- reasoning.encrypted_content: Innehåller en krypterad version av resonemanget
token i utdata för resonemangsobjekt. Detta gör det möjligt att använda resonemangsobjekt i
Flervändiga konversationer när du använder respons-API:et tillståndslöst (till exempel
när parametern store är inställd på false, eller när en organisation är
registrerats i programmet för ingen datalagring.		 No
input sträng eller matris No
instructions string Ett systemmeddelande (eller utvecklarmeddelande) som infogats i modellens kontext.

När du använder detta tillsammans med previous_response_id, anvisningarna från en tidigare
svaret kommer inte att överföras till nästa svar. Detta gör det enkelt
för att växla ut systemmeddelanden (eller utvecklarmeddelanden) i nya svar.		 No
max_output_tokens integer En övre gräns för antalet token som kan genereras för ett svar, inklusive synliga utdatatoken och resonemangstoken No
max_tool_calls integer Det maximala antalet totala anrop till inbyggda verktyg som kan bearbetas i ett svar. Det här maximala antalet gäller för alla inbyggda verktygsanrop, inte per enskilt verktyg. Eventuella ytterligare försök att anropa ett verktyg av modellen ignoreras. No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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 Implementeringen av modellen som ska användas för att skapa det här svaret. Yes
parallel_tool_calls boolean Om modellen ska kunna köra verktygsanrop parallellt. No True
previous_response_id string Det unika ID:t för föregående svar på modellen. Använd detta för att
skapa flerstegskonversationer		 No
prompt object Referens till en promptmall och dess variabler. No
└– id string Den unika identifieraren för den promptmall som ska användas. No
└– variabler OpenAI.ResponsePromptVariables Valfri mappning av värden att ersätta med variabler i din
datorn. Ersättningsvärdena kan antingen vara strängar eller andra
Svarsindatatyper som bilder eller filer.		 No
└— version string Valfri version av promptmallen. No
reasoning object Endast o-seriemodeller

Konfigurationsalternativ för resonemangsmodeller.		 No
└— insats OpenAI.ReasoningEffort Endast o-seriemodeller

Begränsar arbetet med resonemang för resonemangsmodeller.
Värden som stöds för närvarande är low, mediumoch high. Minska
Ansträngning i resonemang kan leda till snabbare svar och färre token som används
om resonemang i ett svar.		 No
└– generate_summary enum Inaktuell: använd summary i stället.

En sammanfattning av det resonemang som utförs av modellen. Detta kan vara
användbart för att felsöka och förstå modellens resonemangsprocess.
En av auto, conciseeller detailed.
Möjliga värden: auto, concise, detailed		 No
└— sammanfattning enum En sammanfattning av det resonemang som utförs av modellen. Detta kan vara
användbart för att felsöka och förstå modellens resonemangsprocess.
En av auto, conciseeller detailed.
Möjliga värden: auto, concise, detailed		 No
store boolean Om du vill lagra det genererade modellsvaret för senare hämtning via
API		 No True
stream boolean Om värdet är true strömmas modellsvarsdata till klienten
eftersom det genereras med hjälp av server-skickade händelser.		 No False
temperature number Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt.
Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.		 No 1
text object Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. No
└– format OpenAI.ResponseTextFormatConfiguration No
tool_choice object Styr vilket (om något) verktyg som anropas av modellen.

none innebär att modellen inte anropar något verktyg och i stället genererar ett meddelande.

auto innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett eller
fler verktyg.

required innebär att modellen måste anropa ett eller flera verktyg.		 No
└– typ OpenAI.ToolChoiceObjectType Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. No
tools array En matris med verktyg som modellen kan anropa när ett svar genereras. Du
kan ange vilket verktyg som ska användas genom att ange parametern tool_choice .

De två kategorier av verktyg som du kan tillhandahålla modellen är:

- Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar
modellens funktioner, till exempel filsökning.
- Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig,
så att modellen kan anropa din egen kod.		 No
top_logprobs integer Ett heltal mellan 0 och 20 som anger antalet mest sannolika token som ska returneras vid varje tokenposition, var och en med en associerad loggsannolikhet. No
top_p number Ett alternativ till provtagning med temperatur, som kallas kärnsampling,
där modellen tar hänsyn till resultatet av token med top_p sannolikhet
massa. Så 0,1 innebär endast de token som omfattar de 10 främsta i%:s sannolikhetsmassa.
övervägs.

Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.		 No 1
truncation enum Den trunkeringsstrategi som ska användas för modellsvaret.
- auto: Om sammanhanget för det här svaret och tidigare svar överskrider
modellens kontextfönsterstorlek trunkerar modellen
svar för att anpassa till kontextfönstret genom att ta bort indataobjekt i
mitt i samtalet.
- disabled (standard): Om ett modellsvar överskrider kontextfönstret
Om storleken för en modell är felaktig, kommer begäran att misslyckas med felkod 400.
Möjliga värden: auto, disabled		 No
user string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json AzureResponse
text/event-stream OpenAI.ResponseStreamEvent

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

Skapa ett modellsvar

POST {endpoint}/openai/v1/responses?api-version=preview

Hämta svar

GET {endpoint}/openai/v1/responses/{response_id}?api-version=preview

Hämtar ett modellsvar med angivet ID.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
response_id path Yes string
include[] query No array

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json AzureResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Ta bort svar

DELETE {endpoint}/openai/v1/responses/{response_id}?api-version=preview

Tar bort ett svar med ID.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
response_id path Yes string

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json object

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Lista indataobjekt

GET {endpoint}/openai/v1/responses/{response_id}/input_items?api-version=preview

Returnerar en lista över indataobjekt för ett givet svar.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
response_id path Yes string
limit query No integer En gräns för hur många objekt som ska returneras. Gränsen kan sträcka sig mellan 1 och 100, och
standardvärdet är 20.
order query No string
Möjliga värden: asc, desc		 Sortera ordning efter created_at tidsstämpeln för objekten. asc för stigande ordning ochdesc
för fallande ordning.
after query No string En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan.
Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo
efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
before query No string En markör för användning i sidnumrering. before är ett objekt-ID som definierar din plats i listan.
Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo
efterföljande anrop kan innehålla before=obj_foo för att hämta föregående sida i listan.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.ResponseItemList

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Lista vektorlager

GET {endpoint}/openai/v1/vector_stores?api-version=preview

Returnerar en lista över vektorlager.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
limit query No integer En gräns för hur många objekt som ska returneras. Gränsen kan sträcka sig mellan 1 och 100, och
standardvärdet är 20.
order query No string
Möjliga värden: asc, desc		 Sortera ordning efter created_at tidsstämpeln för objekten. asc för stigande ordning ochdesc
för fallande ordning.
after query No string En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan.
Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo
efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
before query No string En markör för användning i sidnumrering. before är ett objekt-ID som definierar din plats i listan.
Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo
efterföljande anrop kan innehålla before=obj_foo för att hämta föregående sida i listan.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.ListVectorStoresResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Skapa vektorlager

POST {endpoint}/openai/v1/vector_stores?api-version=preview

Skapar ett vektorlager.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
chunking_strategy object Standardstrategin. Den här strategin använder för närvarande en max_chunk_size_tokens av 800 och chunk_overlap_tokens av 400. No
└– statisk OpenAI.StaticChunkingStrategy No
└– typ enum Alltid static.
Möjliga värden: static		 No
går ut efter OpenAI.VectorStoreExpirationAfter Förfalloprincipen för ett vektorlager. No
file_ids array En lista över fil-ID:t som vektorarkivet ska använda. Användbart för verktyg som file_search dessa kan komma åt filer. No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
name string Namnet på vektorarkivet. No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.VectorStoreObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Det går inte att hitta exempelfilen: ./examples/vector_stores.json

Hämta vektorarkiv

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Hämtar ett vektorlager.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
vector_store_id path Yes string ID för vektorlagringen som ska hämtas.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.VectorStoreObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Ändra vektorarkiv

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Ändrar ett vektorlager.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
vector_store_id path Yes string ID:t för vektorarkivet som ska ändras.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
går ut efter object Förfalloprincipen för ett vektorlager. No
└– fästpunkt enum Tidsstämpel för fästpunkt varefter förfalloprincipen gäller. Fästpunkter som stöds: last_active_at.
Möjliga värden: last_active_at		 No
└– dagar integer Antalet dagar efter ankartiden som vektorlagret upphör att gälla. No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
name string Namnet på vektorarkivet. No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.VectorStoreObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Ta bort vektorarkiv

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Ta bort ett vektorlager.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
vector_store_id path Yes string ID:t för vektorarkivet som ska tas bort.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.DeleteVectorStoreResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Skapa vektorlagringsfilbatch

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches?api-version=preview

Skapa en vektorlagringsfilbatch.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
vector_store_id path Yes string ID:t för vektorarkivet som du vill skapa en filbatch för.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
Egenskaper object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen. Nycklar är strängar
med en maximal längd på 64 tecken. Värden är strängar med ett maxvärde
längd på 512 tecken, booleska värden eller tal.		 No
chunking_strategy OpenAI.ChunkingStrategyRequestParam Segmenteringsstrategin som används för att segmentera filen eller filerna. Om den inte har angetts använder du auto strategin. No
file_ids array En lista över fil-ID:t som vektorarkivet ska använda. Användbart för verktyg som file_search dessa kan komma åt filer. Yes

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Hämta filbatch för vektorlagring

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=preview

Hämtar en vektorlagringsfilbatch.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
vector_store_id path Yes string ID:t för vektorarkivet som filbatchen tillhör.
batch_id path Yes string ID:t för den filbatch som hämtas.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Avbryt vektorlagringsfilsbatch

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=preview

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

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
vector_store_id path Yes string ID:t för vektorarkivet som filbatchen tillhör.
batch_id path Yes string ID:t för den filbatch som ska avbrytas.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Visa en lista över filer i batchen för vektorlager

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=preview

Returnerar en lista över vektorlagringsfiler i en batch.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
vector_store_id path Yes string ID:t för vektorarkivet som filbatchen 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 hur många objekt som ska returneras. Gränsen kan sträcka sig mellan 1 och 100, och
standardvärdet är 20.
order query No string
Möjliga värden: asc, desc		 Sortera ordning efter created_at tidsstämpeln för objekten. asc för stigande ordning ochdesc
för fallande ordning.
after query No string En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan.
Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo
efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
before query No string En markör för användning i sidnumrering. before är ett objekt-ID som definierar din plats i listan.
Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo
efterföljande anrop kan innehålla before=obj_foo för att hämta föregående sida i listan.
filter query No Filtrera efter filstatus. En av in_progress, completed, failed, cancelled.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.ListVectorStoreFilesResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Lista vektorlagringsfiler

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

Returnerar en lista över vektorlagringsfiler.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
vector_store_id path Yes string ID för vektorarkivet som filerna tillhör.
limit query No integer En gräns för hur många objekt som ska returneras. Gränsen kan sträcka sig mellan 1 och 100, och
standardvärdet är 20.
order query No string
Möjliga värden: asc, desc		 Sortera ordning efter created_at tidsstämpeln för objekten. asc för stigande ordning ochdesc
för fallande ordning.
after query No string En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan.
Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo
efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
before query No string En markör för användning i sidnumrering. before är ett objekt-ID som definierar din plats i listan.
Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo
efterföljande anrop kan innehålla before=obj_foo för att hämta föregående sida i listan.
filter query No Filtrera efter filstatus. En av in_progress, completed, failed, cancelled.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.ListVectorStoreFilesResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Skapa vektorlagringsfil

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

Skapa en vektorlagringsfil genom att bifoga en fil till ett vektorarkiv.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
vector_store_id path Yes string ID:t för vektorarkivet som du vill skapa en fil för.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
Egenskaper object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen. Nycklar är strängar
med en maximal längd på 64 tecken. Värden är strängar med ett maxvärde
längd på 512 tecken, booleska värden eller tal.		 No
chunking_strategy OpenAI.ChunkingStrategyRequestParam Segmenteringsstrategin som används för att segmentera filen eller filerna. Om den inte har angetts använder du auto strategin. No
file_id string Ett fil-ID som vektorarkivet ska använda. Användbart för verktyg som file_search dessa kan komma åt filer. Yes

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Hämta vektorlagringsfil

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

Hämtar en vektorlagringsfil.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
vector_store_id path Yes string ID:t för vektorarkivet som filen tillhör.
file_id path Yes string ID:t för filen som hämtas.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Uppdatera filattribut för vektorarkiv

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
vector_store_id path Yes string
file_id path Yes string

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
Egenskaper object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen. Nycklar är strängar
med en maximal längd på 64 tecken. Värden är strängar med ett maxvärde
längd på 512 tecken, booleska värden eller tal.		 Yes

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Ta bort vektorlagringsfil

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

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

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
vector_store_id path Yes string ID:t för vektorarkivet som filen tillhör.
file_id path Yes string ID:t för filen som ska tas bort.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json OpenAI.DeleteVectorStoreFileResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureErrorResponse

Videogenereringsjobb – Skapa

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Skapar ett nytt videogenereringsjobb.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Name Type Description Required Default
height integer Videons höjd. Följande dimensioner stöds: 480x480, 854x480, 720x720, 1280x720, 1080x1080 och 1920x1080 i både liggande och stående orienteringar. Yes
model string Namnet på distributionen som ska användas för den här begäran. Yes
n_seconds integer Varaktigheten för videogenereringsjobbet. Måste vara mellan 1 och 20 sekunder. No 5
n_variants integer Antalet videor som ska skapas som varianter för det här jobbet. Måste vara mellan 1 och 5. Mindre dimensioner tillåter fler varianter. No 1
prompt string Uppmaningen för det här videogenereringsjobbet. Yes
width integer Videons bredd. Följande dimensioner stöds: 480x480, 854x480, 720x720, 1280x720, 1080x1080 och 1920x1080 i både liggande och stående orienteringar. Yes

Begärandekropp

Innehållstyp: flera delar/formulärdata

Name Type Description Required Default
files array Yes
height integer Videons höjd. Följande dimensioner stöds: 480x480, 854x480, 720x720, 1280x720, 1080x1080 och 1920x1080 i både liggande och stående orienteringar. Yes
inpaint_items array Valfria inpainting-objekt för det här videogenereringsjobbet. No
model string Namnet på distributionen som ska användas för den här begäran. Yes
n_seconds integer Varaktigheten för videogenereringsjobbet. Måste vara mellan 1 och 20 sekunder. No 5
n_variants integer Antalet videor som ska skapas som varianter för det här jobbet. Måste vara mellan 1 och 5. Mindre dimensioner tillåter fler varianter. No 1
prompt string Uppmaningen för det här videogenereringsjobbet. Yes
width integer Videons bredd. Följande dimensioner stöds: 480x480, 854x480, 720x720, 1280x720, 1080x1080 och 1920x1080 i både liggande och stående orienteringar. Yes

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json VideoGenerationJob

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

Det går inte att hitta exempelfilen: ./examples/create_video_generation_job_simple.json

Videogenereringsjobb – lista

GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Visar en lista över videogenereringsjobb.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
before query No string
after query No string
limit query Yes integer
statuses query No array

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json VideoGenerationJobList

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

Det går inte att hitta exempelfilen: ./examples/get_video_generation_job_list.json

Videogenereringsjobb – Hämta

GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Hämtar egenskaper för ett videogenereringsjobb.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
job-id path Yes string ID för videogenereringsjobbet som ska användas för Azure OpenAI-begäran.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json VideoGenerationJob

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

Det går inte att hitta exempelfilen: ./examples/get_video_generation_job.json

Videogenereringsjobb – Ta bort

DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Tar bort ett videogenereringsjobb.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
job-id path Yes string ID för videogenereringsjobbet som ska användas för Azure OpenAI-begäran.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 204

Beskrivning: Det finns inget innehåll att skicka för den här begäran, men rubrikerna kan vara användbara.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Videogenerationer – Ladda ner

GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview

Hämtar en videogenerering efter ID.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
generation-id path Yes string ID:t för videogenerationen som ska användas för Azure OpenAI-begäran.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
application/json VideoGeneration

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

Det går inte att hitta exempelfilen: ./examples/get_video_generation.json

Videogenerering – Hämta miniatyrbild

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview

Hämtar en miniatyrbild av det genererade videoinnehållet.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
generation-id path Yes string ID:t för videogenerationen som ska användas för Azure OpenAI-begäran.

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
bild/jpg string

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Videogenerationer – Hämta videoinnehåll

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Hämtar det genererade videoinnehållet.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
generation-id path Yes string ID:t för videogenerationen som ska användas för Azure OpenAI-begäran.
quality query No

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Content-Type Type Description
video/mp4 string

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Videogenerationer – Hämta endast videoinnehållshuvuden

HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Hämtar rubriker för det genererade videoinnehållet.

URI parametrar

Name In Required Type Description
endpoint path Yes string
url		 Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
api-version query No Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran.
v1 om inget annat anges.
generation-id path Yes string ID:t för videogenerationen som ska användas för Azure OpenAI-begäran.
quality query No

Begärandehuvud

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentisering med tokenbaserad autentisering rekommenderas och säkrare.

Name Required Type Description
Authorization True string Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Typ: oauth2
Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
omfattning: https://cognitiveservices.azure.com/.default
api-key True string Ange Azure OpenAI API-nyckel här

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Components

AudioTaskLabel

Definierar möjliga beskrivningar för tillgängliga ljudåtgärdssvar.

Property Value
Description Definierar möjliga beskrivningar för tillgängliga ljudåtgärdssvar.
Type string
Values transcribe
translate

AudioTranslationSegment

Utökad information om ett enda segment med översatta ljuddata. Segment representerar vanligtvis ungefär 5–10 sekunders tal. Segmentgränser förekommer vanligtvis mellan ord men inte nödvändigtvis meningar.

Name Type Description Required Default
avg_logprob number Den genomsnittliga loggsannolikheten som är associerad med det här ljudsegmentet. Yes
compression_ratio number Komprimeringsförhållandet för det här ljudsegmentet. Yes
end number Den tid då det här segmentet slutade i förhållande till början av det översatta ljudet. Yes
id integer Det 0-baserade indexet för det här segmentet inom en översättning. Yes
no_speech_prob number Sannolikheten för ingen talidentifiering inom det här ljudsegmentet. Yes
seek integer Sökpositionen som är associerad med bearbetningen av det här ljudsegmentet.
Sökpositioner uttrycks som hundradelars sekunder.
Modellen kan bearbeta flera segment från en enda sökposition, så även om sökpositionen aldrig kommer att representera
en senare tid än segmentets start kan segmentets start representera en betydligt senare tid än
segmentets associerade sökposition.		 Yes
start number Den tid då det här segmentet startade i förhållande till början av det översatta ljudet. Yes
temperature number Temperaturpoängen som är associerad med det här ljudsegmentet. Yes
text string Den översatta texten som ingick i det här ljudsegmentet. Yes
tokens array Token-ID:t som matchar den översatta texten i det här ljudsegmentet. Yes

AzureAIFoundryModelsApiVersion

Property Value
Type string
Values v1
preview

AzureAudioTranscriptionResponse

Resultatinformation för en åtgärd som transkriberade talat ljud till skriftlig text.

Name Type Description Required Default
duration number Den totala varaktigheten för det ljud som bearbetas för att producera tillhörande transkriptionsinformation. No
language string Det talade språket som identifierades i transkriberade ljuddata.
Detta uttrycks som en iso-639-1-språkkod med två bokstäver som "en" eller "fr".		 No
segments array En samling information om tidpunkt, sannolikheter och annan information om varje bearbetat ljudsegment. No
task object Definierar möjliga beskrivningar för tillgängliga ljudåtgärdssvar. No
text string Transkriberad text för angivna ljuddata. Yes
words array En samling information om tidpunkten för varje bearbetat ord. No

AzureAudioTranslationResponse

Resultatinformation för en åtgärd som översatte talat ljud till skriftlig text.

Name Type Description Required Default
duration number Den totala varaktigheten för det ljud som bearbetas för att producera tillhörande översättningsinformation. No
language string Det talade språket som identifierades i översatta ljuddata.
Detta uttrycks som en iso-639-1-språkkod med två bokstäver som "en" eller "fr".		 No
segments array En samling information om tidpunkt, sannolikheter och annan information om varje bearbetat ljudsegment. No
task object Definierar möjliga beskrivningar för tillgängliga ljudåtgärdssvar. No
text string Den översatta texten för angivna ljuddata. Yes

AzureChatCompletionResponseMessage

Komponenten för utökad svarsmodell för chatt-svar i Azure OpenAI-tjänsten. Den här modellen lägger till stöd för kontext i chattmeddelanden, vilket används av funktionen På dina data för avsikt, citat och annan information relaterad till genomförd hämtningsförstärkt generering.

Name Type Description Required Default
annotations array Anteckningar för meddelandet, när det är tillämpligt, som när du använder
webbsökningsverktyg.		 No
audio object Om ljudutdatamodalitet begärs innehåller det här objektet data
om ljudsvaret från modellen.		 No
└– data string Base64-kodade ljudbyte som genereras av modellen, i formatet
anges i begäran.		 No
└─ utgår_vid integer Unix-tidsstämpeln (i sekunder) för när det här ljudsvaret kommer att
inte längre vara tillgänglig på servern för användning i flera svängar
Samtal.		 No
└– id string Unik identifierare för det här ljudsvaret. No
└─ avskrift string Avskrift av det ljud som genereras av modellen. No
content string Innehållet i meddelandet. Yes
context object En ytterligare egenskap, som läggs till i svarsmeddelanden om chattens slutförande, som skapas av Azure OpenAI-tjänsten när du använder
tilläggsbeteende. Detta inkluderar avsikts- och källhänvisningsinformation från funktionen På dina data.		 No
└– alla_återhämtade_dokument object Sammanfattningsinformation om dokument som hämtats av datahämtningsåtgärden. No
└– chunk_id string Segment-ID:t för källhänvisning. No
└– innehåll string Innehållet i källhänvisning. No
└– data_source_index integer Indexet för datakällan som används för hämtning. No
└– filsökväg string Filsökvägen för källhänvisning. No
└─ filter_anledning enum I förekommande fall en indikation på varför dokumentet filtrerades.
Möjliga värden: score, rerank		 No
└– original_search_score number Den ursprungliga sökpoängen för hämtningen. No
└– omvärderingspoäng number Rerank-poängen för sökningen. No
└– sökfrågor array Sökfrågorna som körs för att hämta dokument. No
└– rubrik string Rubriken för citatet. No
└— url string URL:en för källhänvisning. No
└– citat array Citaten som skapas av datahämtningen. No
└— avsikt string Den identifierade avsikten från chatthistoriken, som används för att behålla samtalskontext mellan interaktioner No
function_call object Inaktuell och ersatt av tool_calls. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen. No
└─ argument string No
└— namn string No
reasoning_content string En Azure-specifik tilläggsegenskap som innehåller genererat resonemangsinnehåll från modeller som stöds. No
refusal string Avslagsmeddelandet som genereras av modellen. Yes
role enum Rollen som författare till det här meddelandet.
Möjliga värden: assistant		 Yes
tool_calls ChatCompletionMessageToolCallsItem Verktyget anropar som genereras av modellen, till exempel funktionsanrop. No

AzureChatCompletionStreamResponseDelta

Den utökade svarsmodellen för ett strömningschattsvarsmeddelande i Azure OpenAI-tjänsten. Den här modellen lägger till stöd för kontext i chattmeddelanden, vilket används av funktionen På dina data för avsikt, citat och annan information relaterad till genomförd hämtningsförstärkt generering.

Name Type Description Required Default
audio object No
└– data string No
└─ utgår_vid integer No
└– id string No
└─ avskrift string No
content string Innehållet i segmentmeddelandet. No
context object En ytterligare egenskap, som läggs till i svarsmeddelanden om chattens slutförande, som skapas av Azure OpenAI-tjänsten när du använder
tilläggsbeteende. Detta inkluderar avsikts- och källhänvisningsinformation från funktionen På dina data.		 No
└– alla_återhämtade_dokument object Sammanfattningsinformation om dokument som hämtats av datahämtningsåtgärden. No
└– chunk_id string Segment-ID:t för källhänvisning. No
└– innehåll string Innehållet i källhänvisning. No
└– data_source_index integer Indexet för datakällan som används för hämtning. No
└– filsökväg string Filsökvägen för källhänvisning. No
└─ filter_anledning enum I förekommande fall en indikation på varför dokumentet filtrerades.
Möjliga värden: score, rerank		 No
└– original_search_score number Den ursprungliga sökpoängen för hämtningen. No
└– omvärderingspoäng number Rerank-poängen för sökningen. No
└– sökfrågor array Sökfrågorna som körs för att hämta dokument. No
└– rubrik string Rubriken för citatet. No
└— url string URL:en för källhänvisning. No
└– citat array Citaten som skapas av datahämtningen. No
└— avsikt string Den identifierade avsikten från chatthistoriken, som används för att behålla samtalskontext mellan interaktioner No
function_call object Inaktuell och ersatt av tool_calls. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen. No
└─ argument string No
└— namn string No
reasoning_content string En Azure-specifik tilläggsegenskap som innehåller genererat resonemangsinnehåll från modeller som stöds. No
refusal string Avslagsmeddelandet som genereras av modellen. No
role object Rollen som författare till ett meddelande No
tool_calls array No

AzureChatDataSource

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

Diskriminator för AzureChatDataSource

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
azure_search AzureSearchChatDataSource
azure_cosmos_db AzureCosmosDBChatDataSource
elasticsearch ElasticsearchChatDataSource
pinecone PineconeChatDataSource
mongo_db MongoDBChatDataSource
Name Type Description Required Default
type object Yes

AzureChatDataSourceAccessTokenAuthenticationOptions

Name Type Description Required Default
access_token string Yes
type enum
Möjliga värden: access_token		 Yes

AzureChatDataSourceApiKeyAuthenticationOptions

Name Type Description Required Default
key string Yes
type enum
Möjliga värden: api_key		 Yes

AzureChatDataSourceAuthenticationOptions

Diskriminerande för AzureChatDataSourceAuthenticationOptions

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
system_assigned_managed_identity AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions
user_assigned_managed_identity AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions
access_token AzureChatDataSourceAccessTokenAuthenticationOptions
connection_string AzureChatDataSourceConnectionStringAuthenticationOptions
key_and_key_id AzureChatDataSourceKeyAndKeyIdAuthenticationOptions
encoded_api_key AzureChatDataSourceEncodedApiKeyAuthenticationOptions
username_and_password AzureChatDataSourceUsernameAndPasswordAuthenticationOptions
Name Type Description Required Default
type AzureChatDataSourceAuthenticationOptionsType Yes

AzureChatDataSourceAuthenticationOptionsType

Property Value
Type string
Values api_key
username_and_password
connection_string
key_and_key_id
encoded_api_key
access_token
system_assigned_managed_identity
user_assigned_managed_identity

AzureChatDataSourceConnectionStringAuthenticationOptions

Name Type Description Required Default
connection_string string Yes
type enum
Möjliga värden: connection_string		 Yes

AzureChatDataSourceDeploymentNameVectorizationSource

Representerar en vektoriseringskälla som gör interna tjänstanrop mot en Azure OpenAI-inbäddningsmodelldistribution. Till skillnad från den slutpunktsbaserade vektoriseringskällan måste en distributionsnamnsbaserad vektoriseringskälla ingå i samma Azure OpenAI-resurs men kan användas även i privata nätverk.

Name Type Description Required Default
deployment_name string Den inbäddningsmodelldistribution som ska användas för vektorisering. Den här distributionen måste finnas inom samma Azure OpenAI
resurs som modelldistributionen som används för chattavslutningar.		 Yes
dimensions integer Antalet dimensioner som ska begäras för inbäddningar.
Stöds endast i "text-embedding-3" och senare modeller.		 No
type enum Typidentifieraren, alltid "deployment_name" för den här källtypen för vektorisering.
Möjliga värden: deployment_name		 Yes

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

Name Type Description Required Default
encoded_api_key string Yes
type enum
Möjliga värden: encoded_api_key		 Yes

AzureChatDataSourceEndpointVectorizationSource

Representerar en vektoriseringskälla som gör offentliga tjänstanrop mot en Azure OpenAI-inbäddningsmodelldistribution.

Name Type Description Required Default
authentication object Yes
└– access_token string No
└– nyckel string No
└– typ enum
Möjliga värden: access_token		 No
dimensions integer Antalet dimensioner som ska begäras för inbäddningar.
Stöds endast i "text-embedding-3" och senare modeller.		 No
endpoint string Anger resursslutpunkts-URL:en som inbäddningar ska hämtas från.
Den ska vara i följande format:
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
Frågeparametern api-version tillåts inte.		 Yes
type enum Typidentifieraren, alltid "slutpunkt" för den här källtypen för vektorisering.
Möjliga värden: endpoint		 Yes

AzureChatDataSourceIntegratedVectorizationSource

Representerar en integrerad vektoriseringskälla enligt definitionen i den stödande sökresursen.

Name Type Description Required Default
type enum Typidentifieraren, alltid "integrerad" för den här källtypen för vektorisering.
Möjliga värden: integrated		 Yes

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Name Type Description Required Default
key string Yes
key_id string Yes
type enum
Möjliga värden: key_and_key_id		 Yes

AzureChatDataSourceModelIdVectorizationSource

Representerar en vektoriseringskälla som gör tjänstanrop baserat på ett söktjänstmodell-ID. Den här källtypen stöds för närvarande endast av Elasticsearch.

Name Type Description Required Default
model_id string Bygg-ID:t för inbäddningsmodellen som ska användas för vektorisering. Yes
type enum Typidentifieraren, alltid "model_id" för den här källtypen för vektorisering.
Möjliga värden: model_id		 Yes

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

Name Type Description Required Default
type enum
Möjliga värden: system_assigned_managed_identity		 Yes

AzureChatDataSourceType

Property Value
Type string
Values azure_search
azure_cosmos_db
elasticsearch
pinecone
mongo_db

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

Name Type Description Required Default
managed_identity_resource_id string Yes
type enum
Möjliga värden: user_assigned_managed_identity		 Yes

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Name Type Description Required Default
password string Yes
type enum
Möjliga värden: username_and_password		 Yes
username string Yes

AzureChatDataSourceVectorizationSource

En representation av en datavektoriseringskälla som kan användas som en inbäddningsresurs med en datakälla.

Diskriminerande för AzureChatDataSourceVectorizationSource

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
deployment_name AzureChatDataSourceDeploymentNameVectorizationSource
integrated AzureChatDataSourceIntegratedVectorizationSource
model_id AzureChatDataSourceModelIdVectorizationSource
Name Type Description Required Default
type object Yes

AzureChatDataSourceVectorizationSourceType

Property Value
Type string
Values endpoint
deployment_name
model_id
integrated

AzureChatMessageContext

En ytterligare egenskap, som läggs till i svarsmeddelanden om chattens slutförande, som skapas av Azure OpenAI-tjänsten när tilläggsbeteende används. Detta inkluderar avsikts- och källhänvisningsinformation från funktionen På dina data.

Name Type Description Required Default
all_retrieved_documents object Sammanfattningsinformation om dokument som hämtats av datahämtningsåtgärden. No
└– chunk_id string Segment-ID:t för källhänvisning. No
└– innehåll string Innehållet i källhänvisning. No
└– data_source_index integer Indexet för datakällan som används för hämtning. No
└– filsökväg string Filsökvägen för källhänvisning. No
└─ filter_anledning enum I förekommande fall en indikation på varför dokumentet filtrerades.
Möjliga värden: score, rerank		 No
└– original_search_score number Den ursprungliga sökpoängen för hämtningen. No
└– omvärderingspoäng number Rerank-poängen för sökningen. No
└– sökfrågor array Sökfrågorna som körs för att hämta dokument. No
└– rubrik string Rubriken för citatet. No
└— url string URL:en för källhänvisning. No
citations array Citaten som skapas av datahämtningen. No
intent string Den identifierade avsikten från chatthistoriken, som används för att behålla samtalskontext mellan interaktioner No

AzureContentFilterBlocklistResult

En samling true/false-filtreringsresultat för konfigurerade anpassade blocklistor.

Name Type Description Required Default
details array Paren med enskilda blocklist-ID:er och om de resulterade i en filtreringsåtgärd. No
filtered boolean Ett värde som anger om någon av de detaljerade blocklisterna resulterade i en filtreringsåtgärd. Yes

AzureContentFilterCompletionTextSpan

En representation av ett intervall med slutförandetext som används av Azure OpenAI-innehållsfilterresultat.

Name Type Description Required Default
completion_end_offset integer Förskjutning av den första UTF32-kodpunkten som undantas från intervallet. Det här fältet är alltid lika med completion_start_offset för tomma intervall. Det här fältet är alltid större än completion_start_offset för intervall som inte är tomma. Yes
completion_start_offset integer Förskjutning av UTF32-kodpunkten som börjar intervallet. Yes

AzureContentFilterCompletionTextSpanDetectionResult

Name Type Description Required Default
details array Detaljerad information om det identifierade slutförandetextintervallet. Yes
detected boolean Om den etiketterade innehållskategorin identifierades i innehållet. Yes
filtered boolean Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd. Yes

AzureContentFilterCustomTopicResult

En samling sant/falskt filtreringsresultat för konfigurerade anpassade ämnen.

Name Type Description Required Default
details array Paren med enskilda ämnes-ID:er och om de identifieras. No
filtered boolean Ett värde som anger om något av de detaljerade ämnena resulterade i en filtreringsåtgärd. Yes

AzureContentFilterDetectionResult

Ett resultatobjekt med etiketterat innehållsfilter som anger om innehållet har identifierats och om innehållet har filtrerats.

Name Type Description Required Default
detected boolean Om den etiketterade innehållskategorin identifierades i innehållet. Yes
filtered boolean Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd. Yes

AzureContentFilterImagePromptResults

Resultatet av ett innehållsfilter för innehållsinmatningen vid en bildgenereringsprocess.

Name Type Description Required Default
custom_blocklists object En samling true/false-filtreringsresultat för konfigurerade anpassade blocklistor. No
└— detaljer array Paren med enskilda blocklist-ID:er och om de resulterade i en filtreringsåtgärd. No
└– filtrerad boolean Ett värde som anger om någon av de detaljerade blocklisterna resulterade i en filtreringsåtgärd. No
custom_topics object En samling sant/falskt filtreringsresultat för konfigurerade anpassade ämnen. No
└— detaljer array Paren med enskilda ämnes-ID:er och om de identifieras. No
└– filtrerad boolean Ett värde som anger om något av de detaljerade ämnena resulterade i en filtreringsåtgärd. No
jailbreak object Ett etikettinnehållsfilterresultatobjekt som anger om innehållet har upptäckts och om innehållet har identifierats
filtrerad.		 Yes
└— har identifierats boolean Om den etiketterade innehållskategorin identifierades i innehållet. No
└– filtrerad boolean Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd. No
profanity object Ett etikettinnehållsfilterresultatobjekt som anger om innehållet har upptäckts och om innehållet har identifierats
filtrerad.		 No
└— har identifierats boolean Om den etiketterade innehållskategorin identifierades i innehållet. No
└– filtrerad boolean Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd. No

AzureContentFilterImageResponseResults

Ett innehållsfilterresultat för en bildgenereringsåtgärds utdatasvarsinnehåll.

Name Type Description Required Default
hate object Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är.
Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.		 No
└– filtrerad boolean Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd. No
└– allvarlighetsgrad enum Innehållets etiketterade allvarlighetsgrad.
Möjliga värden: safe, low, medium, high		 No
self_harm object Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är.
Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.		 No
└– filtrerad boolean Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd. No
└– allvarlighetsgrad enum Innehållets etiketterade allvarlighetsgrad.
Möjliga värden: safe, low, medium, high		 No
sexual object Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är.
Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.		 No
└– filtrerad boolean Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd. No
└– allvarlighetsgrad enum Innehållets etiketterade allvarlighetsgrad.
Möjliga värden: safe, low, medium, high		 No
violence object Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är.
Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.		 No
└– filtrerad boolean Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd. No
└– allvarlighetsgrad enum Innehållets etiketterade allvarlighetsgrad.
Möjliga värden: safe, low, medium, high		 No

AzureContentFilterResultForChoice

Ett innehållsfilterresultat för ett enda svarsobjekt som skapats av ett generativt AI-system.

Name Type Description Required Default
custom_blocklists object En samling true/false-filtreringsresultat för konfigurerade anpassade blocklistor. No
└— detaljer array Paren med enskilda blocklist-ID:er och om de resulterade i en filtreringsåtgärd. No
└– filtrerad boolean Ett värde som anger om någon av de detaljerade blocklisterna resulterade i en filtreringsåtgärd. No
custom_topics object En samling sant/falskt filtreringsresultat för konfigurerade anpassade ämnen. No
└— detaljer array Paren med enskilda ämnes-ID:er och om de identifieras. No
└– filtrerad boolean Ett värde som anger om något av de detaljerade ämnena resulterade i en filtreringsåtgärd. No
error object Om det finns information om ett fel som hindrade innehållsfiltrering från att slutföra utvärderingen. No
└– kod integer En distinkt, maskinläsbar kod som är associerad med felet. No
└– meddelande string Ett läsbart meddelande som är associerat med felet. No
hate object Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är.
Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.		 No
└– filtrerad boolean Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd. No
└– allvarlighetsgrad enum Innehållets etiketterade allvarlighetsgrad.
Möjliga värden: safe, low, medium, high		 No
profanity object Ett etikettinnehållsfilterresultatobjekt som anger om innehållet har upptäckts och om innehållet har identifierats
filtrerad.		 No
└— har identifierats boolean Om den etiketterade innehållskategorin identifierades i innehållet. No
└– filtrerad boolean Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd. No
protected_material_code object Ett identifieringsresultat som beskriver en matchning mot licensierad kod eller annat skyddat källmaterial. No
└— citat object Om det är tillgängligt beskriver källhänvisningsinformationen den associerade licensen och dess plats. No
└– URL string URL:en som är associerad med licensen. No
└─ licens string Namnet eller ID för den licens som är associerad med upptäckten. No
└— har identifierats boolean Om den etiketterade innehållskategorin identifierades i innehållet. No
└– filtrerad boolean Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd. No
protected_material_text object Ett etikettinnehållsfilterresultatobjekt som anger om innehållet har upptäckts och om innehållet har identifierats
filtrerad.		 No
└— har identifierats boolean Om den etiketterade innehållskategorin identifierades i innehållet. No
└– filtrerad boolean Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd. No
self_harm object Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är.
Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.		 No
└– filtrerad boolean Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd. No
└– allvarlighetsgrad enum Innehållets etiketterade allvarlighetsgrad.
Möjliga värden: safe, low, medium, high		 No
sexual object Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är.
Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.		 No
└– filtrerad boolean Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd. No
└– allvarlighetsgrad enum Innehållets etiketterade allvarlighetsgrad.
Möjliga värden: safe, low, medium, high		 No
ungrounded_material AzureContentFilterCompletionTextSpanDetectionResult No
violence object Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är.
Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.		 No
└– filtrerad boolean Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd. No
└– allvarlighetsgrad enum Innehållets etiketterade allvarlighetsgrad.
Möjliga värden: safe, low, medium, high		 No

AzureContentFilterResultForPrompt

Ett resultat av ett innehållsfilter som är associerat med ett enda indatameddelandeobjekt i ett generativt AI-system.

Name Type Description Required Default
content_filter_results object Detaljer om innehållsfilterkategorier för resultatet. No
└– anpassade_blocklistor object En samling true/false-filtreringsresultat för konfigurerade anpassade blocklistor. No
└— detaljer array Paren med enskilda blocklist-ID:er och om de resulterade i en filtreringsåtgärd. No
└– filtrerad boolean Ett värde som anger om någon av de detaljerade blocklisterna resulterade i en filtreringsåtgärd. No
└– custom_topics object En samling sant/falskt filtreringsresultat för konfigurerade anpassade ämnen. No
└— detaljer array Paren med enskilda ämnes-ID:er och om de identifieras. No
└– filtrerad boolean Ett värde som anger om något av de detaljerade ämnena resulterade i en filtreringsåtgärd. No
└– fel object Om det finns information om ett fel som hindrade innehållsfiltrering från att slutföra utvärderingen. No
└– kod integer En distinkt, maskinläsbar kod som är associerad med felet. No
└– meddelande string Ett läsbart meddelande som är associerat med felet. No
└─ hatar object Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är.
Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.		 No
└– filtrerad boolean Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd. No
└– allvarlighetsgrad enum Innehållets etiketterade allvarlighetsgrad.
Möjliga värden: safe, low, medium, high		 No
└– indirekt_attack object Ett etikettinnehållsfilterresultatobjekt som anger om innehållet har upptäckts och om innehållet har identifierats
filtrerad.		 No
└— har identifierats boolean Om den etiketterade innehållskategorin identifierades i innehållet. No
└– filtrerad boolean Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd. No
└– jailbreak object Ett etikettinnehållsfilterresultatobjekt som anger om innehållet har upptäckts och om innehållet har identifierats
filtrerad.		 No
└— har identifierats boolean Om den etiketterade innehållskategorin identifierades i innehållet. No
└– filtrerad boolean Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd. No
└— svordomar object Ett etikettinnehållsfilterresultatobjekt som anger om innehållet har upptäckts och om innehållet har identifierats
filtrerad.		 No
└— har identifierats boolean Om den etiketterade innehållskategorin identifierades i innehållet. No
└– filtrerad boolean Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd. No
└─ självskada object Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är.
Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.		 No
└– filtrerad boolean Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd. No
└– allvarlighetsgrad enum Innehållets etiketterade allvarlighetsgrad.
Möjliga värden: safe, low, medium, high		 No
└— sexuellt object Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är.
Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.		 No
└– filtrerad boolean Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd. No
└– allvarlighetsgrad enum Innehållets etiketterade allvarlighetsgrad.
Möjliga värden: safe, low, medium, high		 No
└– våld object Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är.
Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.		 No
└– filtrerad boolean Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd. No
└– allvarlighetsgrad enum Innehållets etiketterade allvarlighetsgrad.
Möjliga värden: safe, low, medium, high		 No
prompt_index integer Indexet för indataprompten som är associerad med de tillhörande innehållsfilterresultatkategorierna. No

AzureContentFilterSeverityResult

Ett resultatobjekt med etiketterat innehållsfilter som anger om innehållet har filtrerats och vilken kvalitativ allvarlighetsgrad innehållet var, enligt utvärderingen mot innehållsfilterkonfigurationen för kategorin.

Name Type Description Required Default
filtered boolean Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd. Yes
severity enum Innehållets etiketterade allvarlighetsgrad.
Möjliga värden: safe, low, medium, high		 Yes

AzureCosmosDBChatDataSource

Representerar en konfiguration av datakällan som ska använda en Azure CosmosDB-resurs.

Name Type Description Required Default
parameters object Parameterinformationen för att styra användningen av Azure CosmosDB-datakällan. Yes
└– allow_partial_result boolean Om värdet är true tillåter systemet att partiella sökresultat används och begäran misslyckas om alla
Delvisa sökfrågor misslyckas. Om det inte anges eller anges som falskt misslyckas begäran om någon sökfråga misslyckas.		 No False
└– autentisering AzureChatDataSourceConnectionStringAuthenticationOptions No
└– container_name string No
└– databasnamn string No
└─ inbäddningsberoende AzureChatDataSourceVectorizationSource En representation av en datavektoriseringskälla som kan användas som en inbäddningsresurs med en datakälla. No
└– fields_mapping object No
└– innehållsfält array No
└– content_fields_separator string No
└– filepath_field string No
└– title_field string No
└– url_field string No
└– vector_fields array No
└– in_scope boolean Om frågor ska begränsas till användning av indexerade data. No
└– include_contexts array Egenskaperna för utdatakontexten som ska inkluderas i svaret.
Som standard begärs citat och avsikt.		 No ['citat', 'avsikt']
└– index_namn string No
└─ max_sökfrågor integer Det maximala antalet omskrivna frågor som ska skickas till sökprovidern för ett meddelande från en enskild användare.
Som standard gör systemet en automatisk bestämning.		 No
└– strikthet integer Den konfigurerade strängheten för sökrelevansfiltreringen.
Högre strikthet kommer att öka precisionen men minska återkallningen av svaret.		 No
└top_n_documents integer Det konfigurerade antalet dokument som ska visas i frågan. No
type enum Den diskriminerade typidentifieraren, som alltid är "azure_cosmos_db".
Möjliga värden: azure_cosmos_db		 Yes

AzureCreateChatCompletionRequest

Den utökade begärandemodellen för chattavslut mot Azure OpenAI-tjänsten. Detta lägger till möjligheten att tillhandahålla datakällor för funktionen På dina data.

Name Type Description Required Default
audio object Parametrar för ljudutdata. Krävs när ljudutdata begärs med
modalities: ["audio"].		 No
└– format enum Anger utdataljudformatet. Måste vara en av wav, mp3, flac,
opus, eller pcm16.
Möjliga värden: wav, aac, mp3, flac, , opuspcm16		 No
└– röst object No
data_sources array De datakällor som ska användas för funktionen 'On Your Data', exklusivt i Azure OpenAI. No
frequency_penalty number Tal mellan -2.0 och 2.0. Positiva värden straffar nya tokens baserat på
den befintliga frekvensen i texten hittills, vilket resulterar i att modellens frekvens minskas
sannolikhet att upprepa samma rad ordagrant.		 No 0
function_call enum Om du anger en viss funktion via {"name": "my_function"} tvingar modellen att anropa den funktionen.
Möjliga värden: none, auto		 No
functions array Inaktuell 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 angivna token visas i slutförandet.

Accepterar ett JSON-objekt som mappar token (anges av deras token-ID i
tokenizer) till ett associerat bias-värde från -100 till 100. Matematiskt
bias läggs till i de logits som genereras av modellen före sampling.
Den exakta effekten varierar per modell, men värden mellan -1 och 1 bör
minska eller öka sannolikheten för urval. värden som -100 eller 100
bör leda till ett förbud eller ett specifikt val av relevant markör.		 No None
logprobs boolean Om du vill returnera loggannolikheter för utdatatoken eller inte. Om sant,
returnerar de logaritmiska sannolikheterna för varje utdatatoken som returneras i
content av message.		 No False
max_completion_tokens integer En övre gräns för antalet token som kan genereras för en
komplettering, inklusive synliga utdatatoken och slutledningstoken.		 No
max_tokens integer Det maximala antalet token som kan genereras i chattens slutförande.
Det här värdet kan användas för att styra kostnader för text som genereras via API.

Det här värdet är nu inaktuellt till förmån för max_completion_tokens, och det är
inte kompatibel med o1-seriemodeller.		 No
messages array En lista över meddelanden som består av konversationen hittills. Beroende på vilken
Olika meddelandetyper (modaliteter) stöds beroende på vilken modell du använder.
som text, bilder och ljud.		 Yes
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
modalities object 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. Så här begär du att den här modellen ska generera
både text- och ljudsvar kan du använda:

["text", "audio"]		 No
model string Modellimplementeringsidentifikatorn som ska användas för begäran om slutförande av chatten. Yes
n integer Hur många alternativ för chattavslut som ska genereras för varje indatameddelande. Observera att du debiteras baserat på antalet genererade token för alla alternativ. Behåll n för 1 att minimera kostnaderna. No 1
parallel_tool_calls object Om du vill aktivera parallell funktionsanrop under verktygsanvändning. No
prediction object Basrepresentation av förutsagda utdata från en modell. No
└– typ OpenAI.ChatOutputPredictionType No
presence_penalty number Tal mellan -2.0 och 2.0. Positiva värden straffar nya tokens baserat på
om de visas i texten hittills, vilket ökar modellens sannolikhet
för att prata om nya ämnen.		 No 0
reasoning_effort object Endast o-seriemodeller

Begränsar arbetet med resonemang för resonemangsmodeller.
Värden som stöds för närvarande är low, mediumoch high. Minska
Ansträngning i resonemang kan leda till snabbare svar och färre token som används
om resonemang i ett svar.		 No
response_format object No
└– typ enum
Möjliga värden: text, json_object, json_schema		 No
seed integer Den här funktionen finns i Beta.
Om det anges gör vårt system bästa för att sampla deterministiskt, så att upprepade begäranden med samma seed och parametrar ska returnera samma resultat.
Determinism är inte garanterad och du bör referera till parametern system_fingerprint svar för att övervaka ändringar i serverdelen.		 No
stop object Stöds inte med de senaste resonemangsmodellerna o3 och o4-mini.

Upp till 4 sekvenser där API:et slutar generera ytterligare token. Filtypen
returnerad text innehåller inte stoppsekvensen.		 No
store boolean Om man ska lagra utdata från denna chattens slutförandebegäran eller inte
användning i modelldestillation eller utvärderingsprodukter.		 No False
stream boolean Om värdet är true strömmas modellsvarsdata till klienten
eftersom det genereras med hjälp av server-skickade händelser.		 No False
stream_options object Alternativ för strömningssvar. Ange endast detta när du anger stream: true. No
└– inkludera_användning boolean Om det anges strömmas ytterligare ett segment före data: [DONE]
-meddelande. Fältet usage i det här segmentet visar tokenanvändningsstatistiken
för hela begäran, och fältet choices kommer alltid att vara tomt
samling.

Alla andra segment kommer också att innehålla ett usage fält, men med en null
värde. NOTERA: Om strömningen avbryts kanske du inte får
slutligt användningssegment som innehåller den totala tokenanvändningen för begäran.		 No
temperature number Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt.
Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.		 No 1
tool_choice OpenAI.ChatCompletionToolChoiceOption Styr vilket (om något) verktyg som anropas av modellen.
none innebär att modellen inte anropar något verktyg och i stället genererar ett meddelande.
auto innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett eller flera verktyg.
required innebär att modellen måste anropa ett eller flera verktyg.
Att ange ett visst verktyg via {"type": "function", "function": {"name": "my_function"}} tvingar modellen att anropa verktyget.

none är standard när inga verktyg finns. auto är standardvärdet om det finns verktyg.		 No
tools array En lista över verktyg som modellen kan anropa. För närvarande stöds endast funktioner som ett verktyg. Använd detta för att ange en lista över funktioner som modellen kan generera JSON-indata för. Högst 128 funktioner stöds. No
top_logprobs integer Ett heltal mellan 0 och 20 som anger antalet mest sannolika token som ska returneras vid varje tokenposition, var och en med en associerad loggsannolikhet. No
top_p number Ett alternativ till provtagning med temperatur, som kallas kärnsampling,
där modellen tar hänsyn till resultatet av token med top_p sannolikhet
massa. Så 0,1 innebär endast de token som omfattar de 10 främsta i%:s sannolikhetsmassa.
övervägs.

Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.		 No 1
user string En unik identifierare som representerar slutanvändaren, vilket kan hjälpa dig att
övervaka och upptäcka missbruk.		 No
user_security_context AzureUserSecurityContext Användarsäkerhetskontexten innehåller flera parametrar som beskriver själva programmet och slutanvändaren som interagerar med programmet. De här fälten hjälper dina säkerhetsteam att undersöka och minimera säkerhetsincidenter genom att tillhandahålla en omfattande metod för att skydda dina AI-program. Läs mer om att skydda AI-program med hjälp av Microsoft Defender för molnet. No

AzureCreateChatCompletionResponse

Den utökade modellen för att slutföra konversationer på högsta nivå för Azure OpenAI-tjänsten. Den här modellen lägger till anteckningar för innehållsfilter för ansvarsfull AI till promptens indata.

Name Type Description Required Default
choices array 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 slutförande. Yes
model string Modellen som används för chattens slutförande. Yes
object enum Objekttypen, som alltid chat.completionär .
Möjliga värden: chat.completion		 Yes
prompt_filter_results array De anteckningar om ansvarsfulla AI-innehållsfilter som är kopplade till inmatningar i fullständiga chattmeddelanden. No
system_fingerprint string Det här fingeravtrycket representerar serverdelskonfigurationen som modellen körs med.

Kan användas tillsammans med parametern seed för begäran för att förstå när serverdelsändringar har gjorts som kan påverka determinismen.		 No
usage OpenAI.CompletionUsage Användningsstatistik för slutförandebegäran. No

AzureCreateChatCompletionStreamResponse

Name Type Description Required Default
choices array En lista över alternativ för chattens slutförande. Kan innehålla fler än ett element om n det är större än 1. Kan också lämnas tom för
sista delen om du anger stream_options: {"include_usage": true}.		 Yes
content_filter_results AzureContentFilterResultForChoice Ett innehållsfilterresultat för ett enda svarsobjekt som skapats av ett generativt AI-system. No
created integer Unix-tidsstämpeln (i sekunder) för när chatten slutfördes skapades. Varje segment har samma tidsstämpel. Yes
delta AzureChatCompletionStreamResponseDelta Den utökade svarsmodellen för ett strömningschattsvarsmeddelande i Azure OpenAI-tjänsten.
Den här modellen lägger till stöd för kontext i chattmeddelanden, som används av funktionen På dina data för avsikt, hänvisningar och annat.
information som rör hämtning av utökad generering som utförts.		 No
id string En unik identifierare för chattens slutförande. Varje segment har samma ID. Yes
model string Modellen som ska generera slutförandet. Yes
object enum Objekttypen, som alltid chat.completion.chunkär .
Möjliga värden: chat.completion.chunk		 Yes
system_fingerprint string Det här fingeravtrycket representerar serverdelskonfigurationen som modellen körs med.
Kan användas tillsammans med parametern seed för begäran för att förstå när serverdelsändringar har gjorts som kan påverka determinismen.		 No
usage object Användningsstatistik för slutförandebegäran. No
└– completion_tokens integer Antal token i det genererade slutförandet. No 0
└– slutförandetoken_detaljer object Uppdelning av token som används i en slutförande. No
└– accepted_prediction_tokens integer När du använder förutsagda utdata, antalet token i
förutsägelse som dök upp i textpåfyllningen.		 No 0
└– ljud_tokens integer Ljudindatatoken som genereras av modellen. No 0
└– reasoning_tokens integer Token som genereras av modellen för resonemang. No 0
└─ avvisade_predikteringstokens integer När du använder förutsagda utdata, antalet token i
förutsägelse som inte framkom i slutförandet. Men precis som
Resonemangstoken räknas, och dessa token ingår fortfarande i det totala antalet.
slutförandetoken för fakturering, utdata och kontextfönster
Gränser.		 No 0
└– prompt_tokens integer Antal token i prompten. No 0
└– prompt_tokens_details object Uppdelning av element som används i prompten. No
└– ljud_tokens integer Ljudindatatoken som finns i prompten. No 0
└– cached_tokens integer Cachelagrade tokens som finns i ledtexten. No 0
└– totalt_antal_tokenar integer Totalt antal token som används i begäran (fråga + slutförande). No 0

AzureCreateEmbeddingRequest

Name Type Description Required Default
dimensions integer Antalet dimensioner som resulterande inbäddningar av utdata ska ha. Stöds endast i text-embedding-3 och senare modeller. No
encoding_format enum Formatet för att returnera inbäddningarna i. Kan vara antingen float eller base64.
Möjliga värden: float, base64		 No
input sträng eller matris Yes
model string Den modell som ska användas för inbäddningsbegäran. Yes
user string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. No

AzureCreateFileRequestMultiPart

Name Type Description Required Default
går ut efter object Yes
└– fästpunkt AzureFileExpiryAnchor No
└– sekunder integer No
file string Yes
avsikt enum Det avsedda syftet med den uppladdade filen. En av: - assistants: Används i API:et Assistants – batch: Används i Batch-API:et – fine-tune: Används för finjustering – evals: Används för eval-datauppsättningar
Möjliga värden: assistants, batch, fine-tune, evals		 Yes

AzureCreateImageEditRequestMultiPart

Name Type Description Required Default
background enum Gör att du kan ange transparens för bakgrunden för de genererade avbildningarna.
Den här parametern stöds endast för gpt-image-1. Måste vara en av
transparent, opaque eller auto (standardvärde). När auto används
kommer modellen automatiskt att fastställa den bästa bakgrunden för bilden.

Om transparentmåste utdataformatet ha stöd för transparens, så det
ska anges till antingen png (standardvärde) eller webp.
Möjliga värden: transparent, opaque, auto		 No
image sträng eller matris Yes
mask string No
model string Modellimplementeringen att använda för bildredigeringsoperationen. Yes
n integer Antalet bilder som ska genereras. Måste vara mellan 1 och 10. No 1
output_compression integer Komprimeringsnivån (0–100%) för de genererade bilderna. Den här parametern
stöds endast för gpt-image-1 med webp eller jpeg utdata
format och standardvärdet är 100.		 No 100
output_format enum Formatet där de genererade bilderna returneras. Den här parametern är
stöds endast för gpt-image-1. Måste vara en av png, jpegeller webp.
Standardvärdet är png.
Möjliga värden: png, jpeg, webp		 No
prompt string En textbeskrivning av de önskade bilderna. Den maximala längden är 1 000 tecken för dall-e-2och 32 000 tecken för gpt-image-1. Yes
quality enum Kvaliteten på den bild som ska genereras. highoch mediumlow stöds endast för gpt-image-1. dall-e-2 stöder endast standard-kvalitet. Standardinställningen är auto.
Möjliga värden: standard, low, medium, , highauto		 No
response_format enum Formatet där de genererade bilderna returneras. Måste vara en av url eller b64_json. URL:er är endast giltiga i 60 minuter efter att avbildningen har genererats. Den här parametern stöds bara för dall-e-2, vilket gpt-image-1 alltid returnerar base64-kodade bilder.
Möjliga värden: url, b64_json		 No
size enum Storleken på de genererade bilderna. Måste vara ett av 1024x1024, 1536x1024 (liggande), 1024x1536 (stående) eller auto (standardvärde) för gpt-image-1, och ett av 256x256, 512x512eller 1024x1024 för dall-e-2.
Möjliga värden: 256x256, 512x512, 1024x1024, 1536x1024, , 1024x1536auto		 No
user string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. No

AzureCreateImageRequest

Name Type Description Required Default
background enum Gör att du kan ange transparens för bakgrunden för de genererade avbildningarna.
Den här parametern stöds endast för gpt-image-1. Måste vara en av
transparent, opaque eller auto (standardvärde). När auto används
kommer modellen automatiskt att fastställa den bästa bakgrunden för bilden.

Om transparentmåste utdataformatet ha stöd för transparens, så det
ska anges till antingen png (standardvärde) eller webp.
Möjliga värden: transparent, opaque, auto		 No
model string Den valda modellen som ska användas för att generera bilder. Yes
moderation enum Kontrollera innehållsmodereringsnivån för bilder som genereras av gpt-image-1. Måste vara antingen low för mindre restriktiv filtrering eller auto (standardvärde).
Möjliga värden: low, auto		 No
n integer Antalet bilder som ska genereras. Måste vara mellan 1 och 10. För dall-e-3stöds endast n=1 . No 1
output_compression integer Komprimeringsnivån (0–100%) för de genererade bilderna. Den här parametern stöds endast för gpt-image-1 med utdataformaten webp eller jpeg och är som standard 100. No 100
output_format enum Formatet där de genererade bilderna returneras. Den här parametern stöds endast för gpt-image-1. Måste vara en av png, jpegeller webp.
Möjliga värden: png, jpeg, webp		 No
prompt string En textbeskrivning av de önskade bilderna. Den maximala längden är 32 000 tecken för gpt-image-1, 1 000 tecken för dall-e-2 och 4 000 tecken för dall-e-3. Yes
quality enum Kvaliteten på den bild som ska genereras.

- auto (standardvärde) väljer automatiskt den bästa kvaliteten för den angivna modellen.
- highoch mediumlow stöds för gpt-image-1.
- hd och standard stöds för dall-e-3.
- standard är det enda alternativet för dall-e-2.
Möjliga värden: standard, hd, low, medium, , highauto		 No
response_format enum Formatet där genererade bilder med dall-e-2 och dall-e-3 returneras. Måste vara en av url eller b64_json. URL:er är endast giltiga i 60 minuter efter att avbildningen har genererats. Den här parametern stöds inte som gpt-image-1 alltid returnerar base64-kodade bilder.
Möjliga värden: url, b64_json		 No
size enum Storleken på de genererade bilderna. Måste vara en av 1024x1024, 1536x1024 (liggande), 1024x1536 (stående) eller auto (standardvärde) för gpt-image-1, en av 256x256, 512x512, eller 1024x1024 för dall-e-2, och en av 1024x1024, 1792x1024eller 1024x1792 för dall-e-3.
Möjliga värden: auto, 1024x1024, 1536x1024, 1024x1536, 256x256, 512x512, , , 1792x10241024x1792		 No
style enum Formatmallen för de genererade bilderna. Den här parametern stöds endast för dall-e-3. Måste vara en av vivid eller natural. Livfullhet gör att modellen tenderar att generera hyperreella och dramatiska bilder. Naturlighet gör att modellen producerar mer naturliga och mindre hyperrealistiska bilder.
Möjliga värden: vivid, natural		 No
user string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. No

AzureCreateResponse

Name Type Description Required Default
background boolean Om modellsvaret ska köras i bakgrunden. No False
include array Ange ytterligare utdata som ska inkluderas i modellsvaret. För närvarande
värden som stöds är:
- code_interpreter_call.outputs: Innehåller utdata från python-kodkörning
i kodtolkarverktyget anropar objekt.
- computer_call_output.output.image_url: Inkludera bild-URL:er från datorns anropsresultat.
- file_search_call.results: Inkludera sökresultaten för
anropet till filsökningsverktyget.
- message.input_image.image_url: Inkludera bild-URL:er från indatameddelandet.
- message.output_text.logprobs: Inkludera logprobs med assistentmeddelanden.
- reasoning.encrypted_content: Innehåller en krypterad version av resonemanget
token i utdata för resonemangsobjekt. Detta gör det möjligt att använda resonemangsobjekt i
Flervändiga konversationer när du använder respons-API:et tillståndslöst (till exempel
när parametern store är inställd på false, eller när en organisation är
registrerats i programmet för ingen datalagring.		 No
input sträng eller matris No
instructions string Ett systemmeddelande (eller utvecklarmeddelande) som infogats i modellens kontext.

När du använder detta tillsammans med previous_response_id, anvisningarna från en tidigare
svaret kommer inte att överföras till nästa svar. Detta gör det enkelt
för att växla ut systemmeddelanden (eller utvecklarmeddelanden) i nya svar.		 No
max_output_tokens integer En övre gräns för antalet token som kan genereras för ett svar, inklusive synliga utdatatoken och resonemangstoken No
max_tool_calls integer Det maximala antalet totala anrop till inbyggda verktyg som kan bearbetas i ett svar. Det här maximala antalet gäller för alla inbyggda verktygsanrop, inte per enskilt verktyg. Eventuella ytterligare försök att anropa ett verktyg av modellen ignoreras. No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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 Implementeringen av modellen som ska användas för att skapa det här svaret. Yes
parallel_tool_calls boolean Om modellen ska kunna köra verktygsanrop parallellt. No True
previous_response_id string Det unika ID:t för föregående svar på modellen. Använd detta för att
skapa flerstegskonversationer		 No
prompt object Referens till en promptmall och dess variabler. No
└– id string Den unika identifieraren för den promptmall som ska användas. No
└– variabler OpenAI.ResponsePromptVariables Valfri mappning av värden att ersätta med variabler i din
datorn. Ersättningsvärdena kan antingen vara strängar eller andra
Svarsindatatyper som bilder eller filer.		 No
└— version string Valfri version av promptmallen. No
reasoning object Endast o-seriemodeller

Konfigurationsalternativ för resonemangsmodeller.		 No
└— insats OpenAI.ReasoningEffort Endast o-seriemodeller

Begränsar arbetet med resonemang för resonemangsmodeller.
Värden som stöds för närvarande är low, mediumoch high. Minska
Ansträngning i resonemang kan leda till snabbare svar och färre token som används
om resonemang i ett svar.		 No
└– generate_summary enum Inaktuell: använd summary i stället.

En sammanfattning av det resonemang som utförs av modellen. Detta kan vara
användbart för att felsöka och förstå modellens resonemangsprocess.
En av auto, conciseeller detailed.
Möjliga värden: auto, concise, detailed		 No
└— sammanfattning enum En sammanfattning av det resonemang som utförs av modellen. Detta kan vara
användbart för att felsöka och förstå modellens resonemangsprocess.
En av auto, conciseeller detailed.
Möjliga värden: auto, concise, detailed		 No
store boolean Om du vill lagra det genererade modellsvaret för senare hämtning via
API		 No True
stream boolean Om värdet är true strömmas modellsvarsdata till klienten
eftersom det genereras med hjälp av server-skickade händelser.		 No False
temperature number Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt.
Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.		 No 1
text object Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. No
└– format OpenAI.ResponseTextFormatConfiguration No
tool_choice object Styr vilket (om något) verktyg som anropas av modellen.

none innebär att modellen inte anropar något verktyg och i stället genererar ett meddelande.

auto innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett eller
fler verktyg.

required innebär att modellen måste anropa ett eller flera verktyg.		 No
└– typ OpenAI.ToolChoiceObjectType Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. No
tools array En matris med verktyg som modellen kan anropa när ett svar genereras. Du
kan ange vilket verktyg som ska användas genom att ange parametern tool_choice .

De två kategorier av verktyg som du kan tillhandahålla modellen är:

- Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar
modellens funktioner, till exempel filsökning.
- Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig,
så att modellen kan anropa din egen kod.		 No
top_logprobs integer Ett heltal mellan 0 och 20 som anger antalet mest sannolika token som ska returneras vid varje tokenposition, var och en med en associerad loggsannolikhet. No
top_p number Ett alternativ till provtagning med temperatur, som kallas kärnsampling,
där modellen tar hänsyn till resultatet av token med top_p sannolikhet
massa. Så 0,1 innebär endast de token som omfattar de 10 främsta i%:s sannolikhetsmassa.
övervägs.

Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.		 No 1
truncation enum Den trunkeringsstrategi som ska användas för modellsvaret.
- auto: Om sammanhanget för det här svaret och tidigare svar överskrider
modellens kontextfönsterstorlek trunkerar modellen
svar för att anpassa till kontextfönstret genom att ta bort indataobjekt i
mitt i samtalet.
- disabled (standard): Om ett modellsvar överskrider kontextfönstret
Om storleken för en modell är felaktig, kommer begäran att misslyckas med felkod 400.
Möjliga värden: auto, disabled		 No
user string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. No

AzureCreateSpeechRequestMultiPart

En representation av de begärandealternativ som styr beteendet för en text-till-tal-åtgärd.

Name Type Description Required Default
input string Texten som ljud ska genereras för. Den maximala längden är 4 096 tecken. Yes
instructions string Kontrollera rösten för ditt genererade ljud med ytterligare instruktioner. Fungerar inte med tts-1 eller tts-1-hd. No
model string Den modell som ska användas för den här text-till-tal-begäran. Yes
response_format object De ljudutdataformat som stöds för text till tal. No
speed number Talhastigheten för genererat ljud. Värdena är giltiga i intervallet från 0,25 till 4,0, med 1,0 standardvärden och högre värden som motsvarar snabbare tal. No 1
stream_format enum Formatet för att strömma ljudet i. Format som stöds är sse och audio. sse stöds inte för tts-1 eller tts-1-hd.
Möjliga värden: sse, audio		 No
voice object Yes

AzureCreateTranscriptionRequestMultiPart

Konfigurationsinformationen för en begäran om ljudavskrift.

Name Type Description Required Default
chunking_strategy object No
└– prefix_padding_ms integer Mängden ljud som ska inkluderas innan detekteringen av VAD-tal (i sekunder)
millisekunder).		 No 300
└ silence_duration_ms integer Varaktighet för tystnad för att identifiera talstopp (i millisekunder).
Med kortare värden svarar modellen snabbare.
men kan hoppa in under korta pauser från användaren.		 No 200
└– tröskelvärde number Känslighetströskel (0,0 till 1,0) för identifiering av röstaktivitet. A
högre tröskelvärde kräver högre ljud för att aktivera modellen, och
kan därför fungera bättre i bullriga miljöer.		 No 0.5
└– typ enum Måste anges till server_vad för att aktivera manuell segmentering med hjälp av VAD på serversidan.
Möjliga värden: server_vad		 No
file string Yes
filename string Det valfria filnamnet eller den beskrivande identifieraren som ska associeras med ljuddata. No
include[] array Ytterligare information som ska ingå i transkriptionssvaret.
logprobs returnerar loggannolikorna för token i
svar för att förstå modellens förtroende för transkriptionen.
logprobs fungerar endast med response_format inställt på json och endast med
modellerna gpt-4o-transcribe, gpt-4o-transcribe-diarize, och gpt-4o-mini-transcribe.		 No
language string Språket för indataljudet. Om du anger indataspråket i FORMATET ISO-639-1 (t.ex. en) förbättras noggrannheten och svarstiden. No
model string Den modell som ska användas för den här transkriptionsbegäran. No
prompt string En valfri text som vägleder modellens formatmall eller fortsätter med ett tidigare ljudsegment. Uppmaningen ska matcha ljudspråket. No
response_format object No
stream boolean Om värdet är true strömmas modellsvarsdata till klienten
eftersom det genereras med hjälp av server-skickade händelser. Obs! Direktuppspelning stöds inte för whisper-1 modellen och ignoreras.		 No False
temperature number Provtagningstemperaturen, mellan 0 och 1. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Om värdet är 0 använder modellen loggsannolikhet för att automatiskt öka temperaturen tills vissa tröskelvärden uppnås. No 0
timestamp_granularities[] array Tidsstämpelkornigheterna som ska fyllas i för den här transkriptionen. response_format måste anges verbose_json för att använda tidsstämpelkornigheter. Något av eller båda alternativen stöds: word, eller segment. Obs! Det finns ingen ytterligare svarstid för segmenttidsstämplar, men att generera ordtidsstämplar medför ytterligare svarstid. No ['segment']

AzureCreateTranslationRequestMultiPart

Konfigurationsinformationen för en begäran om ljudavskrift.

Name Type Description Required Default
file string Yes
filename string Det valfria filnamnet eller den beskrivande identifieraren som ska associeras med ljuddata No
model string Den modell som ska användas för den här översättningsbegäran. No
prompt string En valfri text som vägleder modellens formatmall eller fortsätter med ett tidigare ljudsegment. Uppmaningen ska vara på engelska. No
response_format object No
temperature number Provtagningstemperaturen, mellan 0 och 1. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Om värdet är 0 använder modellen loggsannolikhet för att automatiskt öka temperaturen tills vissa tröskelvärden uppnås. No 0

AzureErrorResponse

Name Type Description Required Default
error object Felinformationen. No
└– kod string Den distinkta, maskingenererade identifieraren för felet. No
└– inner_error No
└– meddelande string Ett läsbart meddelande som är associerat med felet. No
└– param string Om tillämpligt, den indataparameter för begäran som är associerad med felet No
└– typ enum Objekttypen, alltid "error".
Möjliga värden: error		 No

AzureEvalAPICompletionsSamplingParams

Name Type Description Required Default
parallel_tool_calls boolean No
response_format OpenAI.ResponseTextFormatConfiguration No
tools array No

AzureEvalAPIModelSamplingParams

Name Type Description Required Default
max_tokens integer Det maximala antalet token i de genererade utdata. No
reasoning_effort enum Styr den resonemangsnivå som tillämpas under genereringen.
Möjliga värden: low, medium, high		 No
seed integer Ett frövärde för att initiera slumpmässigheten under samplingen. No
temperature number En högre temperatur ökar slumpmässigheten i utdata. No
top_p number Ett alternativ till temperatur för kärnprovtagning. 1.0 innehåller alla token. No

AzureEvalAPIResponseSamplingParams

Name Type Description Required Default
parallel_tool_calls boolean No
response_format OpenAI.ResponseTextFormatConfiguration No
tools array No

AzureFileExpiryAnchor

Property Value
Type string
Values created_at

AzureFineTuneReinforcementMethod

Name Type Description Required Default
väghyvel object Ett StringCheckGrader-objekt som utför en strängjämförelse mellan indata och referens med en angiven åtgärd. Yes
└– calculate_output string En formel för att beräkna utdata baserat på graderresultat. No
└– evaluation_metric enum Det utvärderingsmått som ska användas. En av fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5eller rouge_l.
Möjliga värden: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , , rouge_5rouge_l		 No
└– väghyvlar object No
└– indata array Inmatningstexten. Detta kan innehålla mallsträngar. No
└– modell string Den modell som ska användas för utvärderingen. No
└— namn string Namnet på bedömaren. No
└— åtgärd enum Strängkontrollprocessen som ska utföras. En av eq, ne, likeeller ilike.
Möjliga värden: eq, ne, like, ilike		 No
└– intervall array Poängintervallet. Standardinställningen är [0, 1]. No
└– referens string Texten som betygsätts och jämförs med. No
└– sampling_params Samplingsparametrarna för modellen. No
└– typ enum Objekttypen, som alltid multiär .
Möjliga värden: multi		 No
hyperparametrar OpenAI.FineTuneReinforcementHyperparameters De hyperparametrar som används för finjusteringsjobbet för förstärkning. No
response_format object No
└– json_schema object JSON-schema för svarsformatet No
└– typ enum Typ av svarsformat
Möjliga värden: json_schema		 No

AzureImage

Name Type Description Required Default
b64_json string Den base64-kodade JSON för den genererade avbildningen. Standardvärdet för gpt-image-1, och visas endast om response_format är inställt på b64_json för dall-e-2 och dall-e-3. No
content_filter_results AzureContentFilterImageResponseResults Ett innehållsfilterresultat för en bildgenereringsåtgärds utdatasvarsinnehåll. Yes
prompt_filter_results AzureContentFilterImagePromptResults Resultatet av ett innehållsfilter för innehållsinmatningen vid en bildgenereringsprocess. Yes
Omarbetad uppmaning string Endast dall-e-3 den reviderade prompten som användes för att generera avbildningen. No
url string När du använder dall-e-2 eller dall-e-3är URL:en för den genererade avbildningen inställd response_format på url (standardvärde). Stöds inte för gpt-image-1. No

AzureImagesResponse

Name Type Description Required Default
background enum Bakgrundsparametern som används för bildgenereringen. Antingen transparent eller opaque.
Möjliga värden: transparent, opaque		 No
created integer Unix-tidsstämpeln (i sekunder) för när avbildningen skapades. Yes
data array No
output_format enum Utdataformatet för bildgenereringen. Antingen png, webpeller jpeg.
Möjliga värden: png, webp, jpeg		 No
quality enum Kvaliteten på avbildningen som genereras. Antingen low, mediumeller high.
Möjliga värden: low, medium, high		 No
size enum Storleken på avbildningen som genereras. Antingen 1024x1024, 1024x1536eller 1536x1024.
Möjliga värden: 1024x1024, 1024x1536, 1536x1024		 No
usage object Endast gpt-image-1 för information om tokenanvändning för avbildningsgenerering. No
└– input_tokens integer Antalet token (bilder och text) i indataprompten. No
└─ inmatningstokensdetaljer object Indatatoken innehåller detaljerad information för bildgenereringen. No
└– image_tokens integer Antalet bildtoken i indataprompten. No
└– text_tokens integer Antalet texttoken i indataprompten. No
└– output_tokens integer Antalet bildtoken i utdatabilden. No
└– totalt_antal_tokenar integer Det totala antalet token (bilder och text) som används för bildgenereringen. No

AzureListFilesResponse

Name Type Description Required Default
data array Yes
first_id string Yes
has_more boolean Yes
last_id string Yes
object enum
Möjliga värden: list		 Yes

AzureOpenAIFile

Name Type Description Required Default
bytes integer Filens storlek i byte. Yes
created_at integer Unix-tidsstämpeln (i sekunder) för när filen skapades. Yes
expires_at integer Unix-tidsstämpeln (i sekunder) för när filen upphör att gälla. No
filename string Namnet på filen. Yes
id string Filidentifieraren, som kan refereras till i API-slutpunkterna. Yes
object enum Objekttypen, som alltid fileär .
Möjliga värden: file		 Yes
avsikt enum Det avsedda syftet med filen. Värden som stöds är assistants, assistants_output, batch, batch_outputoch fine-tunefine-tune-results .
Möjliga värden: assistants, assistants_output, batch, batch_output, fine-tune, , fine-tune-resultsevals		 Yes
status enum
Möjliga värden: uploaded, pending, running, processed, error, , deletingdeleted		 Yes
statusdetaljer string Avrådd. Mer information om varför en finjusteringsträningsfil misslyckades med valideringen finns i fältet error på fine_tuning.job. No

AzureOpenAIVideoGenerationErrorResponse

Name Type Description Required Default
code string Den distinkta, maskingenererade identifieraren för felet. No
inner_error object Om tillämpligt, ett uppströmsfel som orsakade detta fel. No
└– kod enum Koden som är associerad med det inre felet.
Möjliga värden: ResponsibleAIPolicyViolation		 No
└─ felinformation Resultatinformationen för innehållsfiltret som är associerad med det inre felet. No
└– revised_prompt string Om tillämpligt, den ändrade prompten som används för generering. No
message string Ett läsbart meddelande som är associerat med felet. No
param string Om tillämpligt, den indataparameter för begäran som är associerad med felet No
type string I förekommande fall det indataradsnummer som är associerat med felet. No

AzureResponse

Name Type Description Required Default
background boolean Om modellsvaret ska köras i bakgrunden. No False
created_at integer Unix-tidsstämpel (i sekunder) för när det här svaret skapades. Yes
error object Ett felobjekt som returneras när modellen inte genererar ett svar. Yes
└– kod OpenAI.ResponseErrorCode Felkoden för svaret. No
└– meddelande string En läsbar beskrivning av felet. No
id string Unik identifierare för det här svaret. Yes
incomplete_details object Information om varför svaret är ofullständigt. Yes
└— orsak enum Anledningen till att svaret är ofullständigt.
Möjliga värden: max_output_tokens, content_filter		 No
instructions sträng eller matris Yes
max_output_tokens integer En övre gräns för antalet token som kan genereras för ett svar, inklusive synliga utdatatoken och resonemangstoken No
max_tool_calls integer Det maximala antalet totala anrop till inbyggda verktyg som kan bearbetas i ett svar. Det här maximala antalet gäller för alla inbyggda verktygsanrop, inte per enskilt verktyg. Eventuella ytterligare försök att anropa ett verktyg av modellen ignoreras. No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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 Den modell som används för att generera det här svaret. Yes
object enum Objekttypen för den här resursen – ange alltid till response.
Möjliga värden: response		 Yes
output array En matris med innehållsobjekt som genereras av modellen.

– Längden och ordningen på objekt i matrisen output är beroende
på modellens svar.
– I stället för att komma åt det första objektet i matrisen output och
anta att det är ett assistant meddelande med innehållet som har genererats av
i modellen kan du överväga att använda egenskapen output_text där
stöds i SDK:er.		 Yes
output_text string Endast SDK-bekvämlighetsegenskap som innehåller aggregerade textutdata
från alla output_text objekt i matrisen output , om några finns.
Stöds i Python- och JavaScript-SDK:er.		 No
parallel_tool_calls boolean Om modellen ska kunna köra verktygsanrop parallellt. Yes True
previous_response_id string Det unika ID:t för föregående svar på modellen. Använd detta för att
skapa flerstegskonversationer		 No
prompt object Referens till en promptmall och dess variabler. No
└– id string Den unika identifieraren för den promptmall som ska användas. No
└– variabler OpenAI.ResponsePromptVariables Valfri mappning av värden att ersätta med variabler i din
datorn. Ersättningsvärdena kan antingen vara strängar eller andra
Svarsindatatyper som bilder eller filer.		 No
└— version string Valfri version av promptmallen. No
reasoning object Endast o-seriemodeller

Konfigurationsalternativ för resonemangsmodeller.		 No
└— insats OpenAI.ReasoningEffort Endast o-seriemodeller

Begränsar arbetet med resonemang för resonemangsmodeller.
Värden som stöds för närvarande är low, mediumoch high. Minska
Ansträngning i resonemang kan leda till snabbare svar och färre token som används
om resonemang i ett svar.		 No
└– generate_summary enum Inaktuell: använd summary i stället.

En sammanfattning av det resonemang som utförs av modellen. Detta kan vara
användbart för att felsöka och förstå modellens resonemangsprocess.
En av auto, conciseeller detailed.
Möjliga värden: auto, concise, detailed		 No
└— sammanfattning enum En sammanfattning av det resonemang som utförs av modellen. Detta kan vara
användbart för att felsöka och förstå modellens resonemangsprocess.
En av auto, conciseeller detailed.
Möjliga värden: auto, concise, detailed		 No
status enum Status för svarsgenereringen. En av completed, failed,
in_progress, cancelled, queued eller incomplete.
Möjliga värden: completed, failed, in_progress, cancelled, , queuedincomplete		 No
temperature number Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt.
Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.		 Yes
text object Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. No
└– format OpenAI.ResponseTextFormatConfiguration No
tool_choice object Styr vilket (om något) verktyg som anropas av modellen.

none innebär att modellen inte anropar något verktyg och i stället genererar ett meddelande.

auto innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett eller
fler verktyg.

required innebär att modellen måste anropa ett eller flera verktyg.		 No
└– typ OpenAI.ToolChoiceObjectType Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. No
tools array En matris med verktyg som modellen kan anropa när ett svar genereras. Du
kan ange vilket verktyg som ska användas genom att ange parametern tool_choice .

De två kategorier av verktyg som du kan tillhandahålla modellen är:

- Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar
modellens funktioner.		 No
top_logprobs integer Ett heltal mellan 0 och 20 som anger antalet mest sannolika token som ska returneras vid varje tokenposition, var och en med en associerad loggsannolikhet. No
top_p number Ett alternativ till provtagning med temperatur, som kallas kärnsampling,
där modellen tar hänsyn till resultatet av token med top_p sannolikhet
massa. Så 0,1 innebär endast de token som omfattar de 10 främsta i%:s sannolikhetsmassa.
övervägs.

Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.		 Yes
truncation enum Den trunkeringsstrategi som ska användas för modellsvaret.
- auto: Om sammanhanget för det här svaret och tidigare svar överskrider
modellens kontextfönsterstorlek trunkerar modellen
svar för att anpassa till kontextfönstret genom att ta bort indataobjekt i
mitt i samtalet.
- disabled (standard): Om ett modellsvar överskrider kontextfönstret
Om storleken för en modell är felaktig, kommer begäran att misslyckas med felkod 400.
Möjliga värden: auto, disabled		 No
usage OpenAI.ResponseUsage Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken,
en uppdelning av utdatatoken och de totala token som används.		 No
user string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. Yes

AzureSearchChatDataSource

Representerar en konfiguration av datakällan som ska använda en Azure Search-resurs.

Name Type Description Required Default
parameters object Parameterinformationen för att styra användningen av Azure Search-datakällan. Yes
└– allow_partial_result boolean Om värdet är true tillåter systemet att partiella sökresultat används och begäran misslyckas om alla
Delvisa sökfrågor misslyckas. Om det inte anges eller anges som falskt misslyckas begäran om någon sökfråga misslyckas.		 No False
└– autentisering object No
└– access_token string No
└– nyckel string No
└– managed_identity_resource_id string No
└– typ enum
Möjliga värden: access_token		 No
└─ inbäddningsberoende object Representerar en vektoriseringskälla som gör offentliga tjänstanrop mot en Azure OpenAI-inbäddningsmodelldistribution. No
└– autentisering AzureChatDataSourceApiKeyAuthenticationOptions eller AzureChatDataSourceAccessTokenAuthenticationOptions Autentiseringsmekanismen som ska användas med den slutpunktsbaserade vektoriseringskällan.
Slutpunktsautentisering stöder mekanismer för API-nyckel och åtkomsttoken.		 No
└– deployment_name string Den inbäddningsmodelldistribution som ska användas för vektorisering. Den här distributionen måste finnas inom samma Azure OpenAI
resurs som modelldistributionen som används för chattavslutningar.		 No
└– dimensioner integer Antalet dimensioner som ska begäras för inbäddningar.
Stöds endast i "text-embedding-3" och senare modeller.		 No
└– slutpunkt string Anger resursslutpunkts-URL:en som inbäddningar ska hämtas från.
Den ska vara i följande format:
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
Frågeparametern api-version tillåts inte.		 No
└– typ enum Typidentifieraren, alltid "integrerad" för den här källtypen för vektorisering.
Möjliga värden: integrated		 No
└– slutpunkt string Den absoluta slutpunktssökvägen som Azure Search-resursen ska använda. No
└– fields_mapping object Fältmappningarna som ska användas med Azure Search-resursen. No
└– innehållsfält array Namnen på indexfält som ska behandlas som innehåll. No
└– content_fields_separator string Det avgränsarmönster som innehållsfält ska använda. No
└– filepath_field string Namnet på det indexfält som ska användas som en filsökväg. No
└– image_vector_fields array Namnen på fält som representerar bildvektordata. No
└– title_field string Namnet på det indexfält som ska användas som rubrik. No
└– url_field string Namnet på det indexfält som ska användas som en URL. No
└– vector_fields array Namnen på fält som representerar vektordata. No
└– filter string Ett filter som ska tillämpas på sökningen. No
└– in_scope boolean Om frågor ska begränsas till användning av indexerade data. No
└– include_contexts array Egenskaperna för utdatakontexten som ska inkluderas i svaret.
Som standard begärs citat och avsikt.		 No ['citat', 'avsikt']
└– index_namn string Namnet på det index som ska användas, enligt vad som anges i Azure Search-resursen. No
└─ max_sökfrågor integer Det maximala antalet omskrivna frågor som ska skickas till sökprovidern för ett meddelande från en enskild användare.
Som standard gör systemet en automatisk bestämning.		 No
└query_type enum Frågetypen som Azure Search-resursen ska använda.
Möjliga värden: simple, semantic, vector, , vector_simple_hybridvector_semantic_hybrid		 No
└– semantic_configuration string Ytterligare semantisk konfiguration för frågan. No
└– strikthet integer Den konfigurerade strängheten för sökrelevansfiltreringen.
Högre strikthet kommer att öka precisionen men minska återkallningen av svaret.		 No
└top_n_documents integer Det konfigurerade antalet dokument som ska visas i frågan. No
type enum Den särskiljande typidentifieraren, som alltid är 'azure_search'.
Möjliga värden: azure_search		 Yes

AzureUserSecurityContext

Användarsäkerhetskontexten innehåller flera parametrar som beskriver själva programmet och slutanvändaren som interagerar med programmet. De här fälten hjälper dina säkerhetsteam att undersöka och minimera säkerhetsincidenter genom att tillhandahålla en omfattande metod för att skydda dina AI-program. Läs mer om att skydda AI-program 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 ingå i det här fältet. No
end_user_id string Den här identifieraren är användarobjekt-ID:t för Microsoft Entra (tidigare Azure Active Directory) som används för att autentisera slutanvändare i det generativa AI-programmet. Känslig personlig information bör inte ingå i det här fältet. No
end_user_tenant_id string Det Microsoft 365-klient-ID som slutanvändaren tillhör. Det krävs när generativ AI-programmet är multitenant. No
source_ip string Samlar in ursprungliga klientens IP-adress. No

ChatCompletionMessageToolCallsItem

Verktyget anropar som genereras av modellen, till exempel funktionsanrop.

Matris för: OpenAI.ChatCompletionMessageToolCall

CreateVideoGenerationRequest

Name Type Description Required Default
height integer Videons höjd. Följande dimensioner stöds: 480x480, 854x480, 720x720, 1280x720, 1080x1080 och 1920x1080 i både liggande och stående orienteringar. Yes
model string Namnet på distributionen som ska användas för den här begäran. Yes
n_seconds integer Varaktigheten för videogenereringsjobbet. Måste vara mellan 1 och 20 sekunder. No 5
n_variants integer Antalet videor som ska skapas som varianter för det här jobbet. Måste vara mellan 1 och 5. Mindre dimensioner tillåter fler varianter. No 1
prompt string Uppmaningen för det här videogenereringsjobbet. Yes
width integer Videons bredd. Följande dimensioner stöds: 480x480, 854x480, 720x720, 1280x720, 1080x1080 och 1920x1080 i både liggande och stående orienteringar. Yes

CreateVideoGenerationWithMediaRequestMultiPart

Egenskaperna för en videogenereringsjobbbegäran med mediefiler.

Name Type Description Required Default
files array Yes
height integer Videons höjd. Följande dimensioner stöds: 480x480, 854x480, 720x720, 1280x720, 1080x1080 och 1920x1080 i både liggande och stående orienteringar. Yes
inpaint_items array Valfria inpainting-objekt för det här videogenereringsjobbet. No
model string Namnet på distributionen som ska användas för den här begäran. Yes
n_seconds integer Varaktigheten för videogenereringsjobbet. Måste vara mellan 1 och 20 sekunder. No 5
n_variants integer Antalet videor som ska skapas som varianter för det här jobbet. Måste vara mellan 1 och 5. Mindre dimensioner tillåter fler varianter. No 1
prompt string Uppmaningen för det här videogenereringsjobbet. Yes
width integer Videons bredd. Följande dimensioner stöds: 480x480, 854x480, 720x720, 1280x720, 1080x1080 och 1920x1080 i både liggande och stående orienteringar. Yes

CropBounds

Beskärningsgränsen för ett inpainting-objekt. Detta anger området för medieobjektet som ska användas för inpainting.

Name Type Description Required Default
bottom_fraction number Den nedre gränsen för beskärningsrutan som anges som bråkdel av höjden på det ursprungliga medieobjektet. Måste vara mellan 0.0 och 1.0. Använd t.ex. 0,5 för halva höjden på det ursprungliga medieobjektet. No 1
left_fraction number Den vänstra gränsen för beskärningsrutan som anges som bråkdel av bredden på det ursprungliga medieobjektet. Måste vara mellan 0.0 och 1.0. Använd t.ex. 0,5 för halva bredden på det ursprungliga medieobjektet. No 0
right_fraction number Den högra gränsen för beskärningsrutan som anges som bråkdel av bredden på det ursprungliga medieobjektet. Måste vara mellan 0.0 och 1.0. Använd t.ex. 0,5 för halva bredden på det ursprungliga medieobjektet. No 1
top_fraction number Den övre gränsen för beskärningsrutan som anges som fraktion av höjden på det ursprungliga medieobjektet. Måste vara mellan 0.0 och 1.0. Använd t.ex. 0,5 för halva höjden på det ursprungliga medieobjektet. No 0

ElasticsearchChatDataSource

Name Type Description Required Default
parameters object Parameterinformationen som styr användningen av Elasticsearch-datakällan. Yes
└– allow_partial_result boolean Om värdet är true tillåter systemet att partiella sökresultat används och begäran misslyckas om alla
Delvisa sökfrågor misslyckas. Om det inte anges eller anges som falskt misslyckas begäran om någon sökfråga misslyckas.		 No False
└– autentisering object No
└– encoded_api_key string No
└– nyckel string No
└– key_id string No
└– typ enum
Möjliga värden: encoded_api_key		 No
└─ inbäddningsberoende AzureChatDataSourceVectorizationSource En representation av en datavektoriseringskälla som kan användas som en inbäddningsresurs med en datakälla. No
└– slutpunkt string No
└– fields_mapping object No
└– innehållsfält array No
└– content_fields_separator string No
└– filepath_field string No
└– title_field string No
└– url_field string No
└– vector_fields array No
└– in_scope boolean Om frågor ska begränsas till användning av indexerade data. No
└– include_contexts array Egenskaperna för utdatakontexten som ska inkluderas i svaret.
Som standard begärs citat och avsikt.		 No ['citat', 'avsikt']
└– index_namn string No
└─ max_sökfrågor integer Det maximala antalet omskrivna frågor som ska skickas till sökprovidern för ett meddelande från en enskild användare.
Som standard gör systemet en automatisk bestämning.		 No
└query_type enum
Möjliga värden: simple, vector		 No
└– strikthet integer Den konfigurerade strängheten för sökrelevansfiltreringen.
Högre strikthet kommer att öka precisionen men minska återkallningen av svaret.		 No
└top_n_documents integer Det konfigurerade antalet dokument som ska visas i frågan. No
type enum Den differentierade typidentifieraren, som alltid är "elasticsearch".
Möjliga värden: elasticsearch		 Yes

InpaintItem

Ett inpainting-objekt för ett videogenereringsjobb. Detta anger medieobjektet som ska användas för inpainting i videogenereringen.

Name Type Description Required Default
crop_bounds object Beskärningsgränsen för ett inpainting-objekt.
Detta anger området för medieobjektet som ska användas för inpainting.		 No
└– bottom_fraction number Den nedre gränsen för beskärningsrutan som anges som bråkdel av höjden på det ursprungliga medieobjektet. Måste vara mellan 0.0 och 1.0. Använd t.ex. 0,5 för halva höjden på det ursprungliga medieobjektet. No 1
└– left_fraction number Den vänstra gränsen för beskärningsrutan som anges som bråkdel av bredden på det ursprungliga medieobjektet. Måste vara mellan 0.0 och 1.0. Använd t.ex. 0,5 för halva bredden på det ursprungliga medieobjektet. No 0
└– right_fraction number Den högra gränsen för beskärningsrutan som anges som bråkdel av bredden på det ursprungliga medieobjektet. Måste vara mellan 0.0 och 1.0. Använd t.ex. 0,5 för halva bredden på det ursprungliga medieobjektet. No 1
└– top_fraction number Den övre gränsen för beskärningsrutan som anges som fraktion av höjden på det ursprungliga medieobjektet. Måste vara mellan 0.0 och 1.0. Använd t.ex. 0,5 för halva höjden på det ursprungliga medieobjektet. No 0
filnamn string Medieobjektets filnamn. Den måste matcha filnamnet för en bifogad fil i den här begäran. Yes
frame_index integer Ramindexet för det här medieobjektet. Detta anger startramen i den resulterande genererade videon för det här inpaintingobjektet. Yes 0
type object Typ av inpainting-objekt. Yes

JobStatus

Status för ett videogenereringsjobb.

Property Value
Description Status för ett videogenereringsjobb.
Type string
Values preprocessing
queued
running
processing
cancelled
succeeded
failed

MediaItemType

Typ av inpainting-objekt.

Property Value
Description Typ av inpainting-objekt.
Type string
Values image

MongoDBChatDataSource

Name Type Description Required Default
parameters object Parameterinformationen som styr användningen av MongoDB-datakällan. Yes
└– allow_partial_result boolean Om värdet är true tillåter systemet att partiella sökresultat används och begäran misslyckas om alla
Delvisa sökfrågor misslyckas. Om det inte anges eller anges som falskt misslyckas begäran om någon sökfråga misslyckas.		 No False
└– app_name string Namnet på MongoDB-programmet. No
└– autentisering object No
└– lösenord string No
└– typ enum
Möjliga värden: username_and_password		 No
└– användarnamn string No
└– collection_name string Namnet på MongoDB-samlingen. No
└– databasnamn string Namnet på MongoDB-databasen. No
└─ inbäddningsberoende object Representerar en vektoriseringskälla som gör offentliga tjänstanrop mot en Azure OpenAI-inbäddningsmodelldistribution. No
└– autentisering AzureChatDataSourceApiKeyAuthenticationOptions eller AzureChatDataSourceAccessTokenAuthenticationOptions Autentiseringsmekanismen som ska användas med den slutpunktsbaserade vektoriseringskällan.
Slutpunktsautentisering stöder mekanismer för API-nyckel och åtkomsttoken.		 No
└– deployment_name string Den inbäddningsmodelldistribution som ska användas för vektorisering. Den här distributionen måste finnas inom samma Azure OpenAI
resurs som modelldistributionen som används för chattavslutningar.		 No
└– dimensioner integer Antalet dimensioner som ska begäras för inbäddningar.
Stöds endast i "text-embedding-3" och senare modeller.		 No
└– slutpunkt string Anger resursslutpunkts-URL:en som inbäddningar ska hämtas från.
Den ska vara i följande format:
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
Frågeparametern api-version tillåts inte.		 No
└– typ enum Typidentifieraren, alltid "deployment_name" för den här källtypen för vektorisering.
Möjliga värden: deployment_name		 No
└– slutpunkt string Namnet på MongoDB-klusterslutpunkten. No
└– fields_mapping object Fältmappningar som ska tillämpas på data som används av MongoDB-datakällan.
Observera att innehålls- och vektorfältmappningar krävs för MongoDB.		 No
└– innehållsfält array No
└– content_fields_separator string No
└– filepath_field string No
└– title_field string No
└– url_field string No
└– vector_fields array No
└– in_scope boolean Om frågor ska begränsas till användning av indexerade data. No
└– include_contexts array Egenskaperna för utdatakontexten som ska inkluderas i svaret.
Som standard begärs citat och avsikt.		 No ['citat', 'avsikt']
└– index_namn string Namnet på MongoDB-indexet. No
└─ max_sökfrågor integer Det maximala antalet omskrivna frågor som ska skickas till sökprovidern för ett meddelande från en enskild användare.
Som standard gör systemet en automatisk bestämning.		 No
└– strikthet integer Den konfigurerade strängheten för sökrelevansfiltreringen.
Högre strikthet kommer att öka precisionen men minska återkallningen av svaret.		 No
└top_n_documents integer Det konfigurerade antalet dokument som ska visas i frågan. No
type enum Den diskriminerade typidentifieraren, som alltid är "mongo_db".
Möjliga värden: mongo_db		 Yes

OpenAI.Annotation

Diskriminator för OpenAI.Annotation

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
file_citation OpenAI.AnnotationFileCitation
url_citation OpenAI.AnnotationUrlCitation
file_path OpenAI.AnnotationFilePath
Name Type Description Required Default
type OpenAI.AnnotationType Yes

OpenAI.AnnotationFileCitation

En källhänvisning till en fil.

Name Type Description Required Default
file_id string ID:t för filen. Yes
filename string Filnamnet för den citerade filen. Yes
index integer Indexet för filen i listan över filer. Yes
type enum Filreferenstyp. Alltid file_citation.
Möjliga värden: file_citation		 Yes

OpenAI.AnnotationFilePath

En sökväg till en fil.

Name Type Description Required Default
file_id string ID:t för filen. Yes
index integer Indexet för filen i listan över filer. Yes
type enum Typ av filsökväg. Alltid file_path.
Möjliga värden: file_path		 Yes

OpenAI.AnnotationType

Property Value
Type string
Values file_citation
url_citation
file_path
container_file_citation

OpenAI.AnnotationUrlCitation

En källhänvisning för en webbresurs som används för att generera ett modellsvar.

Name Type Description Required Default
end_index integer Indexet för det sista tecknet i URL-källhänvisning i meddelandet. Yes
start_index integer Indexet för det första tecknet i URL-källhänvisning i meddelandet. Yes
title string Webbresursens rubrik. Yes
type enum Typ av URL-källhänvisning. Alltid url_citation.
Möjliga värden: url_citation		 Yes
url string Url:en för webbresursen. Yes

OpenAI.ApproximateLocation

Name Type Description Required Default
city string No
country string No
region string No
timezone string No
type enum
Möjliga värden: approximate		 Yes

OpenAI.AudioResponseFormat

Formatet för utdata i något av följande alternativ: json, , textsrt, , verbose_jsoneller vtt. För gpt-4o-transcribe, gpt-4o-transcribe-diarizeoch gpt-4o-mini-transcribeär jsondet enda format som stöds .

Property Value
Description Formatet för utdata i något av följande alternativ: json, , textsrt, , verbose_jsoneller vtt. För gpt-4o-transcribe, gpt-4o-transcribe-diarizeoch gpt-4o-mini-transcribeär jsondet enda format som stöds .
Type string
Values json
text
srt
verbose_json
vtt

OpenAI.AutoChunkingStrategyRequestParam

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

Name Type Description Required Default
type enum Alltid auto.
Möjliga värden: auto		 Yes

OpenAI.ChatCompletionFunctionCallOption

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

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

OpenAI.ChatCompletionFunctions

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

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

OpenAI.ChatCompletionMessageAudioChunk

Name Type Description Required Default
data string No
expires_at integer No
id string No
transcript string No

OpenAI.ChatCompletionMessageToolCall

Name Type Description Required Default
function object Den funktion som modellen anropade. Yes
└─ argument 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 funktionsschemat. Verifiera argumenten i koden innan du anropar funktionen. No
└— namn string Namnet på funktionen som ska anropas. No
id string ID:t för verktygsanropet. Yes
type enum Verktygets typ. För närvarande stöds endast function.
Möjliga värden: function		 Yes

OpenAI.ChatCompletionMessageToolCallChunk

Name Type Description Required Default
function object No
└─ argument 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 funktionsschemat. Verifiera argumenten i koden innan du anropar funktionen. No
└— namn string Namnet på funktionen som ska anropas. No
id string ID:t för verktygsanropet. No
index integer Yes
type enum Verktygets typ. För närvarande stöds endast function.
Möjliga värden: function		 No

OpenAI.ChatCompletionNamedToolChoice

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

Name Type Description Required Default
function object Yes
└— namn string Namnet på funktionen som ska anropas. No
type enum Verktygets typ. För närvarande stöds endast function.
Möjliga värden: function		 Yes

OpenAI.ChatCompletionRequestAssistantMessage

Meddelanden som skickas av modellen som svar på användarmeddelanden.

Name Type Description Required Default
audio object Data om ett tidigare ljudsvar från modellen. No
└– id string Unik identifierare för ett tidigare ljudsvar från modellen. No
content sträng eller matris No
function_call object Inaktuell och ersatt av tool_calls. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen. No
└─ argument string No
└— namn string No
name string Ett valfritt namn för deltagaren. Tillhandahåller modellinformation för att skilja mellan deltagare med samma roll. No
refusal string Assistentens avslagsmeddelande. No
role enum Rollen som meddelandenas författare, i det här fallet assistant.
Möjliga värden: assistant		 Yes
tool_calls ChatCompletionMessageToolCallsItem Verktyget anropar som genereras av modellen, till exempel funktionsanrop. No

OpenAI.ChatCompletionRequestAssistantMessageContentPart

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

OpenAI.ChatCompletionRequestDeveloperMessage

Instruktioner som tillhandahålls av utvecklare som modellen ska följa, oavsett vilka meddelanden som skickas av användaren. Med o1-modeller och nyare developer ersätter meddelanden föregående system meddelanden.

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

OpenAI.ChatCompletionRequestFunctionMessage

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

OpenAI.ChatCompletionRequestMessage

Diskriminator för OpenAI.ChatCompletionRequestMessage

Den här komponenten använder egenskapen role för att skilja mellan olika typer:

Typvärde Schema
system OpenAI.ChatCompletionRequestSystemMessage
developer OpenAI.ChatCompletionRequestDeveloperMessage
user OpenAI.ChatCompletionRequestUserMessage
assistant OpenAI.ChatCompletionRequestAssistantMessage
tool OpenAI.ChatCompletionRequestToolMessage
function OpenAI.ChatCompletionRequestFunctionMessage
Name Type Description Required Default
content sträng eller matris No
role object Rollen som författare till ett meddelande Yes

OpenAI.ChatCompletionRequestMessageContentPart

Diskriminator för OpenAI.ChatCompletionRequestMessageContentPart

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
text OpenAI.ChatCompletionRequestMessageContentPartText
image_url OpenAI.ChatCompletionRequestMessageContentPartImage
refusal OpenAI.ChatCompletionRequestMessageContentPartRefusal
file OpenAI.ChatCompletionRequestMessageContentPartFile
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudio
Name Type Description Required Default
type OpenAI.ChatCompletionRequestMessageContentPartType Yes

OpenAI.ChatCompletionRequestMessageContentPartAudio

Name Type Description Required Default
input_audio object Yes
└– data string Base64-kodade ljuddata. No
└– format enum Formatet för kodade ljuddata. Stöder för närvarande "wav" och "mp3".
Möjliga värden: wav, mp3		 No
type enum Typ av innehållsdel. Alltid input_audio.
Möjliga värden: input_audio		 Yes

OpenAI.ChatCompletionRequestMessageContentPartFile

Name Type Description Required Default
file object Yes
└– file_data string Base64-kodade fildata som används när filen skickas till modellen
som en sträng.		 No
└– file_id string ID:t för en uppladdad fil som ska användas som indata. No
└– filnamn string Namnet på filen som används när filen skickas till modellen som en
sträng.		 No
type enum Typ av innehållsdel. Alltid file.
Möjliga värden: file		 Yes

OpenAI.ChatCompletionRequestMessageContentPartImage

Name Type Description Required Default
image_url object Yes
└– detalj enum Anger detaljnivån för bilden.
Möjliga värden: auto, low, high		 No
└— url string Antingen en URL för bilden eller base64-kodade bilddata. No
type enum Typ av innehållsdel.
Möjliga värden: image_url		 Yes

OpenAI.ChatCompletionRequestMessageContentPartRefusal

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

OpenAI.ChatCompletionRequestMessageContentPartText

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

OpenAI.ChatCompletionRequestMessageContentPartType

Property Value
Type string
Values text
file
input_audio
image_url
refusal

OpenAI.ChatCompletionRequestSystemMessage

Instruktioner som tillhandahålls av utvecklare som modellen ska följa, oavsett vilka meddelanden som skickas av användaren. Med o1-modeller och nyare använder du developer meddelanden för det här ändamålet i stället.

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

OpenAI.ChatCompletionRequestSystemMessageContentPart

Referenser: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

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

OpenAI.ChatCompletionRequestToolMessageContentPart

Referenser: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

Meddelanden som skickas av en slutanvändare, som innehåller frågor eller ytterligare kontextinformation.

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

OpenAI.ChatCompletionRequestUserMessageContentPart

Name Type Description Required Default
file object Yes
└– file_data string Base64-kodade fildata som används när filen skickas till modellen
som en sträng.		 No
└– file_id string ID:t för en uppladdad fil som ska användas som indata. No
└– filnamn string Namnet på filen som används när filen skickas till modellen som en
sträng.		 No
image_url object Yes
└– detalj enum Anger detaljnivån för bilden.
Möjliga värden: auto, low, high		 No
└— url string Antingen en URL för bilden eller base64-kodade bilddata. No
input_audio object Yes
└– data string Base64-kodade ljuddata. No
└– format enum Formatet för kodade ljuddata. Stöder för närvarande "wav" och "mp3".
Möjliga värden: wav, mp3		 No
text string Textinnehållet. Yes
type enum Typ av innehållsdel. Alltid file.
Möjliga värden: file		 Yes

OpenAI.ChatCompletionRole

Rollen som författare till ett meddelande

Property Value
Description Rollen som författare till ett meddelande
Type string
Values system
developer
user
assistant
tool
function

OpenAI.ChatCompletionStreamOptions

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

Name Type Description Required Default
include_usage boolean Om det anges strömmas ytterligare ett segment före data: [DONE]
-meddelande. Fältet usage i det här segmentet visar tokenanvändningsstatistiken
för hela begäran, och fältet choices kommer alltid att vara tomt
samling.

Alla andra segment kommer också att innehålla ett usage fält, men med en null
värde. NOTERA: Om strömningen avbryts kanske du inte får
slutligt användningssegment som innehåller den totala tokenanvändningen för begäran.		 No

OpenAI.ChatCompletionStreamResponseDelta

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

Name Type Description Required Default
audio object No
└– data string No
└─ utgår_vid integer No
└– id string No
└─ avskrift string No
content string Innehållet i segmentmeddelandet. No
function_call object Inaktuell och ersatt av tool_calls. Namnet och argumenten för en funktion som ska anropas, som genereras av modellen. No
└─ argument string No
└— namn string No
refusal string Avslagsmeddelandet som genereras av modellen. No
role object Rollen som författare till ett meddelande No
tool_calls array No

OpenAI.ChatCompletionTokenLogprob

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

OpenAI.ChatCompletionTool

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

OpenAI.ChatCompletionToolChoiceOption

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

none är standard när inga verktyg finns. auto är standardvärdet om det finns verktyg.

Name Type Description Required Default
function object Yes
└— namn string Namnet på funktionen som ska anropas. No
type enum Verktygets typ. För närvarande stöds endast function.
Möjliga värden: function		 Yes

OpenAI.ChatOutputPrediction

Basrepresentation av förutsagda utdata från en modell.

Diskriminerande för OpenAI.ChatOutputPrediction

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
content OpenAI.ChatOutputPredictionContent
Name Type Description Required Default
type OpenAI.ChatOutputPredictionType Yes

OpenAI.ChatOutputPredictionContent

Statiskt förutsagt utdatainnehåll, till exempel innehållet i en textfil som återskapas.

Name Type Description Required Default
content sträng eller matris Yes
type enum Den typ av förutsagt innehåll som du vill ange. Den här typen är
för närvarande alltid content.
Möjliga värden: content		 Yes

OpenAI.ChatOutputPredictionType

Property Value
Type string
Values content

OpenAI.ChunkingStrategyRequestParam

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

Diskriminerande för OpenAI.ChunkingStrategyRequestParam

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
static OpenAI.StaticChunkingStrategyRequestParam
Name Type Description Required Default
type enum Typ av segmenteringsstrategi.
Möjliga värden: auto, static		 Yes

OpenAI.ChunkingStrategyResponseParam

Diskriminerande för OpenAI.ChunkingStrategyResponseParam

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
other OpenAI.OtherChunkingStrategyResponseParam
static OpenAI.StaticChunkingStrategyResponseParam
Name Type Description Required Default
type enum
Möjliga värden: static, other		 Yes

OpenAI.CodeInterpreterOutput

Diskriminerande för OpenAI.CodeInterpreterOutput

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
image OpenAI.CodeInterpreterOutputImage
logs OpenAI.CodeInterpreterOutputLogs
Name Type Description Required Default
type OpenAI.CodeInterpreterOutputType Yes

OpenAI.CodeInterpreterOutputImage

Bilden utdata från kodtolkaren.

Name Type Description Required Default
type enum Typ av utdata. Alltid "bild".
Möjliga värden: image		 Yes
url string URL:en för bildens utdata från kodtolkaren. Yes

OpenAI.CodeInterpreterOutputLogs

Loggarna utdata från kodtolkaren.

Name Type Description Required Default
logs string Loggarna utdata från kodtolkaren. Yes
type enum Typ av utdata. Alltid "loggar".
Möjliga värden: logs		 Yes

OpenAI.CodeInterpreterOutputType

Property Value
Type string
Values logs
image

OpenAI.CodeInterpreterTool

Ett verktyg som kör Python-kod för att generera ett svar på en fråga.

Name Type Description Required Default
container object Konfiguration för en kodtolkarcontainer. Du kan också ange ID:erna
av de filer som koden ska köras på.		 Yes
└– file_ids array En valfri lista över uppladdade filer som ska vara tillgängliga för din kod. No
└– typ enum Alltid auto.
Möjliga värden: auto		 No
type enum Typ av kodtolkarverktyg. Alltid code_interpreter.
Möjliga värden: code_interpreter		 Yes

OpenAI.CodeInterpreterToolAuto

Konfiguration för en kodtolkarcontainer. Du kan också ange ID:t för de filer som koden ska köras på.

Name Type Description Required Default
file_ids array En valfri lista över uppladdade filer som ska vara tillgängliga för din kod. No
type enum Alltid auto.
Möjliga värden: auto		 Yes

OpenAI.CodeInterpreterToolCallItemParam

Ett verktygsanrop för att köra kod.

Name Type Description Required Default
code string Koden som ska köras eller null om den inte är tillgänglig. Yes
container_id string ID:t för containern som används för att köra koden. Yes
Utgångar array Utdata som genereras av kodtolkaren, till exempel loggar eller bilder.
Kan vara null om inga utdata är tillgängliga.		 Yes
type enum
Möjliga värden: code_interpreter_call		 Yes

OpenAI.CodeInterpreterToolCallItemResource

Ett verktygsanrop för att köra kod.

Name Type Description Required Default
code string Koden som ska köras eller null om den inte är tillgänglig. Yes
container_id string ID:t för containern som används för att köra koden. Yes
Utgångar array Utdata som genereras av kodtolkaren, till exempel loggar eller bilder.
Kan vara null om inga utdata är tillgängliga.		 Yes
status enum
Möjliga värden: in_progress, completed, incomplete, , interpretingfailed		 Yes
type enum
Möjliga värden: code_interpreter_call		 Yes

OpenAI.ComparisonFilter

Ett filter som används för att jämföra en angiven attributnyckel med ett angivet värde med hjälp av en definierad jämförelseåtgärd.

Name Type Description Required Default
key string Nyckeln som ska jämföras med värdet. Yes
type enum Anger jämförelseoperatorn: eq, ne, gt, gte, , lt, lte.
- eq: Motsvarar
- ne: inte lika med
- gt: större än
- gte: större än eller lika med
- lt: mindre än
- lte: mindre än eller lika med
Möjliga värden: eq, ne, gt, gte, , ltlte		 Yes
value sträng eller tal eller booleskt värde Yes

OpenAI.CompletionUsage

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

Name Type Description Required Default
completion_tokens integer Antal token i det genererade slutförandet. Yes 0
completion_tokens_details object Uppdelning av token som används i en slutförande. No
└– accepted_prediction_tokens integer När du använder förutsagda utdata, antalet token i
förutsägelse som dök upp i textpåfyllningen.		 No 0
└– ljud_tokens integer Ljudindatatoken som genereras av modellen. No 0
└– reasoning_tokens integer Token som genereras av modellen för resonemang. No 0
└─ avvisade_predikteringstokens integer När du använder förutsagda utdata, antalet token i
förutsägelse som inte framkom i slutförandet. Men precis som
Resonemangstoken räknas, och dessa token ingår fortfarande i det totala antalet.
slutförandetoken för fakturering, utdata och kontextfönster
Gränser.		 No 0
prompt_tokens integer Antal token i prompten. Yes 0
prompt_tokens_details object Uppdelning av element som används i prompten. No
└– ljud_tokens integer Ljudindatatoken som finns i prompten. No 0
└– cached_tokens integer Cachelagrade tokens som finns i ledtexten. No 0
total_tokens integer Totalt antal token som används i begäran (fråga + slutförande). Yes 0

OpenAI.CompoundFilter

Kombinera flera filter med and eller or.

Name Type Description Required Default
filters array Matris med filter som ska kombineras. Objekt kan vara ComparisonFilter eller CompoundFilter. Yes
type enum Typ av åtgärd: and eller or.
Möjliga värden: and, or		 Yes

OpenAI.ComputerAction

Diskriminerande för OpenAI.ComputerAction

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
click OpenAI.ComputerActionClick
double_click OpenAI.ComputerActionDoubleClick
drag OpenAI.ComputerActionDrag
move OpenAI.ComputerActionMove
screenshot OpenAI.ComputerActionScreenshot
scroll OpenAI.ComputerActionScroll
type OpenAI.ComputerActionTypeKeys
wait OpenAI.ComputerActionWait
keypress OpenAI.ComputerActionKeyPress
Name Type Description Required Default
type OpenAI.ComputerActionType Yes

OpenAI.ComputerActionClick

En klickåtgärd.

Name Type Description Required Default
button enum Anger vilken musknapp som trycktes på under klickningen. En av left, right, wheel, backeller forward.
Möjliga värden: left, right, wheel, , backforward		 Yes
type enum Anger händelsetypen. För en klickåtgärd är den här egenskapen
alltid inställd på click.
Möjliga värden: click		 Yes
x integer X-koordinaten där klicket inträffade. Yes
y integer y-koordinaten där klicket inträffade. Yes

OpenAI.ComputerActionDoubleClick

En dubbelklicksåtgärd.

Name Type Description Required Default
type enum Anger händelsetypen. För en dubbelklicksåtgärd är den här egenskapen
alltid inställd på double_click.
Möjliga värden: double_click		 Yes
x integer X-koordinaten där dubbelklicket inträffade. Yes
y integer Den y-koordinaten där dubbelklicket inträffade. Yes

OpenAI.ComputerActionDrag

En dragåtgärd.

Name Type Description Required Default
path array En matris med koordinater som representerar sökvägen för dragåtgärden. Koordinater visas som en matris
av objekt, t.ex.
<br>[<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br>]<br>		 Yes
type enum Anger händelsetypen. För en dragåtgärd är den här egenskapen
alltid inställd på drag.
Möjliga värden: drag		 Yes

OpenAI.ComputerActionKeyPress

En samling tangenttryckningar som modellen vill utföra.

Name Type Description Required Default
keys array Kombinationen av knappar som modellen vill att man trycker på. Det här är en
matris med strängar som var och en representerar en nyckel.		 Yes
type enum Anger händelsetypen. För en keypress-åtgärd är den här egenskapen
alltid inställd på keypress.
Möjliga värden: keypress		 Yes

OpenAI.ComputerActionMove

En musflyttningsåtgärd.

Name Type Description Required Default
type enum Anger händelsetypen. För en flyttåtgärd är den här egenskapen
alltid inställd på move.
Möjliga värden: move		 Yes
x integer X-koordinaten som ska flyttas till. Yes
y integer Y-koordinaten att flytta till. Yes

OpenAI.ComputerActionScreenshot

En skärmbildsåtgärd.

Name Type Description Required Default
type enum Anger händelsetypen. För en skärmbildåtgärd är den här egenskapen
alltid inställd på screenshot.
Möjliga värden: screenshot		 Yes

OpenAI.ComputerActionScroll

En scrollningsåtgärd.

Name Type Description Required Default
scroll_x integer Det vågräta rullningsavståndet. Yes
scroll_y integer Det lodräta rullningsavståndet. Yes
type enum Anger händelsetypen. För en rullningsåtgärd är den här egenskapen
alltid inställd på scroll.
Möjliga värden: scroll		 Yes
x integer X-koordinaten där rullningen inträffade. Yes
y integer y-koordinaten där scrollningen inträffade. Yes

OpenAI.ComputerActionType

Property Value
Type string
Values screenshot
click
double_click
scroll
type
wait
keypress
drag
move

OpenAI.ComputerActionTypeKeys

En åtgärd för att skriva in text.

Name Type Description Required Default
text string Texten som ska skrivas. Yes
type enum Anger händelsetypen. För en typåtgärd är den här egenskapen
alltid inställd på type.
Möjliga värden: type		 Yes

OpenAI.ComputerActionWait

En väntåtgärd.

Name Type Description Required Default
type enum Anger händelsetypen. För en vänta-åtgärd är den här egenskapen
alltid inställd på wait.
Möjliga värden: wait		 Yes

OpenAI.ComputerToolCallItemParam

Ett verktygsanrop till ett datoranvändningsverktyg.

Name Type Description Required Default
action OpenAI.ComputerAction Yes
call_id string En identifierare som används när du svarar på verktygsanropet med utdata. Yes
pending_safety_checks array De väntande säkerhetskontrollerna för datorsamtalet. Yes
type enum
Möjliga värden: computer_call		 Yes

OpenAI.ComputerToolCallItemResource

Ett verktygsanrop till ett datoranvändningsverktyg.

Name Type Description Required Default
action OpenAI.ComputerAction Yes
call_id string En identifierare som används när du svarar på verktygsanropet med utdata. Yes
pending_safety_checks array De väntande säkerhetskontrollerna för datorsamtalet. Yes
status enum Status för objektet. En av in_progress, completed eller
incomplete. Fylls i när objekt returneras via API.
Möjliga värden: in_progress, completed, incomplete		 Yes
type enum
Möjliga värden: computer_call		 Yes

OpenAI.ComputerToolCallOutputItemOutput

Diskriminerande för OpenAI.ComputerToolCallOutputItemOutput

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
computer_screenshot OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot
Name Type Description Required Default
type OpenAI.ComputerToolCallOutputItemOutputType En skärmbild av datorn som används med datoranvändningsverktyget. Yes

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Name Type Description Required Default
file_id string No
image_url string No
type enum
Möjliga värden: computer_screenshot		 Yes

OpenAI.ComputerToolCallOutputItemOutputType

En skärmbild av datorn som används med datoranvändningsverktyget.

Property Value
Description En skärmbild av datorn som används med datoranvändningsverktyget.
Type string
Values computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

Utdata från ett datorverktygsanrop.

Name Type Description Required Default
acknowledged_safety_checks array De säkerhetskontroller som rapporterats av API:et och som har bekräftats av
utvecklare.		 No
call_id string ID:t för datorverktygets anrop som genererade utdata. Yes
output OpenAI.ComputerToolCallOutputItemOutput Yes
type enum
Möjliga värden: computer_call_output		 Yes

OpenAI.ComputerToolCallOutputItemResource

Utdata från ett datorverktygsanrop.

Name Type Description Required Default
acknowledged_safety_checks array De säkerhetskontroller som rapporterats av API:et och som har bekräftats av
utvecklare.		 No
call_id string ID:t för datorverktygets anrop som genererade utdata. Yes
output OpenAI.ComputerToolCallOutputItemOutput Yes
status enum Status för objektet. En av in_progress, completed eller
incomplete. Fylls i när objekt returneras via API.
Möjliga värden: in_progress, completed, incomplete		 Yes
type enum
Möjliga värden: computer_call_output		 Yes

OpenAI.ComputerToolCallSafetyCheck

En väntande säkerhetskontroll för datorsamtalet.

Name Type Description Required Default
code string Typ av väntande säkerhetskontroll. Yes
id string ID för den väntande säkerhetskontrollen. Yes
message string Information om den väntande säkerhetskontrollen. Yes

OpenAI.ComputerUsePreviewTool

Ett verktyg som styr en virtuell dator.

Name Type Description Required Default
display_height integer Höjden på datorskärmen. Yes
display_width integer Datorns skärmbredd. Yes
environment enum Vilken typ av datormiljö som ska styras.
Möjliga värden: windows, mac, linux, , ubuntubrowser		 Yes
type enum Typ av datoranvändningsverktyg. Alltid computer_use_preview.
Möjliga värden: computer_use_preview		 Yes

OpenAI.Coordinate

Ett x/y-koordinatpar, t.ex. { x: 100, y: 200 }.

Name Type Description Required Default
x integer X-koordinaten. Yes
y integer Y-koordinaten. Yes

OpenAI.CreateEmbeddingResponse

Name Type Description Required Default
data array Listan över inbäddningar som genereras av modellen. Yes
model string Namnet på den modell som används för att generera inbäddningen. Yes
object enum Objekttypen, som alltid är "lista".
Möjliga värden: list		 Yes
usage object Användningsinformationen för begäran. Yes
└– prompt_tokens integer Antalet token som används av prompten. No
└– totalt_antal_tokenar integer Det totala antalet token som används av begäran. No

OpenAI.CreateEvalItem

Ett chattmeddelande som utgör prompten eller kontexten. Kan innehålla variabelreferenser till item namnområdet, d.v.s. {{item.name}}.

Name Type Description Required Default
content string eller OpenAI.EvalItemContent Textindata till modellen – kan innehålla mallsträngar. Yes
role enum Rollen för meddelandets inmatning. En av user, assistant, systemeller
developer.
Möjliga värden: user, assistant, system, developer		 Yes
type enum Typ av meddelandeindata. Alltid message.
Möjliga värden: message		 No

OpenAI.CreateEvalRunRequest

Name Type Description Required Default
datakälla object Yes
└– typ OpenAI.EvalRunDataSourceType No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
name string Namnet på körningen. No

OpenAI.CreateFineTuningJobRequest

Giltiga modeller:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini
Name Type Description Required Default
hyperparametrar object De hyperparametrar som används för finjusteringsjobbet.
Det här värdet är nu inaktuellt till förmån för methodoch bör skickas under parametern method .		 No
└– batch_size enum
Möjliga värden: auto		 No
└– learning_rate_multiplier enum
Möjliga värden: auto		 No
└– n_epochs enum
Möjliga värden: auto		 No
Integrationer array En lista över integreringar som ska aktiveras för ditt finjusteringsjobb. No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
metod OpenAI.FineTuneMethod Metoden som används för finjustering. No
model sträng (se giltiga modeller nedan) Namnet på modellen som ska finjusteras. Yes
seed integer Fröet styr reproducerbarheten för uppgiften. Att skicka in samma parametrar för start- och jobb bör ge samma resultat, men kan skilja sig i sällsynta fall.
Om ett frö inte har angetts genereras ett för dig.		 No
suffix string En sträng på upp till 64 tecken som läggs till i ditt finjusterade modellnamn.

Till exempel skulle en suffix av "custom-model-name" generera ett modellnamn som ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.		 No None
utbildningsfil string ID för en uppladdad fil som innehåller träningsdata. Datamängden måste formateras som en JSONL-fil. Dessutom måste du ladda upp filen med syftet fine-tune.

Innehållet i filen bör variera beroende på om modellen använder chattformatet, slutförandeformatet eller om finjusteringsmetoden använder inställningsformatet.		 Yes
validation_file string ID för en uppladdad fil som innehåller valideringsdata.

Om du anger den här filen används data för att generera validering
mått regelbundet under finjustering. Dessa mått kan visas i
finjusteringsresultatfilen.
Samma data bör inte finnas i både tränings- och valideringsfiler.

Datamängden måste formateras som en JSONL-fil. Du måste ladda upp filen med syftet fine-tune.		 No

OpenAI.CreateFineTuningJobRequestIntegration

Diskriminerande för OpenAI.CreateFineTuningJobRequestIntegration

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
wandb OpenAI.CreateFineTuningJobRequestWandbIntegration
Name Type Description Required Default
type sträng (se giltiga modeller nedan) Yes

OpenAI.CreateFineTuningJobRequestWandbIntegration

Name Type Description Required Default
type enum
Möjliga värden: wandb		 Yes
wandb object Yes
└— entitet string No
└— namn string No
└– projekt string No
└– taggar array No

OpenAI.CreateVectorStoreFileBatchRequest

Name Type Description Required Default
Egenskaper object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen. Nycklar är strängar
med en maximal längd på 64 tecken. Värden är strängar med ett maxvärde
längd på 512 tecken, booleska värden eller tal.		 No
chunking_strategy OpenAI.ChunkingStrategyRequestParam Segmenteringsstrategin som används för att segmentera filen eller filerna. Om den inte har angetts använder du auto strategin. No
file_ids array En lista över fil-ID:t som vektorarkivet ska använda. Användbart för verktyg som file_search dessa kan komma åt filer. Yes

OpenAI.CreateVectorStoreFileRequest

Name Type Description Required Default
Egenskaper object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen. Nycklar är strängar
med en maximal längd på 64 tecken. Värden är strängar med ett maxvärde
längd på 512 tecken, booleska värden eller tal.		 No
chunking_strategy OpenAI.ChunkingStrategyRequestParam Segmenteringsstrategin som används för att segmentera filen eller filerna. Om den inte har angetts använder du auto strategin. No
file_id string Ett fil-ID som vektorarkivet ska använda. Användbart för verktyg som file_search dessa kan komma åt filer. Yes

OpenAI.CreateVectorStoreRequest

Name Type Description Required Default
chunking_strategy object Standardstrategin. Den här strategin använder för närvarande en max_chunk_size_tokens av 800 och chunk_overlap_tokens av 400. No
└– statisk OpenAI.StaticChunkingStrategy No
└– typ enum Alltid static.
Möjliga värden: static		 No
går ut efter OpenAI.VectorStoreExpirationAfter Förfalloprincipen för ett vektorlager. No
file_ids array En lista över fil-ID:t som vektorarkivet ska använda. Användbart för verktyg som file_search dessa kan komma åt filer. No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
name string Namnet på vektorarkivet. No

OpenAI.DeleteFileResponse

Name Type Description Required Default
borttagen boolean Yes
id string Yes
object enum
Möjliga värden: file		 Yes

OpenAI.DeleteVectorStoreFileResponse

Name Type Description Required Default
borttagen boolean Yes
id string Yes
object enum
Möjliga värden: vector_store.file.deleted		 Yes

OpenAI.DeleteVectorStoreResponse

Name Type Description Required Default
borttagen boolean Yes
id string Yes
object enum
Möjliga värden: vector_store.deleted		 Yes

OpenAI.Embedding

Representerar en inbäddningsvektor som returneras av inbäddningsslutpunkten.

Name Type Description Required Default
embedding matris eller sträng Yes
index integer Indexet för inbäddningen i listan över inbäddningar. Yes
object enum Objekttypen, som alltid är "inbäddning".
Möjliga värden: embedding		 Yes

OpenAI.Eval

Ett Eval-objekt med ett konfigurations- och testvillkor för datakällan. En Eval representerar en uppgift som ska utföras för DIN LLM-integrering. Tycka om:

  • Förbättra kvaliteten på min chattrobot
  • Se hur bra min chattrobot hanterar kundsupport
  • Kontrollera om o4-mini är bättre på min usecase än gpt-4o
Name Type Description Required Default
created_at integer Unix-tidsstämpeln (i sekunder) för när eval skapades. Yes
datakällkonfiguration object Yes
└– typ OpenAI.EvalDataSourceConfigType No
id string Unik identifierare för utvärderingen. Yes
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
name string Namnet på utvärderingen. Yes
object enum Objekttypen.
Möjliga värden: eval		 Yes
testkriterier array En lista över testkriterier. Yes None

OpenAI.EvalApiError

Ett objekt som representerar ett felsvar från Eval-API:et.

Name Type Description Required Default
code string Felkoden. Yes
message string Felmeddelandet. Yes

OpenAI.EvalCompletionsRunDataSourceParams

Ett CompletionsRunDataSource-objekt som beskriver en modellsamplingskonfiguration.

Name Type Description Required Default
inmatningsmeddelanden object No
└– item_reference string En referens till en variabel i item namnområdet. Dvs, "item.input_trajectory" No
└– mall array En lista över chattmeddelanden som utgör prompten eller kontexten. Kan innehålla variabelreferenser till item namnområdet, d.v.s. {{item.name}}. No
└– typ enum Typ av indatameddelanden. Alltid item_reference.
Möjliga värden: item_reference		 No
model string Namnet på den modell som ska användas för att generera slutföranden (t.ex. "o3-mini"). No
provtagning_parametrar AzureEvalAPICompletionsSamplingParams No
källa object Yes
└– innehåll array Innehållet i jsonl-filen. No
└– created_after integer En valfri Unix-tidsstämpel för att filtrera objekt som skapats efter den här tiden. No
└– created_before integer En valfri Unix-tidsstämpel för att filtrera objekt som skapats före den här tiden. No
└– id string Identifieraren för filen. No
└– gräns integer Ett valfritt maximalt antal objekt som ska returneras. No
└– metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
└– modell string En valfri modell att filtrera efter (t.ex. "gpt-4o"). No
└– typ enum Typ av källa. Alltid stored_completions.
Möjliga värden: stored_completions		 No
type enum Typen av körningsdatakälla. Alltid completions.
Möjliga värden: completions		 Yes

OpenAI.EvalCustomDataSourceConfigParams

Ett CustomDataSourceConfig-objekt som definierar schemat för datakällan som används för utvärderingskörningarna. Det här schemat används för att definiera formen på de data som ska vara:

  • Används för att definiera dina testkriterier och
  • Vilka data som krävs när du skapar en körning
Name Type Description Required Default
inkludera_exempelschema boolean Om utvärderingen ska förutsätta att du fyller exempelnamnområdet (dvs. genom att generera svar från din datakälla) No False
objektschema object Json-schemat för varje rad i datakällan. Yes
type enum Typen av datakälla. Alltid custom.
Möjliga värden: custom		 Yes

OpenAI.EvalCustomDataSourceConfigResource

En CustomDataSourceConfig som anger schemat för dina item och eventuellt sample namnområden. Svarsschemat definierar formen på de data som ska vara:

  • Används för att definiera dina testkriterier och
  • Vilka data som krävs när du skapar en körning
Name Type Description Required Default
schema object Json-schemat för körningen av datakällans objekt.
Lär dig hur du skapar JSON-scheman här.		 Yes
type enum Typen av datakälla. Alltid custom.
Möjliga värden: custom		 Yes

OpenAI.EvalDataSourceConfigParams

Diskriminerande för OpenAI.EvalDataSourceConfigParams

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
custom OpenAI.EvalCustomDataSourceConfigParams
logs OpenAI.EvalLogsDataSourceConfigParams
stored_completions OpenAI.EvalStoredCompletionsDataSourceConfigParams
Name Type Description Required Default
type OpenAI.EvalDataSourceConfigType Yes

OpenAI.EvalDataSourceConfigResource

Diskriminerande för OpenAI.EvalDataSourceConfigResource

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
custom OpenAI.EvalCustomDataSourceConfigResource
stored_completions OpenAI.EvalStoredCompletionsDataSourceConfigResource
logs OpenAI.EvalLogsDataSourceConfigResource
Name Type Description Required Default
type OpenAI.EvalDataSourceConfigType Yes

OpenAI.EvalDataSourceConfigType

Property Value
Type string
Values custom
logs
stored_completions

OpenAI.EvalGraderLabelModelParams

Ett LabelModelGrader-objekt som använder en modell för att tilldela etiketter till varje objekt i utvärderingen.

Name Type Description Required Default
input array En lista över chattmeddelanden som utgör prompten eller kontexten. Kan innehålla variabelreferenser till item namnområdet, d.v.s. {{item.name}}. Yes
Etiketter array Etiketterna som ska klassificeras för varje objekt i utvärderingen. Yes
model string Den modell som ska användas för utvärderingen. Måste ha stöd för strukturerade utdata. Yes
name string Namnet på bedömaren. Yes
godkända_etiketter array Etiketterna som anger ett godkänt resultat. Måste vara en delmängd av etiketter. Yes
type enum Objekttypen, som alltid label_modelär .
Möjliga värden: label_model		 Yes

OpenAI.EvalGraderLabelModelResource

Name Type Description Required Default
input array Yes
Etiketter array Etiketterna som ska tilldelas till varje objekt i utvärderingen. Yes
model string Den modell som ska användas för utvärderingen. Måste ha stöd för strukturerade utdata. Yes
name string Namnet på bedömaren. Yes
godkända_etiketter array Etiketterna som anger ett godkänt resultat. Måste vara en delmängd av etiketter. Yes
type enum Objekttypen, som alltid label_modelär .
Möjliga värden: label_model		 Yes

OpenAI.EvalGraderParams

Diskriminerande för OpenAI.EvalGraderParams

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
label_model OpenAI.EvalGraderLabelModelParams
string_check OpenAI.EvalGraderStringCheckParams
text_similarity OpenAI.EvalGraderTextSimilarityParams
python OpenAI.EvalGraderPythonParams
score_model OpenAI.EvalGraderScoreModelParams
Name Type Description Required Default
type OpenAI.GraderType Yes

OpenAI.EvalGraderPythonParams

Name Type Description Required Default
image_tag string Avbildningstaggen som ska användas för Python-skriptet. No
name string Namnet på bedömaren. Yes
passera gränsvärde number Tröskelvärdet för poängen. No
källa string Källkoden för Python-skriptet. Yes
type enum Objekttypen, som alltid pythonär .
Möjliga värden: python		 Yes

OpenAI.EvalGraderPythonResource

Name Type Description Required Default
image_tag string Avbildningstaggen som ska användas för Python-skriptet. No
name string Namnet på bedömaren. Yes
passera gränsvärde number Tröskelvärdet för poängen. No
källa string Källkoden för Python-skriptet. Yes
type enum Objekttypen, som alltid pythonär .
Möjliga värden: python		 Yes

OpenAI.EvalGraderResource

Diskriminerande för OpenAI.EvalGraderResource

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
label_model OpenAI.EvalGraderLabelModelResource
text_similarity OpenAI.EvalGraderTextSimilarityResource
python OpenAI.EvalGraderPythonResource
score_model OpenAI.EvalGraderScoreModelResource
Name Type Description Required Default
type OpenAI.GraderType Yes

OpenAI.EvalGraderScoreModelParams

Name Type Description Required Default
input array Inmatningstexten. Detta kan innehålla mallsträngar. Yes
model string Den modell som ska användas för utvärderingen. Yes
name string Namnet på bedömaren. Yes
passera gränsvärde number Tröskelvärdet för poängen. No
omfång array Poängintervallet. Standardinställningen är [0, 1]. No
provtagning_parametrar Samplingsparametrarna för modellen. No
type enum Objekttypen, som alltid score_modelär .
Möjliga värden: score_model		 Yes

OpenAI.EvalGraderScoreModelResource

Name Type Description Required Default
input array Inmatningstexten. Detta kan innehålla mallsträngar. Yes
model string Den modell som ska användas för utvärderingen. Yes
name string Namnet på bedömaren. Yes
passera gränsvärde number Tröskelvärdet för poängen. No
omfång array Poängintervallet. Standardinställningen är [0, 1]. No
provtagning_parametrar Samplingsparametrarna för modellen. No
type enum Objekttypen, som alltid score_modelär .
Möjliga värden: score_model		 Yes

OpenAI.EvalGraderStringCheckParams

Name Type Description Required Default
input string Inmatningstexten. Detta kan innehålla mallsträngar. Yes
name string Namnet på bedömaren. Yes
Operation enum Strängkontrollprocessen som ska utföras. En av eq, ne, likeeller ilike.
Möjliga värden: eq, ne, like, ilike		 Yes
hänvisning string Referenstexten. Detta kan innehålla mallsträngar. Yes
type enum Objekttypen, som alltid string_checkär .
Möjliga värden: string_check		 Yes

OpenAI.EvalGraderTextSimilarityParams

Name Type Description Required Default
utvärderingsmetrik enum Det utvärderingsmått som ska användas. En av fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5eller rouge_l.
Möjliga värden: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , , rouge_5rouge_l		 Yes
input string Texten som bedöms. Yes
name string Namnet på bedömaren. Yes
passera gränsvärde number Tröskelvärdet för poängen. Yes
hänvisning string Texten som betygsätts och jämförs med. Yes
type enum Typ av väghyvel.
Möjliga värden: text_similarity		 Yes

OpenAI.EvalGraderTextSimilarityResource

Name Type Description Required Default
utvärderingsmetrik enum Det utvärderingsmått som ska användas. En av fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5eller rouge_l.
Möjliga värden: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , , rouge_5rouge_l		 Yes
input string Texten som bedöms. Yes
name string Namnet på bedömaren. Yes
passera gränsvärde number Tröskelvärdet för poängen. Yes
hänvisning string Texten som betygsätts och jämförs med. Yes
type enum Typ av väghyvel.
Möjliga värden: text_similarity		 Yes

OpenAI.EvalItem

Ett meddelande som matas in till modellen med en roll som anger instruktionen efter hierarkin. Instruktioner som ges med developer rollen eller system har företräde framför instruktioner som ges med user rollen. Meddelanden med assistant rollen antas ha genererats av modellen i tidigare interaktioner.

Name Type Description Required Default
content object Yes
└– typ OpenAI.EvalItemContentType No
role enum Rollen för meddelandets inmatning. En av user, assistant, systemeller
developer.
Möjliga värden: user, assistant, system, developer		 Yes
type enum Typ av meddelandeindata. Alltid message.
Möjliga värden: message		 No

OpenAI.EvalItemContent

Diskriminerande för OpenAI.EvalItemContent

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
input_text OpenAI.EvalItemContentInputText
output_text OpenAI.EvalItemContentOutputText
Name Type Description Required Default
type OpenAI.EvalItemContentType Yes

OpenAI.EvalItemContentInputText

Name Type Description Required Default
text string Yes
type enum
Möjliga värden: input_text		 Yes

OpenAI.EvalItemContentOutputText

Name Type Description Required Default
text string Yes
type enum
Möjliga värden: output_text		 Yes

OpenAI.EvalItemContentType

Property Value
Type string
Values input_text
output_text

OpenAI.EvalJsonlRunDataSourceParams

Ett JsonlRunDataSource-objekt som anger en JSONL-fil som matchar eval

Name Type Description Required Default
källa object Yes
└– innehåll array Innehållet i jsonl-filen. No
└– id string Identifieraren för filen. No
└– typ enum Typen av jsonl-källa. Alltid file_id.
Möjliga värden: file_id		 No
type enum Typen av datakälla. Alltid jsonl.
Möjliga värden: jsonl		 Yes

OpenAI.EvalList

Ett objekt som representerar en lista över evals.

Name Type Description Required Default
data array En matris med eval-objekt. Yes
first_id string Identifieraren för den första evalen i datamatrisen. Yes
has_more boolean Anger om det finns fler utvärderingar tillgängliga. Yes
last_id string Identifieraren för den senaste evalen i datamatrisen. Yes
object enum Typen av det här objektet. Den är alltid inställd på "lista".
Möjliga värden: list		 Yes

OpenAI.EvalLogsDataSourceConfigParams

En konfiguration av datakälla som anger metadataegenskapen för loggfrågan. Det här är vanligtvis metadata som usecase=chatbot eller prompt-version=v2osv.

Name Type Description Required Default
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
type enum Typen av datakälla. Alltid logs.
Möjliga värden: logs		 Yes

OpenAI.EvalLogsDataSourceConfigResource

En LogsDataSourceConfig som anger metadataegenskapen för loggfrågan. Det här är vanligtvis metadata som usecase=chatbot eller prompt-version=v2osv. Schemat som returneras av den här datakällans konfiguration används för att definiera vilka variabler som är tillgängliga i dina evals. item och sample definieras båda när du använder den här datakällans konfiguration.

Name Type Description Required Default
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
schema object Json-schemat för körningen av datakällans objekt.
Lär dig hur du skapar JSON-scheman här.		 Yes
type enum Typen av datakälla. Alltid logs.
Möjliga värden: logs		 Yes

OpenAI.EvalResponsesRunDataSourceParams

Ett ResponsesRunDataSource-objekt som beskriver en modellsamplingskonfiguration.

Name Type Description Required Default
inmatningsmeddelanden object No
└– item_reference string En referens till en variabel i item namnområdet. Dvs, "item.name" No
└– mall array En lista över chattmeddelanden som utgör prompten eller kontexten. Kan innehålla variabelreferenser till item namnområdet, d.v.s. {{item.name}}. No
└– typ enum Typ av indatameddelanden. Alltid item_reference.
Möjliga värden: item_reference		 No
model string Namnet på den modell som ska användas för att generera slutföranden (t.ex. "o3-mini"). No
provtagning_parametrar AzureEvalAPIResponseSamplingParams No
källa object Yes
└– innehåll array Innehållet i jsonl-filen. No
└– created_after integer Inkludera endast objekt som skapats efter den här tidsstämpeln (inklusive). Det här är en frågeparameter som används för att välja svar. No
└– created_before integer Inkludera endast objekt som skapats före den här tidsstämpeln (inklusive). Det här är en frågeparameter som används för att välja svar. No
└– id string Identifieraren för filen. No
└– instructions_search string Valfri sträng för att söka i instruktionsfältet. Det här är en frågeparameter som används för att välja svar. No
└– metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
└– modell string Namnet på modellen som svar ska hittas för. Det här är en frågeparameter som används för att välja svar. No
└– reasoning_effort OpenAI.ReasoningEffort Valfria parametrar för resonemangsinsats. Det här är en frågeparameter som används för att välja svar. No
└– temperatur number Samplingstemperatur. Det här är en frågeparameter som används för att välja svar. No
└— verktyg array Lista över verktygsnamn. Det här är en frågeparameter som används för att välja svar. No
└– top_p number Nucleus-samplingsparameter. Det här är en frågeparameter som används för att välja svar. No
└– typ enum Typen av körningsdatakälla. Alltid responses.
Möjliga värden: responses		 No
└— användare array Lista över användaridentifierare. Det här är en frågeparameter som används för att välja svar. No
type enum Typen av körningsdatakälla. Alltid responses.
Möjliga värden: responses		 Yes

OpenAI.EvalRun

Ett schema som representerar en utvärderingskörning.

Name Type Description Required Default
created_at integer Unix-tidsstämpel (i sekunder) när utvärderingskörningen skapades. Yes
datakälla object Yes
└– typ OpenAI.EvalRunDataSourceType No
error OpenAI.EvalApiError Ett objekt som representerar ett felsvar från Eval-API:et. Yes
eval_id string Identifieraren för den associerade utvärderingen. Yes
id string Unik identifierare för utvärderingskörningen. Yes
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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 Den modell som utvärderas, om tillämpligt. Yes
name string Namnet på utvärderingskörningen. Yes
object enum Typ av objekt. Alltid "eval.run".
Möjliga värden: eval.run		 Yes
per modellanvändning array Användningsstatistik för varje modell under utvärderingskörningen. Yes
per_testkriterier_resultat array Resultat per testkriterier som tillämpades under utvärderingen. Yes
report_url string URL:en till den renderade utvärderingskörningsrapporten på instrumentpanelen för användargränssnittet. Yes
antalresultat object Räknare som sammanfattar resultatet av utvärderingsprocessen. Yes
└– felaktig integer Antal utdataobjekt som resulterade i ett fel. No
└– misslyckades integer Antal utdataobjekt som inte klarade utvärderingen. No
└– godkänd integer Antal utdataobjekt som klarade utvärderingen. No
└— totalt integer Totalt antal utförda utdataobjekt. No
status string Status för utvärderingskörningen. Yes

OpenAI.EvalRunDataContentSource

Diskriminerande för OpenAI.EvalRunDataContentSource

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
file_id OpenAI.EvalRunFileIdDataContentSource
stored_completions OpenAI.EvalRunStoredCompletionsDataContentSource
responses OpenAI.EvalRunResponsesDataContentSource
Name Type Description Required Default
type OpenAI.EvalRunDataContentSourceType Yes

OpenAI.EvalRunDataContentSourceType

Property Value
Type string
Values file_id
file_content
stored_completions
responses

OpenAI.EvalRunDataSourceCompletionsResource

Name Type Description Required Default
type enum
Möjliga värden: completions		 Yes

OpenAI.EvalRunDataSourceJsonlResource

Name Type Description Required Default
type enum
Möjliga värden: jsonl		 Yes

OpenAI.EvalRunDataSourceParams

Diskriminerande för OpenAI.EvalRunDataSourceParams

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
jsonl OpenAI.EvalJsonlRunDataSourceParams
completions OpenAI.EvalCompletionsRunDataSourceParams
responses OpenAI.EvalResponsesRunDataSourceParams
Name Type Description Required Default
type OpenAI.EvalRunDataSourceType Yes

OpenAI.EvalRunDataSourceResource

Name Type Description Required Default
type OpenAI.EvalRunDataSourceType Yes

OpenAI.EvalRunDataSourceResponsesResource

Name Type Description Required Default
type enum
Möjliga värden: responses		 Yes

OpenAI.EvalRunDataSourceType

Property Value
Type string
Values jsonl
completions
responses

OpenAI.EvalRunFileContentDataContentSource

Name Type Description Required Default
content array Innehållet i jsonl-filen. Yes
type enum Typen av jsonl-källa. Alltid file_content.
Möjliga värden: file_content		 Yes

OpenAI.EvalRunFileIdDataContentSource

Name Type Description Required Default
id string Identifieraren för filen. Yes
type enum Typen av jsonl-källa. Alltid file_id.
Möjliga värden: file_id		 Yes

OpenAI.EvalRunList

Ett objekt som representerar en lista över exekveringar för en utvärdering.

Name Type Description Required Default
data array En matris med eval-körningsobjekt. Yes
first_id string Identifieraren för den första eval-körningen i datamatrisen. Yes
has_more boolean Anger om det finns fler utvärderingar tillgängliga. Yes
last_id string Identifierare för den senaste eval-körningen i dataarrayen. Yes
object enum Typen av det här objektet. Den är alltid inställd på "lista".
Möjliga värden: list		 Yes

OpenAI.EvalRunOutputItem

Ett schema som representerar ett utdataobjekt för utvärderingskörning.

Name Type Description Required Default
created_at integer Unix-tidsstämpel (i sekunder) när utvärderingskörningen skapades. Yes
datasource-objekt object Information om indatakällans objekt. Yes
datakälla_objekt_id integer Identifieraren för datakällans objekt. Yes
eval_id string Identifieraren för utvärderingsgruppen. Yes
id string Unik identifierare för output-objektet vid utvärderingskörningen. Yes
object enum Typ av objekt. Alltid "eval.run.output_item".
Möjliga värden: eval.run.output_item		 Yes
results array En lista över resultat från utvärderingskörningen. Yes
run_id string Identifieraren för utvärderingskörningen som är associerad med det här utdataobjektet. Yes
exempel object Ett exempel som innehåller indata och utdata från utvärderingskörningen. Yes
└– fel OpenAI.EvalApiError Ett objekt som representerar ett felsvar från Eval-API:et. No
└– avslutnings_anledning string Anledningen till att exempelgenereringen slutfördes. No
└– indata array En matris med indatameddelanden. No
└– max_completion_tokens integer Det maximala antalet token som tillåts för slutförande. No
└– modell string Den modell som används för att generera exemplet. No
└– utdata array En matris med utdatameddelanden. No
└– frö integer Det frö som används för att generera exemplet. No
└– temperatur number Den samplingstemperatur som används. No
└– top_p number Det top_p värde som används för sampling. No
└— användning object Information om tokenanvändning för exemplet. No
└– cached_tokens integer Antalet token som hämtats från cacheminnet. No
└– completion_tokens integer Antalet slutförandetoken som genererats. No
└– prompt_tokens integer Antalet prompttoken som används. No
└– totalt_antal_tokenar integer Det totala antalet token som används. No
status string Status för utvärderingskörningen. Yes

OpenAI.EvalRunOutputItemList

Ett objekt som representerar en lista över utdataobjekt för en utvärderingskörning.

Name Type Description Required Default
data array En matris med objekt för eval-körning av utdataobjekt. Yes
first_id string Identifieraren för utdataobjektet från första eval-körningen i datamatrisen. Yes
has_more boolean Anger om det finns mer utvärderingskörningsutdata tillgänglig. Yes
last_id string Identifieraren för utdataobjektet för den senaste eval-körningen i datamatrisen. Yes
object enum Typen av det här objektet. Den är alltid inställd på "lista".
Möjliga värden: list		 Yes

OpenAI.EvalRunResponsesDataContentSource

Ett EvalResponsesSource-objekt som beskriver en konfiguration av datakällan som körs.

Name Type Description Required Default
skapad_efter integer Inkludera endast objekt som skapats efter den här tidsstämpeln (inklusive). Det här är en frågeparameter som används för att välja svar. No
skapat_före integer Inkludera endast objekt som skapats före den här tidsstämpeln (inklusive). Det här är en frågeparameter som används för att välja svar. No
instructions_search string Valfri sträng för att söka i instruktionsfältet. Det här är en frågeparameter som används för att välja svar. No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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 Namnet på modellen som svar ska hittas för. Det här är en frågeparameter som används för att välja svar. No
reasoning_effort object Endast o-seriemodeller

Begränsar arbetet med resonemang för resonemangsmodeller.
Värden som stöds för närvarande är low, mediumoch high. Minska
Ansträngning i resonemang kan leda till snabbare svar och färre token som används
om resonemang i ett svar.		 No
temperature number Samplingstemperatur. Det här är en frågeparameter som används för att välja svar. No
tools array Lista över verktygsnamn. Det här är en frågeparameter som används för att välja svar. No
top_p number Nucleus-samplingsparameter. Det här är en frågeparameter som används för att välja svar. No
type enum Typen av körningsdatakälla. Alltid responses.
Möjliga värden: responses		 Yes
användare array Lista över användaridentifierare. Det här är en frågeparameter som används för att välja svar. No

OpenAI.EvalRunStoredCompletionsDataContentSource

En StoredCompletionsRunDataSource-konfiguration som beskriver en uppsättning filter

Name Type Description Required Default
skapad_efter integer En valfri Unix-tidsstämpel för att filtrera objekt som skapats efter den här tiden. No
skapat_före integer En valfri Unix-tidsstämpel för att filtrera objekt som skapats före den här tiden. No
limit integer Ett valfritt maximalt antal objekt som ska returneras. No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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 En valfri modell att filtrera efter (t.ex. "gpt-4o"). No
type enum Typ av källa. Alltid stored_completions.
Möjliga värden: stored_completions		 Yes

OpenAI.EvalStoredCompletionsDataSourceConfigParams

Inaktuell till förmån för LogsDataSourceConfig.

Name Type Description Required Default
metadata object Metadatafilter för datakällan för lagrade slutföranden. No
type enum Typen av datakälla. Alltid stored_completions.
Möjliga värden: stored_completions		 Yes

OpenAI.EvalStoredCompletionsDataSourceConfigResource

Inaktuell till förmån för LogsDataSourceConfig.

Name Type Description Required Default
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
schema object Json-schemat för körningen av datakällans objekt.
Lär dig hur du skapar JSON-scheman här.		 Yes
type enum Typen av datakälla. Alltid stored_completions.
Möjliga värden: stored_completions		 Yes

OpenAI.FileSearchTool

Ett verktyg som söker efter relevant innehåll från uppladdade filer.

Name Type Description Required Default
filters object No
max_num_results integer Det maximala antalet resultat som ska returneras. Det här talet ska vara mellan 1 och 50 inklusive. No
ranking_options object No
└— ranker enum Rangordningen som ska användas för filsökningen.
Möjliga värden: auto, default-2024-11-15		 No
└– poängtröskel number Tröskelvärdet för poäng för filsökningen, ett tal mellan 0 och 1. Tal närmare 1 försöker returnera endast de mest relevanta resultaten, men kan returnera färre resultat. No
type enum Typ av filsökningsverktyg. Alltid file_search.
Möjliga värden: file_search		 Yes
vector_store_ids array ID:t för vektorarkiven som ska sökas. Yes

OpenAI.FileSearchToolCallItemParam

Resultatet av ett filsökningsverktygsanrop.

Name Type Description Required Default
queries array De frågor som används för att söka efter filer. Yes
results array Resultatet av anropet till filsökningsverktyget. No
type enum
Möjliga värden: file_search_call		 Yes

OpenAI.FileSearchToolCallItemResource

Resultatet av ett filsökningsverktygsanrop.

Name Type Description Required Default
queries array De frågor som används för att söka efter filer. Yes
results array Resultatet av anropet till filsökningsverktyget. 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, , incompletefailed		 Yes
type enum
Möjliga värden: file_search_call		 Yes

OpenAI.Filters

Name Type Description Required Default
filters array Matris med filter som ska kombineras. Objekt kan vara ComparisonFilter eller CompoundFilter. Yes
key string Nyckeln som ska jämföras med värdet. Yes
type enum Typ av åtgärd: and eller or.
Möjliga värden: and, or		 Yes
value sträng eller tal eller booleskt värde Det värde som ska jämföras med attributnyckeln. stöder sträng-, nummer- eller booleska typer. Yes

OpenAI.FineTuneDPOHyperparameters

De hyperparametrar som används för DPO-finjusteringsjobbet.

Name Type Description Required Default
batchstorlek enum
Möjliga värden: auto		 No
beta enum
Möjliga värden: auto		 No
inlärningshastighetsmultiplikator enum
Möjliga värden: auto		 No
antal epoker enum
Möjliga värden: auto		 No

OpenAI.FineTuneDPOMethod

Konfiguration för DPO-finjusteringsmetoden.

Name Type Description Required Default
hyperparametrar OpenAI.FineTuneDPOHyperparameters De hyperparametrar som används för DPO-finjusteringsjobbet. No

OpenAI.FineTuneMethod

Metoden som används för finjustering.

Name Type Description Required Default
dpo OpenAI.FineTuneDPOMethod Konfiguration för DPO-finjusteringsmetoden. No
förstärkning AzureFineTuneReinforcementMethod No
Övervakas OpenAI.FineTuneSupervisedMethod Konfiguration för den övervakade finjusteringsmetoden. No
type enum Typ av metod. Är antingen supervised, dpoeller reinforcement.
Möjliga värden: supervised, dpo, reinforcement		 Yes

OpenAI.FineTuneReinforcementHyperparameters

De hyperparametrar som används för finjusteringsjobbet för förstärkning.

Name Type Description Required Default
batchstorlek enum
Möjliga värden: auto		 No
compute_multiplier enum
Möjliga värden: auto		 No
eval_interval enum
Möjliga värden: auto		 No
eval_samples enum
Möjliga värden: auto		 No
inlärningshastighetsmultiplikator enum
Möjliga värden: auto		 No
antal epoker enum
Möjliga värden: auto		 No
reasoning_effort enum Nivå av resonemangsarbete.
Möjliga värden: default, low, medium, high		 No

OpenAI.FineTuneSupervisedHyperparameters

De hyperparametrar som används för finjusteringsjobbet.

Name Type Description Required Default
batchstorlek enum
Möjliga värden: auto		 No
inlärningshastighetsmultiplikator enum
Möjliga värden: auto		 No
antal epoker enum
Möjliga värden: auto		 No

OpenAI.FineTuneSupervisedMethod

Konfiguration för den övervakade finjusteringsmetoden.

Name Type Description Required Default
hyperparametrar OpenAI.FineTuneSupervisedHyperparameters De hyperparametrar som används för finjusteringsjobbet. No

OpenAI.FineTuningIntegration

Diskriminerande för OpenAI.FineTuningIntegration

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
wandb OpenAI.FineTuningIntegrationWandb
Name Type Description Required Default
type sträng (se giltiga modeller nedan) Yes

OpenAI.FineTuningIntegrationWandb

Name Type Description Required Default
type enum Vilken typ av integrering som aktiveras för finjusteringsjobbet
Möjliga värden: wandb		 Yes
wandb object Inställningarna för din integrering med Vikter och Biases. Den här nyttolasten anger det projekt som
mått skickas till. Du kan också ange ett explicit visningsnamn för körningen, lägga till taggar
till din körning och ange en standardentitet (team, användarnamn osv.) som ska associeras med din körning.		 Yes
└— entitet string Entiteten som ska användas för körningen. På så sätt kan du ange det team eller användarnamn för WandB-användaren som du vill
som associeras med körningen. Om den inte anges används standardentiteten för den registrerade WandB API-nyckeln.		 No
└— namn string Ett visningsnamn som ska anges för körningen. Om det inte anges använder vi jobb-ID:t som namn. No
└– projekt string Namnet på projektet som den nya körningen ska skapas under. No
└– taggar array En lista över taggar som ska kopplas till den nyligen skapade körningen. Dessa taggar skickas direkt till WandB. Vissa
standardtaggar genereras av OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".		 No

OpenAI.FineTuningJob

Objektet fine_tuning.job representerar ett finjusteringsjobb som har skapats via API:et.

Name Type Description Required Default
created_at integer Unix-tidsstämpeln (i sekunder) för när finjusteringsjobbet skapades. Yes
error object För finjusteringsjobb som har failedinnehåller detta mer information om orsaken till felet. Yes
└– kod string En felkod som kan läsas av datorn. No
└– meddelande string Ett felmeddelande som kan läsas av människor. No
└– param string Parametern som var ogiltig, vanligtvis training_file eller validation_file. Det här fältet är null om felet inte var parameterspecifikt. No
beräknad avslutning integer Unix-tidsstämpeln (i sekunder) för när finjusteringsjobbet beräknas vara klart. Värdet är null om finjusteringsjobbet inte körs. No
finjusterad modell string Namnet på den finjusterade modell som skapas. Värdet är null om finjusteringsjobbet fortfarande körs. Yes
finished_at integer Unix-tidsstämpeln (i sekunder) för när finjusteringsjobbet slutfördes. Värdet är null om finjusteringsjobbet fortfarande körs. Yes
hyperparametrar object De hyperparametrar som används för finjusteringsjobbet. Det här värdet returneras endast när jobb körs supervised . Yes
└– batch_size enum
Möjliga värden: auto		 No
└– learning_rate_multiplier enum
Möjliga värden: auto		 No
└– n_epochs enum
Möjliga värden: auto		 No
id string Objektidentifieraren, som kan refereras till i API-slutpunkterna. Yes
Integrationer array En lista över integreringar som ska aktiveras för det här finjusteringsjobbet. No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
metod OpenAI.FineTuneMethod Metoden som används för finjustering. No
model string Basmodellen som finjusteras. Yes
object enum Objekttypen, som alltid är "fine_tuning.job".
Möjliga värden: fine_tuning.job		 Yes
organization_id string Den organisation som äger finjusteringsjobbet. Yes
resultatfiler array Det kompilerade resultatfil-ID:t för finjusteringsjobbet. Du kan hämta resultatet med Api:et Files. Yes
seed integer Det frö som används för finjusteringsjobbet. Yes
status enum Den aktuella statusen för finjusteringsjobbet, som kan vara antingen validating_files, queued, running, succeeded, failedeller cancelled.
Möjliga värden: validating_files, queued, running, succeeded, , failedcancelled		 Yes
tränade_token integer Det totala antalet fakturerbara token som bearbetas av det här finjusteringsjobbet. Värdet är null om finjusteringsjobbet fortfarande körs. Yes
utbildningsfil string Det fil-ID som används för träning. Du kan hämta träningsdata med Files-API:et. Yes
user_provided_suffix string Det beskrivande suffixet som tillämpas på jobbet, enligt beskrivningen i begäran om jobbskapande. No
validation_file string Det fil-ID som används för validering. Du kan hämta valideringsresultatet med Files-API:et. Yes

OpenAI.FineTuningJobCheckpoint

Objektet fine_tuning.job.checkpoint representerar en modellkontrollpunkt för ett finjusteringsjobb som är redo att användas.

Name Type Description Required Default
created_at integer Unix-tidsstämpeln (i sekunder) för när kontrollpunkten skapades. Yes
Fintjusterad modellkontrollpunkt string Namnet på den finjusterade kontrollpunktsmodellen som skapas. Yes
finjusteringsjobb_id string Namnet på det finjusteringsjobb från vilket denna kontrollpunkt skapades. Yes
id string Kontrollpunktsidentifieraren, som kan refereras till i API-slutpunkterna. Yes
mätvärden object Mått vid stegnumret under finjusteringsjobbet. Yes
└– full_valid_loss number No
└– full_valid_mean_token_accuracy number No
└– steg number No
└– train_loss number No
└– train_mean_token_accuracy number No
└– valid_loss number No
└– valid_mean_token_accuracy number No
object enum Objekttypen, som alltid är "fine_tuning.job.checkpoint".
Möjliga värden: fine_tuning.job.checkpoint		 Yes
stegnummer integer Det stegnummer som kontrollpunkten skapades vid. Yes

OpenAI.FineTuningJobEvent

Finjustera jobbhändelseobjekt

Name Type Description Required Default
created_at integer Unix-tidsstämpeln (i sekunder) för när finjusteringsjobbet skapades. Yes
data De data som är associerade med händelsen. No
id string Objektidentifieraren. Yes
nivå enum Loggnivån för händelsen.
Möjliga värden: info, warn, error		 Yes
message string Meddelandet om händelsen. Yes
object enum Objekttypen, som alltid är "fine_tuning.job.event".
Möjliga värden: fine_tuning.job.event		 Yes
type enum Typ av händelse.
Möjliga värden: message, metrics		 No

OpenAI.FunctionObject

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

OpenAI.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 som ska anropas. Yes
parameters Ett JSON-schemaobjekt som beskriver funktionens parametrar. Yes
strict boolean Om strikt parameterverifiering ska tillämpas. Standard true. Yes
type enum Typ av funktionsverktyg. Alltid function.
Möjliga värden: function		 Yes

OpenAI.FunctionToolCallItemParam

Ett verktygsanrop för att köra en funktion.

Name Type Description Required Default
arguments string En JSON-sträng med argumenten som ska skickas till funktionen. Yes
call_id string Det unika ID:t för funktionsverktygets anrop som genereras av modellen. Yes
name string Namnet på den funktion som ska köras. Yes
type enum
Möjliga värden: function_call		 Yes

OpenAI.FunctionToolCallItemResource

Ett verktygsanrop för att köra en funktion.

Name Type Description Required Default
arguments string En JSON-sträng med argumenten som ska skickas till funktionen. Yes
call_id string Det unika ID:t för funktionsverktygets anrop som genereras av modellen. Yes
name string Namnet på den funktion som ska köras. Yes
status enum Status för objektet. En av in_progress, completed eller
incomplete. Fylls i när objekt returneras via API.
Möjliga värden: in_progress, completed, incomplete		 Yes
type enum
Möjliga värden: function_call		 Yes

OpenAI.FunctionToolCallOutputItemParam

Utdata från ett funktionsverktygsanrop.

Name Type Description Required Default
call_id string Det unika ID:t för funktionsverktygets anrop som genereras av modellen. Yes
output string En JSON-sträng med utdata från funktionsverktygets anrop. Yes
type enum
Möjliga värden: function_call_output		 Yes

OpenAI.FunctionToolCallOutputItemResource

Utdata från ett funktionsverktygsanrop.

Name Type Description Required Default
call_id string Det unika ID:t för funktionsverktygets anrop som genereras av modellen. Yes
output string En JSON-sträng med utdata från funktionsverktygets anrop. Yes
status enum Status för objektet. En av in_progress, completed eller
incomplete. Fylls i när objekt returneras via API.
Möjliga värden: in_progress, completed, incomplete		 Yes
type enum
Möjliga värden: function_call_output		 Yes

OpenAI.Grader

Diskriminerande för OpenAI.Grader

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
label_model OpenAI.GraderLabelModel
text_similarity OpenAI.GraderTextSimilarity
python OpenAI.GraderPython
score_model OpenAI.GraderScoreModel
multi OpenAI.GraderMulti
Name Type Description Required Default
type OpenAI.GraderType Yes

OpenAI.GraderLabelModel

Ett LabelModelGrader-objekt som använder en modell för att tilldela etiketter till varje objekt i utvärderingen.

Name Type Description Required Default
input array Yes
Etiketter array Etiketterna som ska tilldelas till varje objekt i utvärderingen. Yes
model string Den modell som ska användas för utvärderingen. Måste ha stöd för strukturerade utdata. Yes
name string Namnet på bedömaren. Yes
godkända_etiketter array Etiketterna som anger ett godkänt resultat. Måste vara en delmängd av etiketter. Yes
type enum Objekttypen, som alltid label_modelär .
Möjliga värden: label_model		 Yes

OpenAI.GraderMulti

Ett MultiGrader-objekt kombinerar utdata från flera graders för att skapa en enda poäng.

Name Type Description Required Default
calculate_output string En formel för att beräkna utdata baserat på graderresultat. Yes
Klassare object Yes
name string Namnet på bedömaren. Yes
type enum Objekttypen, som alltid multiär .
Möjliga värden: multi		 Yes

OpenAI.GraderPython

Ett PythonGrader-objekt som kör ett Python-skript på indata.

Name Type Description Required Default
image_tag string Avbildningstaggen som ska användas för Python-skriptet. No
name string Namnet på bedömaren. Yes
källa string Källkoden för Python-skriptet. Yes
type enum Objekttypen, som alltid pythonär .
Möjliga värden: python		 Yes

OpenAI.GraderScoreModel

Ett ScoreModelGrader-objekt som använder en modell för att tilldela en poäng till indata.

Name Type Description Required Default
input array Inmatningstexten. Detta kan innehålla mallsträngar. Yes
model string Den modell som ska användas för utvärderingen. Yes
name string Namnet på bedömaren. Yes
omfång array Poängintervallet. Standardinställningen är [0, 1]. No
provtagning_parametrar Samplingsparametrarna för modellen. No
type enum Objekttypen, som alltid score_modelär .
Möjliga värden: score_model		 Yes

OpenAI.GraderStringCheck

Ett StringCheckGrader-objekt som utför en strängjämförelse mellan indata och referens med en angiven åtgärd.

Name Type Description Required Default
input string Inmatningstexten. Detta kan innehålla mallsträngar. Yes
name string Namnet på bedömaren. Yes
Operation enum Strängkontrollprocessen som ska utföras. En av eq, ne, likeeller ilike.
Möjliga värden: eq, ne, like, ilike		 Yes
hänvisning string Referenstexten. Detta kan innehålla mallsträngar. Yes
type enum Objekttypen, som alltid string_checkär .
Möjliga värden: string_check		 Yes

OpenAI.GraderTextSimilarity

Ett TextSimilarityGrader-objekt som betygsätter text baserat på likhetsmått.

Name Type Description Required Default
utvärderingsmetrik enum Det utvärderingsmått som ska användas. En av fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5eller rouge_l.
Möjliga värden: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , , rouge_5rouge_l		 Yes
input string Texten som bedöms. Yes
name string Namnet på bedömaren. Yes
hänvisning string Texten som betygsätts och jämförs med. Yes
type enum Typ av väghyvel.
Möjliga värden: text_similarity		 Yes

OpenAI.GraderType

Property Value
Type string
Values string_check
text_similarity
score_model
label_model
python
multi

OpenAI.ImageGenTool

Ett verktyg som genererar bilder med hjälp av en modell som gpt-image-1.

Name Type Description Required Default
background enum Bakgrundstyp för den genererade bilden. En av transparent,
opaque, eller auto. Förvald: auto.
Möjliga värden: transparent, opaque, auto		 No
input_image_mask object Valfri mask för inpainting. Innehåller image_url
(sträng, valfritt) och file_id (sträng, valfritt).		 No
└– file_id string Fil-ID för maskbilden. No
└ image_url string Base64-kodad maskbild. No
model enum Den bildgenereringsmodell som ska användas. Förvald: gpt-image-1.
Möjliga värden: gpt-image-1		 No
moderation enum Modereringsnivå för den genererade avbildningen. Förvald: auto.
Möjliga värden: auto, low		 No
output_compression integer Komprimeringsnivå för utdatabilden. Standard: 100. No 100
output_format enum Utdataformatet för den genererade avbildningen. En av png, webp eller
jpeg. Förvald: png.
Möjliga värden: png, webp, jpeg		 No
partial_images integer Antal partiella bilder som ska genereras i strömningsläge, från 0 (standardvärde) till 3. No 0
quality enum Kvaliteten på den genererade avbildningen. En av low, medium, high,
eller auto. Förvald: auto.
Möjliga värden: low, medium, high, auto		 No
size enum Storleken på den genererade avbildningen. En av 1024x1024, 1024x1536,
1536x1024, eller auto. Förvald: auto.
Möjliga värden: 1024x1024, 1024x1536, 1536x1024, auto		 No
type enum Typ av bildgenereringsverktyg. Alltid image_generation.
Möjliga värden: image_generation		 Yes

OpenAI.ImageGenToolCallItemParam

En begäran om bildgenerering som gjorts av modellen.

Name Type Description Required Default
result string Den genererade avbildningen som kodas i base64. Yes
type enum
Möjliga värden: image_generation_call		 Yes

OpenAI.ImageGenToolCallItemResource

En begäran om bildgenerering som gjorts av modellen.

Name Type Description Required Default
result string Den genererade avbildningen som kodas i base64. Yes
status enum
Möjliga värden: in_progress, completed, generating, failed		 Yes
type enum
Möjliga värden: image_generation_call		 Yes

OpenAI.ImplicitUserMessage

Name Type Description Required Default
content sträng eller matris Yes

OpenAI.Includable

Ange ytterligare utdata som ska inkluderas i modellsvaret. För närvarande stöds värden:

  • code_interpreter_call.outputs: Innehåller utdata från python-kodkörning i kodtolkverktygets anropsobjekt.
  • computer_call_output.output.image_url: Inkludera bild-URL:er från datorns anropsutdata.
  • file_search_call.results: Inkludera sökresultaten för filsökningsverktygets anrop.
  • message.input_image.image_url: Inkludera bild-URL:er från indatameddelandet.
  • message.output_text.logprobs: Inkludera logprobs med assistentmeddelanden.
  • reasoning.encrypted_content: Innehåller en krypterad version av resonemangstoken i utdata för resonemangsobjekt. Detta gör att resonemangsobjekt kan användas i konversationer med flera turer när du använder svars-API:et tillståndslöst (till exempel när parametern store är inställd på falseeller när en organisation har registrerats i programmet för datakvarhållning utan data).
Property Value
Description Ange ytterligare utdata som ska inkluderas i modellsvaret. För närvarande
värden som stöds är:
- code_interpreter_call.outputs: Innehåller utdata från python-kodkörning
i kodtolkarverktyget anropar objekt.
- computer_call_output.output.image_url: Inkludera bild-URL:er från datorns anropsresultat.
- file_search_call.results: Inkludera sökresultaten för
anropet till filsökningsverktyget.
- message.input_image.image_url: Inkludera bild-URL:er från indatameddelandet.
- message.output_text.logprobs: Inkludera logprobs med assistentmeddelanden.
- reasoning.encrypted_content: Innehåller en krypterad version av resonemanget
token i utdata för resonemangsobjekt. Detta gör det möjligt att använda resonemangsobjekt i
Flervändiga konversationer när du använder respons-API:et tillståndslöst (till exempel
när parametern store är inställd på false, eller när en organisation är
registrerats i programmet för ingen datalagring.
Type string
Values code_interpreter_call.outputs
computer_call_output.output.image_url
file_search_call.results
message.input_image.image_url
message.output_text.logprobs
reasoning.encrypted_content

OpenAI.ItemContent

Diskriminerande för OpenAI.ItemContent

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
input_audio OpenAI.ItemContentInputAudio
output_audio OpenAI.ItemContentOutputAudio
refusal OpenAI.ItemContentRefusal
input_text OpenAI.ItemContentInputText
input_image OpenAI.ItemContentInputImage
input_file OpenAI.ItemContentInputFile
output_text OpenAI.ItemContentOutputText
Name Type Description Required Default
type OpenAI.ItemContentType Multimodala in- och utdataflöden. Yes

OpenAI.ItemContentInputAudio

En ljudinmatning till modellen.

Name Type Description Required Default
data string Base64-kodade ljuddata. Yes
format enum Formatet för ljuddata. Format som stöds för närvarande är mp3 och
wav.
Möjliga värden: mp3, wav		 Yes
type enum Typ av indataobjekt. Alltid input_audio.
Möjliga värden: input_audio		 Yes

OpenAI.ItemContentInputFile

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 Typ av indataobjekt. Alltid input_file.
Möjliga värden: input_file		 Yes

OpenAI.ItemContentInputImage

En bildinmatning till modellen.

Name Type Description Required Default
detail enum Detaljnivån för bilden som ska skickas till modellen. En av high, loweller auto. Standardinställningen är auto.
Möjliga värden: low, high, auto		 No
file_id string ID:t för filen som ska skickas till modellen. No
image_url string URL:en för den bild som ska skickas till modellen. En fullständigt kvalificerad URL eller base64-kodad bild i en data-URL. No
type enum Typ av indataobjekt. Alltid input_image.
Möjliga värden: input_image		 Yes

OpenAI.ItemContentInputText

En textinmatning till modellen.

Name Type Description Required Default
text string Textinmatningen till modellen. Yes
type enum Typ av indataobjekt. Alltid input_text.
Möjliga värden: input_text		 Yes

OpenAI.ItemContentOutputAudio

Ett ljudutgång från modellen.

Name Type Description Required Default
data string Base64-kodade ljuddata från modellen. Yes
transcript string Avskriften av ljuddata från modellen. Yes
type enum Typen av utdataljudet. Alltid output_audio.
Möjliga värden: output_audio		 Yes

OpenAI.ItemContentOutputText

En textutgång från modellen.

Name Type Description Required Default
annotations array Anteckningarna i textutdata. Yes
logprobs array No
text string Textutdata från modellen. Yes
type enum Typ av utdatatext. Alltid output_text.
Möjliga värden: output_text		 Yes

OpenAI.ItemContentRefusal

En vägran från modellen.

Name Type Description Required Default
refusal string Avslagsförklaringen från modellen. Yes
type enum Typ av vägran. Alltid refusal.
Möjliga värden: refusal		 Yes

OpenAI.ItemContentType

Multimodala in- och utdataflöden.

Property Value
Description Multimodala in- och utdataflöden.
Type string
Values input_text
input_audio
input_image
input_file
output_text
output_audio
refusal

OpenAI.ItemParam

Innehållsobjekt som används för att generera ett svar.

Discriminator för OpenAI.ItemParam

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
file_search_call OpenAI.FileSearchToolCallItemParam
computer_call OpenAI.ComputerToolCallItemParam
computer_call_output OpenAI.ComputerToolCallOutputItemParam
web_search_call OpenAI.WebSearchToolCallItemParam
function_call OpenAI.FunctionToolCallItemParam
function_call_output OpenAI.FunctionToolCallOutputItemParam
reasoning OpenAI.ReasoningItemParam
item_reference OpenAI.ItemReferenceItemParam
image_generation_call OpenAI.ImageGenToolCallItemParam
code_interpreter_call OpenAI.CodeInterpreterToolCallItemParam
local_shell_call OpenAI.LocalShellToolCallItemParam
local_shell_call_output OpenAI.LocalShellToolCallOutputItemParam
mcp_list_tools OpenAI.MCPListToolsItemParam
mcp_approval_request OpenAI.MCPApprovalRequestItemParam
mcp_approval_response OpenAI.MCPApprovalResponseItemParam
mcp_call OpenAI.MCPCallItemParam
message OpenAI.ResponsesMessageItemParam
Name Type Description Required Default
type OpenAI.ItemType Yes

OpenAI.ItemReferenceItemParam

En intern identifierare för ett objekt att referera till.

Name Type Description Required Default
id string Det tjänstbaserade ID:t för det tidigare genererade svarsobjektet som refereras till. Yes
type enum
Möjliga värden: item_reference		 Yes

OpenAI.ItemResource

Innehållsobjekt som används för att generera ett svar.

Diskriminerande för OpenAI.ItemResource

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
file_search_call OpenAI.FileSearchToolCallItemResource
computer_call OpenAI.ComputerToolCallItemResource
computer_call_output OpenAI.ComputerToolCallOutputItemResource
web_search_call OpenAI.WebSearchToolCallItemResource
function_call OpenAI.FunctionToolCallItemResource
function_call_output OpenAI.FunctionToolCallOutputItemResource
reasoning OpenAI.ReasoningItemResource
image_generation_call OpenAI.ImageGenToolCallItemResource
code_interpreter_call OpenAI.CodeInterpreterToolCallItemResource
local_shell_call OpenAI.LocalShellToolCallItemResource
local_shell_call_output OpenAI.LocalShellToolCallOutputItemResource
mcp_list_tools OpenAI.MCPListToolsItemResource
mcp_approval_request OpenAI.MCPApprovalRequestItemResource
mcp_approval_response OpenAI.MCPApprovalResponseItemResource
mcp_call OpenAI.MCPCallItemResource
message OpenAI.ResponsesMessageItemResource
Name Type Description Required Default
id string Yes
type OpenAI.ItemType Yes

OpenAI.ItemType

Property Value
Type string
Values message
file_search_call
function_call
function_call_output
computer_call
computer_call_output
web_search_call
reasoning
item_reference
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call

OpenAI.ListFineTuningJobCheckpointsResponse

Name Type Description Required Default
data array Yes
first_id string No
has_more boolean Yes
last_id string No
object enum
Möjliga värden: list		 Yes

OpenAI.ListFineTuningJobEventsResponse

Name Type Description Required Default
data array Yes
has_more boolean Yes
object enum
Möjliga värden: list		 Yes

OpenAI.ListModelsResponse

Name Type Description Required Default
data array Yes
object enum
Möjliga värden: list		 Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Name Type Description Required Default
data array Yes
has_more boolean Yes
object enum
Möjliga värden: list		 Yes

OpenAI.ListVectorStoreFilesFilter

Property Value
Type string
Values in_progress
completed
failed
cancelled

OpenAI.ListVectorStoreFilesResponse

Name Type Description Required Default
data array Yes
first_id string Yes
has_more boolean Yes
last_id string Yes
object enum
Möjliga värden: list		 Yes

OpenAI.ListVectorStoresResponse

Name Type Description Required Default
data array Yes
first_id string Yes
has_more boolean Yes
last_id string Yes
object enum
Möjliga värden: list		 Yes

OpenAI.LocalShellExecAction

Kör ett gränssnittskommando på servern.

Name Type Description Required Default
kommando array Kommandot som ska köras. Yes
env object Miljövariabler som ska anges för kommandot. Yes
timeout_ms (timeout i millisekunder) integer Valfri timeout i millisekunder för kommandot. No
type enum Typen av lokal gränssnittsåtgärd. Alltid exec.
Möjliga värden: exec		 Yes
user string Valfri användare att köra kommandot som. No
working_directory string Valfri arbetskatalog för att köra kommandot i. No

OpenAI.LocalShellTool

Ett verktyg som gör att modellen kan köra gränssnittskommandon i en lokal miljö.

Name Type Description Required Default
type enum Typ av lokalt gränssnittsverktyg. Alltid local_shell.
Möjliga värden: local_shell		 Yes

OpenAI.LocalShellToolCallItemParam

Ett verktygsanrop för att köra ett kommando i det lokala gränssnittet.

Name Type Description Required Default
action OpenAI.LocalShellExecAction Kör ett gränssnittskommando på servern. Yes
call_id string Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen. Yes
type enum
Möjliga värden: local_shell_call		 Yes

OpenAI.LocalShellToolCallItemResource

Ett verktygsanrop för att köra ett kommando i det lokala gränssnittet.

Name Type Description Required Default
action OpenAI.LocalShellExecAction Kör ett gränssnittskommando på servern. Yes
call_id string Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen. Yes
status enum
Möjliga värden: in_progress, completed, incomplete		 Yes
type enum
Möjliga värden: local_shell_call		 Yes

OpenAI.LocalShellToolCallOutputItemParam

Utdata från ett lokalt gränssnittsverktygsanrop.

Name Type Description Required Default
output string En JSON-sträng med utdata från det lokala gränssnittets verktygsanrop. Yes
type enum
Möjliga värden: local_shell_call_output		 Yes

OpenAI.LocalShellToolCallOutputItemResource

Utdata från ett lokalt gränssnittsverktygsanrop.

Name Type Description Required Default
output string En JSON-sträng med utdata från det lokala gränssnittets verktygsanrop. Yes
status enum
Möjliga värden: in_progress, completed, incomplete		 Yes
type enum
Möjliga värden: local_shell_call_output		 Yes

OpenAI.Location

Diskriminator för OpenAI.Location

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
approximate OpenAI.ApproximateLocation
Name Type Description Required Default
type OpenAI.LocationType Yes

OpenAI.LocationType

Property Value
Type string
Values approximate

OpenAI.LogProb

Loggens sannolikhet för en token.

Name Type Description Required Default
bytes array Yes
logprob number Yes
token string Yes
top_logprobs array Yes

OpenAI.MCPApprovalRequestItemParam

En begäran om mänskligt godkännande av ett verktygsanrop.

Name Type Description Required Default
arguments string En JSON-sträng med argument för verktyget. Yes
name string Namnet på det verktyg som ska köras. Yes
server_label string Etiketten på MCP-servern som skickar begäran. Yes
type enum
Möjliga värden: mcp_approval_request		 Yes

OpenAI.MCPApprovalRequestItemResource

En begäran om mänskligt godkännande av ett verktygsanrop.

Name Type Description Required Default
arguments string En JSON-sträng med argument för verktyget. Yes
name string Namnet på det verktyg som ska köras. Yes
server_label string Etiketten på MCP-servern som skickar begäran. Yes
type enum
Möjliga värden: mcp_approval_request		 Yes

OpenAI.MCPApprovalResponseItemParam

Ett svar på en begäran om MCP-godkännande.

Name Type Description Required Default
approval_request_id string ID:t för godkännandebegäran som besvaras. Yes
approve boolean Om begäran godkändes. Yes
reason string Valfri orsak till beslutet. No
type enum
Möjliga värden: mcp_approval_response		 Yes

OpenAI.MCPApprovalResponseItemResource

Ett svar på en begäran om MCP-godkännande.

Name Type Description Required Default
approval_request_id string ID:t för godkännandebegäran som besvaras. Yes
approve boolean Om begäran godkändes. Yes
reason string Valfri orsak till beslutet. No
type enum
Möjliga värden: mcp_approval_response		 Yes

OpenAI.MCPCallItemParam

Ett anrop av ett verktyg på en MCP-server.

Name Type Description Required Default
arguments string En JSON-sträng med argumenten som skickas till verktyget. Yes
error string Felet från verktygsanropet, om det finns något. No
name string Namnet på verktyget som kördes. Yes
output string Utdata från verktygsanropet. No
server_label string Etiketten på MCP-servern som kör verktyget. Yes
type enum
Möjliga värden: mcp_call		 Yes

OpenAI.MCPCallItemResource

Ett anrop av ett verktyg på en MCP-server.

Name Type Description Required Default
arguments string En JSON-sträng med argumenten som skickas till verktyget. Yes
error string Felet från verktygsanropet, om det finns något. No
name string Namnet på verktyget som kördes. Yes
output string Utdata från verktygsanropet. No
server_label string Etiketten på MCP-servern som kör verktyget. Yes
type enum
Möjliga värden: mcp_call		 Yes

OpenAI.MCPListToolsItemParam

En lista över verktyg som är tillgängliga på en MCP-server.

Name Type Description Required Default
error string Felmeddelande om servern inte kunde lista verktyg. No
server_label string MCP-serverns etikett. Yes
tools array Verktygen som är tillgängliga på servern. Yes
type enum
Möjliga värden: mcp_list_tools		 Yes

OpenAI.MCPListToolsItemResource

En lista över verktyg som är tillgängliga på en MCP-server.

Name Type Description Required Default
error string Felmeddelande om servern inte kunde lista verktyg. No
server_label string MCP-serverns etikett. Yes
tools array Verktygen som är tillgängliga på servern. Yes
type enum
Möjliga värden: mcp_list_tools		 Yes

OpenAI.MCPListToolsTool

Ett verktyg som är tillgängligt på en MCP-server.

Name Type Description Required Default
annotations Ytterligare anteckningar om verktyget. No
description string Beskrivningen av verktyget. No
input_schema JSON-schemat som beskriver verktygets indata. Yes
name string Namnet på verktyget. Yes

OpenAI.MCPTool

Ge modellen åtkomst till ytterligare verktyg via MCP-servrar (Remote Model Context Protocol).

Name Type Description Required Default
allowed_tools object No
└– tool_names array Lista över tillåtna verktygsnamn. No
headers object Valfria HTTP-huvuden som ska skickas till MCP-servern. Använda för autentisering
eller andra ändamål		 No
require_approval objekt (se giltiga modeller nedan) Ange vilket av MCP-serverns verktyg som kräver godkännande. No
server_label string En etikett för den här MCP-servern som används för att identifiera den i verktygsanrop. Yes
server_url string URL:en för MCP-servern. Yes
type enum Typ av MCP-verktyg. Alltid mcp.
Möjliga värden: mcp		 Yes

OpenAI.MetadataPropertyForRequest

Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och fråga efter objekt via API eller instrumentpanelen.

Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken.

Name Type Description Required Default
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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

OpenAI.Model

Beskriver ett OpenAI-modellerbjudande som kan användas med API:et.

Name Type Description Required Default
created integer Unix-tidsstämpeln (i sekunder) när modellen skapades. Yes
id string Modellidentifieraren, som kan refereras till i API-slutpunkterna. Yes
object enum Objekttypen, som alltid är "modell".
Möjliga värden: model		 Yes
owned_by string Den organisation som äger modellen. Yes

OpenAI.OtherChunkingStrategyResponseParam

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

Name Type Description Required Default
type enum Alltid other.
Möjliga värden: other		 Yes

OpenAI.ParallelToolCalls

Om du vill aktivera parallell funktionsanrop under verktygsanvändning.

Typ: booleskt värde

OpenAI.Prompt

Referens till en promptmall och dess variabler.

Name Type Description Required Default
id string Den unika identifieraren för den promptmall som ska användas. Yes
Variabler object Valfri mappning av värden att ersätta med variabler i din
datorn. Ersättningsvärdena kan antingen vara strängar eller andra
Svarsindatatyper som bilder eller filer.		 No
version string Valfri version av promptmallen. No

OpenAI.RankingOptions

Name Type Description Required Default
ranker enum Rangordningen som ska användas för filsökningen.
Möjliga värden: auto, default-2024-11-15		 No
score_threshold number Tröskelvärdet för poäng för filsökningen, ett tal mellan 0 och 1. Tal närmare 1 försöker returnera endast de mest relevanta resultaten, men kan returnera färre resultat. No

OpenAI.Reasoning

Endast o-seriemodeller

Name Type Description Required Default
effort object Endast o-seriemodeller

Begränsar arbetet med resonemang för resonemangsmodeller.
Värden som stöds för närvarande är low, mediumoch high. Minska
Ansträngning i resonemang kan leda till snabbare svar och färre token som används
om resonemang i ett svar.		 No
generate_summary enum Inaktuell: använd summary i stället.

En sammanfattning av det resonemang som utförs av modellen. Detta kan vara
användbart för att felsöka och förstå modellens resonemangsprocess.
En av auto, conciseeller detailed.
Möjliga värden: auto, concise, detailed		 No
summary enum En sammanfattning av det resonemang som utförs av modellen. Detta kan vara
användbart för att felsöka och förstå modellens resonemangsprocess.
En av auto, conciseeller detailed.
Möjliga värden: auto, concise, detailed		 No

OpenAI.ReasoningEffort

Endast o-seriemodeller

Begränsar arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är low, mediumoch high. Att minska resonemangsinsatsen kan resultera i snabbare svar och färre token som används vid resonemang i ett svar.

Property Value
Description Endast o-seriemodeller

Begränsar arbetet med resonemang för resonemangsmodeller.
Värden som stöds för närvarande är low, mediumoch high. Minska
Ansträngning i resonemang kan leda till snabbare svar och färre token som används
om resonemang i ett svar.
Type string
Values low
medium
high

OpenAI.ReasoningItemParam

En beskrivning av den tankekedja som används av en resonemangsmodell när ett svar genereras. Se till att dessa objekt inkluderas i svarens API input för efterföljande turer i en konversation om du hanterar kontexten manuellt.

Name Type Description Required Default
encrypted_content string Det krypterade innehållet i resonemangsobjektet fylls i när ett svar har lämnats.
genereras med reasoning.encrypted_content i parametern include .		 No
summary array Resonerande textinnehåll Yes
type enum
Möjliga värden: reasoning		 Yes

OpenAI.ReasoningItemResource

En beskrivning av den tankekedja som används av en resonemangsmodell när ett svar genereras. Se till att dessa objekt inkluderas i svarens API input för efterföljande turer i en konversation om du hanterar kontexten manuellt.

Name Type Description Required Default
encrypted_content string Det krypterade innehållet i resonemangsobjektet fylls i när ett svar har lämnats.
genereras med reasoning.encrypted_content i parametern include .		 No
summary array Resonerande textinnehåll Yes
type enum
Möjliga värden: reasoning		 Yes

OpenAI.ReasoningItemSummaryPart

Diskriminerande för OpenAI.ReasoningItemSummaryPart

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
summary_text OpenAI.ReasoningItemSummaryTextPart
Name Type Description Required Default
type OpenAI.ReasoningItemSummaryPartType Yes

OpenAI.ReasoningItemSummaryPartType

Property Value
Type string
Values summary_text

OpenAI.ReasoningItemSummaryTextPart

Name Type Description Required Default
text string Yes
type enum
Möjliga värden: summary_text		 Yes

OpenAI.Response

Name Type Description Required Default
background boolean Om modellsvaret ska köras i bakgrunden. No False
created_at integer Unix-tidsstämpel (i sekunder) för när det här svaret skapades. Yes
error object Ett felobjekt som returneras när modellen inte genererar ett svar. Yes
└– kod OpenAI.ResponseErrorCode Felkoden för svaret. No
└– meddelande string En läsbar beskrivning av felet. No
id string Unik identifierare för det här svaret. Yes
incomplete_details object Information om varför svaret är ofullständigt. Yes
└— orsak enum Anledningen till att svaret är ofullständigt.
Möjliga värden: max_output_tokens, content_filter		 No
instructions sträng eller matris Yes
max_output_tokens integer En övre gräns för antalet token som kan genereras för ett svar, inklusive synliga utdatatoken och resonemangstoken No
max_tool_calls integer Det maximala antalet totala anrop till inbyggda verktyg som kan bearbetas i ett svar. Det här maximala antalet gäller för alla inbyggda verktygsanrop, inte per enskilt verktyg. Eventuella ytterligare försök att anropa ett verktyg av modellen ignoreras. No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
object enum Objekttypen för den här resursen – ange alltid till response.
Möjliga värden: response		 Yes
output array En matris med innehållsobjekt som genereras av modellen.

– Längden och ordningen på objekt i matrisen output är beroende
på modellens svar.
– I stället för att komma åt det första objektet i matrisen output och
anta att det är ett assistant meddelande med innehållet som har genererats av
i modellen kan du överväga att använda egenskapen output_text där
stöds i SDK:er.		 Yes
output_text string Endast SDK-bekvämlighetsegenskap som innehåller aggregerade textutdata
från alla output_text objekt i matrisen output , om några finns.
Stöds i Python- och JavaScript-SDK:er.		 No
parallel_tool_calls boolean Om modellen ska kunna köra verktygsanrop parallellt. Yes True
previous_response_id string Det unika ID:t för föregående svar på modellen. Använd detta för att
skapa flerstegskonversationer		 No
prompt object Referens till en promptmall och dess variabler. No
└– id string Den unika identifieraren för den promptmall som ska användas. No
└– variabler OpenAI.ResponsePromptVariables Valfri mappning av värden att ersätta med variabler i din
datorn. Ersättningsvärdena kan antingen vara strängar eller andra
Svarsindatatyper som bilder eller filer.		 No
└— version string Valfri version av promptmallen. No
reasoning object Endast o-seriemodeller

Konfigurationsalternativ för resonemangsmodeller.		 No
└— insats OpenAI.ReasoningEffort Endast o-seriemodeller

Begränsar arbetet med resonemang för resonemangsmodeller.
Värden som stöds för närvarande är low, mediumoch high. Minska
Ansträngning i resonemang kan leda till snabbare svar och färre token som används
om resonemang i ett svar.		 No
└– generate_summary enum Inaktuell: använd summary i stället.

En sammanfattning av det resonemang som utförs av modellen. Detta kan vara
användbart för att felsöka och förstå modellens resonemangsprocess.
En av auto, conciseeller detailed.
Möjliga värden: auto, concise, detailed		 No
└— sammanfattning enum En sammanfattning av det resonemang som utförs av modellen. Detta kan vara
användbart för att felsöka och förstå modellens resonemangsprocess.
En av auto, conciseeller detailed.
Möjliga värden: auto, concise, detailed		 No
status enum Status för svarsgenereringen. En av completed, failed,
in_progress, cancelled, queued eller incomplete.
Möjliga värden: completed, failed, in_progress, cancelled, , queuedincomplete		 No
temperature number Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt.
Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.		 Yes
text object Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. No
└– format OpenAI.ResponseTextFormatConfiguration No
tool_choice object Styr vilket (om något) verktyg som anropas av modellen.

none innebär att modellen inte anropar något verktyg och i stället genererar ett meddelande.

auto innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett eller
fler verktyg.

required innebär att modellen måste anropa ett eller flera verktyg.		 No
└– typ OpenAI.ToolChoiceObjectType Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. No
tools array En matris med verktyg som modellen kan anropa när ett svar genereras. Du
kan ange vilket verktyg som ska användas genom att ange parametern tool_choice .

De två kategorier av verktyg som du kan tillhandahålla modellen är:

- Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar
modellens funktioner.		 No
top_logprobs integer Ett heltal mellan 0 och 20 som anger antalet mest sannolika token som ska returneras vid varje tokenposition, var och en med en associerad loggsannolikhet. No
top_p number Ett alternativ till provtagning med temperatur, som kallas kärnsampling,
där modellen tar hänsyn till resultatet av token med top_p sannolikhet
massa. Så 0,1 innebär endast de token som omfattar de 10 främsta i%:s sannolikhetsmassa.
övervägs.

Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.		 Yes
truncation enum Den trunkeringsstrategi som ska användas för modellsvaret.
- auto: Om sammanhanget för det här svaret och tidigare svar överskrider
modellens kontextfönsterstorlek trunkerar modellen
svar för att anpassa till kontextfönstret genom att ta bort indataobjekt i
mitt i samtalet.
- disabled (standard): Om ett modellsvar överskrider kontextfönstret
Om storleken för en modell är felaktig, kommer begäran att misslyckas med felkod 400.
Möjliga värden: auto, disabled		 No
usage OpenAI.ResponseUsage Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken,
en uppdelning av utdatatoken och de totala token som används.		 No
user string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Genereras när ett partiellt kodfragment strömmas av kodtolkaren.

Name Type Description Required Default
delta string Det partiella kodfragmentet som strömmas av kodtolkaren. Yes
item_id string Den unika identifieraren för kodtolkarverktygets anropsobjekt. Yes
output_index integer Indexet för utdataobjektet i svaret som koden strömmas för. Yes
type enum Typen av händelse. Alltid response.code_interpreter_call_code.delta.
Möjliga värden: response.code_interpreter_call_code.delta		 Yes

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Genereras när kodfragmentet slutförs av kodtolkaren.

Name Type Description Required Default
code string Det slutliga utdatat från kodtolken för kodfragmentet. Yes
item_id string Den unika identifieraren för kodtolkarverktygets anropsobjekt. Yes
output_index integer Indexet för utdataobjektet i svaret som koden har slutförts för. Yes
type enum Typen av händelse. Alltid response.code_interpreter_call_code.done.
Möjliga värden: response.code_interpreter_call_code.done		 Yes

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Genereras när kodtolkaranropet har slutförts.

Name Type Description Required Default
item_id string Den unika identifieraren för kodtolkarverktygets anropsobjekt. Yes
output_index integer Indexet för utdataobjektet i svaret som kodtolkanropet har slutförts för. Yes
type enum Typen av händelse. Alltid response.code_interpreter_call.completed.
Möjliga värden: response.code_interpreter_call.completed		 Yes

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Genereras när ett kodtolkaranrop pågår.

Name Type Description Required Default
item_id string Den unika identifieraren för kodtolkarverktygets anropsobjekt. Yes
output_index integer Indexet för utdataobjektet i svaret som kodtolkanropet pågår för. Yes
type enum Typen av händelse. Alltid response.code_interpreter_call.in_progress.
Möjliga värden: response.code_interpreter_call.in_progress		 Yes

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Genereras när kodtolkaren aktivt tolkar kodfragmentet.

Name Type Description Required Default
item_id string Den unika identifieraren för kodtolkarverktygets anropsobjekt. Yes
output_index integer Indexet för utdataobjektet i svaret som kodtolkaren tolkar kod för. Yes
type enum Typen av händelse. Alltid response.code_interpreter_call.interpreting.
Möjliga värden: response.code_interpreter_call.interpreting		 Yes

OpenAI.ResponseCompletedEvent

Genereras när modellsvaret är klart.

Name Type Description Required Default
response object Yes
└– bakgrund boolean Om modellsvaret ska köras i bakgrunden. No False
└– created_at integer Unix-tidsstämpel (i sekunder) för när det här svaret skapades. No
└– fel OpenAI.ResponseError Ett felobjekt som returneras när modellen inte genererar ett svar. No
└– id string Unik identifierare för det här svaret. No
└─ ofullständiga_detlajer object Information om varför svaret är ofullständigt. No
└— orsak enum Anledningen till att svaret är ofullständigt.
Möjliga värden: max_output_tokens, content_filter		 No
└─ Instruktioner sträng eller matris Ett systemmeddelande (eller utvecklarmeddelande) som infogats i modellens kontext.

När du använder detta tillsammans med previous_response_id, anvisningarna från en tidigare
svaret kommer inte att överföras till nästa svar. Detta gör det enkelt
för att växla ut systemmeddelanden (eller utvecklarmeddelanden) i nya svar.		 No
└– max_output_tokens integer En övre gräns för antalet token som kan genereras för ett svar, inklusive synliga utdatatoken och resonemangstoken No
└– max_tool_calls integer Det maximala antalet totala anrop till inbyggda verktyg som kan bearbetas i ett svar. Det här maximala antalet gäller för alla inbyggda verktygsanrop, inte per enskilt verktyg. Eventuella ytterligare försök att anropa ett verktyg av modellen ignoreras. No
└– metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
└– objekt enum Objekttypen för den här resursen – ange alltid till response.
Möjliga värden: response		 No
└– utdata array En matris med innehållsobjekt som genereras av modellen.

– Längden och ordningen på objekt i matrisen output är beroende
på modellens svar.
– I stället för att komma åt det första objektet i matrisen output och
anta att det är ett assistant meddelande med innehållet som har genererats av
i modellen kan du överväga att använda egenskapen output_text där
stöds i SDK:er.		 No
└output_text string Endast SDK-bekvämlighetsegenskap som innehåller aggregerade textutdata
från alla output_text objekt i matrisen output , om några finns.
Stöds i Python- och JavaScript-SDK:er.		 No
└– parallel_tool_calls boolean Om modellen ska kunna köra verktygsanrop parallellt. No True
└– föregående_svar_id string Det unika ID:t för föregående svar på modellen. Använd detta för att
skapa flerstegskonversationer		 No
└─ uppmaning OpenAI.Prompt Referens till en promptmall och dess variabler. No
└– resonemang OpenAI.Reasoning Endast o-seriemodeller

Konfigurationsalternativ för resonemangsmodeller.		 No
└— status enum Status för svarsgenereringen. En av completed, failed,
in_progress, cancelled, queued eller incomplete.
Möjliga värden: completed, failed, in_progress, cancelled, , queuedincomplete		 No
└– temperatur number Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt.
Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.		 No
└– text object Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. No
└– format OpenAI.ResponseTextFormatConfiguration No
└– verktygsval OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceObject Hur modellen ska välja vilket verktyg (eller verktyg) som ska användas vid generering
ett svar. Se parametern tools för att se hur du anger vilka verktyg
modellen kan anropa.		 No
└— verktyg array En matris med verktyg som modellen kan anropa när ett svar genereras. Du
kan ange vilket verktyg som ska användas genom att ange parametern tool_choice .

De två kategorier av verktyg som du kan tillhandahålla modellen är:

- Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar
modellens funktioner.		 No
└– top_logprobs integer Ett heltal mellan 0 och 20 som anger antalet mest sannolika token som ska returneras vid varje tokenposition, var och en med en associerad loggsannolikhet. No
└– top_p number Ett alternativ till provtagning med temperatur, som kallas kärnsampling,
där modellen tar hänsyn till resultatet av token med top_p sannolikhet
massa. Så 0,1 innebär endast de token som omfattar de 10 främsta i%:s sannolikhetsmassa.
övervägs.

Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.		 No
└– trunkering enum Den trunkeringsstrategi som ska användas för modellsvaret.
- auto: Om sammanhanget för det här svaret och tidigare svar överskrider
modellens kontextfönsterstorlek trunkerar modellen
svar för att anpassa till kontextfönstret genom att ta bort indataobjekt i
mitt i samtalet.
- disabled (standard): Om ett modellsvar överskrider kontextfönstret
Om storleken för en modell är felaktig, kommer begäran att misslyckas med felkod 400.
Möjliga värden: auto, disabled		 No
└— användning OpenAI.ResponseUsage Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken,
en uppdelning av utdatatoken och de totala token som används.		 No
└– användare string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. No
type enum Typen av händelse. Alltid response.completed.
Möjliga värden: response.completed		 Yes

OpenAI.ResponseContentPartAddedEvent

Genereras när en ny innehållsdel läggs till.

Name Type Description Required Default
content_index integer Indexet för innehållsdelen 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 utdataobjektet som innehållsdelen lades till i. Yes
part object Yes
└– typ OpenAI.ItemContentType Multimodala in- och utdataflöden. No
type enum Typen av händelse. Alltid response.content_part.added.
Möjliga värden: response.content_part.added		 Yes

OpenAI.ResponseContentPartDoneEvent

Genereras när en innehållsdel är klar.

Name Type Description Required Default
content_index integer Indexet för innehållsdelen som är klar. Yes
item_id string ID:t för utdataobjektet som innehållsdelen lades till i. Yes
output_index integer Indexet för utdataobjektet som innehållsdelen lades till i. Yes
part object Yes
└– typ OpenAI.ItemContentType Multimodala in- och utdataflöden. No
type enum Typen av händelse. Alltid response.content_part.done.
Möjliga värden: response.content_part.done		 Yes

OpenAI.ResponseCreatedEvent

En händelse som genereras när ett svar skapas.

Name Type Description Required Default
response object Yes
└– bakgrund boolean Om modellsvaret ska köras i bakgrunden. No False
└– created_at integer Unix-tidsstämpel (i sekunder) för när det här svaret skapades. No
└– fel OpenAI.ResponseError Ett felobjekt som returneras när modellen inte genererar ett svar. No
└– id string Unik identifierare för det här svaret. No
└─ ofullständiga_detlajer object Information om varför svaret är ofullständigt. No
└— orsak enum Anledningen till att svaret är ofullständigt.
Möjliga värden: max_output_tokens, content_filter		 No
└─ Instruktioner sträng eller matris Ett systemmeddelande (eller utvecklarmeddelande) som infogats i modellens kontext.

När du använder detta tillsammans med previous_response_id, anvisningarna från en tidigare
svaret kommer inte att överföras till nästa svar. Detta gör det enkelt
för att växla ut systemmeddelanden (eller utvecklarmeddelanden) i nya svar.		 No
└– max_output_tokens integer En övre gräns för antalet token som kan genereras för ett svar, inklusive synliga utdatatoken och resonemangstoken No
└– max_tool_calls integer Det maximala antalet totala anrop till inbyggda verktyg som kan bearbetas i ett svar. Det här maximala antalet gäller för alla inbyggda verktygsanrop, inte per enskilt verktyg. Eventuella ytterligare försök att anropa ett verktyg av modellen ignoreras. No
└– metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
└– objekt enum Objekttypen för den här resursen – ange alltid till response.
Möjliga värden: response		 No
└– utdata array En matris med innehållsobjekt som genereras av modellen.

– Längden och ordningen på objekt i matrisen output är beroende
på modellens svar.
– I stället för att komma åt det första objektet i matrisen output och
anta att det är ett assistant meddelande med innehållet som har genererats av
i modellen kan du överväga att använda egenskapen output_text där
stöds i SDK:er.		 No
└output_text string Endast SDK-bekvämlighetsegenskap som innehåller aggregerade textutdata
från alla output_text objekt i matrisen output , om några finns.
Stöds i Python- och JavaScript-SDK:er.		 No
└– parallel_tool_calls boolean Om modellen ska kunna köra verktygsanrop parallellt. No True
└– föregående_svar_id string Det unika ID:t för föregående svar på modellen. Använd detta för att
skapa flerstegskonversationer		 No
└─ uppmaning OpenAI.Prompt Referens till en promptmall och dess variabler. No
└– resonemang OpenAI.Reasoning Endast o-seriemodeller

Konfigurationsalternativ för resonemangsmodeller.		 No
└— status enum Status för svarsgenereringen. En av completed, failed,
in_progress, cancelled, queued eller incomplete.
Möjliga värden: completed, failed, in_progress, cancelled, , queuedincomplete		 No
└– temperatur number Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt.
Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.		 No
└– text object Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. No
└– format OpenAI.ResponseTextFormatConfiguration No
└– verktygsval OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceObject Hur modellen ska välja vilket verktyg (eller verktyg) som ska användas vid generering
ett svar. Se parametern tools för att se hur du anger vilka verktyg
modellen kan anropa.		 No
└— verktyg array En matris med verktyg som modellen kan anropa när ett svar genereras. Du
kan ange vilket verktyg som ska användas genom att ange parametern tool_choice .

De två kategorier av verktyg som du kan tillhandahålla modellen är:

- Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar
modellens funktioner.		 No
└– top_logprobs integer Ett heltal mellan 0 och 20 som anger antalet mest sannolika token som ska returneras vid varje tokenposition, var och en med en associerad loggsannolikhet. No
└– top_p number Ett alternativ till provtagning med temperatur, som kallas kärnsampling,
där modellen tar hänsyn till resultatet av token med top_p sannolikhet
massa. Så 0,1 innebär endast de token som omfattar de 10 främsta i%:s sannolikhetsmassa.
övervägs.

Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.		 No
└– trunkering enum Den trunkeringsstrategi som ska användas för modellsvaret.
- auto: Om sammanhanget för det här svaret och tidigare svar överskrider
modellens kontextfönsterstorlek trunkerar modellen
svar för att anpassa till kontextfönstret genom att ta bort indataobjekt i
mitt i samtalet.
- disabled (standard): Om ett modellsvar överskrider kontextfönstret
Om storleken för en modell är felaktig, kommer begäran att misslyckas med felkod 400.
Möjliga värden: auto, disabled		 No
└— användning OpenAI.ResponseUsage Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken,
en uppdelning av utdatatoken och de totala token som används.		 No
└– användare string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. No
type enum Typen av händelse. Alltid response.created.
Möjliga värden: response.created		 Yes

OpenAI.ResponseError

Ett felobjekt som returneras när modellen inte genererar ett svar.

Name Type Description Required Default
code OpenAI.ResponseErrorCode Felkoden för svaret. Yes
message string En läsbar beskrivning av felet. Yes

OpenAI.ResponseErrorCode

Felkoden för svaret.

Property Value
Description Felkoden för svaret.
Type string
Values server_error
rate_limit_exceeded
invalid_prompt
vector_store_timeout
invalid_image
invalid_image_format
invalid_base64_image
invalid_image_url
image_too_large
image_too_small
image_parse_error
image_content_policy_violation
invalid_image_mode
image_file_too_large
unsupported_image_media_type
empty_image_file
failed_to_download_image
image_file_not_found

OpenAI.ResponseErrorEvent

Genereras när ett fel inträffar.

Name Type Description Required Default
code string Felkoden. Yes
message string Felmeddelandet. Yes
param string Felparametern. Yes
type enum Typen av händelse. Alltid error.
Möjliga värden: error		 Yes

OpenAI.ResponseFailedEvent

En händelse som genereras när ett svar misslyckas.

Name Type Description Required Default
response object Yes
└– bakgrund boolean Om modellsvaret ska köras i bakgrunden. No False
└– created_at integer Unix-tidsstämpel (i sekunder) för när det här svaret skapades. No
└– fel OpenAI.ResponseError Ett felobjekt som returneras när modellen inte genererar ett svar. No
└– id string Unik identifierare för det här svaret. No
└─ ofullständiga_detlajer object Information om varför svaret är ofullständigt. No
└— orsak enum Anledningen till att svaret är ofullständigt.
Möjliga värden: max_output_tokens, content_filter		 No
└─ Instruktioner sträng eller matris Ett systemmeddelande (eller utvecklarmeddelande) som infogats i modellens kontext.

När du använder detta tillsammans med previous_response_id, anvisningarna från en tidigare
svaret kommer inte att överföras till nästa svar. Detta gör det enkelt
för att växla ut systemmeddelanden (eller utvecklarmeddelanden) i nya svar.		 No
└– max_output_tokens integer En övre gräns för antalet token som kan genereras för ett svar, inklusive synliga utdatatoken och resonemangstoken No
└– max_tool_calls integer Det maximala antalet totala anrop till inbyggda verktyg som kan bearbetas i ett svar. Det här maximala antalet gäller för alla inbyggda verktygsanrop, inte per enskilt verktyg. Eventuella ytterligare försök att anropa ett verktyg av modellen ignoreras. No
└– metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
└– objekt enum Objekttypen för den här resursen – ange alltid till response.
Möjliga värden: response		 No
└– utdata array En matris med innehållsobjekt som genereras av modellen.

– Längden och ordningen på objekt i matrisen output är beroende
på modellens svar.
– I stället för att komma åt det första objektet i matrisen output och
anta att det är ett assistant meddelande med innehållet som har genererats av
i modellen kan du överväga att använda egenskapen output_text där
stöds i SDK:er.		 No
└output_text string Endast SDK-bekvämlighetsegenskap som innehåller aggregerade textutdata
från alla output_text objekt i matrisen output , om några finns.
Stöds i Python- och JavaScript-SDK:er.		 No
└– parallel_tool_calls boolean Om modellen ska kunna köra verktygsanrop parallellt. No True
└– föregående_svar_id string Det unika ID:t för föregående svar på modellen. Använd detta för att
skapa flerstegskonversationer		 No
└─ uppmaning OpenAI.Prompt Referens till en promptmall och dess variabler. No
└– resonemang OpenAI.Reasoning Endast o-seriemodeller

Konfigurationsalternativ för resonemangsmodeller.		 No
└— status enum Status för svarsgenereringen. En av completed, failed,
in_progress, cancelled, queued eller incomplete.
Möjliga värden: completed, failed, in_progress, cancelled, , queuedincomplete		 No
└– temperatur number Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt.
Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.		 No
└– text object Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. No
└– format OpenAI.ResponseTextFormatConfiguration No
└– verktygsval OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceObject Hur modellen ska välja vilket verktyg (eller verktyg) som ska användas vid generering
ett svar. Se parametern tools för att se hur du anger vilka verktyg
modellen kan anropa.		 No
└— verktyg array En matris med verktyg som modellen kan anropa när ett svar genereras. Du
kan ange vilket verktyg som ska användas genom att ange parametern tool_choice .

De två kategorier av verktyg som du kan tillhandahålla modellen är:

- Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar
modellens funktioner.		 No
└– top_logprobs integer Ett heltal mellan 0 och 20 som anger antalet mest sannolika token som ska returneras vid varje tokenposition, var och en med en associerad loggsannolikhet. No
└– top_p number Ett alternativ till provtagning med temperatur, som kallas kärnsampling,
där modellen tar hänsyn till resultatet av token med top_p sannolikhet
massa. Så 0,1 innebär endast de token som omfattar de 10 främsta i%:s sannolikhetsmassa.
övervägs.

Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.		 No
└– trunkering enum Den trunkeringsstrategi som ska användas för modellsvaret.
- auto: Om sammanhanget för det här svaret och tidigare svar överskrider
modellens kontextfönsterstorlek trunkerar modellen
svar för att anpassa till kontextfönstret genom att ta bort indataobjekt i
mitt i samtalet.
- disabled (standard): Om ett modellsvar överskrider kontextfönstret
Om storleken för en modell är felaktig, kommer begäran att misslyckas med felkod 400.
Möjliga värden: auto, disabled		 No
└— användning OpenAI.ResponseUsage Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken,
en uppdelning av utdatatoken och de totala token som används.		 No
└– användare string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. No
type enum Typen av händelse. Alltid response.failed.
Möjliga värden: response.failed		 Yes

OpenAI.ResponseFileSearchCallCompletedEvent

Genereras när ett filsökningsanrop har slutförts (resultat hittades).

Name Type Description Required Default
item_id string ID för utdataobjektet när filsökningsanropet initieras. Yes
output_index integer Indexet för det utdataobjekt som initieras av filsökningsanropet. Yes
type enum Typen av händelse. Alltid response.file_search_call.completed.
Möjliga värden: response.file_search_call.completed		 Yes

OpenAI.ResponseFileSearchCallInProgressEvent

Genereras när ett filsökningsanrop initieras.

Name Type Description Required Default
item_id string ID för utdataobjektet när filsökningsanropet initieras. Yes
output_index integer Indexet för det utdataobjekt som initieras av filsökningsanropet. Yes
type enum Typen av händelse. Alltid response.file_search_call.in_progress.
Möjliga värden: response.file_search_call.in_progress		 Yes

OpenAI.ResponseFileSearchCallSearchingEvent

Genereras när en filsökning för närvarande söker.

Name Type Description Required Default
item_id string ID för utdataobjektet när filsökningsanropet initieras. Yes
output_index integer Indexet för utdataobjektet som filsökningsanropet söker efter. Yes
type enum Typen av händelse. Alltid response.file_search_call.searching.
Möjliga värden: response.file_search_call.searching		 Yes

OpenAI.ResponseFormat

Diskriminerande för OpenAI.ResponseFormat

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
text OpenAI.ResponseFormatText
json_object OpenAI.ResponseFormatJsonObject
json_schema OpenAI.ResponseFormatJsonSchema
Name Type Description Required Default
type enum
Möjliga värden: text, json_object, json_schema		 Yes

OpenAI.ResponseFormatJsonObject

JSON-objektsvarsformat. En äldre metod för att generera JSON-svar. Användning json_schema rekommenderas för modeller som stöder det. Observera att modellen inte genererar JSON utan ett system- eller användarmeddelande som instruerar den att göra det.

Name Type Description Required Default
type enum Vilken typ av svarsformat som definieras. Alltid json_object.
Möjliga värden: json_object		 Yes

OpenAI.ResponseFormatJsonSchema

JSON-schema svarsformat. Används för att generera strukturerade JSON-svar.

Name Type Description Required Default
json_schema object Konfigurationsalternativ för strukturerade utdata, inklusive ett JSON-schema. Yes
└— beskrivning string En beskrivning av vad svarsformatet är till för, som används av modellen för att
bestämma hur man ska svara enligt formatet.		 No
└— namn string Namnet på svarsformatet. Måste vara a-z, A-Z, 0-9 eller innehålla
understreck och bindestreck, med en maximal längd på 64.		 No
└– schema OpenAI.ResponseFormatJsonSchemaSchema Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt.
Lär dig hur du skapar JSON-scheman här.		 No
└– strikt boolean Om du vill aktivera strikt schemaefterlevnad när utdata genereras.
Om värdet är true följer modellen alltid det exakta schema som definierats
i fältet schema . Endast en delmängd av JSON-schemat stöds när
strict är true.		 No False
type enum Vilken typ av svarsformat som definieras. Alltid json_schema.
Möjliga värden: json_schema		 Yes

OpenAI.ResponseFormatJsonSchemaSchema

Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt. Lär dig hur du skapar JSON-scheman här.

Typ: objekt

OpenAI.ResponseFormatText

Standardformat för svar. Används för att generera textsvar.

Name Type Description Required Default
type enum Vilken typ av svarsformat som definieras. Alltid text.
Möjliga värden: text		 Yes

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Genereras när det finns ett partiellt funktionsanropsargument delta.

Name Type Description Required Default
delta string Funktionsanropsargumentens delta som läggs till. Yes
item_id string ID:t för utdataobjektet som deltat för funktionsanropsargument läggs till i. Yes
output_index integer Indexet för det utdataobjekt som funktionsanropsargumenten delta läggs till i. Yes
type enum Typen av händelse. Alltid response.function_call_arguments.delta.
Möjliga värden: response.function_call_arguments.delta		 Yes

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Genereras när argumenten för funktionsanrop slutförs.

Name Type Description Required Default
arguments string Argumenten för funktionsanrop. Yes
item_id string Objektets ID. Yes
output_index integer Indexet för utdataobjektet. Yes
type enum
Möjliga värden: response.function_call_arguments.done		 Yes

OpenAI.ResponseImageGenCallCompletedEvent

Genereras när ett bildgenereringsverktygsanrop har slutförts och den slutliga avbildningen är tillgänglig.

Name Type Description Required Default
item_id string Den unika identifieraren för det bildgenereringsobjekt som bearbetas. Yes
output_index integer Indexet för utdataobjektet i svarets utdatamatris. Yes
type enum Typen av händelse. Alltid "response.image_generation_call.completed".
Möjliga värden: response.image_generation_call.completed		 Yes

OpenAI.ResponseImageGenCallGeneratingEvent

Genereras när ett verktygsanrop för bildgenerering aktivt genererar en avbildning (mellanliggande tillstånd).

Name Type Description Required Default
item_id string Den unika identifieraren för det bildgenereringsobjekt som bearbetas. Yes
output_index integer Indexet för utdataobjektet i svarets utdatamatris. Yes
type enum Typen av händelse. Alltid “response.image_generation_call.generating”.
Möjliga värden: response.image_generation_call.generating		 Yes

OpenAI.ResponseImageGenCallInProgressEvent

Genereras när ett avbildningsgenereringsverktygsanrop pågår.

Name Type Description Required Default
item_id string Den unika identifieraren för det bildgenereringsobjekt som bearbetas. Yes
output_index integer Indexet för utdataobjektet i svarets utdatamatris. Yes
type enum Typen av händelse. Alltid "response.image_generation_call.in_progress".
Möjliga värden: response.image_generation_call.in_progress		 Yes

OpenAI.ResponseImageGenCallPartialImageEvent

Genereras när en partiell avbildning är tillgänglig under direktuppspelning av bildgenerering.

Name Type Description Required Default
item_id string Den unika identifieraren för det bildgenereringsobjekt som bearbetas. Yes
output_index integer Indexet för utdataobjektet i svarets utdatamatris. Yes
partial_image_b64 string Base64-kodade partiella bilddata, lämpliga för återgivning som en bild. Yes
partial_image_index integer 0-baserat index för den partiella avbildningen (serverdelen är 1-baserad, men detta är 0-baserat för användaren). Yes
type enum Typen av händelse. Alltid "response.image_generation_call.partial_image".
Möjliga värden: response.image_generation_call.partial_image		 Yes

OpenAI.ResponseInProgressEvent

Genereras när svaret pågår.

Name Type Description Required Default
response object Yes
└– bakgrund boolean Om modellsvaret ska köras i bakgrunden. No False
└– created_at integer Unix-tidsstämpel (i sekunder) för när det här svaret skapades. No
└– fel OpenAI.ResponseError Ett felobjekt som returneras när modellen inte genererar ett svar. No
└– id string Unik identifierare för det här svaret. No
└─ ofullständiga_detlajer object Information om varför svaret är ofullständigt. No
└— orsak enum Anledningen till att svaret är ofullständigt.
Möjliga värden: max_output_tokens, content_filter		 No
└─ Instruktioner sträng eller matris Ett systemmeddelande (eller utvecklarmeddelande) som infogats i modellens kontext.

När du använder detta tillsammans med previous_response_id, anvisningarna från en tidigare
svaret kommer inte att överföras till nästa svar. Detta gör det enkelt
för att växla ut systemmeddelanden (eller utvecklarmeddelanden) i nya svar.		 No
└– max_output_tokens integer En övre gräns för antalet token som kan genereras för ett svar, inklusive synliga utdatatoken och resonemangstoken No
└– max_tool_calls integer Det maximala antalet totala anrop till inbyggda verktyg som kan bearbetas i ett svar. Det här maximala antalet gäller för alla inbyggda verktygsanrop, inte per enskilt verktyg. Eventuella ytterligare försök att anropa ett verktyg av modellen ignoreras. No
└– metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
└– objekt enum Objekttypen för den här resursen – ange alltid till response.
Möjliga värden: response		 No
└– utdata array En matris med innehållsobjekt som genereras av modellen.

– Längden och ordningen på objekt i matrisen output är beroende
på modellens svar.
– I stället för att komma åt det första objektet i matrisen output och
anta att det är ett assistant meddelande med innehållet som har genererats av
i modellen kan du överväga att använda egenskapen output_text där
stöds i SDK:er.		 No
└output_text string Endast SDK-bekvämlighetsegenskap som innehåller aggregerade textutdata
från alla output_text objekt i matrisen output , om några finns.
Stöds i Python- och JavaScript-SDK:er.		 No
└– parallel_tool_calls boolean Om modellen ska kunna köra verktygsanrop parallellt. No True
└– föregående_svar_id string Det unika ID:t för föregående svar på modellen. Använd detta för att
skapa flerstegskonversationer		 No
└─ uppmaning OpenAI.Prompt Referens till en promptmall och dess variabler. No
└– resonemang OpenAI.Reasoning Endast o-seriemodeller

Konfigurationsalternativ för resonemangsmodeller.		 No
└— status enum Status för svarsgenereringen. En av completed, failed,
in_progress, cancelled, queued eller incomplete.
Möjliga värden: completed, failed, in_progress, cancelled, , queuedincomplete		 No
└– temperatur number Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt.
Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.		 No
└– text object Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. No
└– format OpenAI.ResponseTextFormatConfiguration No
└– verktygsval OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceObject Hur modellen ska välja vilket verktyg (eller verktyg) som ska användas vid generering
ett svar. Se parametern tools för att se hur du anger vilka verktyg
modellen kan anropa.		 No
└— verktyg array En matris med verktyg som modellen kan anropa när ett svar genereras. Du
kan ange vilket verktyg som ska användas genom att ange parametern tool_choice .

De två kategorier av verktyg som du kan tillhandahålla modellen är:

- Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar
modellens funktioner.		 No
└– top_logprobs integer Ett heltal mellan 0 och 20 som anger antalet mest sannolika token som ska returneras vid varje tokenposition, var och en med en associerad loggsannolikhet. No
└– top_p number Ett alternativ till provtagning med temperatur, som kallas kärnsampling,
där modellen tar hänsyn till resultatet av token med top_p sannolikhet
massa. Så 0,1 innebär endast de token som omfattar de 10 främsta i%:s sannolikhetsmassa.
övervägs.

Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.		 No
└– trunkering enum Den trunkeringsstrategi som ska användas för modellsvaret.
- auto: Om sammanhanget för det här svaret och tidigare svar överskrider
modellens kontextfönsterstorlek trunkerar modellen
svar för att anpassa till kontextfönstret genom att ta bort indataobjekt i
mitt i samtalet.
- disabled (standard): Om ett modellsvar överskrider kontextfönstret
Om storleken för en modell är felaktig, kommer begäran att misslyckas med felkod 400.
Möjliga värden: auto, disabled		 No
└— användning OpenAI.ResponseUsage Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken,
en uppdelning av utdatatoken och de totala token som används.		 No
└– användare string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. No
type enum Typen av händelse. Alltid response.in_progress.
Möjliga värden: response.in_progress		 Yes

OpenAI.ResponseIncompleteEvent

En händelse som genereras när ett svar avslutas som ofullständigt.

Name Type Description Required Default
response object Yes
└– bakgrund boolean Om modellsvaret ska köras i bakgrunden. No False
└– created_at integer Unix-tidsstämpel (i sekunder) för när det här svaret skapades. No
└– fel OpenAI.ResponseError Ett felobjekt som returneras när modellen inte genererar ett svar. No
└– id string Unik identifierare för det här svaret. No
└─ ofullständiga_detlajer object Information om varför svaret är ofullständigt. No
└— orsak enum Anledningen till att svaret är ofullständigt.
Möjliga värden: max_output_tokens, content_filter		 No
└─ Instruktioner sträng eller matris Ett systemmeddelande (eller utvecklarmeddelande) som infogats i modellens kontext.

När du använder detta tillsammans med previous_response_id, anvisningarna från en tidigare
svaret kommer inte att överföras till nästa svar. Detta gör det enkelt
för att växla ut systemmeddelanden (eller utvecklarmeddelanden) i nya svar.		 No
└– max_output_tokens integer En övre gräns för antalet token som kan genereras för ett svar, inklusive synliga utdatatoken och resonemangstoken No
└– max_tool_calls integer Det maximala antalet totala anrop till inbyggda verktyg som kan bearbetas i ett svar. Det här maximala antalet gäller för alla inbyggda verktygsanrop, inte per enskilt verktyg. Eventuella ytterligare försök att anropa ett verktyg av modellen ignoreras. No
└– metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
└– objekt enum Objekttypen för den här resursen – ange alltid till response.
Möjliga värden: response		 No
└– utdata array En matris med innehållsobjekt som genereras av modellen.

– Längden och ordningen på objekt i matrisen output är beroende
på modellens svar.
– I stället för att komma åt det första objektet i matrisen output och
anta att det är ett assistant meddelande med innehållet som har genererats av
i modellen kan du överväga att använda egenskapen output_text där
stöds i SDK:er.		 No
└output_text string Endast SDK-bekvämlighetsegenskap som innehåller aggregerade textutdata
från alla output_text objekt i matrisen output , om några finns.
Stöds i Python- och JavaScript-SDK:er.		 No
└– parallel_tool_calls boolean Om modellen ska kunna köra verktygsanrop parallellt. No True
└– föregående_svar_id string Det unika ID:t för föregående svar på modellen. Använd detta för att
skapa flerstegskonversationer		 No
└─ uppmaning OpenAI.Prompt Referens till en promptmall och dess variabler. No
└– resonemang OpenAI.Reasoning Endast o-seriemodeller

Konfigurationsalternativ för resonemangsmodeller.		 No
└— status enum Status för svarsgenereringen. En av completed, failed,
in_progress, cancelled, queued eller incomplete.
Möjliga värden: completed, failed, in_progress, cancelled, , queuedincomplete		 No
└– temperatur number Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt.
Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.		 No
└– text object Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. No
└– format OpenAI.ResponseTextFormatConfiguration No
└– verktygsval OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceObject Hur modellen ska välja vilket verktyg (eller verktyg) som ska användas vid generering
ett svar. Se parametern tools för att se hur du anger vilka verktyg
modellen kan anropa.		 No
└— verktyg array En matris med verktyg som modellen kan anropa när ett svar genereras. Du
kan ange vilket verktyg som ska användas genom att ange parametern tool_choice .

De två kategorier av verktyg som du kan tillhandahålla modellen är:

- Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar
modellens funktioner.		 No
└– top_logprobs integer Ett heltal mellan 0 och 20 som anger antalet mest sannolika token som ska returneras vid varje tokenposition, var och en med en associerad loggsannolikhet. No
└– top_p number Ett alternativ till provtagning med temperatur, som kallas kärnsampling,
där modellen tar hänsyn till resultatet av token med top_p sannolikhet
massa. Så 0,1 innebär endast de token som omfattar de 10 främsta i%:s sannolikhetsmassa.
övervägs.

Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.		 No
└– trunkering enum Den trunkeringsstrategi som ska användas för modellsvaret.
- auto: Om sammanhanget för det här svaret och tidigare svar överskrider
modellens kontextfönsterstorlek trunkerar modellen
svar för att anpassa till kontextfönstret genom att ta bort indataobjekt i
mitt i samtalet.
- disabled (standard): Om ett modellsvar överskrider kontextfönstret
Om storleken för en modell är felaktig, kommer begäran att misslyckas med felkod 400.
Möjliga värden: auto, disabled		 No
└— användning OpenAI.ResponseUsage Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken,
en uppdelning av utdatatoken och de totala token som används.		 No
└– användare string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. No
type enum Typen av händelse. Alltid response.incomplete.
Möjliga värden: response.incomplete		 Yes

OpenAI.ResponseItemList

En lista över svarsobjekt.

Name Type Description Required Default
data array En lista över objekt som används för att generera det här svaret. Yes
first_id string ID för det första objektet i listan. Yes
has_more boolean Om det finns fler tillgängliga objekt. Yes
last_id string ID för det sista objektet i listan. Yes
object enum Den typ av objekt som returneras måste vara list.
Möjliga värden: list		 Yes

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Genereras när det finns ett delta (partiell uppdatering) till argumenten för ett MCP-verktygsanrop.

Name Type Description Required Default
delta Den partiella uppdateringen av argumenten för MCP-verktygsanropet. Yes
item_id string Den unika identifieraren för MCP-verktygets anropsobjekt som bearbetas. Yes
output_index integer Indexet för utdataobjektet i svarets utdatamatris. Yes
type enum Typen av händelse. Alltid "response.mcp_call.arguments_delta".
Möjliga värden: response.mcp_call.arguments_delta		 Yes

OpenAI.ResponseMCPCallArgumentsDoneEvent

Genereras när argumenten för ett MCP-verktygsanrop slutförs.

Name Type Description Required Default
arguments De färdiga argumenten för MCP-verktygsanropet. Yes
item_id string Den unika identifieraren för MCP-verktygets anropsobjekt som bearbetas. Yes
output_index integer Indexet för utdataobjektet i svarets utdatamatris. Yes
type enum Typen av händelse. Alltid "response.mcp_call.arguments_done".
Möjliga värden: response.mcp_call.arguments_done		 Yes

OpenAI.ResponseMCPCallCompletedEvent

Genereras när ett MCP-verktygsanrop har slutförts.

Name Type Description Required Default
type enum Typen av händelse. Alltid «response.mcp_call.completed».
Möjliga värden: response.mcp_call.completed		 Yes

OpenAI.ResponseMCPCallFailedEvent

Genereras när ett MCP-verktygsanrop har misslyckats.

Name Type Description Required Default
type enum Typen av händelse. Alltid "response.mcp_call.failed".
Möjliga värden: response.mcp_call.failed		 Yes

OpenAI.ResponseMCPCallInProgressEvent

Genereras när ett MCP-verktygsanrop pågår.

Name Type Description Required Default
item_id string Den unika identifieraren för MCP-verktygets anropsobjekt som bearbetas. Yes
output_index integer Indexet för utdataobjektet i svarets utdatamatris. Yes
type enum Typen av händelse. Alltid ‘response.mcp_call.in_progress’.
Möjliga värden: response.mcp_call.in_progress		 Yes

OpenAI.ResponseMCPListToolsCompletedEvent

Genereras när listan över tillgängliga MCP-verktyg har hämtats.

Name Type Description Required Default
type enum Typen av händelse. Alltid ”response.mcp_list_tools.completed”.
Möjliga värden: response.mcp_list_tools.completed		 Yes

OpenAI.ResponseMCPListToolsFailedEvent

Genereras när försöket att visa tillgängliga MCP-verktyg misslyckades.

Name Type Description Required Default
type enum Typen av händelse. Alltid "response.mcp_list_tools.failed".
Möjliga värden: response.mcp_list_tools.failed		 Yes

OpenAI.ResponseMCPListToolsInProgressEvent

Genereras när systemet håller på att hämta listan över tillgängliga MCP-verktyg.

Name Type Description Required Default
type enum Typen av händelse. Alltid "response.mcp_list_tools.in_progress".
Möjliga värden: response.mcp_list_tools.in_progress		 Yes

OpenAI.ResponseOutputItemAddedEvent

Genereras när ett nytt utdataobjekt läggs till.

Name Type Description Required Default
item object Innehållsobjekt som används för att generera ett svar. Yes
└– id string No
└– typ OpenAI.ItemType No
output_index integer Indexet för utdataobjektet som lades till. Yes
type enum Typen av händelse. Alltid response.output_item.added.
Möjliga värden: response.output_item.added		 Yes

OpenAI.ResponseOutputItemDoneEvent

Genereras när ett utdataobjekt markeras som klart.

Name Type Description Required Default
item object Innehållsobjekt som används för att generera ett svar. Yes
└– id string No
└– typ OpenAI.ItemType No
output_index integer Indexet för utdataobjektet som har markerats som gjort. Yes
type enum Typen av händelse. Alltid response.output_item.done.
Möjliga värden: response.output_item.done		 Yes

OpenAI.ResponsePromptVariables

Valfri mappning av värden att ersätta med variabler i din fråga. Ersättningsvärdena kan antingen vara strängar eller andra typer av svarsindata som bilder eller filer.

Typ: objekt

OpenAI.ResponseQueuedEvent

Genereras när ett svar placeras i kö och väntar på att bearbetas.

Name Type Description Required Default
response object Yes
└– bakgrund boolean Om modellsvaret ska köras i bakgrunden. No False
└– created_at integer Unix-tidsstämpel (i sekunder) för när det här svaret skapades. No
└– fel OpenAI.ResponseError Ett felobjekt som returneras när modellen inte genererar ett svar. No
└– id string Unik identifierare för det här svaret. No
└─ ofullständiga_detlajer object Information om varför svaret är ofullständigt. No
└— orsak enum Anledningen till att svaret är ofullständigt.
Möjliga värden: max_output_tokens, content_filter		 No
└─ Instruktioner sträng eller matris Ett systemmeddelande (eller utvecklarmeddelande) som infogats i modellens kontext.

När du använder detta tillsammans med previous_response_id, anvisningarna från en tidigare
svaret kommer inte att överföras till nästa svar. Detta gör det enkelt
för att växla ut systemmeddelanden (eller utvecklarmeddelanden) i nya svar.		 No
└– max_output_tokens integer En övre gräns för antalet token som kan genereras för ett svar, inklusive synliga utdatatoken och resonemangstoken No
└– max_tool_calls integer Det maximala antalet totala anrop till inbyggda verktyg som kan bearbetas i ett svar. Det här maximala antalet gäller för alla inbyggda verktygsanrop, inte per enskilt verktyg. Eventuella ytterligare försök att anropa ett verktyg av modellen ignoreras. No
└– metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
└– objekt enum Objekttypen för den här resursen – ange alltid till response.
Möjliga värden: response		 No
└– utdata array En matris med innehållsobjekt som genereras av modellen.

– Längden och ordningen på objekt i matrisen output är beroende
på modellens svar.
– I stället för att komma åt det första objektet i matrisen output och
anta att det är ett assistant meddelande med innehållet som har genererats av
i modellen kan du överväga att använda egenskapen output_text där
stöds i SDK:er.		 No
└output_text string Endast SDK-bekvämlighetsegenskap som innehåller aggregerade textutdata
från alla output_text objekt i matrisen output , om några finns.
Stöds i Python- och JavaScript-SDK:er.		 No
└– parallel_tool_calls boolean Om modellen ska kunna köra verktygsanrop parallellt. No True
└– föregående_svar_id string Det unika ID:t för föregående svar på modellen. Använd detta för att
skapa flerstegskonversationer		 No
└─ uppmaning OpenAI.Prompt Referens till en promptmall och dess variabler. No
└– resonemang OpenAI.Reasoning Endast o-seriemodeller

Konfigurationsalternativ för resonemangsmodeller.		 No
└— status enum Status för svarsgenereringen. En av completed, failed,
in_progress, cancelled, queued eller incomplete.
Möjliga värden: completed, failed, in_progress, cancelled, , queuedincomplete		 No
└– temperatur number Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt.
Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.		 No
└– text object Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. No
└– format OpenAI.ResponseTextFormatConfiguration No
└– verktygsval OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceObject Hur modellen ska välja vilket verktyg (eller verktyg) som ska användas vid generering
ett svar. Se parametern tools för att se hur du anger vilka verktyg
modellen kan anropa.		 No
└— verktyg array En matris med verktyg som modellen kan anropa när ett svar genereras. Du
kan ange vilket verktyg som ska användas genom att ange parametern tool_choice .

De två kategorier av verktyg som du kan tillhandahålla modellen är:

- Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar
modellens funktioner.		 No
└– top_logprobs integer Ett heltal mellan 0 och 20 som anger antalet mest sannolika token som ska returneras vid varje tokenposition, var och en med en associerad loggsannolikhet. No
└– top_p number Ett alternativ till provtagning med temperatur, som kallas kärnsampling,
där modellen tar hänsyn till resultatet av token med top_p sannolikhet
massa. Så 0,1 innebär endast de token som omfattar de 10 främsta i%:s sannolikhetsmassa.
övervägs.

Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.		 No
└– trunkering enum Den trunkeringsstrategi som ska användas för modellsvaret.
- auto: Om sammanhanget för det här svaret och tidigare svar överskrider
modellens kontextfönsterstorlek trunkerar modellen
svar för att anpassa till kontextfönstret genom att ta bort indataobjekt i
mitt i samtalet.
- disabled (standard): Om ett modellsvar överskrider kontextfönstret
Om storleken för en modell är felaktig, kommer begäran att misslyckas med felkod 400.
Möjliga värden: auto, disabled		 No
└— användning OpenAI.ResponseUsage Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken,
en uppdelning av utdatatoken och de totala token som används.		 No
└– användare string En unik identifierare som representerar slutanvändaren, som kan hjälpa OpenAI att övervaka och upptäcka missbruk. No
type enum Typen av händelse. Alltid "response.queued".
Möjliga värden: response.queued		 Yes

OpenAI.ResponseReasoningDeltaEvent

Genereras när det finns ett delta (partiell uppdatering) till resonemangsinnehållet.

Name Type Description Required Default
content_index integer Indexet för innehållsdelen för resonemang i utdataobjektet. Yes
delta Den partiella uppdateringen av resonemangsinnehållet. Yes
item_id string Den unika identifieraren för det objekt som resonemanget uppdateras för. Yes
output_index integer Indexet för utdataobjektet i svarets utdatamatris. Yes
type enum Typen av händelse. Alltid "response.reasoning.delta".
Möjliga värden: response.reasoning.delta		 Yes

OpenAI.ResponseReasoningDoneEvent

Genereras när resonemangsinnehållet har slutförts för ett objekt.

Name Type Description Required Default
content_index integer Indexet för innehållsdelen för resonemang i utdataobjektet. Yes
item_id string Den unika identifieraren för det objekt för vilket resonemanget har slutförts. Yes
output_index integer Indexet för utdataobjektet i svarets utdatamatris. Yes
text string Den färdiga resonemangstexten. Yes
type enum Typen av händelse. Alltid "response.reasoning.done".
Möjliga värden: response.reasoning.done		 Yes

OpenAI.ResponseReasoningSummaryDeltaEvent

Genereras när det finns ett delta (partiell uppdatering) i sammanfattningsinnehållet för resonemanget.

Name Type Description Required Default
delta Den partiella uppdateringen av innehållet i sammanfattningen av resonemanget. Yes
item_id string Den unika identifieraren för det objekt som sammanfattningen av resonemanget uppdateras för. Yes
output_index integer Indexet för utdataobjektet i svarets utdatamatris. Yes
summary_index integer Indexet för sammanfattningsdelen i utdataobjektet. Yes
type enum Typen av händelse. Alltid "response.reasoning_summary.delta".
Möjliga värden: response.reasoning_summary.delta		 Yes

OpenAI.ResponseReasoningSummaryDoneEvent

Genereras när sammanfattningsinnehållet i motiveringen slutförs för ett objekt.

Name Type Description Required Default
item_id string Den unika identifieraren för det objekt som sammanfattningen av resonemanget har slutförts för. Yes
output_index integer Indexet för utdataobjektet i svarets utdatamatris. Yes
summary_index integer Indexet för sammanfattningsdelen i utdataobjektet. Yes
text string Sammanfattningstexten för det färdiga resonemanget. Yes
type enum Typen av händelse. Alltid "response.reasoning_summary.done".
Möjliga värden: response.reasoning_summary.done		 Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

Genereras när en ny sammanfattningsdel för resonemang läggs till.

Name Type Description Required Default
item_id string ID:t för objektet som den här sammanfattningsdelen är associerad med. Yes
output_index integer Indexet för utdataobjektet som den här sammanfattningsdelen är associerad med. Yes
part object Yes
└– typ OpenAI.ReasoningItemSummaryPartType No
summary_index integer Indexet för sammanfattningsdelen i motiveringssammanfattningen. Yes
type enum Typen av händelse. Alltid response.reasoning_summary_part.added.
Möjliga värden: response.reasoning_summary_part.added		 Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

Genereras när en sammanfattningsdel av resonemanget har slutförts.

Name Type Description Required Default
item_id string ID:t för objektet som den här sammanfattningsdelen är associerad med. Yes
output_index integer Indexet för utdataobjektet som den här sammanfattningsdelen är associerad med. Yes
part object Yes
└– typ OpenAI.ReasoningItemSummaryPartType No
summary_index integer Indexet för sammanfattningsdelen i motiveringssammanfattningen. Yes
type enum Typen av händelse. Alltid response.reasoning_summary_part.done.
Möjliga värden: response.reasoning_summary_part.done		 Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Genereras när ett delta läggs till i en sammanfattningstext för resonemang.

Name Type Description Required Default
delta string Textdeltat som har lagts till i sammanfattningen. Yes
item_id string ID:t för objektet som den här sammanfattningstextdelten är associerad med. Yes
output_index integer Indexet för utdataobjektet som det här sammanfattningstextdeltat är associerat med. Yes
summary_index integer Indexet för sammanfattningsdelen i motiveringssammanfattningen. Yes
type enum Typen av händelse. Alltid response.reasoning_summary_text.delta.
Möjliga värden: response.reasoning_summary_text.delta		 Yes

OpenAI.ResponseReasoningSummaryTextDoneEvent

Genereras när en sammanfattningstext för resonemanget har slutförts.

Name Type Description Required Default
item_id string ID:t för objektet som den här sammanfattningstexten är associerad med. Yes
output_index integer Indexet för utdataobjektet som den här sammanfattningstexten är associerad med. Yes
summary_index integer Indexet för sammanfattningsdelen i motiveringssammanfattningen. Yes
text string Den fullständiga texten i den slutförda motiveringssammanfattningen. Yes
type enum Typen av händelse. Alltid response.reasoning_summary_text.done.
Möjliga värden: response.reasoning_summary_text.done		 Yes

OpenAI.ResponseRefusalDeltaEvent

Genereras när det finns en partiell avslagstext.

Name Type Description Required Default
content_index integer Indexet för innehållsdelen som avslagstexten läggs till i. Yes
delta string Avslagstexten som läggs till. Yes
item_id string ID för det utdataobjekt som avslagstexten läggs till i. Yes
output_index integer Indexet för det utdataobjekt som avslagstexten läggs till i. Yes
type enum Typen av händelse. Alltid response.refusal.delta.
Möjliga värden: response.refusal.delta		 Yes

OpenAI.ResponseRefusalDoneEvent

Genereras när avslagstexten har slutförts.

Name Type Description Required Default
content_index integer Indexet för den innehållsdelen där texten som visar avslag har färdigställts. Yes
item_id string ID för det utdataobjekt där avslagstexten slutförs. Yes
output_index integer Indexet för det utdataobjekt som avslagstexten är slutförd. Yes
refusal string Avslagstexten som har slutförts. Yes
type enum Typen av händelse. Alltid response.refusal.done.
Möjliga värden: response.refusal.done		 Yes

OpenAI.ResponseStreamEvent

Diskriminator för OpenAI.ResponseStreamEvent

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
response.completed OpenAI.ResponseCompletedEvent
response.content_part.added OpenAI.ResponseContentPartAddedEvent
response.content_part.done OpenAI.ResponseContentPartDoneEvent
response.created OpenAI.ResponseCreatedEvent
error OpenAI.ResponseErrorEvent
response.file_search_call.completed OpenAI.ResponseFileSearchCallCompletedEvent
response.file_search_call.in_progress OpenAI.ResponseFileSearchCallInProgressEvent
response.file_search_call.searching OpenAI.ResponseFileSearchCallSearchingEvent
response.function_call_arguments.delta OpenAI.ResponseFunctionCallArgumentsDeltaEvent
response.function_call_arguments.done OpenAI.ResponseFunctionCallArgumentsDoneEvent
response.in_progress OpenAI.ResponseInProgressEvent
response.failed OpenAI.ResponseFailedEvent
response.incomplete OpenAI.ResponseIncompleteEvent
response.output_item.added OpenAI.ResponseOutputItemAddedEvent
response.output_item.done OpenAI.ResponseOutputItemDoneEvent
response.refusal.delta OpenAI.ResponseRefusalDeltaEvent
response.refusal.done OpenAI.ResponseRefusalDoneEvent
response.output_text.delta OpenAI.ResponseTextDeltaEvent
response.output_text.done OpenAI.ResponseTextDoneEvent
response.reasoning_summary_part.added OpenAI.ResponseReasoningSummaryPartAddedEvent
response.reasoning_summary_part.done OpenAI.ResponseReasoningSummaryPartDoneEvent
response.reasoning_summary_text.delta OpenAI.ResponseReasoningSummaryTextDeltaEvent
response.reasoning_summary_text.done OpenAI.ResponseReasoningSummaryTextDoneEvent
response.web_search_call.completed OpenAI.ResponseWebSearchCallCompletedEvent
response.web_search_call.in_progress OpenAI.ResponseWebSearchCallInProgressEvent
response.web_search_call.searching OpenAI.ResponseWebSearchCallSearchingEvent
response.image_generation_call.completed OpenAI.ResponseImageGenCallCompletedEvent
response.image_generation_call.generating OpenAI.ResponseImageGenCallGeneratingEvent
response.image_generation_call.in_progress OpenAI.ResponseImageGenCallInProgressEvent
response.image_generation_call.partial_image OpenAI.ResponseImageGenCallPartialImageEvent
response.mcp_call.arguments_delta OpenAI.ResponseMCPCallArgumentsDeltaEvent
response.mcp_call.arguments_done OpenAI.ResponseMCPCallArgumentsDoneEvent
response.mcp_call.completed OpenAI.ResponseMCPCallCompletedEvent
response.mcp_call.failed OpenAI.ResponseMCPCallFailedEvent
response.mcp_call.in_progress OpenAI.ResponseMCPCallInProgressEvent
response.mcp_list_tools.completed OpenAI.ResponseMCPListToolsCompletedEvent
response.mcp_list_tools.failed OpenAI.ResponseMCPListToolsFailedEvent
response.mcp_list_tools.in_progress OpenAI.ResponseMCPListToolsInProgressEvent
response.queued OpenAI.ResponseQueuedEvent
response.reasoning.delta OpenAI.ResponseReasoningDeltaEvent
response.reasoning.done OpenAI.ResponseReasoningDoneEvent
response.reasoning_summary.delta OpenAI.ResponseReasoningSummaryDeltaEvent
response.reasoning_summary.done OpenAI.ResponseReasoningSummaryDoneEvent
response.code_interpreter_call_code.delta OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
response.code_interpreter_call_code.done OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
response.code_interpreter_call.completed OpenAI.ResponseCodeInterpreterCallCompletedEvent
response.code_interpreter_call.in_progress OpenAI.ResponseCodeInterpreterCallInProgressEvent
response.code_interpreter_call.interpreting OpenAI.ResponseCodeInterpreterCallInterpretingEvent
Name Type Description Required Default
sequence_number integer Sekvensnumret för den här händelsen. Yes
type OpenAI.ResponseStreamEventType Yes

OpenAI.ResponseStreamEventType

Property Value
Type string
Values response.audio.delta
response.audio.done
response.audio_transcript.delta
response.audio_transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.refusal.delta
response.refusal.done
response.output_text.annotation.added
response.output_text.delta
response.output_text.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.web_search_call.completed
response.web_search_call.in_progress
response.web_search_call.searching
response.image_generation_call.completed
response.image_generation_call.generating
response.image_generation_call.in_progress
response.image_generation_call.partial_image
response.mcp_call.arguments_delta
response.mcp_call.arguments_done
response.mcp_call.completed
response.mcp_call.failed
response.mcp_call.in_progress
response.mcp_list_tools.completed
response.mcp_list_tools.failed
response.mcp_list_tools.in_progress
response.queued
response.reasoning.delta
response.reasoning.done
response.reasoning_summary.delta
response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

Genereras när det finns ytterligare ett textdelta.

Name Type Description Required Default
content_index integer Indexet för innehållsdelen som textdeltat lades till i. Yes
delta string Textdeltat som lades till. Yes
item_id string ID:t för utdataobjektet som textdeltat lades till i. Yes
output_index integer Indexet för utdataobjektet som textdeltat lades till i. Yes
type enum Typen av händelse. Alltid response.output_text.delta.
Möjliga värden: response.output_text.delta		 Yes

OpenAI.ResponseTextDoneEvent

Genereras när textinnehållet har slutförts.

Name Type Description Required Default
content_index integer Indexet för innehållsdelen där textinnehållet har slutgiltiggjorts. Yes
item_id string ID för utdataobjektet där textinnehållet har slutförts. Yes
output_index integer Indexet för utdataobjektet där textinnehållet är slutfört. Yes
text string Textinnehållet som har slutförts. Yes
type enum Typen av händelse. Alltid response.output_text.done.
Möjliga värden: response.output_text.done		 Yes

OpenAI.ResponseTextFormatConfiguration

Diskriminerande för OpenAI.ResponseTextFormatConfiguration

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
text OpenAI.ResponseTextFormatConfigurationText
json_object OpenAI.ResponseTextFormatConfigurationJsonObject
json_schema OpenAI.ResponseTextFormatConfigurationJsonSchema
Name Type Description Required Default
type OpenAI.ResponseTextFormatConfigurationType Ett objekt som anger det format som modellen måste mata ut.

Konfigurera { "type": "json_schema" } möjliggör strukturerade utdata,
som säkerställer att modellen matchar ditt angivna JSON-schema. Standardformatet är { "type": "text" } utan ytterligare alternativ.

Rekommenderas inte för gpt-4o- och nyare modeller:

Inställning som gör att { "type": "json_object" } aktiverar det äldre JSON-läget, vilket
ser till att meddelandet som modellen genererar är giltigt JSON. Att använda json_schema
är att föredra för modeller som stöder det.		 Yes

OpenAI.ResponseTextFormatConfigurationJsonObject

Name Type Description Required Default
type enum
Möjliga värden: json_object		 Yes

OpenAI.ResponseTextFormatConfigurationJsonSchema

JSON-schema svarsformat. Används för att generera strukturerade JSON-svar.

Name Type Description Required Default
description string En beskrivning av vad svarsformatet är till för, som används av modellen för att
bestämma hur man ska svara enligt formatet.		 No
name string Namnet på svarsformatet. Måste vara a-z, A-Z, 0-9 eller innehålla
understreck och bindestreck, med en maximal längd på 64.		 Yes
schema OpenAI.ResponseFormatJsonSchemaSchema Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt.
Lär dig hur du skapar JSON-scheman här.		 Yes
strict boolean Om du vill aktivera strikt schemaefterlevnad när utdata genereras.
Om värdet är true följer modellen alltid det exakta schema som definierats
i fältet schema . Endast en delmängd av JSON-schemat stöds när
strict är true.		 No False
type enum Vilken typ av svarsformat som definieras. Alltid json_schema.
Möjliga värden: json_schema		 Yes

OpenAI.ResponseTextFormatConfigurationText

Name Type Description Required Default
type enum
Möjliga värden: text		 Yes

OpenAI.ResponseTextFormatConfigurationType

Ett objekt som anger det format som modellen måste mata ut.

Konfiguration { "type": "json_schema" } möjliggör strukturerade utdata, vilket säkerställer att modellen matchar ditt angivna JSON-schema.

Standardformatet är { "type": "text" } utan ytterligare alternativ.

Rekommenderas inte för gpt-4o- och nyare modeller:

Att ställa in { "type": "json_object" } aktiverar det äldre JSON-läget, vilket säkerställer att meddelandet som modellen genererar är giltig JSON. Att använda json_schema är att föredra för modeller som stöder det.

Property Value
Description Ett objekt som anger det format som modellen måste mata ut.

Konfiguration { "type": "json_schema" } möjliggör strukturerade utdata, vilket säkerställer att modellen matchar ditt angivna JSON-schema.

Standardformatet är { "type": "text" } utan ytterligare alternativ.

Rekommenderas inte för gpt-4o- och nyare modeller:

Att ställa in { "type": "json_object" } aktiverar det äldre JSON-läget, vilket säkerställer att meddelandet som modellen genererar är giltig JSON. Att använda json_schemaär att föredra för modeller som stöder det.

OpenAI.ResponseUsage

Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.

Name Type Description Required Default
input_tokens integer Antalet indatatoken. Yes
input_tokens_details object En detaljerad uppdelning av indatatoken. Yes
└– cached_tokens integer Antalet token som hämtades från cacheminnet. No
output_tokens integer Antalet utdatatoken. Yes
output_tokens_details object En detaljerad uppdelning av utdatatoken. Yes
└– reasoning_tokens integer Antalet resonemangstoken. No
total_tokens integer Det totala antalet token som används. Yes

OpenAI.ResponseWebSearchCallCompletedEvent

Obs! web_search är ännu inte tillgängligt via Azure OpenAI.

Name Type Description Required Default
item_id string Unikt ID för utdataobjektet som är associerat med webbsökningsanropet. Yes
output_index integer Indexet för det utdataobjekt som webbsökningsanropet är associerat med. Yes
type enum Typen av händelse. Alltid response.web_search_call.completed.
Möjliga värden: response.web_search_call.completed		 Yes

OpenAI.ResponseWebSearchCallInProgressEvent

Obs! web_search är ännu inte tillgängligt via Azure OpenAI.

Name Type Description Required Default
item_id string Unikt ID för utdataobjektet som är associerat med webbsökningsanropet. Yes
output_index integer Indexet för det utdataobjekt som webbsökningsanropet är associerat med. Yes
type enum Typen av händelse. Alltid response.web_search_call.in_progress.
Möjliga värden: response.web_search_call.in_progress		 Yes

OpenAI.ResponseWebSearchCallSearchingEvent

Obs! web_search är ännu inte tillgängligt via Azure OpenAI.

Name Type Description Required Default
item_id string Unikt ID för utdataobjektet som är associerat med webbsökningsanropet. Yes
output_index integer Indexet för det utdataobjekt som webbsökningsanropet är associerat med. Yes
type enum Typen av händelse. Alltid response.web_search_call.searching.
Möjliga värden: response.web_search_call.searching		 Yes

OpenAI.ResponsesAssistantMessageItemParam

Ett meddelandeparameterobjekt med assistant rollen.

Name Type Description Required Default
content array Innehållet som är associerat med meddelandet. Yes
role enum Rollen för meddelandet, som alltid är assistant.
Möjliga värden: assistant		 Yes

OpenAI.ResponsesAssistantMessageItemResource

Ett meddelanderesursobjekt med assistant rollen.

Name Type Description Required Default
content array Innehållet som är associerat med meddelandet. Yes
role enum Rollen för meddelandet, som alltid är assistant.
Möjliga värden: assistant		 Yes

OpenAI.ResponsesDeveloperMessageItemParam

Ett meddelandeparameterobjekt med developer rollen.

Name Type Description Required Default
content array Innehållet som är associerat med meddelandet. Yes
role enum Rollen för meddelandet, som alltid är developer.
Möjliga värden: developer		 Yes

OpenAI.ResponsesDeveloperMessageItemResource

Ett meddelanderesursobjekt med developer rollen.

Name Type Description Required Default
content array Innehållet som är associerat med meddelandet. Yes
role enum Rollen för meddelandet, som alltid är developer.
Möjliga värden: developer		 Yes

OpenAI.ResponsesMessageItemParam

Ett svarsmeddelandeobjekt som representerar en roll och ett innehåll som tillhandahålls som parametrar för klientbegäran.

Diskriminator för OpenAI.ResponsesMessageItemParam

Den här komponenten använder egenskapen role för att skilja mellan olika typer:

Typvärde Schema
user OpenAI.ResponsesUserMessageItemParam
system OpenAI.ResponsesSystemMessageItemParam
developer OpenAI.ResponsesDeveloperMessageItemParam
assistant OpenAI.ResponsesAssistantMessageItemParam
Name Type Description Required Default
role object Samlingen med giltiga roller för svarsmeddelandeobjekt. Yes
type enum Typen av svarsobjekt, som alltid är "meddelande".
Möjliga värden: message		 Yes

OpenAI.ResponsesMessageItemResource

Ett resursobjekt i ett svarsmeddelande som representerar en roll och innehåll, som tillhandahålls i tjänstsvar.

Diskriminator för OpenAI.ResponsesMessageItemResource

Den här komponenten använder egenskapen role för att skilja mellan olika typer:

Typvärde Schema
user OpenAI.ResponsesUserMessageItemResource
system OpenAI.ResponsesSystemMessageItemResource
developer OpenAI.ResponsesDeveloperMessageItemResource
assistant OpenAI.ResponsesAssistantMessageItemResource
Name Type Description Required Default
role object Samlingen med giltiga roller för svarsmeddelandeobjekt. Yes
status enum Status för objektet. En av in_progress, completed eller
incomplete. Fylls i när objekt returneras via API.
Möjliga värden: in_progress, completed, incomplete		 Yes
type enum Typen av svarsobjekt, som alltid är "meddelande".
Möjliga värden: message		 Yes

OpenAI.ResponsesMessageRole

Samlingen med giltiga roller för svarsmeddelandeobjekt.

Property Value
Description Samlingen med giltiga roller för svarsmeddelandeobjekt.
Type string
Values system
developer
user
assistant

OpenAI.ResponsesSystemMessageItemParam

Ett meddelandeparameterobjekt med system rollen.

Name Type Description Required Default
content array Innehållet som är associerat med meddelandet. Yes
role enum Rollen för meddelandet, som alltid är system.
Möjliga värden: system		 Yes

OpenAI.ResponsesSystemMessageItemResource

Ett meddelanderesursobjekt med system rollen.

Name Type Description Required Default
content array Innehållet som är associerat med meddelandet. Yes
role enum Rollen för meddelandet, som alltid är system.
Möjliga värden: system		 Yes

OpenAI.ResponsesUserMessageItemParam

Ett meddelandeparameterobjekt med user rollen.

Name Type Description Required Default
content array Innehållet som är associerat med meddelandet. Yes
role enum Rollen för meddelandet, som alltid är user.
Möjliga värden: user		 Yes

OpenAI.ResponsesUserMessageItemResource

Ett meddelanderesursobjekt med user rollen.

Name Type Description Required Default
content array Innehållet som är associerat med meddelandet. Yes
role enum Rollen för meddelandet, som alltid är user.
Möjliga värden: user		 Yes

OpenAI.RunGraderRequest

Name Type Description Required Default
väghyvel object Ett StringCheckGrader-objekt som utför en strängjämförelse mellan indata och referens med en angiven åtgärd. Yes
└– calculate_output string En formel för att beräkna utdata baserat på graderresultat. No
└– evaluation_metric enum Det utvärderingsmått som ska användas. En av fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5eller rouge_l.
Möjliga värden: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , , rouge_5rouge_l		 No
└– väghyvlar object No
└image_tag string Avbildningstaggen som ska användas för Python-skriptet. No
└– indata array Inmatningstexten. Detta kan innehålla mallsträngar. No
└– modell string Den modell som ska användas för utvärderingen. No
└— namn string Namnet på bedömaren. No
└— åtgärd enum Strängkontrollprocessen som ska utföras. En av eq, ne, likeeller ilike.
Möjliga värden: eq, ne, like, ilike		 No
└– intervall array Poängintervallet. Standardinställningen är [0, 1]. No
└– referens string Texten som betygsätts och jämförs med. No
└– sampling_params Samplingsparametrarna för modellen. No
└– källa string Källkoden för Python-skriptet. No
└– typ enum Objekttypen, som alltid multiär .
Möjliga värden: multi		 No
item Datamängdsobjektet som tillhandahålls till väghyveln. Detta används för att fylla i
namnområdet item .		 No
model_sample string Modellexemplet som ska utvärderas. Det här värdet används för att fylla i
namnområdet sample .
Variabeln output_json fylls i om modellexemplet är en
giltig JSON-sträng.		 Yes

OpenAI.RunGraderResponse

Name Type Description Required Default
metadata object Yes
└– fel object No
└– formula_parse_error boolean No
└– invalid_variable_error boolean No
└– model_grader_parse_error boolean No
└– model_grader_refusal_error boolean No
└– model_grader_server_error boolean No
└– model_grader_server_error_details string No
└– other_error boolean No
└– python_grader_runtime_error boolean No
└– python_grader_runtime_error_details string No
└– python_grader_server_error boolean No
└– python_grader_server_error_type string No
└– sample_parse_error boolean No
└– truncated_observation_error boolean No
└– unresponsive_reward_error boolean No
└– execution_time number No
└— namn string No
└– sampled_model_name string No
└— poäng No
└token_usage integer No
└– typ string No
model_grader_token_usage_per_model Yes
belöning number Yes
sub_rewards Yes

OpenAI.StaticChunkingStrategy

Name Type Description Required Default
delöverlappande_token integer Antalet token som överlappar mellan segment. Standardvärdet är 400.

Observera att överlappningen inte får överstiga hälften av max_chunk_size_tokens.		 Yes
maximal_chunkstorlek_token integer Det maximala antalet token i varje segment. Standardvärdet är 800. Det minsta värdet är 100 och det maximala värdet är 4096. Yes

OpenAI.StaticChunkingStrategyRequestParam

Anpassa din egen segmenteringsstrategi genom att ange segmentstorlek och segment överlappning.

Name Type Description Required Default
statiskt OpenAI.StaticChunkingStrategy Yes
type enum Alltid static.
Möjliga värden: static		 Yes

OpenAI.StaticChunkingStrategyResponseParam

Name Type Description Required Default
statiskt OpenAI.StaticChunkingStrategy Yes
type enum Alltid static.
Möjliga värden: static		 Yes

OpenAI.StopConfiguration

Stöds inte med de senaste resonemangsmodellerna o3 och o4-mini.

Upp till 4 sekvenser där API:et slutar generera ytterligare token. Den returnerade texten innehåller inte stoppsekvensen.

Det här schemat accepterar någon av följande typer:

  • string
  • array

OpenAI.Tool

Discriminator för OpenAI.Tool

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
function OpenAI.FunctionTool
file_search OpenAI.FileSearchTool
computer_use_preview OpenAI.ComputerUsePreviewTool
web_search_preview OpenAI.WebSearchPreviewTool
code_interpreter OpenAI.CodeInterpreterTool
image_generation OpenAI.ImageGenTool
local_shell OpenAI.LocalShellTool
mcp OpenAI.MCPTool
Name Type Description Required Default
type OpenAI.ToolType Ett verktyg som kan användas för att generera ett svar. Yes

OpenAI.ToolChoiceObject

Diskriminator för OpenAI.ToolChoiceObject

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
file_search OpenAI.ToolChoiceObjectFileSearch
computer_use_preview OpenAI.ToolChoiceObjectComputer
web_search_preview OpenAI.ToolChoiceObjectWebSearch
image_generation OpenAI.ToolChoiceObjectImageGen
code_interpreter OpenAI.ToolChoiceObjectCodeInterpreter
function OpenAI.ToolChoiceObjectFunction
mcp OpenAI.ToolChoiceObjectMCP
Name Type Description Required Default
type OpenAI.ToolChoiceObjectType Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Yes

OpenAI.ToolChoiceObjectCodeInterpreter

Name Type Description Required Default
type enum
Möjliga värden: code_interpreter		 Yes

OpenAI.ToolChoiceObjectComputer

Name Type Description Required Default
type enum
Möjliga värden: computer_use_preview		 Yes

OpenAI.ToolChoiceObjectFileSearch

Name Type Description Required Default
type enum
Möjliga värden: file_search		 Yes

OpenAI.ToolChoiceObjectFunction

Använd det här alternativet för att tvinga modellen att anropa en specifik funktion.

Name Type Description Required Default
name string Namnet på funktionen som ska anropas. Yes
type enum För funktionsanrop är typen alltid function.
Möjliga värden: function		 Yes

OpenAI.ToolChoiceObjectImageGen

Name Type Description Required Default
type enum
Möjliga värden: image_generation		 Yes

OpenAI.ToolChoiceObjectMCP

Använd det här alternativet för att tvinga modellen att anropa ett specifikt verktyg på en fjärr-MCP-server.

Name Type Description Required Default
name string Namnet på verktyget som ska anropas på servern. No
server_label string Etiketten på DEN MCP-server som ska användas. Yes
type enum För MCP-verktyg är typen alltid mcp.
Möjliga värden: mcp		 Yes

OpenAI.ToolChoiceObjectType

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar.

Property Value
Description Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar.
Type string
Values file_search
function
computer_use_preview
web_search_preview
image_generation
code_interpreter
mcp

OpenAI.ToolChoiceObjectWebSearch

Obs! web_search är ännu inte tillgängligt via Azure OpenAI.

Name Type Description Required Default
type enum
Möjliga värden: web_search_preview		 Yes

OpenAI.ToolChoiceOptions

Styr vilket (om något) verktyg som anropas av modellen.

none innebär att modellen inte anropar något verktyg och i stället genererar ett meddelande.

auto innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett eller flera verktyg.

required innebär att modellen måste anropa ett eller flera verktyg.

Property Value
Description Styr vilket (om något) verktyg som anropas av modellen.

none innebär att modellen inte anropar något verktyg och i stället genererar ett meddelande.

auto innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett eller
fler verktyg.

required innebär att modellen måste anropa ett eller flera verktyg.
Type string
Values none
auto
required

OpenAI.ToolType

Ett verktyg som kan användas för att generera ett svar.

Property Value
Description Ett verktyg som kan användas för att generera ett svar.
Type string
Values file_search
function
computer_use_preview
web_search_preview
mcp
code_interpreter
image_generation
local_shell

OpenAI.TopLogProb

Den högsta loggens sannolikhet för en token.

Name Type Description Required Default
bytes array Yes
logprob number Yes
token string Yes

OpenAI.TranscriptionAudioResponseFormat

Referenser: OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

Property Value
Type string
Values logprobs

OpenAI.TranscriptionSegment

Name Type Description Required Default
avg_logprob number Genomsnittlig logprob för segmentet. Om värdet är lägre än -1 bör du överväga att logprobs misslyckades. Yes
compression_ratio number Komprimeringsförhållande för segmentet. Om värdet är större än 2,4 bör du överväga att komprimering misslyckades. Yes
end number Sluttid för segmentet i sekunder. Yes
id integer Unik identifierare för segmentet. Yes
no_speech_prob number Sannolikhet för inget tal i segmentet. Om värdet är högre än 1,0 och avg_logprob är under -1 bör du betrakta det här segmentet som tyst. Yes
seek integer Sök efter förskjutning av segmentet. Yes
start number Starttid för segmentet i sekunder. Yes
temperature number Temperaturparameter som används för att generera segmentet. Yes
text string Textinnehåll i segmentet. Yes
tokens array Matris med token-ID:t för textinnehållet. Yes

OpenAI.TranscriptionWord

Name Type Description Required Default
end number Sluttid för ordet i sekunder. Yes
start number Starttid för ordet i sekunder. Yes
word string Textens innehåll i ordet. Yes

OpenAI.TranslationAudioResponseFormat

Referenser: OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

Name Type Description Required Default
Egenskaper object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen. Nycklar är strängar
med en maximal längd på 64 tecken. Värden är strängar med ett maxvärde
längd på 512 tecken, booleska värden eller tal.		 Yes

OpenAI.UpdateVectorStoreRequest

Name Type Description Required Default
går ut efter object Förfalloprincipen för ett vektorlager. No
└– fästpunkt enum Tidsstämpel för fästpunkt varefter förfalloprincipen gäller. Fästpunkter som stöds: last_active_at.
Möjliga värden: last_active_at		 No
└– dagar integer Antalet dagar efter ankartiden som vektorlagret upphör att gälla. No
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
name string Namnet på vektorarkivet. No

OpenAI.VadConfig

Name Type Description Required Default
prefix_padding_ms integer Mängden ljud som ska inkluderas innan detekteringen av VAD-tal (i sekunder)
millisekunder).		 No 300
silence_duration_ms integer Varaktighet för tystnad för att identifiera talstopp (i millisekunder).
Med kortare värden svarar modellen snabbare.
men kan hoppa in under korta pauser från användaren.		 No 200
threshold number Känslighetströskel (0,0 till 1,0) för identifiering av röstaktivitet. A
högre tröskelvärde kräver högre ljud för att aktivera modellen, och
kan därför fungera bättre i bullriga miljöer.		 No 0.5
type enum Måste anges till server_vad för att aktivera manuell segmentering med hjälp av VAD på serversidan.
Möjliga värden: server_vad		 Yes

OpenAI.ValidateGraderRequest

Name Type Description Required Default
väghyvel object Ett StringCheckGrader-objekt som utför en strängjämförelse mellan indata och referens med en angiven åtgärd. Yes
└– calculate_output string En formel för att beräkna utdata baserat på graderresultat. No
└– evaluation_metric enum Det utvärderingsmått som ska användas. En av fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5eller rouge_l.
Möjliga värden: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , , rouge_5rouge_l		 No
└– väghyvlar object No
└image_tag string Avbildningstaggen som ska användas för Python-skriptet. No
└– indata array Inmatningstexten. Detta kan innehålla mallsträngar. No
└– modell string Den modell som ska användas för utvärderingen. No
└— namn string Namnet på bedömaren. No
└— åtgärd enum Strängkontrollprocessen som ska utföras. En av eq, ne, likeeller ilike.
Möjliga värden: eq, ne, like, ilike		 No
└– intervall array Poängintervallet. Standardinställningen är [0, 1]. No
└– referens string Texten som betygsätts och jämförs med. No
└– sampling_params Samplingsparametrarna för modellen. No
└– källa string Källkoden för Python-skriptet. No
└– typ enum Objekttypen, som alltid multiär .
Möjliga värden: multi		 No

OpenAI.ValidateGraderResponse

Name Type Description Required Default
väghyvel object Ett StringCheckGrader-objekt som utför en strängjämförelse mellan indata och referens med en angiven åtgärd. No
└– calculate_output string En formel för att beräkna utdata baserat på graderresultat. No
└– evaluation_metric enum Det utvärderingsmått som ska användas. En av fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5eller rouge_l.
Möjliga värden: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , , rouge_5rouge_l		 No
└– väghyvlar object No
└image_tag string Avbildningstaggen som ska användas för Python-skriptet. No
└– indata array Inmatningstexten. Detta kan innehålla mallsträngar. No
└– modell string Den modell som ska användas för utvärderingen. No
└— namn string Namnet på bedömaren. No
└— åtgärd enum Strängkontrollprocessen som ska utföras. En av eq, ne, likeeller ilike.
Möjliga värden: eq, ne, like, ilike		 No
└– intervall array Poängintervallet. Standardinställningen är [0, 1]. No
└– referens string Texten som betygsätts och jämförs med. No
└– sampling_params Samplingsparametrarna för modellen. No
└– källa string Källkoden för Python-skriptet. No
└– typ enum Objekttypen, som alltid multiär .
Möjliga värden: multi		 No

OpenAI.VectorStoreExpirationAfter

Förfalloprincipen för ett vektorlager.

Name Type Description Required Default
anchor enum Tidsstämpel för fästpunkt varefter förfalloprincipen gäller. Fästpunkter som stöds: last_active_at.
Möjliga värden: last_active_at		 Yes
Dagar integer Antalet dagar efter ankartiden som vektorlagret upphör att gälla. Yes

OpenAI.VectorStoreFileAttributes

Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och fråga efter objekt via API eller instrumentpanelen. Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken, booleska värden eller tal.

Typ: objekt

OpenAI.VectorStoreFileBatchObject

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

Name Type Description Required Default
created_at integer Unix-tidsstämpeln (i sekunder) för när batchen för vektorlagringsfiler skapades. Yes
antal_filer object Yes
└– avbröts integer Antalet filer som avbröts. No
└– har slutförts integer Antalet filer som har bearbetats. No
└– misslyckades integer Antalet filer som inte har bearbetats. No
└– in_progress integer Antalet filer som bearbetas för närvarande. No
└— totalt integer Det totala antalet filer. No
id string Identifieraren, som kan refereras till i API-slutpunkter. Yes
object enum Objekttypen, som alltid vector_store.file_batchär .
Möjliga värden: vector_store.files_batch		 Yes
status enum Status för batchen för vektorlagringsfiler, som kan vara antingen in_progress, completedeller cancelledfailed.
Möjliga värden: in_progress, completed, cancelled, failed		 Yes
vector_store_id string ID:t för vektorarkivet som filen är kopplad till. Yes

OpenAI.VectorStoreFileObject

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

Name Type Description Required Default
Egenskaper object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen. Nycklar är strängar
med en maximal längd på 64 tecken. Värden är strängar med ett maxvärde
längd på 512 tecken, booleska värden eller tal.		 No
chunking_strategy object No
└– typ enum
Möjliga värden: static, other		 No
created_at integer Unix-tidsstämpeln (i sekunder) för när vektorlagringsfilen skapades. Yes
id string Identifieraren, som kan refereras till i API-slutpunkter. Yes
senaste_fel object Det sista felet som är associerat med den här vektorlagringsfilen. Kommer att vara null om det inte finns några fel. Yes
└– kod enum En av server_error eller rate_limit_exceeded.
Möjliga värden: server_error, unsupported_file, invalid_file		 No
└– meddelande string En läsbar beskrivning av felet. No
object enum Objekttypen, som alltid vector_store.fileär .
Möjliga värden: vector_store.file		 Yes
status enum Status för vektorlagringsfilen, som kan vara antingen in_progress, completed, cancelledeller failed. Statusen completed anger att vektorlagringsfilen är klar för användning.
Möjliga värden: in_progress, completed, cancelled, failed		 Yes
användning i byte integer Den totala vektorlagringsanvändningen i byte. Observera att detta kan skilja sig från den ursprungliga filstorleken. Yes
vector_store_id string ID:t för vektorarkivet som filen är kopplad till. Yes

OpenAI.VectorStoreObject

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

Name Type Description Required Default
created_at integer Unix-tidsstämpeln (i sekunder) för när vektorlagret skapades. Yes
går ut efter OpenAI.VectorStoreExpirationAfter Förfalloprincipen för ett vektorlager. No
expires_at integer Unix-tidsstämpeln (i sekunder) för när vektorlagret upphör att gälla. No
antal_filer object Yes
└– avbröts integer Antalet filer som avbröts. No
└– har slutförts integer Antalet filer som har bearbetats. No
└– misslyckades integer Antalet filer som inte har bearbetats. No
└– in_progress integer Antalet filer som bearbetas för närvarande. No
└— totalt integer Det totala antalet filer. No
id string Identifieraren, som kan refereras till i API-slutpunkter. Yes
senast_aktiv_vid integer Unix-tidsstämpeln (i sekunder) för när vektorlagret senast var aktivt. Yes
metadata object Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara
användbart för att lagra ytterligare information om objektet i en strukturerad form
format och fråga efter objekt via API eller kontrollpanelen.

Nycklar ä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
name string Namnet på vektorarkivet. Yes
object enum Objekttypen, som alltid vector_storeär .
Möjliga värden: vector_store		 Yes
status enum Status för vektorlagret, som kan vara antingen expired, in_progresseller completed. completed Statusen anger att vektorlagret är redo att användas.
Möjliga värden: expired, in_progress, completed		 Yes
användning i byte integer Det totala antalet byte som används av filerna i vektorarkivet. Yes

OpenAI.VoiceIdsShared

Property Value
Type string
Values alloy
ash
ballad
coral
echo
fable
onyx
nova
sage
shimmer
verse

OpenAI.WebSearchAction

Diskriminerande för OpenAI.WebSearchAction

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde Schema
find OpenAI.WebSearchActionFind
open_page OpenAI.WebSearchActionOpenPage
search OpenAI.WebSearchActionSearch
Name Type Description Required Default
type OpenAI.WebSearchActionType Yes

OpenAI.WebSearchActionFind

Åtgärdstyp "find": Söker efter ett mönster på en inläst sida.

Name Type Description Required Default
mönster string Det mönster eller den text som ska sökas efter på sidan. Yes
type enum Åtgärdstypen.
Möjliga värden: find		 Yes
url string Url:en för sidan sökte efter mönstret. Yes

OpenAI.WebSearchActionOpenPage

Åtgärdstyp "open_page" – Öppnar en specifik URL från sökresultat.

Name Type Description Required Default
type enum Åtgärdstypen.
Möjliga värden: open_page		 Yes
url string Url:en som öppnats av modellen. Yes

OpenAI.WebSearchActionSearch

Åtgärdstyp "sök" – Utför en webbsökningsfråga.

Name Type Description Required Default
query string Sökfrågan. Yes
type enum Åtgärdstypen.
Möjliga värden: search		 Yes

OpenAI.WebSearchActionType

Property Value
Type string
Values search
open_page
find

OpenAI.WebSearchPreviewTool

Obs! web_search är ännu inte tillgängligt via Azure OpenAI.

Name Type Description Required Default
search_context_size enum Vägledning på hög nivå för hur mycket utrymme i kontextfönstret som ska användas för sökningen. En av low, mediumeller high. medium används som standard.
Möjliga värden: low, medium, high		 No
type enum Typen av webbsökningsverktyg. En av web_search_preview eller web_search_preview_2025_03_11.
Möjliga värden: web_search_preview		 Yes
user_location object No
└– typ OpenAI.LocationType No

OpenAI.WebSearchToolCallItemParam

Obs! web_search är ännu inte tillgängligt via Azure OpenAI.

Name Type Description Required Default
action object Yes
└– typ OpenAI.WebSearchActionType No
type enum
Möjliga värden: web_search_call		 Yes

OpenAI.WebSearchToolCallItemResource

Obs! web_search är ännu inte tillgängligt via Azure OpenAI.

Name Type Description Required Default
action object Yes
└– typ OpenAI.WebSearchActionType No
status enum Status för webbsökningsverktygets anrop.
Möjliga värden: in_progress, searching, completed, failed		 Yes
type enum
Möjliga värden: web_search_call		 Yes

PineconeChatDataSource

Name Type Description Required Default
parameters object Parameterinformationen som styr användningen av Pinecone-datakällan. Yes
└– allow_partial_result boolean Om värdet är true tillåter systemet att partiella sökresultat används och begäran misslyckas om alla
Delvisa sökfrågor misslyckas. Om det inte anges eller anges som falskt misslyckas begäran om någon sökfråga misslyckas.		 No False
└– autentisering object No
└– nyckel string No
└– typ enum
Möjliga värden: api_key		 No
└─ inbäddningsberoende object En representation av en datavektoriseringskälla som kan användas som en inbäddningsresurs med en datakälla. No
└– typ AzureChatDataSourceVectorizationSourceType Differentierande identifierare för konkret vektoriseringskälla. No
└– miljö string Miljönamnet som ska användas med Pinecone. No
└– fields_mapping object Fältmappningar som ska tillämpas på data som används av Pinecone-datakällan.
Observera att innehållsfältmappningar krävs för Pinecone.		 No
└– innehållsfält array No
└– content_fields_separator string No
└– filepath_field string No
└– title_field string No
└– url_field string No
└– in_scope boolean Om frågor ska begränsas till användning av indexerade data. No
└– include_contexts array Egenskaperna för utdatakontexten som ska inkluderas i svaret.
Som standard begärs citat och avsikt.		 No ['citat', 'avsikt']
└– index_namn string Namnet på det Pinecone-databasindex som ska användas. No
└─ max_sökfrågor integer Det maximala antalet omskrivna frågor som ska skickas till sökprovidern för ett meddelande från en enskild användare.
Som standard gör systemet en automatisk bestämning.		 No
└– strikthet integer Den konfigurerade strängheten för sökrelevansfiltreringen.
Högre strikthet kommer att öka precisionen men minska återkallningen av svaret.		 No
└top_n_documents integer Det konfigurerade antalet dokument som ska visas i frågan. No
type enum Den särskiljande typidentifieraren, som alltid är "pinecone".
Möjliga värden: pinecone		 Yes

Quality

Kvaliteten på videoinnehållet som ska hämtas. Detta anger kvaliteten på det videoinnehåll som ska returneras.

Property Value
Description Kvaliteten på videoinnehållet som ska hämtas.
Detta anger kvaliteten på det videoinnehåll som ska returneras.
Type string
Values high
low

ResponseFormatJSONSchemaRequest

Name Type Description Required Default
json_schema object JSON-schema för svarsformatet Yes
type enum Typ av svarsformat
Möjliga värden: json_schema		 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. Om du vill begära att den här modellen genererar både text- och ljudsvar kan du använda:

["text", "audio"]

Array av: sträng

SpeechGenerationResponseFormat

De ljudutdataformat som stöds för text till tal.

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

VideoGeneration

Ett videogenereringsresultat.

Name Type Description Required Default
created_at integer Den tid då videogenerationen skapades. Yes
height integer Videons höjd. Yes
id string ID:t för videogenerationen. Yes
job_id string ID:t för videogenereringsjobbet för den här videon. Yes
n_seconds integer Videogenereringens varaktighet. Yes
object enum
Möjliga värden: video.generation		 Yes
prompt string Uppmaningen för den här videogenereringen. Yes
width integer Videons bredd. Yes

VideoGenerationJob

Ett videogenereringsjobb.

Name Type Description Required Default
created_at integer Tiden då jobbet skapades. Yes
expires_at integer Den tid då jobbet tas bort automatiskt från tjänsten. Videoinnehållet och metadata för jobbet bör lagras före det här datumet för att undvika dataförlust. No
failure_reason sträng (se giltiga modeller nedan) No
finished_at integer Tiden då jobbet blev klart med alla videogenerationer. No
generations array De genererade videorna för det här jobbet. Talet beror på den angivna n_variants och generationernas skapandeframgång. No
height integer Videons höjd. Yes
id string Jobbets ID. Yes
inpaint_items array Valfria inpainting-objekt för det här videogenereringsjobbet. No
model string Namnet på distributionen som ska användas för det här videogenereringsjobbet. Yes
n_seconds integer Varaktigheten för videogenereringsjobbet. Yes
n_variants integer Antalet videor som ska skapas som varianter för det här videogenereringsjobbet. Yes
object enum
Möjliga värden: video.generation.job		 Yes
prompt string Uppmaningen för det här videogenereringsjobbet. Yes
status object Status för ett videogenereringsjobb. Yes
width integer Videons höjd. Yes

VideoGenerationJobList

En lista över videogenereringsjobb.

Name Type Description Required Default
data array Listan över videogenereringsjobb. Yes
first_id string ID för det första jobbet på den aktuella sidan, om det är tillgängligt. No
has_more boolean En flagga som anger om det finns fler jobb tillgängliga efter listan. Yes
last_id string ID:t för det senaste jobbet på den aktuella sidan, om det är tillgängligt. No
object enum
Möjliga värden: list		 Yes

Nästa steg

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