Azure OpenAI in Microsoft Foundry Models REST API v1 Preview-Referenz

Dieser Artikel enthält Details zu den Ableitungs-REST-API-Endpunkten für Azure OpenAI.

Datenebenen-Ableitung

Der Rest des Artikels behandelt die neue Version der v1-Vorschau-API-Version der Azure OpenAI-Datenebenen-Ableitungsspezifikation. Weitere Informationen finden Sie im API-Lebenszyklushandbuch.

Wenn Sie nach Dokumentationen zur neuesten Version der v1 GA-API suchen, lesen Sie die neueste GA-Datenebenen-Ableitungs-API.

Sprache erstellen

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

Generiert Text-zu-Sprache-Audio aus dem Eingabetext.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite Microsoft Foundry Models API-Version, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Typ: mehrteilige Formulardaten (multipart/form-data)

Name	Typ	Beschreibung	Erforderlich	Vorgabe
input	string	Der Text, für den Audio generiert werden soll. Die maximale Länge beträgt 4096 Zeichen.	Ja
Anweisungen	string	Steuern Sie die Stimme Ihrer generierten Audiodaten mit zusätzlichen Anweisungen. Funktioniert nicht mit `tts-1` oder `tts-1-hd`.	No
Modell	string	Das Modell, das für diese Text-zu-Sprache-Anforderung verwendet werden soll.	Ja
Antwortformat	Objekt	Die unterstützten Audioausgabeformate für Text-zu-Sprache.	No
Geschwindigkeit	number	Die Geschwindigkeit der Spracherkennung für generierte Audiodaten. Werte sind im Bereich von 0,25 bis 4,0 gültig, wobei 1,0 die Standardwerte und höhere Werte, die schnelleren Spracherkennungen entsprechen.	No	1
stream_format	enum	Das Format, in das die Audiodaten gestreamt werden sollen. Unterstützte Formate sind `sse` und `audio`. `sse` wird für `tts-1` oder `tts-1-hd`. Mögliche Werte: `sse`, `audio`	No
Stimme	Objekt		Ja

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/octet-stream	string

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Beispiele

Example

Synthetisiert Audio aus dem bereitgestellten Text.

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

Antworten: Statuscode: 200

{
  "body": "101010101"
}

Transkription erstellen

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

Transkribiert Audio in die Eingabesprache.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Typ: mehrteilige Formulardaten (multipart/form-data)

Name	Typ	Beschreibung	Erforderlich	Vorgabe
chunking_strategy	Objekt		No
└– prefix_padding_ms	Ganzzahl	Die Menge der Audiodaten, die vor der erkannten VAD-Sprache (in Millisekunden) enthalten sein sollen.	No	300
└– Dauer_der_Stille_in_ms	Ganzzahl	Dauer der Stille zum Erkennen des Sprachstopps (in Millisekunden). Mit kürzeren Werten reagiert das Modell schneller, kann aber an kurzen Pausen vom Benutzer teilnehmen.	No	200
└– Schwellenwert	number	Vertraulichkeitsschwellenwert (0,0 bis 1,0) für die Sprachaktivitätserkennung. Eine höhere Schwelle erfordert lauteres Audio, um das Modell zu aktivieren, und kann daher in lauten Umgebungen besser funktionieren.	No	0,5
└– Typ	enum	Muss so festgelegt sein, dass `server_vad` manuelle Blöcke mithilfe der serverseitigen VAD aktiviert werden. Mögliche Werte: `server_vad`	No
Datei	string		Ja
filename	string	Der optionale Dateiname oder der beschreibende Bezeichner, der den Audiodaten zugeordnet werden soll.	No
include[]	array	Zusätzliche Informationen, die in die Transkriptionsantwort aufgenommen werden sollen. `logprobs` gibt die Protokollwahrscheinlichkeiten der Token in der Antwort zurück, um das Vertrauen des Modells in die Transkription zu verstehen. `logprobs` funktioniert nur mit response_format auf `json` und nur mit den Modellen `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, , `gpt-4o-mini-transcribe`und `gpt-4o-mini-transcribe-2025-12-15`.	No
language	string	Die Sprache des Eingabeaudios. Durch die Bereitstellung der Eingabesprache in ISO-639-1 (z. B. `en`) wird die Genauigkeit und Latenz verbessert.	No
Modell	string	Das Modell, das für diese Transkriptionsanforderung verwendet werden soll.	No
Eingabeaufforderung	string	Optionaler Text zum Leiten der Formatvorlage des Modells oder Fortsetzen eines vorherigen Audiosegments. Die Eingabeaufforderung sollte mit der Audiosprache übereinstimmen.	No
Antwortformat	Objekt		No
stream	Boolescher Wert	Wenn dieser Wert auf "true" festgelegt ist, werden die Modellantwortdaten an den Client gestreamt, da sie mithilfe von Server gesendeten Ereignissen generiert wird. Hinweis: Streaming wird für das `whisper-1` Modell nicht unterstützt und wird ignoriert.	No	Falsch
Temperatur	number	Die Probenahmetemperatur zwischen 0 und 1. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Bei Festlegung auf 0 verwendet das Modell die Protokollwahrscheinlichkeit , um die Temperatur automatisch zu erhöhen, bis bestimmte Schwellenwerte erreicht werden.	No	0
timestamp_granularities[]	array	Die Zeitstempel-Granularitäten, die für diese Transkription aufgefüllt werden sollen. `response_format` muss für die Verwendung von Timestamp-Granularitäten festgelegt `verbose_json` werden. Entweder oder beide dieser Optionen werden unterstützt: `word`oder `segment`. Hinweis: Es gibt keine zusätzliche Latenz für Segmentzeitstempel, aber das Generieren von Wortzeitstempeln verursacht zusätzliche Latenz.	No	['segment']

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	AzureAudioTranscriptionResponse
Textdatei/Klartext	string

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Beispiele

Example

Ruft transkribierten Text und zugeordnete Metadaten aus bereitgestellten gesprochenen Audiodaten ab.

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

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

Antworten: Statuscode: 200

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

Übersetzung erstellen

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

Ruft englischsprachigen transkribierten Text und zugeordnete Metadaten aus bereitgestellten gesprochenen Audiodaten ab.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Typ: mehrteilige Formulardaten (multipart/form-data)

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Datei	string		Ja
filename	string	Optionaler Dateiname oder beschreibender Bezeichner, der den Audiodaten zugeordnet werden soll	No
Modell	string	Das Modell, das für diese Übersetzungsanforderung verwendet werden soll.	No
Eingabeaufforderung	string	Optionaler Text zum Leiten der Formatvorlage des Modells oder Fortsetzen eines vorherigen Audiosegments. Die Eingabeaufforderung sollte in Englisch sein.	No
Antwortformat	Objekt		No
Temperatur	number	Die Probenahmetemperatur zwischen 0 und 1. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Bei Festlegung auf 0 verwendet das Modell die Protokollwahrscheinlichkeit , um die Temperatur automatisch zu erhöhen, bis bestimmte Schwellenwerte erreicht werden.	No	0

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	AzureAudioTranslationResponse
Textdatei/Klartext	string

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Beispiele

Example

Ruft englischsprachigen transkribierten Text und zugeordnete Metadaten aus bereitgestellten gesprochenen Audiodaten ab.

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

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

Antworten: Statuscode: 200

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

Chatabschluss erstellen

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

Erstellt einen Chatabschluss.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Audio	Objekt	Parameter für die Audioausgabe. Erforderlich, wenn die Audioausgabe mit `modalities: ["audio"]`.	No
└─ Format	enum	Gibt das Ausgabeaudioformat an. Muss einer von , , , ,`wav` oder `mp3`. `flacopuspcm16` Mögliche Werte: `wav`, , `aac`, `mp3flac`, , , `opuspcm16`	No
└– Stimme	Objekt		No
data_sources	array	Die Datenquellen, die für das Feature "On Your Data" verwendet werden sollen, ausschließlich für Azure OpenAI.	No
frequency_penalty	number	Zahl zwischen -2,0 und 2,0. Positive Werte bestrafen neue Token basierend auf ihrer vorhandenen Häufigkeit im Text bisher und verringern die Wahrscheinlichkeit, dass das Modell dieselbe Zeile wiederholt.	No	0
function_call	enum	Durch Angeben einer bestimmten Funktion wird `{"name": "my_function"}` das Modell gezwungen, diese Funktion aufzurufen. Mögliche Werte: `none`, `auto`	No
functions	array	Veraltet zugunsten von `tools`. Eine Liste der Funktionen, für die das Modell JSON-Eingaben generieren kann.	No
Logit-Bias	Objekt	Ändern Sie die Wahrscheinlichkeit, dass angegebene Token im Abschluss angezeigt werden. Akzeptiert ein JSON-Objekt, das Token (angegeben durch ihre Token-ID im Tokenizer) einem zugeordneten Bias-Wert von -100 bis 100 zuordnet. Mathematisch wird der vom Modell generierten Logits vor dem Sampling die Verzerrung hinzugefügt. Der genaue Effekt variiert je Modell, aber Werte zwischen -1 und 1 sollten die Wahrscheinlichkeit der Auswahl verringern oder erhöhen; Werte wie -100 oder 100 sollten zu einem Verbot oder einer exklusiven Auswahl des relevanten Tokens führen.	No	Nichts
logprobs	Boolescher Wert	Gibt an, ob Protokollwahrscheinlichkeiten der Ausgabetoken zurückgegeben werden sollen. Wenn wahr, gibt die Protokollwahrscheinlichkeit jedes Ausgabetokens zurück, das in der `content` von `message`.	No	Falsch
max_completion_tokens	Ganzzahl	Eine obere Grenze für die Anzahl der Token, die für einen Abschluss generiert werden können, einschließlich sichtbarer Ausgabetoken und Begründungstoken.	No
maximale_Anzahl_von_Tokens	Ganzzahl	Die maximale Anzahl von Token, die im Chatabschluss generiert werden können. Dieser Wert kann verwendet werden, um die Kosten für Text zu steuern, der über die API generiert wird. Dieser Wert ist jetzt zugunsten von `max_completion_tokens`" veraltet" und ist nicht mit o1-Serienmodellen kompatibel.	No
Nachrichten	array	Eine Liste der Nachrichten, die bisher aus der Unterhaltung bestehen. Abhängig vom verwendeten Modell werden verschiedene Nachrichtentypen (Modalitäten) unterstützt, z. B. Text, Bilder und Audio.	Ja
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
modalities	Objekt	Ausgabetypen, die vom Modell generiert werden sollen. Die meisten Modelle sind in der Lage, Text zu generieren. Dies ist die Standardeinstellung: `["text"]` Das `gpt-4o-audio-preview` Modell kann auch zum Generieren von Audio verwendet werden. Um anzufordern, dass dieses Modell sowohl Text- als auch Audioantworten generiert, können Sie Folgendes verwenden: `["text", "audio"]`	No
Modell	string	Der Modellbereitstellungsbezeichner, der für die Chatabschlussanforderung verwendet werden soll.	Ja
n	Ganzzahl	Wie viele Chatabschlussoptionen für jede Eingabenachricht generiert werden sollen. Beachten Sie, dass Sie basierend auf der Anzahl der generierten Token für alle Auswahlmöglichkeiten in Rechnung gestellt werden. Halten Sie sich `n` an die `1` Minimierung der Kosten.	No	1
Parallele Werkzeugaufrufe	Objekt	Gibt an, ob beim Verwenden des Tools parallele Funktionsaufrufe aktiviert werden sollen.	No
prediction	Objekt	Basisdarstellung der vorhergesagten Ausgabe eines Modells.	No
└– Typ	OpenAI.ChatOutputPredictionType		No
presence_penalty	number	Zahl zwischen -2,0 und 2,0. Positive Werte bestrafen neue Token basierend darauf, ob sie bisher im Text angezeigt werden, wodurch die Wahrscheinlichkeit erhöht wird, dass sie über neue Themen sprechen.	No	0
Denkanstrengung	Objekt	Nur o-Serienmodelle Beschränkt den Aufwand für die Begründung von Begründungsmodellen. Derzeit unterstützte Werte sind `low`, `medium`und `high`. Das Reduzieren von Gründen kann zu schnelleren Antworten und weniger Token führen, die bei der Begründung in einer Antwort verwendet werden.	No
Antwortformat	Objekt		No
└– Typ	enum	Mögliche Werte: `text`, , `json_objectjson_schema`	No
seed	Ganzzahl	Dieses Feature befindet sich in der Betaversion. Wenn angegeben, wird unser System eine optimale Leistung unternehmen, um deterministisch zu proben, sodass wiederholte Anforderungen mit demselben `seed` Und Parameter dasselbe Ergebnis zurückgeben sollten. Der Determinismus ist nicht garantiert, und Sie sollten auf den `system_fingerprint` Antwortparameter verweisen, um Änderungen im Back-End zu überwachen.	No
Stopp	Objekt	Nicht unterstützt mit den neuesten Begründungsmodellen `o3` und `o4-mini`. Bis zu 4 Sequenzen, bei denen die API keine weiteren Token mehr generiert. Der zurückgegebene Text enthält nicht die Stoppsequenz.	No
store	Boolescher Wert	Gibt an, ob die Ausgabe dieser Chatabschlussanforderung für die Verwendung in Modelldestillations- oder Evaluierungsprodukten gespeichert werden soll.	No	Falsch
stream	Boolescher Wert	Wenn dieser Wert auf "true" festgelegt ist, werden die Modellantwortdaten an den Client gestreamt, da sie mithilfe von Server gesendeten Ereignissen generiert wird.	No	Falsch
stream_options	Objekt	Optionen für die Streamingantwort. Legen Sie dies nur fest, wenn Sie festlegen `stream: true`.	No
└– include_usage	Boolescher Wert	Bei Festlegung wird ein zusätzlicher Block vor der `data: [DONE]` Nachricht gestreamt. Das `usage` Feld in diesem Abschnitt zeigt die Tokenverwendungsstatistiken für die gesamte Anforderung an, und das `choices` Feld ist immer ein leeres Array. Alle anderen Blöcke enthalten auch ein `usage` Feld, aber mit einem Nullwert. HINWEIS: Wenn der Datenstrom unterbrochen wird, erhalten Sie möglicherweise nicht den endgültigen Verwendungsabschnitt, der die gesamte Tokenverwendung für die Anforderung enthält.	No
Temperatur	number	Welche Probenahmetemperatur verwendet werden soll, zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Es wird in der Regel empfohlen, dies oder `top_p` nicht beides zu ändern.	No	1
tool_choice	OpenAI.ChatCompletionToolChoiceOption	Steuert, welches Tool (falls vorhanden) vom Modell aufgerufen wird. `none` bedeutet, dass das Modell kein Tool aufruft und stattdessen eine Nachricht generiert. `auto` bedeutet, dass das Modell zwischen dem Generieren einer Nachricht oder dem Aufrufen eines oder mehrerer Tools auswählen kann. `required` bedeutet, dass das Modell mindestens ein Tools aufrufen muss. Wenn Sie ein bestimmtes Tool über `{"type": "function", "function": {"name": "my_function"}}` das Modell angeben, wird das Modell gezwungen, dieses Tool aufzurufen. `none` ist die Standardeinstellung, wenn keine Tools vorhanden sind. `auto` ist die Standardeinstellung, wenn Tools vorhanden sind.	No
tools	array	Eine Liste der Tools, die das Modell aufrufen kann. Derzeit werden nur Funktionen als Tool unterstützt. Verwenden Sie diese Funktion, um eine Liste der Funktionen bereitzustellen, für die das Modell MÖGLICHERWEISE JSON-Eingaben generiert. Maximal 128 Funktionen werden unterstützt.	No
top_logprobs	Ganzzahl	Eine ganze Zahl zwischen 0 und 20, die die Anzahl der höchstwahrscheinlichen Token an jeder Tokenposition angibt, jeweils mit einer zugeordneten Protokollwahrscheinlichkeit.	No
top_p	number	Eine Alternative zur Probenahme mit Temperatur, die als Kernsampling bezeichnet wird, wobei das Modell die Ergebnisse der Token mit top_p Wahrscheinlichkeitsmasse berücksichtigt. 0,1 bedeutet also, dass nur die Token, die die obersten 10% Wahrscheinlichkeitsmasse umfassen, berücksichtigt werden. Es wird in der Regel empfohlen, dies oder `temperature` nicht beides zu ändern.	No	1
user	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der dazu beitragen kann, Missbrauch zu überwachen und zu erkennen.	No
user_security_context	AzureUserSecurityContext	Der Benutzersicherheitskontext enthält mehrere Parameter, die die Anwendung selbst beschreiben, und den Endbenutzer, der mit der Anwendung interagiert. Diese Felder unterstützen Ihre Sicherheitsteams, Sicherheitsvorfälle zu untersuchen und zu mindern, indem sie einen umfassenden Ansatz zum Schutz Ihrer KI-Anwendungen bieten. Learn more zum Schutz von KI-Anwendungen mit Microsoft Defender for Cloud.	No

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	AzureCreateChatCompletionResponse
text/event-stream	AzureCreateChatCompletionStreamResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Beispiele

Example

Erstellt einen Abschluss für die bereitgestellte Eingabeaufforderung, Parameter und das ausgewählte Modell.

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

Antworten: Statuscode: 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
    }
  }
}

Einbettung erstellen

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

Erstellt einen Einbettungsvektor, der den Eingabetext darstellt.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich
Abmessungen	Ganzzahl	Die Anzahl der Dimensionen, die die resultierenden Ausgabeeinbettungen aufweisen sollen. Nur in `text-embedding-3` und späteren Modellen unterstützt.	No
encoding_format	enum	Das Format, in das die Einbettungen zurückgegeben werden sollen. Kann entweder `float` oder `base64`. Mögliche Werte: `float`, `base64`	No
input	Zeichenfolge oder Matrix		Ja
Modell	string	Das Modell, das für die Einbettungsanforderung verwendet werden soll.	Ja
user	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	No

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.CreateEmbeddingResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Beispiele

Example

Gibt die Einbettungen für eine bestimmte Eingabeaufforderung zurück.

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

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

Antworten: Statuscode: 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
    }
  }
}

Evals auflisten

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

Listet Auswertungen für ein Projekt auf.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
aoai-evals	header	Ja	string Mögliche Werte: `preview`	Ermöglicht den Zugriff auf AOAI Evals, ein Vorschaufeature. Für dieses Feature muss die Kopfzeile "aoai-evals" auf "vorschau" festgelegt werden.
Nach	Anfrage	No	string	Bezeichner für die letzte Auswertung der vorherigen Paginierungsanforderung.
Begrenzung	Anfrage	No	Ganzzahl	Ein Grenzwert für die Anzahl der Evals, die in einer einzelnen Paginierungsantwort zurückgegeben werden sollen.
order	Anfrage	No	string Mögliche Werte: `asc`, `desc`	Sortierreihenfolge für Evals nach Zeitstempel. Wird `asc` für aufsteigende Reihenfolge oder `desc` für absteigende Reihenfolge verwendet.
order_by	Anfrage	No	string Mögliche Werte: `created_at`, `updated_at`	Evals können nach Erstellungszeit oder zuletzt aktualisierter Zeit sortiert werden. Wird für die Erstellungszeit oder `created_at` für die uhrzeit der letzten Aktualisierung verwendet`updated_at`.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.EvalList

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Createeval

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

Erstellen Sie die Struktur einer Auswertung, die zum Testen der Leistung eines Modells verwendet werden kann.

Eine Auswertung ist eine Reihe von Testkriterien und eine Datenquelle. Nachdem Sie eine Auswertung erstellt haben, können Sie sie auf verschiedenen Modellen und Modellparametern ausführen. Wir unterstützen verschiedene Arten von Benotern und Datenquellen.

HINWEIS: Diese Azure OpenAI-API befindet sich in der Vorschau und kann geändert werden.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
aoai-evals	header	Ja	string Mögliche Werte: `preview`	Ermöglicht den Zugriff auf AOAI Evals, ein Vorschaufeature. Für dieses Feature muss die Kopfzeile "aoai-evals" auf "vorschau" festgelegt werden.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich
Datenquellenkonfiguration	Objekt		Ja
└– Typ	OpenAI.EvalDataSourceConfigType		No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
Name	string	Der Name der Auswertung.	No
Statuscode	enum	Mögliche Werte: `201`	Ja
Testkriterien	array	Eine Liste der Benoter für alle Auswertungen in dieser Gruppe. Grader können mithilfe von doppelt geschweiften Klammern auf Variablen in der Datenquelle verweisen, z `{{item.variable_name}}`. B. . Um auf die Ausgabe des Modells zu verweisen, verwenden Sie den `sample` Namespace (ie, `{{sample.output_text}}`).	Ja

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.Eval

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Eval abrufen

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

Rufen Sie eine Auswertung anhand ihrer ID ab. Ruft eine Auswertung anhand der ID ab.

HINWEIS: Diese Azure OpenAI-API befindet sich in der Vorschau und kann geändert werden.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
aoai-evals	header	Ja	string Mögliche Werte: `preview`	Ermöglicht den Zugriff auf AOAI Evals, ein Vorschaufeature. Für dieses Feature muss die Kopfzeile "aoai-evals" auf "vorschau" festgelegt werden.
eval_id	path	Ja	string

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.Eval

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Bewertung aktualisieren

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

Aktualisieren Sie ausgewählte, veränderbare Eigenschaften einer angegebenen Auswertung.

HINWEIS: Diese Azure OpenAI-API befindet sich in der Vorschau und kann geändert werden.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
aoai-evals	header	Ja	string Mögliche Werte: `preview`	Ermöglicht den Zugriff auf AOAI Evals, ein Vorschaufeature. Für dieses Feature muss die Kopfzeile "aoai-evals" auf "vorschau" festgelegt werden.
eval_id	path	Ja	string

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich	Vorgabe
metadata	OpenAI.MetadataPropertyForRequest	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
Name	string		No

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.Eval

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Löschen von "eval"

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

Löschen sie eine angegebene Auswertung.

HINWEIS: Diese Azure OpenAI-API befindet sich in der Vorschau und kann geändert werden.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
aoai-evals	header	Ja	string Mögliche Werte: `preview`	Ermöglicht den Zugriff auf AOAI Evals, ein Vorschaufeature. Für dieses Feature muss die Kopfzeile "aoai-evals" auf "vorschau" festgelegt werden.
eval_id	path	Ja	string

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	Objekt

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Abrufen von eval-Ausführungen

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

Dient zum Abrufen einer Liste von Läufen für eine angegebene Auswertung.

HINWEIS: Diese Azure OpenAI-API befindet sich in der Vorschau und kann geändert werden.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
aoai-evals	header	Ja	string Mögliche Werte: `preview`	Ermöglicht den Zugriff auf AOAI Evals, ein Vorschaufeature. Für dieses Feature muss die Kopfzeile "aoai-evals" auf "vorschau" festgelegt werden.
eval_id	path	Ja	string
Nach	Anfrage	No	string
Begrenzung	Anfrage	No	Ganzzahl
order	Anfrage	No	string Mögliche Werte: `asc`, `desc`
Status	Anfrage	No	string Mögliche Werte: `queued`, , `in_progresscompleted`, , `canceledfailed`

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.EvalRunList

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Erstellen einer eval-Ausführung

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

Erstellen Sie einen neuen Auswertungslauf, und beginnen Sie mit dem Benotungsprozess.

HINWEIS: Diese Azure OpenAI-API befindet sich in der Vorschau und kann geändert werden.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
aoai-evals	header	Ja	string Mögliche Werte: `preview`	Ermöglicht den Zugriff auf AOAI Evals, ein Vorschaufeature. Für dieses Feature muss die Kopfzeile "aoai-evals" auf "vorschau" festgelegt werden.
eval_id	path	Ja	string

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich
Datenquelle	Objekt		Ja
└– Typ	OpenAI.EvalRunDataSourceType		No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
Name	string	Der Name der Ausführung.	No

Antworten

Statuscode: 201

Beschreibung: Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.EvalRun

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Abrufen einer eval-Ausführung

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

Dient zum Abrufen einer bestimmten Auswertung, die von der ID ausgeführt wird.

HINWEIS: Diese Azure OpenAI-API befindet sich in der Vorschau und kann geändert werden.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
aoai-evals	header	Ja	string Mögliche Werte: `preview`	Ermöglicht den Zugriff auf AOAI Evals, ein Vorschaufeature. Für dieses Feature muss die Kopfzeile "aoai-evals" auf "vorschau" festgelegt werden.
eval_id	path	Ja	string
run_id	path	Ja	string

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.EvalRun

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Abbrechen der Ausführung der Auswertung

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

Abbrechen einer bestimmten Auswertung, die von der ID ausgeführt wird.

HINWEIS: Diese Azure OpenAI-API befindet sich in der Vorschau und kann geändert werden.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
aoai-evals	header	Ja	string Mögliche Werte: `preview`	Ermöglicht den Zugriff auf AOAI Evals, ein Vorschaufeature. Für dieses Feature muss die Kopfzeile "aoai-evals" auf "vorschau" festgelegt werden.
eval_id	path	Ja	string
run_id	path	Ja	string

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.EvalRun

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Deleteevalrun

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

Löschen Sie eine bestimmte Auswertung, die von ihrer ID ausgeführt wird.

HINWEIS: Diese Azure OpenAI-API befindet sich in der Vorschau und kann geändert werden.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
aoai-evals	header	Ja	string Mögliche Werte: `preview`	Ermöglicht den Zugriff auf AOAI Evals, ein Vorschaufeature. Für dieses Feature muss die Kopfzeile "aoai-evals" auf "vorschau" festgelegt werden.
eval_id	path	Ja	string
run_id	path	Ja	string

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	Objekt

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Abrufen von Ausgabeelementen für die eval-Ausführung

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

Dient zum Abrufen einer Liste der Ausgabeelemente für einen angegebenen Auswertungslauf.

HINWEIS: Diese Azure OpenAI-API befindet sich in der Vorschau und kann geändert werden.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
aoai-evals	header	Ja	string Mögliche Werte: `preview`	Ermöglicht den Zugriff auf AOAI Evals, ein Vorschaufeature. Für dieses Feature muss die Kopfzeile "aoai-evals" auf "vorschau" festgelegt werden.
eval_id	path	Ja	string
run_id	path	Ja	string
Nach	Anfrage	No	string
Begrenzung	Anfrage	No	Ganzzahl
Status	Anfrage	No	string Mögliche Werte: `fail`, `pass`
order	Anfrage	No	string Mögliche Werte: `asc`, `desc`

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.EvalRunOutputItemList

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Abrufen des Ausgabeelements "eval run"

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

Ruft ein bestimmtes Ausgabeelement aus einer Auswertung ab, die von seiner ID ausgeführt wird.

HINWEIS: Diese Azure OpenAI-API befindet sich in der Vorschau und kann geändert werden.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
aoai-evals	header	Ja	string Mögliche Werte: `preview`	Ermöglicht den Zugriff auf AOAI Evals, ein Vorschaufeature. Für dieses Feature muss die Kopfzeile "aoai-evals" auf "vorschau" festgelegt werden.
eval_id	path	Ja	string
run_id	path	Ja	string
output_item_id	path	Ja	string

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.EvalRunOutputItem

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Datei erstellen

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Typ: mehrteilige Formulardaten (multipart/form-data)

Name	Typ	Beschreibung	Erforderlich
expires_after	Objekt		Ja
└– Anker	AzureFileExpiryAnchor		No
└─ Sekunden	Ganzzahl		No
Datei	string		Ja
Zweck	enum	Der beabsichtigte Zweck der hochgeladenen Datei. Einer von: - `assistants`: Wird in der Assistenten-API verwendet - `batch`: Wird in der Batch-API verwendet - `fine-tune`: Verwendet für Feinabstimmung - `evals`: Verwendet für eval-Datasets Mögliche Werte: `assistants`, , `batch`, `fine-tuneevals`	Ja

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	AzureOpenAIFile

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Beispiele

Example

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

Dateien auflisten

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
Zweck	Anfrage	No	string

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	AzureListFilesResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Datei abrufen

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
Datei-ID	path	Ja	string	Die ID der Datei, die für diese Anforderung verwendet werden soll.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	AzureOpenAIFile

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Datei löschen

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
Datei-ID	path	Ja	string	Die ID der Datei, die für diese Anforderung verwendet werden soll.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.DeleteFileResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Datei herunterladen

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
Datei-ID	path	Ja	string	Die ID der Datei, die für diese Anforderung verwendet werden soll.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/octet-stream	string

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Rungrader

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

Führen Sie einen Grader aus.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich
Grader	Objekt	Ein StringCheckGrader-Objekt, das einen Zeichenfolgenvergleich zwischen Eingabe und Verweis mithilfe eines angegebenen Vorgangs durchführt.	Ja
└– calculate_output	string	Eine Formel zum Berechnen der Ausgabe basierend auf den Benotungsergebnissen.	No
└- Bewertungsmetrik	enum	Die zu verwendende Auswertungsmetrik. Einer von `fuzzy_match`, `bleu`, , `gleumeteor`, `rouge_1`, , `rouge_2`, `rouge_3`, `rouge_4`, , oder `rouge_5rouge_l`. Mögliche Werte: `fuzzy_match`, , `bleu`, `gleu`, `meteorrouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5rouge_l`	No
└– Noten	Objekt		No
└– image_tag	string	Das Bildtag, das für das Python-Skript verwendet werden soll.	No
└– Eingabe	array	Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten.	No
└─ Modell	string	Das Modell, das für die Auswertung verwendet werden soll.	No
└– Name	string	Der Name des Graders.	No
└─ Vorgang	enum	Der auszuführende Zeichenfolgenüberprüfungsvorgang. Einer von `eq`, `ne`, , `like`oder `ilike`. Mögliche Werte: `eq`, , `ne`, `likeilike`	No
└– Bereich	array	Der Bereich der Bewertung. Standardwert ist .`[0, 1]`	No
└– Referenz	string	Der Text, der abgestuft wird.	No
└– Stichprobenparameter		Die Samplingparameter für das Modell.	No
└- Quelle	string	Der Quellcode des Python-Skripts.	No
└– Typ	enum	Der Objekttyp, der immer `multi`ist. Mögliche Werte: `multi`	No
item		Das Datasetelement, das dem Grader bereitgestellt wird. Dies wird verwendet, um den `item` Namespace aufzufüllen.	No
model_sample	string	Das zu bewertende Modellbeispiel. Dieser Wert wird verwendet, um den `sample` Namespace aufzufüllen. Die `output_json` Variable wird aufgefüllt, wenn das Modellbeispiel eine gültige JSON-Zeichenfolge ist.	Ja

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.RunGraderResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Überprüfen des Graders

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

Überprüfen sie einen Grader.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich
Grader	Objekt	Ein StringCheckGrader-Objekt, das einen Zeichenfolgenvergleich zwischen Eingabe und Verweis mithilfe eines angegebenen Vorgangs durchführt.	Ja
└– calculate_output	string	Eine Formel zum Berechnen der Ausgabe basierend auf den Benotungsergebnissen.	No
└- Bewertungsmetrik	enum	Die zu verwendende Auswertungsmetrik. Einer von `fuzzy_match`, `bleu`, , `gleumeteor`, `rouge_1`, , `rouge_2`, `rouge_3`, `rouge_4`, , oder `rouge_5rouge_l`. Mögliche Werte: `fuzzy_match`, , `bleu`, `gleu`, `meteorrouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5rouge_l`	No
└– Noten	Objekt		No
└– image_tag	string	Das Bildtag, das für das Python-Skript verwendet werden soll.	No
└– Eingabe	array	Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten.	No
└─ Modell	string	Das Modell, das für die Auswertung verwendet werden soll.	No
└– Name	string	Der Name des Graders.	No
└─ Vorgang	enum	Der auszuführende Zeichenfolgenüberprüfungsvorgang. Einer von `eq`, `ne`, , `like`oder `ilike`. Mögliche Werte: `eq`, , `ne`, `likeilike`	No
└– Bereich	array	Der Bereich der Bewertung. Standardwert ist .`[0, 1]`	No
└– Referenz	string	Der Text, der abgestuft wird.	No
└– Stichprobenparameter		Die Samplingparameter für das Modell.	No
└- Quelle	string	Der Quellcode des Python-Skripts.	No
└– Typ	enum	Der Objekttyp, der immer `multi`ist. Mögliche Werte: `multi`	No

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.ValidateGraderResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Erstellen eines Feinabstimmungsauftrags

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

Erstellt einen Feinabstimmungsauftrag, der mit dem Erstellen eines neuen Modells aus einem bestimmten Dataset beginnt.

Die Antwort enthält Details des enqueuierten Auftrags einschließlich Auftragsstatus und den Namen der fein abgestimmten Modelle nach Abschluss.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Hyperparameter	Objekt	Die hyperparameter, die für den Feinabstimmungsauftrag verwendet werden. Dieser Wert ist nun zugunsten des `method`Parameters veraltet und sollte unter dem `method` Parameter übergeben werden.	No
└- batch_size	enum	Mögliche Werte: `auto`	No
└– Lernraten-Multiplikator	enum	Mögliche Werte: `auto`	No
└– n_epochs	enum	Mögliche Werte: `auto`	No
Integrationen	array	Eine Liste der Integrationen, die Für Ihren Feinabstimmungsauftrag aktiviert werden sollen.	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
method	OpenAI.FineTuneMethod	Die Methode, die für die Feinabstimmung verwendet wird.	No
Modell	Zeichenfolge (siehe gültige Modelle unten)	Der Name des Modells, das optimiert werden soll.	Ja
seed	Ganzzahl	Der Seed steuert die Reproduzierbarkeit des Auftrags. Das Übergeben desselben Ausgangs- und Auftragsparameters sollte die gleichen Ergebnisse erzielen, kann sich aber in seltenen Fällen unterscheiden. Wenn kein Seed angegeben ist, wird ein Seed für Sie generiert.	No
Suffix	string	Eine Zeichenfolge von bis zu 64 Zeichen, die ihrem fein abgestimmten Modellnamen hinzugefügt werden. Beispielsweise würde ein `suffix` "custom-model-name" einen Modellnamen wie `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.	No	Nichts
Trainingsdatei	string	Die ID einer hochgeladenen Datei, die Schulungsdaten enthält. Ihr Dataset muss als JSONL-Datei formatiert werden. Darüber hinaus müssen Sie Ihre Datei mit dem Zweck `fine-tune`hochladen. Der Inhalt der Datei sollte je nachdem, ob das Modell das Chat-, Abschlussformat verwendet oder wenn die Feinabstimmungsmethode das Einstellungsformat verwendet.	Ja
Validierungsdatei	string	Die ID einer hochgeladenen Datei, die Überprüfungsdaten enthält. Wenn Sie diese Datei angeben, werden die Daten verwendet, um während der Feinabstimmung regelmäßig Validierungsmetriken zu generieren. Diese Metriken können in der Feinabstimmungsergebnisdatei angezeigt werden. Die gleichen Daten sollten nicht sowohl in Train- als auch in Validierungsdateien vorhanden sein. Ihr Dataset muss als JSONL-Datei formatiert werden. Sie müssen Ihre Datei mit dem Zweck `fine-tune`hochladen.	No

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.FineTuningJob

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Auflisten von paginierten Feinabstimmungsaufträgen

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

Auflisten der Feinabstimmungsaufträge Ihrer Organisation

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
Nach	Anfrage	No	string	Bezeichner für den letzten Auftrag aus der vorherigen Paginierungsanforderung.
Begrenzung	Anfrage	No	Ganzzahl	Anzahl der abzurufenden Feinabstimmungsaufträge.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Abrufen eines Feinabstimmungsauftrags

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

Erhalten Sie Informationen zu einem Feinabstimmungsauftrag.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
fine_tuning_job_id	path	Ja	string	Die ID des Feinabstimmungsauftrags.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.FineTuningJob

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Abbrechen des Feinabstimmungsauftrags

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

Sofortiges Abbrechen eines Feinabstimmungsauftrags.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
fine_tuning_job_id	path	Ja	string	Die ID des abzubrechenden Feinabstimmungsauftrags.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.FineTuningJob

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Auflisten von Feinabstimmungsauftragsprüfpunkten

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

Auflisten der Prüfpunkte für einen Feinabstimmungsauftrag.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
fine_tuning_job_id	path	Ja	string	Die ID des Feinabstimmungsauftrags, für den Prüfpunkte abgerufen werden sollen.
Nach	Anfrage	No	string	Bezeichner für die letzte Prüfpunkt-ID aus der vorherigen Paginierungsanforderung.
Begrenzung	Anfrage	No	Ganzzahl	Anzahl der abzurufenden Prüfpunkte.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Auflisten von Feinabstimmungsereignissen

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

Abrufen von Statusupdates für einen Feinabstimmungsauftrag.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
fine_tuning_job_id	path	Ja	string	Die ID des Feinabstimmungsauftrags, für den Ereignisse abgerufen werden sollen.
Nach	Anfrage	No	string	Bezeichner für das letzte Ereignis aus der vorherigen Paginierungsanforderung.
Begrenzung	Anfrage	No	Ganzzahl	Anzahl der abzurufenden Ereignisse.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.ListFineTuningJobEventsResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Feinabstimmungsauftrag anhalten

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

Anhalten eines Feinabstimmungsauftrags.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
fine_tuning_job_id	path	Ja	string	Die ID des zu unterbrechenden Feinabstimmungsauftrags.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.FineTuningJob

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Fortsetzen des Feinabstimmungsauftrags

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

Fortsetzen eines angehaltenen Feinabstimmungsauftrags.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
fine_tuning_job_id	path	Ja	string	Die ID des Feinabstimmungsauftrags, der fortgesetzt werden soll.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.FineTuningJob

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Erstellen einer Bildbearbeitung

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Typ: mehrteilige Formulardaten (multipart/form-data)

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Hintergrund	enum	Ermöglicht das Festlegen der Transparenz für den Hintergrund der generierten Bilder. Dieser Parameter wird nur für `gpt-image-1` Modelle unterstützt. Muss einer von `transparent`oder `opaqueauto` (Standardwert) sein. Wenn `auto` das Modell verwendet wird, bestimmt das Modell automatisch den besten Hintergrund für das Bild. Wenn `transparent`das Ausgabeformat Transparenz unterstützen muss, sollte es entweder auf `png` (Standardwert) oder `webp`festgelegt werden. Mögliche Werte: `transparent`, , `opaqueauto`	No
Bild	Zeichenfolge oder Matrix		Ja
mask	string		No
Modell	string	Die Modellbereitstellung, die für den Bildbearbeitungsvorgang verwendet werden soll.	Ja
n	Ganzzahl	Die Anzahl der zu generierenden Bilder. Muss zwischen 1 und 10 sein.	No	1
Ausgabekomprimierung	Ganzzahl	Die Komprimierungsebene (0-100%) für die generierten Bilder. Dieser Parameter wird nur für `gpt-image-1`-Serienmodelle mit den `webp` Formaten oder `jpeg` Ausgabeformaten unterstützt und ist standardmäßig auf 100 festgelegt.	No	100
Ausgabeformat	enum	Das Format, in dem die generierten Bilder zurückgegeben werden. Dieser Parameter wird nur für Modelle der `gpt-image-1`Serie unterstützt. Muss eine von `png`, `jpeg`, oder `webp`. Der Standardwert ist `png`. Mögliche Werte: `png`, , `jpegwebp`	No
Eingabeaufforderung	string	Eine Textbeschreibung der gewünschten Bilder. Die maximale Länge beträgt 1000 Zeichen für `dall-e-2`und 32000 Zeichen für `gpt-image-1`-Serienmodelle.	Ja
Qualität	enum	Die Qualität des Bilds, das generiert wird. `high`, `medium` und `low` werden nur für Modelle der `gpt-image-1`Serie unterstützt. `dall-e-2` unterstützt `standard` nur Qualität. Standardwert ist .`auto` Mögliche Werte: `standard`, , `lowmedium`, , `highauto`	No
Antwortformat	enum	Das Format, in dem die generierten Bilder zurückgegeben werden. Muss eine von `url` oder `b64_json`. URLs sind nur 60 Minuten lang gültig, nachdem das Bild generiert wurde. Dieser Parameter wird nur für `dall-e-2`"-series"-Modelle unterstützt, da `gpt-image-1`base64-codierte Bilder immer zurückgegeben werden. Mögliche Werte: `url`, `b64_json`	No
size	enum	Die Größe der generierten Bilder. Muss eines von `1024x1024`, `1536x1024` (Querformat), `1024x1536` (Hochformat) oder `auto` (Standardwert) für `gpt-image-1`-Serienmodelle und eines von `256x256`, `512x512`oder `1024x1024` für `dall-e-2`. Mögliche Werte: `256x256`, , `512x512`, `1024x10241536x1024`, , , `1024x1536auto`	No
user	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	No

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	AzureImagesResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Createimage

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Hintergrund	enum	Ermöglicht das Festlegen der Transparenz für den Hintergrund der generierten Bilder. Dieser Parameter wird nur für `gpt-image-1` Modelle unterstützt. Muss einer von `transparent`oder `opaqueauto` (Standardwert) sein. Wenn `auto` das Modell verwendet wird, bestimmt das Modell automatisch den besten Hintergrund für das Bild. Wenn `transparent`das Ausgabeformat Transparenz unterstützen muss, sollte es entweder auf `png` (Standardwert) oder `webp`festgelegt werden. Mögliche Werte: `transparent`, , `opaqueauto`	No
Modell	string	Die Modellbereitstellung, die für die Imagegenerierung verwendet werden soll.	Ja
Moderation	enum	Steuern Sie die Inhaltsmoderationsebene für Bilder, die von `gpt-image-1`-Serienmodellen generiert werden. Muss entweder `low` für weniger restriktive Filterung oder `auto` (Standardwert) sein. Mögliche Werte: `low`, `auto`	No
n	Ganzzahl	Die Anzahl der zu generierenden Bilder. Muss zwischen 1 und 10 sein. Nur für `dall-e-3`, `n=1` wird unterstützt.	No	1
Ausgabekomprimierung	Ganzzahl	Die Komprimierungsebene (0-100%) für die generierten Bilder. Dieser Parameter wird nur für `gpt-image-1`-Serienmodelle mit den `webp` Formaten oder `jpeg` Ausgabeformaten unterstützt und ist standardmäßig auf 100 festgelegt.	No	100
Ausgabeformat	enum	Das Format, in dem die generierten Bilder zurückgegeben werden. Dieser Parameter wird nur für Modelle der `gpt-image-1`Serie unterstützt. Muss eine von `png`, `jpeg`, oder `webp`. Mögliche Werte: `png`, , `jpegwebp`	No
Eingabeaufforderung	string	Eine Textbeschreibung der gewünschten Bilder. Die maximale Länge beträgt 32000 Zeichen für `gpt-image-1`-Serienmodelle, 1000 Zeichen für `dall-e-2` und 4000 Zeichen für `dall-e-3`.	Ja
Qualität	enum	Die Qualität des Bilds, das generiert wird. - `auto` (Standardwert) wählt automatisch die beste Qualität für das angegebene Modell aus. - `high`, `medium` und `low` werden für Modelle der `gpt-image-1`Serie unterstützt. - `hd` und `standard` werden für `dall-e-3`. - `standard` ist die einzige Option für `dall-e-2`. Mögliche Werte: `standard`, , `hd`, `lowmedium`, , , `highauto`	No
Antwortformat	enum	Das Format, in dem generierte Bilder mit `dall-e-2` und `dall-e-3` zurückgegeben werden. Muss eine von `url` oder `b64_json`. URLs sind nur 60 Minuten lang gültig, nachdem das Bild generiert wurde. Dieser Parameter wird für `gpt-image-1`Modelle der Serie nicht unterstützt, die immer base64-codierte Bilder zurückgeben. Mögliche Werte: `url`, `b64_json`	No
size	enum	Die Größe der generierten Bilder. Muss eine von `1024x1024`, (Querformat), `1536x1024` (Hochformat) oder `1024x1536` (Standardwert) für `auto`-Serienmodelle, eines von `gpt-image-1`, `256x256`, oder `512x512` für `1024x1024`, und eine von `dall-e-2`, `1024x1024`oder `1792x1024` für `1024x1792dall-e-3` . Mögliche Werte: `auto`, , `1024x1024`, `1536x10241024x1536`, `256x256`, , `512x512`, `1792x10241024x1792`	No
Stil	enum	Die Formatvorlage der generierten Bilder. Dieser Parameter wird nur für `dall-e-3`. Muss eine von `vivid` oder `natural`. Lebendig bewirkt, dass sich das Modell auf die Erzeugung hyper realer und dramatischer Bilder stützt. Natürlich erzeugt das Modell natürlichere, weniger hyper reale Bilder. Mögliche Werte: `vivid`, `natural`	No
user	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	No

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	AzureImagesResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Beispiele

Example

Erstellt Bilder mit einer Eingabeaufforderung.

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

Antworten: Statuscode: 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
          }
        }
      }
    ]
  }
}

Modelle auflisten

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

Listet die derzeit verfügbaren Modelle auf und enthält grundlegende Informationen zu jedem Modell, z. B. besitzer und Verfügbarkeit.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.ListModelsResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Modell abrufen

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

Ruft eine Modellinstanz ab und stellt grundlegende Informationen zum Modell bereit, z. B. den Besitzer und die Berechtigung.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
Modell	path	Ja	string	Die ID des Modells, das für diese Anforderung verwendet werden soll.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.Model

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Antwort erstellen

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

Erstellt eine Modellantwort.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Hintergrund	Boolescher Wert	Gibt an, ob die Modellantwort im Hintergrund ausgeführt werden soll.	No	Falsch
include	array	Geben Sie zusätzliche Ausgabedaten an, die in die Modellantwort eingeschlossen werden sollen. Derzeit unterstützte Werte sind: - `code_interpreter_call.outputs`: Enthält die Ausgaben der Python-Codeausführung in Codedolmetscher-Toolaufrufelemente. - `computer_call_output.output.image_url`: Schließen Sie Bild-URLs aus der Ausgabe des Computeraufrufs ein. - `file_search_call.results`: Schließen Sie die Suchergebnisse des Aufrufs des Dateisuchtools ein. - `message.input_image.image_url`: Fügen Sie Bild-URLs aus der Eingabenachricht ein. - `message.output_text.logprobs`: Fügen Sie Logprobs in Assistentennachrichten ein. - `reasoning.encrypted_content`: Enthält eine verschlüsselte Version von Begründungstoken bei der Ausgabe von Gründen für Elemente. Dies ermöglicht die Verwendung von Elementen in Multi-Turn-Unterhaltungen, wenn die Antwort-API zustandslos verwendet wird (z. B. wenn der `store` Parameter auf `false`" festgelegt ist" oder wenn eine Organisation im Aufbewahrungsprogramm für Nulldaten registriert ist).	No
input	Zeichenfolge oder Matrix		No
Anweisungen	string	Eine Systemnachricht (oder Entwicklernachricht), die in den Kontext des Modells eingefügt wurde. Bei Verwendung dieser `previous_response_id`Antwort werden die Anweisungen aus einer vorherigen Antwort nicht an die nächste Antwort übertragen. Dies erleichtert das Austauschen von Systemnachrichten (oder Entwicklernachrichten) in neuen Antworten.	No
max_output_tokens	Ganzzahl	Eine obere Grenze für die Anzahl der Token, die für eine Antwort generiert werden können, einschließlich sichtbarer Ausgabetoken und Begründungstoken	No
max_tool_calls	Ganzzahl	Die maximale Anzahl der Aufrufe an integrierte Tools, die in einer Antwort verarbeitet werden können. Diese maximale Anzahl gilt für alle integrierten Toolaufrufe, nicht pro einzelnes Tool. Alle weiteren Versuche, ein Tool durch das Modell aufzurufen, werden ignoriert.	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
Modell	string	Die Modellbereitstellung, die für die Erstellung dieser Antwort verwendet werden soll.	Ja
Parallele Werkzeugaufrufe	Boolescher Wert	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	No	Richtig
previous_response_id	string	Die eindeutige ID der vorherigen Antwort auf das Modell. Verwenden Sie diese Option, um Multi-Turn-Unterhaltungen zu erstellen.	No
Eingabeaufforderung	Objekt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	No
└– ID	string	Der eindeutige Bezeichner der zu verwendenden Eingabeaufforderungsvorlage.	No
└- Variablen	OpenAI.ResponsePromptVariables	Optionale Zuordnung von Werten, die durch Variablen in Ihrer Eingabeaufforderung ersetzt werden sollen. Die Ersetzungswerte können entweder Zeichenfolgen oder andere Antworteingabetypen wie Bilder oder Dateien sein.	No
└– Version	string	Optionale Version der Eingabeaufforderungsvorlage.	No
reasoning	Objekt	Nur o-Serienmodelle Konfigurationsoptionen für Begründungsmodelle.	No
└– Aufwand	OpenAI.ReasoningEffort	Nur o-Serienmodelle Beschränkt den Aufwand für die Begründung von Begründungsmodellen. Derzeit unterstützte Werte sind `low`, `medium`und `high`. Das Reduzieren von Gründen kann zu schnelleren Antworten und weniger Token führen, die bei der Begründung in einer Antwort verwendet werden.	No
└– generate_summary	enum	Veraltet: Verwenden Sie `summary` stattdessen. Eine Zusammenfassung der vom Modell durchgeführten Begründung. Dies kann hilfreich sein, um das Debuggen und Verstehen des Begründungsprozesses des Modells zu verstehen. Einer von `auto`, `concise`, oder `detailed`. Mögliche Werte: `auto`, , `concisedetailed`	No
└– Zusammenfassung	enum	Eine Zusammenfassung der vom Modell durchgeführten Begründung. Dies kann hilfreich sein, um das Debuggen und Verstehen des Begründungsprozesses des Modells zu verstehen. Einer von `auto`, `concise`, oder `detailed`. Mögliche Werte: `auto`, , `concisedetailed`	No
store	Boolescher Wert	Gibt an, ob die generierte Modellantwort für den späteren Abruf über die API gespeichert werden soll.	No	Richtig
stream	Boolescher Wert	Wenn dieser Wert auf "true" festgelegt ist, werden die Modellantwortdaten an den Client gestreamt, da sie mithilfe von Server gesendeten Ereignissen generiert wird.	No	Falsch
Temperatur	number	Welche Probenahmetemperatur verwendet werden soll, zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Es wird in der Regel empfohlen, dies oder `top_p` nicht beides zu ändern.	No	1
Text	Objekt	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann Nur-Text- oder strukturierte JSON-Daten sein.	No
└─ Format	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	Objekt	Steuert, welches Tool (falls vorhanden) vom Modell aufgerufen wird. `none` bedeutet, dass das Modell kein Tool aufruft und stattdessen eine Nachricht generiert. `auto` bedeutet, dass das Modell zwischen dem Generieren einer Nachricht oder dem Aufrufen eines oder mehrerer Tools auswählen kann. `required` bedeutet, dass das Modell mindestens ein Tools aufrufen muss.	No
└– Typ	OpenAI.ToolChoiceObjectType	Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll.	No
tools	array	Ein Array von Tools, die das Modell aufrufen kann, während eine Antwort generiert wird. Sie kann angeben, welches Tool verwendet werden soll, indem der `tool_choice` Parameter festgelegt wird. Die beiden Kategorien von Tools, die Sie bereitstellen können, sind: - Integrierte Tools: Tools, die von OpenAI bereitgestellt werden, die die Funktionen des Modells erweitern, z. B. die Dateisuche. - Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, sodass das Modell Ihren eigenen Code aufrufen kann.	No
top_logprobs	Ganzzahl	Eine ganze Zahl zwischen 0 und 20, die die Anzahl der höchstwahrscheinlichen Token an jeder Tokenposition angibt, jeweils mit einer zugeordneten Protokollwahrscheinlichkeit.	No
top_p	number	Eine Alternative zur Probenahme mit Temperatur, die als Kernsampling bezeichnet wird, wobei das Modell die Ergebnisse der Token mit top_p Wahrscheinlichkeitsmasse berücksichtigt. 0,1 bedeutet also, dass nur die Token, die die obersten 10% Wahrscheinlichkeitsmasse umfassen, berücksichtigt werden. Es wird in der Regel empfohlen, dies oder `temperature` nicht beides zu ändern.	No	1
truncation	enum	Die Abkürzungsstrategie, die für die Modellantwort verwendet werden soll. - `auto`: Wenn der Kontext dieser Antwort und früherer Antworten die Größe des Kontextfensters des Modells überschreitet, schneidet das Modell die Antwort ab, um das Kontextfenster anzupassen, indem Eingabeelemente in der Mitte der Unterhaltung gelöscht werden. - `disabled` (Standard): Wenn eine Modellantwort die Kontextfenstergröße für ein Modell überschreitet, schlägt die Anforderung mit einem Fehler von 400 fehl. Mögliche Werte: `auto`, `disabled`	No
user	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	No

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	AzureResponse
text/event-stream	OpenAI.ResponseStreamEvent

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Beispiele

Example

Erstellen einer Modellantwort

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

Antwort abrufen

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

Ruft eine Modellantwort mit der angegebenen ID ab.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
response_id	path	Ja	string
include[]	Anfrage	No	array

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	AzureResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Antwort löschen

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

Löscht eine Antwort nach ID.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
response_id	path	Ja	string

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	Objekt

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Listeneingabeelemente

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

Gibt eine Liste der Eingabeelemente für eine bestimmte Antwort zurück.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
response_id	path	Ja	string
Begrenzung	Anfrage	No	Ganzzahl	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen, und der Standardwert ist 20.
order	Anfrage	No	string Mögliche Werte: `asc`, `desc`	Sortierreihenfolge nach dem `created_at` Zeitstempel der Objekte. `asc` für aufsteigende Reihenfolge und`desc` absteigende Reihenfolge.
Nach	Anfrage	No	string	Ein Cursor für die Verwendung in der Paginierung. `after` ist eine Objekt-ID, die Ihren Platz in der Liste definiert. Wenn Sie z. B. eine Listenanforderung stellen und 100 Objekte empfangen und mit obj_foo enden, kann Der nachfolgende Aufruf after=obj_foo enthalten, um die nächste Seite der Liste abzurufen.
before	Anfrage	No	string	Ein Cursor für die Verwendung in der Paginierung. `before` ist eine Objekt-ID, die Ihren Platz in der Liste definiert. Wenn Sie z. B. eine Listenanforderung stellen und 100 Objekte empfangen, die mit obj_foo enden, kann Ihr nachfolgender Aufruf before=obj_foo enthalten, um die vorherige Seite der Liste abzurufen.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.ResponseItemList

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Auflisten von Vektorspeichern

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

Gibt eine Liste von Vektorspeichern zurück.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
Begrenzung	Anfrage	No	Ganzzahl	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen, und der Standardwert ist 20.
order	Anfrage	No	string Mögliche Werte: `asc`, `desc`	Sortierreihenfolge nach dem `created_at` Zeitstempel der Objekte. `asc` für aufsteigende Reihenfolge und`desc` absteigende Reihenfolge.
Nach	Anfrage	No	string	Ein Cursor für die Verwendung in der Paginierung. `after` ist eine Objekt-ID, die Ihren Platz in der Liste definiert. Wenn Sie z. B. eine Listenanforderung stellen und 100 Objekte empfangen und mit obj_foo enden, kann Der nachfolgende Aufruf after=obj_foo enthalten, um die nächste Seite der Liste abzurufen.
before	Anfrage	No	string	Ein Cursor für die Verwendung in der Paginierung. `before` ist eine Objekt-ID, die Ihren Platz in der Liste definiert. Wenn Sie z. B. eine Listenanforderung stellen und 100 Objekte empfangen, die mit obj_foo enden, kann Ihr nachfolgender Aufruf before=obj_foo enthalten, um die vorherige Seite der Liste abzurufen.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.ListVectorStoresResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Erstellen eines Vektorspeichers

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

Erstellt einen Vektorspeicher.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich
chunking_strategy	Objekt	Die Standardstrategie. Diese Strategie verwendet derzeit eine `max_chunk_size_tokens` von `800` und `chunk_overlap_tokens` von `400`.	No
└– statisch	OpenAI.StaticChunkingStrategy		No
└– Typ	enum	Immer `static`. Mögliche Werte: `static`	No
expires_after	OpenAI.VectorStoreExpirationAfter	Die Ablaufrichtlinie für einen Vektorspeicher.	No
Datei-IDs	array	Eine Liste der Datei-IDs, die der Vektorspeicher verwenden soll. Nützlich für Tools wie `file_search` den Zugriff auf Dateien.	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
Name	string	Der Name des Vektorspeichers.	No

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.VectorStoreObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Beispiele

Beispieldatei nicht gefunden: ./examples/vector_stores.json

Vektorspeicher abrufen

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

Ruft einen Vektorspeicher ab.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
vector_store_id	path	Ja	string	Die ID des abzurufenden Vektorspeichers.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.VectorStoreObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Ändern des Vektorspeichers

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

Ändert einen Vektorspeicher.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
vector_store_id	path	Ja	string	Die ID des zu ändernden Vektorspeichers.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich
expires_after	Objekt	Die Ablaufrichtlinie für einen Vektorspeicher.	No
└– Anker	enum	Ankerzeitstempel, nach dem die Ablaufrichtlinie angewendet wird. Unterstützte Anker: `last_active_at`. Mögliche Werte: `last_active_at`	No
└– Tage	Ganzzahl	Die Anzahl der Tage nach ablaufen der Verankerungszeit des Vektorspeichers.	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
Name	string	Der Name des Vektorspeichers.	No

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.VectorStoreObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Vektorspeicher löschen

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

Löschen eines Vektorspeichers.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
vector_store_id	path	Ja	string	Die ID des zu löschenden Vektorspeichers.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.DeleteVectorStoreResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Erstellen eines Vektorspeicherdateibatches

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

Erstellen Sie einen Vektorspeicherdateibatch.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
vector_store_id	path	Ja	string	Die ID des Vektorspeichers, für den ein Dateibatch erstellt werden soll.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich
attributes	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen, Booleanen oder Zahlen.	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Die Blockierungsstrategie, die verwendet wird, um die Datei(n) zu blöcken. Wenn sie nicht festgelegt ist, wird die `auto` Strategie verwendet.	No
Datei-IDs	array	Eine Liste der Datei-IDs, die der Vektorspeicher verwenden soll. Nützlich für Tools wie `file_search` den Zugriff auf Dateien.	Ja

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.VectorStoreFileBatchObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Abrufen eines Vektorspeicherdateibatches

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

Ruft einen Vektorspeicherdateibatch ab.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
vector_store_id	path	Ja	string	Die ID des Vektorspeichers, zu dem der Dateibatch gehört.
batch_id	path	Ja	string	Die ID des abgerufenen Dateibatches.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.VectorStoreFileBatchObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Abbrechen des Vektorspeicherdateibatches

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

Abbrechen eines Vektorspeicherdateibatches. Dadurch wird versucht, die Verarbeitung von Dateien in diesem Batch so schnell wie möglich abzubrechen.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
vector_store_id	path	Ja	string	Die ID des Vektorspeichers, zu dem der Dateibatch gehört.
batch_id	path	Ja	string	Die ID des zu abbrechenden Dateibatches.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.VectorStoreFileBatchObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Auflisten von Dateien im Vektorspeicherbatch

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

Gibt eine Liste der Vektorspeicherdateien in einem Batch zurück.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
vector_store_id	path	Ja	string	Die ID des Vektorspeichers, zu dem der Dateibatch gehört.
batch_id	path	Ja	string	Die ID des Dateibatches, zu dem die Dateien gehören.
Begrenzung	Anfrage	No	Ganzzahl	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen, und der Standardwert ist 20.
order	Anfrage	No	string Mögliche Werte: `asc`, `desc`	Sortierreihenfolge nach dem `created_at` Zeitstempel der Objekte. `asc` für aufsteigende Reihenfolge und`desc` absteigende Reihenfolge.
Nach	Anfrage	No	string	Ein Cursor für die Verwendung in der Paginierung. `after` ist eine Objekt-ID, die Ihren Platz in der Liste definiert. Wenn Sie z. B. eine Listenanforderung stellen und 100 Objekte empfangen und mit obj_foo enden, kann Der nachfolgende Aufruf after=obj_foo enthalten, um die nächste Seite der Liste abzurufen.
before	Anfrage	No	string	Ein Cursor für die Verwendung in der Paginierung. `before` ist eine Objekt-ID, die Ihren Platz in der Liste definiert. Wenn Sie z. B. eine Listenanforderung stellen und 100 Objekte empfangen, die mit obj_foo enden, kann Ihr nachfolgender Aufruf before=obj_foo enthalten, um die vorherige Seite der Liste abzurufen.
filter	Anfrage	No		Filtern nach Dateistatus. Einer von `in_progress`, `completed`, `failed`, `cancelled`.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.ListVectorStoreFilesResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Auflisten von Vektorspeicherdateien

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

Gibt eine Liste von Vektorspeicherdateien zurück.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
vector_store_id	path	Ja	string	Die ID des Vektorspeichers, zu dem die Dateien gehören.
Begrenzung	Anfrage	No	Ganzzahl	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen, und der Standardwert ist 20.
order	Anfrage	No	string Mögliche Werte: `asc`, `desc`	Sortierreihenfolge nach dem `created_at` Zeitstempel der Objekte. `asc` für aufsteigende Reihenfolge und`desc` absteigende Reihenfolge.
Nach	Anfrage	No	string	Ein Cursor für die Verwendung in der Paginierung. `after` ist eine Objekt-ID, die Ihren Platz in der Liste definiert. Wenn Sie z. B. eine Listenanforderung stellen und 100 Objekte empfangen und mit obj_foo enden, kann Der nachfolgende Aufruf after=obj_foo enthalten, um die nächste Seite der Liste abzurufen.
before	Anfrage	No	string	Ein Cursor für die Verwendung in der Paginierung. `before` ist eine Objekt-ID, die Ihren Platz in der Liste definiert. Wenn Sie z. B. eine Listenanforderung stellen und 100 Objekte empfangen, die mit obj_foo enden, kann Ihr nachfolgender Aufruf before=obj_foo enthalten, um die vorherige Seite der Liste abzurufen.
filter	Anfrage	No		Filtern nach Dateistatus. Einer von `in_progress`, `completed`, `failed`, `cancelled`.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.ListVectorStoreFilesResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Erstellen einer Vektorspeicherdatei

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

Erstellen Sie eine Vektorspeicherdatei, indem Sie eine Datei an einen Vektorspeicher anfügen.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
vector_store_id	path	Ja	string	Die ID des Vektorspeichers, für den eine Datei erstellt werden soll.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich
attributes	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen, Booleanen oder Zahlen.	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Die Blockierungsstrategie, die verwendet wird, um die Datei(n) zu blöcken. Wenn sie nicht festgelegt ist, wird die `auto` Strategie verwendet.	No
Datei-ID	string	Eine Datei-ID, die der Vektorspeicher verwenden soll. Nützlich für Tools wie `file_search` den Zugriff auf Dateien.	Ja

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.VectorStoreFileObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Abrufen einer Vektorspeicherdatei

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

Ruft eine Vektorspeicherdatei ab.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
vector_store_id	path	Ja	string	Die ID des Vektorspeichers, zu dem die Datei gehört.
Datei-ID	path	Ja	string	Die ID der abgerufenen Datei.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.VectorStoreFileObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Aktualisieren von Vektorspeicherdateiattributen

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
vector_store_id	path	Ja	string
Datei-ID	path	Ja	string

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich	Vorgabe
attributes	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen, Booleanen oder Zahlen.	Ja

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.VectorStoreFileObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Vektorspeicherdatei löschen

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

Löschen Sie eine Vektorspeicherdatei. Dadurch wird die Datei aus dem Vektorspeicher entfernt, die Datei selbst wird jedoch nicht gelöscht. Verwenden Sie zum Löschen der Datei den Löschdateiendpunkt.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
vector_store_id	path	Ja	string	Die ID des Vektorspeichers, zu dem die Datei gehört.
Datei-ID	path	Ja	string	Die ID der zu löschenden Datei.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	OpenAI.DeleteVectorStoreFileResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureErrorResponse

Videogenerierungsaufträge – Erstellen

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

Erstellt einen neuen Auftrag zur Videogenerierung.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Anforderungstext

Content-Type: application/json

Name	Typ	Beschreibung	Erforderlich	Vorgabe
height	Ganzzahl	Die Höhe des Videos. Die folgenden Dimensionen werden unterstützt: 480x480, 854x480, 720x720, 1280x720, 1080x1080 und 1920x1080 sowohl im Quer- als auch im Hochformat.	Ja
Modell	string	Der Name der Bereitstellung, die für diese Anforderung verwendet werden soll.	Ja
n_seconds	Ganzzahl	Die Dauer des Auftrags zur Videogenerierung. Muss zwischen 1 und 20 Sekunden betragen.	No	5
n_variants	Ganzzahl	Die Anzahl der Videos, die als Varianten für diesen Auftrag erstellt werden sollen. Muss zwischen 1 und 5 sein. Kleinere Abmessungen ermöglichen mehr Varianten.	No	1
Eingabeaufforderung	string	Die Aufforderung für diesen Auftrag zur Videogenerierung.	Ja
width	Ganzzahl	Die Breite des Videos. Die folgenden Dimensionen werden unterstützt: 480x480, 854x480, 720x720, 1280x720, 1080x1080 und 1920x1080 sowohl im Quer- als auch im Hochformat.	Ja

Anforderungstext

Content-Typ: mehrteilige Formulardaten (multipart/form-data)

Name	Typ	Beschreibung	Erforderlich	Vorgabe
files	array		Ja
height	Ganzzahl	Die Höhe des Videos. Die folgenden Dimensionen werden unterstützt: 480x480, 854x480, 720x720, 1280x720, 1080x1080 und 1920x1080 sowohl im Quer- als auch im Hochformat.	Ja
inpaint_items	array	Optionale Inpaintingelemente für diesen Videogenerierungsauftrag.	No
Modell	string	Der Name der Bereitstellung, die für diese Anforderung verwendet werden soll.	Ja
n_seconds	Ganzzahl	Die Dauer des Auftrags zur Videogenerierung. Muss zwischen 1 und 20 Sekunden betragen.	No	5
n_variants	Ganzzahl	Die Anzahl der Videos, die als Varianten für diesen Auftrag erstellt werden sollen. Muss zwischen 1 und 5 sein. Kleinere Abmessungen ermöglichen mehr Varianten.	No	1
Eingabeaufforderung	string	Die Aufforderung für diesen Auftrag zur Videogenerierung.	Ja
width	Ganzzahl	Die Breite des Videos. Die folgenden Dimensionen werden unterstützt: 480x480, 854x480, 720x720, 1280x720, 1080x1080 und 1920x1080 sowohl im Quer- als auch im Hochformat.	Ja

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	VideoGenerationJob

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureOpenAIVideoGenerationErrorResponse

Beispiele

Beispieldatei nicht gefunden: ./examples/create_video_generation_job_simple.json

Videogenerierungsaufträge – Liste

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

Listet Videogenerierungsaufträge auf.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
before	Anfrage	No	string
Nach	Anfrage	No	string
Begrenzung	Anfrage	Ja	Ganzzahl
statuses	Anfrage	No	array

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	VideoGenerationJobList

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureOpenAIVideoGenerationErrorResponse

Beispiele

Beispieldatei nicht gefunden: ./examples/get_video_generation_job_list.json

Videogenerierungsaufträge – Abrufen

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

Ruft die Eigenschaften eines Auftrags zur Videogenerierung ab.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
job-id	path	Ja	string	Die ID des Videogenerierungsauftrags, der für die Azure OpenAI-Anforderung verwendet werden soll.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	VideoGenerationJob

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureOpenAIVideoGenerationErrorResponse

Beispiele

Beispieldatei nicht gefunden: ./examples/get_video_generation_job.json

Aufträge zur Videogenerierung – Löschen

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

Löscht einen Auftrag zur Videogenerierung.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
job-id	path	Ja	string	Die ID des Videogenerierungsauftrags, der für die Azure OpenAI-Anforderung verwendet werden soll.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 204

Beschreibung: Es gibt keinen Inhalt, der für diese Anforderung gesendet werden soll, aber die Kopfzeilen können nützlich sein.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureOpenAIVideoGenerationErrorResponse

Videogenerationen – Abrufen

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

Ruft eine Videogenerierung nach ID ab.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
generation-id	path	Ja	string	Die ID der Videogenerierung, die für die Azure OpenAI-Anforderung verwendet werden soll.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
application/json	VideoGeneration

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureOpenAIVideoGenerationErrorResponse

Beispiele

Beispieldatei nicht gefunden: ./examples/get_video_generation.json

Videogenerationen – Miniaturansicht abrufen

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

Ruft eine Miniaturansicht des generierten Videoinhalts ab.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
generation-id	path	Ja	string	Die ID der Videogenerierung, die für die Azure OpenAI-Anforderung verwendet werden soll.

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Bild/jpg	string

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureOpenAIVideoGenerationErrorResponse

Videogenerationen – Abrufen von Videoinhalten

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

Ruft den generierten Videoinhalt ab.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
generation-id	path	Ja	string	Die ID der Videogenerierung, die für die Azure OpenAI-Anforderung verwendet werden soll.
Qualität	Anfrage	No

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Video/mp4	string

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureOpenAIVideoGenerationErrorResponse

Videogenerationen – Nur Videoinhaltsheader abrufen

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

Ruft Kopfzeilen für den generierten Videoinhalt ab.

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	Ja	string url	Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: `https://aoairesource.openai.azure.com`. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Ressourcennamen). https://{your-resource-name}.openai.azure.com
API-Version	Anfrage	No		Die explizite VERSION der Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.
generation-id	path	Ja	string	Die ID der Videogenerierung, die für die Azure OpenAI-Anforderung verwendet werden soll.
Qualität	Anfrage	No

Anfrage-Kopf

Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Die Authentifizierung mit tokenbasierter Authentifizierung wird empfohlen und sicherer.

Name	Erforderlich	Typ	Beschreibung
Autorisierung	Richtig	string	Beispiel:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Zu generieren Sie ein Authentifizierungstoken mithilfe von Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Typ: oauth2 Autorisierungs-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Umfang: `https://ai.azure.com/.default`
API-Schlüssel	Richtig	string	Bereitstellen Azure OpenAI-API-Schlüssels hier

Antworten

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
application/json	AzureOpenAIVideoGenerationErrorResponse

Komponenten

AudioTaskLabel

Definiert die möglichen Deskriptoren für verfügbare Audiovorgangsantworten.

Eigentum	Wert
Beschreibung	Definiert die möglichen Deskriptoren für verfügbare Audiovorgangsantworten.
Typ	string
Werte	`transcribe` `translate`

AudioTranslationSegment

Erweiterte Informationen zu einem einzelnen Segment übersetzter Audiodaten. Segmente stellen in der Regel ungefähr 5-10 Sekunden Sprache dar. Segmentgrenzen treten in der Regel zwischen Wörtern, aber nicht unbedingt Sätzen auf.

Name	Typ	Beschreibung	Erforderlich
avg_logprob	number	Die durchschnittliche Protokollwahrscheinlichkeit, die diesem Audiosegment zugeordnet ist.	Ja
Kompressionsverhältnis	number	Das Komprimierungsverhältnis dieses Audiosegments.	Ja
end	number	Die Zeit, zu der dieses Segment relativ zum Anfang der übersetzten Audiodaten endete.	Ja
id	Ganzzahl	Der 0-basierte Index dieses Segments innerhalb einer Übersetzung.	Ja
no_speech_prob	number	Die Wahrscheinlichkeit, dass innerhalb dieses Audiosegments keine Spracherkennung erkannt wird.	Ja
seek	Ganzzahl	Die Suchposition, die der Verarbeitung dieses Audiosegments zugeordnet ist. Suchpositionen werden als Hundertstel Sekunden ausgedrückt. Das Modell kann mehrere Segmente von einer einzelnen Suchposition verarbeiten, während die Suchposition nie später als der Anfang des Segments dargestellt wird, kann der Anfang des Segments einen erheblich späteren Zeitpunkt als die zugeordnete Suchposition des Segments darstellen.	Ja
start	number	Die Zeit, zu der dieses Segment relativ zum Anfang der übersetzten Audiodaten begonnen hat.	Ja
Temperatur	number	Die diesem Audiosegment zugeordnete Temperaturbewertung.	Ja
Text	string	Der übersetzte Text, der Teil dieses Audiosegments war.	Ja
tokens	array	Die Token-IDs, die dem übersetzten Text in diesem Audiosegment entsprechen.	Ja

AzureAIFoundryModelsApiVersion

Eigentum	Wert
Typ	string
Werte	`v1` `preview`

AzureAudioTranscriptionResponse

Ergebnisinformationen für einen Vorgang, der gesprochene Audio in geschriebenen Text transkribiert hat.

Name	Typ	Beschreibung	Erforderlich
Dauer	number	Die Gesamtdauer der verarbeiteten Audiodaten, um begleitende Transkriptionsinformationen zu erzeugen.	No
language	string	Die gesprochene Sprache, die in den transkribierten Audiodaten erkannt wurde. Dies wird als zweiseitiger ISO-639-1-Sprachcode wie "en" oder "fr" ausgedrückt.	No
Segmente	array	Eine Sammlung von Informationen über das Timing, die Wahrscheinlichkeit und andere Details der einzelnen verarbeiteten Audiosegmente.	No
Aufgabe	Objekt	Definiert die möglichen Deskriptoren für verfügbare Audiovorgangsantworten.	No
Text	string	Der transkribierte Text für die bereitgestellten Audiodaten.	Ja
words	array	Eine Sammlung von Informationen über die Anzeigedauer jedes verarbeiteten Worts.	No

AzureAudioTranslationResponse

Ergebnisinformationen für einen Vorgang, der gesprochene Audio in geschriebenen Text übersetzt hat.

Name	Typ	Beschreibung	Erforderlich
Dauer	number	Die Gesamtdauer der verarbeiteten Audiodaten, um begleitende Übersetzungsinformationen zu erzeugen.	No
language	string	Die gesprochene Sprache, die in den übersetzten Audiodaten erkannt wurde. Dies wird als zweiseitiger ISO-639-1-Sprachcode wie "en" oder "fr" ausgedrückt.	No
Segmente	array	Eine Sammlung von Informationen über das Timing, die Wahrscheinlichkeit und andere Details der einzelnen verarbeiteten Audiosegmente.	No
Aufgabe	Objekt	Definiert die möglichen Deskriptoren für verfügbare Audiovorgangsantworten.	No
Text	string	Der übersetzte Text für die bereitgestellten Audiodaten.	Ja

AzureChatCompletionResponseMessage

Die Komponente des erweiterten Antwortmodells für Chatabschlussantwortnachrichten im Azure OpenAI-Dienst. Dieses Modell bietet Unterstützung für den Kontext von Chatnachrichten, die vom Feature "On Your Data" für Absichten, Zitate und andere Informationen im Zusammenhang mit der ausgeführten Generierung von Abruferweiterungen verwendet werden.

Name	Typ	Beschreibung	Erforderlich
annotations	array	Anmerkungen für die Nachricht, falls zutreffend, wie bei Verwendung des Websuchtools.	No
Audio	Objekt	Wenn die Audioausgabemodalitäten angefordert werden, enthält dieses Objekt Daten zur Audioantwort des Modells.	No
└– Daten	string	Base64-codierte Audiobytes, die vom Modell generiert wurden, im in der Anforderung angegebenen Format.	No
└– abläuft_am	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) für den Fall, dass diese Audioantwort nicht mehr auf dem Server zur Verwendung in Multi-Turn-Unterhaltungen zugänglich ist.	No
└– ID	string	Eindeutiger Bezeichner für diese Audioantwort.	No
└– Transkript	string	Transkription der vom Modell generierten Audiodaten.	No
Inhalt	string	Der Inhalt der Nachricht.	Ja
context	Objekt	Eine zusätzliche Eigenschaft, die chat-Abschlussantwortnachrichten hinzugefügt wurde, die vom Azure OpenAI-Dienst bei Verwendung des Erweiterungsverhaltens erstellt werden. Dazu gehören Absichts- und Zitatinformationen aus dem Feature "On Your Data".	No
└– alle_abgerufenen_Dokumente	Objekt	Zusammenfassungsinformationen zu Dokumenten, die vom Datenempfangsvorgang abgerufen werden.	No
└– chunk_id	string	Die Block-ID für das Zitat.	No
└– Inhalt	string	Der Inhalt des Zitats.	No
└– Datenquellenindex	Ganzzahl	Der Index der Datenquelle, die für den Abruf verwendet wird.	No
└– Dateipfad	string	Der Dateipfad für das Zitat.	No
└– filter_begründung	enum	Falls zutreffend, geben Sie an, warum das Dokument gefiltert wurde. Mögliche Werte: `score`, `rerank`	No
└− original_search_score	number	Die ursprüngliche Suchbewertung für den Abruf.	No
└– rerank_score	number	Der Rerank-Score für den Abruf.	No
└– Suchanfragen	array	Die Zum Abrufen von Dokumenten ausgeführten Suchabfragen.	No
└– Titel	string	Der Titel für das Zitat.	No
└– URL	string	Die URL des Zitats.	No
└- Zitate	array	Die Zitate, die vom Datenabruf erzeugt werden.	No
└– Absicht	string	Die erkannte Absicht aus dem Chatverlauf, der verwendet wird, um den Unterhaltungskontext zwischen Interaktionen zu tragen	No
function_call	Objekt	Veraltet und ersetzt durch `tool_calls`. Der Name und die Argumente einer Funktion, die aufgerufen werden soll, wie vom Modell generiert.	No
└- Argumente	string		No
└– Name	string		No
reasoning_content	string	Eine Azure spezifische Erweiterungseigenschaft, die generierten Grundinhalt aus unterstützten Modellen enthält.	No
Weigerung	string	Die vom Modell generierte Ablehnungsmeldung.	Ja
Rolle	enum	Die Rolle des Autors dieser Nachricht. Mögliche Werte: `assistant`	Ja
tool_calls	ChatCompletionMessageToolCallsItem	Das Tool ruft vom Modell generierte Aufrufe auf, z. B. Funktionsaufrufe.	No

AzureChatCompletionStreamResponseDelta

Das erweiterte Antwortmodell für eine Streaming-Chatantwortnachricht im Azure OpenAI-Dienst. Dieses Modell bietet Unterstützung für den Kontext von Chatnachrichten, die vom Feature "On Your Data" für Absichten, Zitate und andere Informationen im Zusammenhang mit der ausgeführten Generierung von Abruferweiterungen verwendet werden.

Name	Typ	Beschreibung	Erforderlich
Audio	Objekt		No
└– Daten	string		No
└– abläuft_am	Ganzzahl		No
└– ID	string		No
└– Transkript	string		No
Inhalt	string	Der Inhalt der Blocknachricht.	No
context	Objekt	Eine zusätzliche Eigenschaft, die chat-Abschlussantwortnachrichten hinzugefügt wurde, die vom Azure OpenAI-Dienst bei Verwendung des Erweiterungsverhaltens erstellt werden. Dazu gehören Absichts- und Zitatinformationen aus dem Feature "On Your Data".	No
└– alle_abgerufenen_Dokumente	Objekt	Zusammenfassungsinformationen zu Dokumenten, die vom Datenempfangsvorgang abgerufen werden.	No
└– chunk_id	string	Die Block-ID für das Zitat.	No
└– Inhalt	string	Der Inhalt des Zitats.	No
└– Datenquellenindex	Ganzzahl	Der Index der Datenquelle, die für den Abruf verwendet wird.	No
└– Dateipfad	string	Der Dateipfad für das Zitat.	No
└– filter_begründung	enum	Falls zutreffend, geben Sie an, warum das Dokument gefiltert wurde. Mögliche Werte: `score`, `rerank`	No
└− original_search_score	number	Die ursprüngliche Suchbewertung für den Abruf.	No
└– rerank_score	number	Der Rerank-Score für den Abruf.	No
└– Suchanfragen	array	Die Zum Abrufen von Dokumenten ausgeführten Suchabfragen.	No
└– Titel	string	Der Titel für das Zitat.	No
└– URL	string	Die URL des Zitats.	No
└- Zitate	array	Die Zitate, die vom Datenabruf erzeugt werden.	No
└– Absicht	string	Die erkannte Absicht aus dem Chatverlauf, der verwendet wird, um den Unterhaltungskontext zwischen Interaktionen zu tragen	No
function_call	Objekt	Veraltet und ersetzt durch `tool_calls`. Der Name und die Argumente einer Funktion, die aufgerufen werden soll, wie vom Modell generiert.	No
└- Argumente	string		No
└– Name	string		No
reasoning_content	string	Eine Azure spezifische Erweiterungseigenschaft, die generierten Grundinhalt aus unterstützten Modellen enthält.	No
Weigerung	string	Die vom Modell generierte Ablehnungsmeldung.	No
Rolle	Objekt	Die Rolle des Autors einer Nachricht	No
tool_calls	array		No

AzureChatDataSource

Eine Darstellung von Konfigurationsdaten für eine einzelne Azure OpenAI-Chatdatenquelle. Dies wird von einer Chatabschlussanfrage verwendet, die Azure OpenAI-Chaterweiterungen verwenden soll, um das Antwortverhalten zu erweitern. Die Verwendung dieser Konfiguration ist nur mit Azure OpenAI kompatibel.

Diskriminator für AzureChatDataSource

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`azure_search`	AzureSearchChatDataSource
`azure_cosmos_db`	AzureCosmosDBChatDataSource
`elasticsearch`	ElasticsearchChatDataSource
`pinecone`	PineconeChatDataSource
`mongo_db`	MongoDBChatDataSource

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	Objekt		Ja

AzureChatDataSourceAccessTokenAuthenticationOptions

Name	Typ	Beschreibung	Erforderlich	Vorgabe
access_token	string		Ja
type	enum	Mögliche Werte: `access_token`	Ja

AzureChatDataSourceApiKeyAuthenticationOptions

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Schlüssel	string		Ja
type	enum	Mögliche Werte: `api_key`	Ja

AzureChatDataSourceAuthenticationOptions

Diskriminator für AzureChatDataSourceAuthenticationOptions

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	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	Typ	Beschreibung	Erforderlich	Vorgabe
type	AzureChatDataSourceAuthenticationOptionsType		Ja

AzureChatDataSourceAuthenticationOptionsType

Eigentum	Wert
Typ	string
Werte	`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	Typ	Beschreibung	Erforderlich	Vorgabe
connection_string	string		Ja
type	enum	Mögliche Werte: `connection_string`	Ja

AzureChatDataSourceDeploymentNameVectorizationSource

Stellt eine Vektorisierungsquelle dar, die interne Dienstaufrufe für eine Azure OpenAI-Einbettungsmodellbereitstellung ausführt. Im Gegensatz zur endpunktbasierten Vektorisierungsquelle muss eine bereitstellungsnamebasierte Vektorisierungsquelle Teil derselben Azure OpenAI-Ressource sein, kann aber auch in privaten Netzwerken verwendet werden.

Name	Typ	Beschreibung	Erforderlich
deployment_name	string	Die Bereitstellung des Einbettungsmodells, die für die Vektorisierung verwendet werden soll. Diese Bereitstellung muss innerhalb derselben Azure OpenAI-Ressource vorhanden sein wie die Modellbereitstellung, die für Chatabschlusse verwendet wird.	Ja
Abmessungen	Ganzzahl	Die Anzahl der Dimensionen, die bei Einbettungen angefordert werden sollen. Wird nur in "text-embedding-3" und späteren Modellen unterstützt.	No
type	enum	Der Typbezeichner, immer "deployment_name" für diesen Vektorisierungsquelltyp. Mögliche Werte: `deployment_name`	Ja

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

Name	Typ	Beschreibung	Erforderlich	Vorgabe
encoded_api_key	string		Ja
type	enum	Mögliche Werte: `encoded_api_key`	Ja

AzureChatDataSourceEndpointVectorizationSource

Stellt eine Vektorisierungsquelle dar, die öffentliche Dienstaufrufe für eine Azure OpenAI-Einbettungsmodellbereitstellung ausführt.

Name	Typ	Beschreibung	Erforderlich
authentication	Objekt		Ja
└─ Zugriffstoken	string		No
└– Schlüssel	string		No
└– Typ	enum	Mögliche Werte: `access_token`	No
Abmessungen	Ganzzahl	Die Anzahl der Dimensionen, die bei Einbettungen angefordert werden sollen. Wird nur in "text-embedding-3" und späteren Modellen unterstützt.	No
endpoint	string	Gibt die Ressourcenendpunkt-URL an, aus der Einbettungen abgerufen werden sollen. Er sollte im Format von: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Der Abfrageparameter der API-Version ist nicht zulässig.	Ja
type	enum	Der Typbezeichner, immer "Endpunkt" für diesen Vektorisierungsquelltyp. Mögliche Werte: `endpoint`	Ja

AzureChatDataSourceIntegratedVectorizationSource

Stellt eine integrierte Vektorisierungsquelle dar, die in der unterstützenden Suchressource definiert ist.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Der Typbezeichner, immer "integriert" für diesen Vektorisierungsquelltyp. Mögliche Werte: `integrated`	Ja

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Name	Typ	Beschreibung	Erforderlich
Schlüssel	string		Ja
key_id	string		Ja
type	enum	Mögliche Werte: `key_and_key_id`	Ja

AzureChatDataSourceModelIdVectorizationSource

Stellt eine Vektorisierungsquelle dar, die Dienstaufrufe basierend auf einer Suchdienstmodell-ID vorgibt. Dieser Quelltyp wird derzeit nur von Elasticsearch unterstützt.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
model_id	string	Die Einbettungsmodell-Build-ID, die für die Vektorisierung verwendet werden soll.	Ja
type	enum	Der Typbezeichner, immer "model_id" für diesen Vektorisierungsquelltyp. Mögliche Werte: `model_id`	Ja

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Mögliche Werte: `system_assigned_managed_identity`	Ja

AzureChatDataSourceType

Eigentum	Wert
Typ	string
Werte	`azure_search` `azure_cosmos_db` `elasticsearch` `pinecone` `mongo_db`

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

Name	Typ	Beschreibung	Erforderlich	Vorgabe
managed_identity_resource_id	string		Ja
type	enum	Mögliche Werte: `user_assigned_managed_identity`	Ja

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Name	Typ	Beschreibung	Erforderlich
Passwort	string		Ja
type	enum	Mögliche Werte: `username_and_password`	Ja
username	string		Ja

AzureChatDataSourceVectorizationSource

Eine Darstellung einer Datenvektorisierungsquelle, die als Einbettungsressource mit einer Datenquelle verwendet werden kann.

Diskriminator für AzureChatDataSourceVectorizationSource

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`deployment_name`	AzureChatDataSourceDeploymentNameVectorizationSource
`integrated`	AzureChatDataSourceIntegratedVectorizationSource
`model_id`	AzureChatDataSourceModelIdVectorizationSource

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	Objekt		Ja

AzureChatDataSourceVectorizationSourceType

Eigentum	Wert
Typ	string
Werte	`endpoint` `deployment_name` `model_id` `integrated`

AzureChatMessageContext

Eine zusätzliche Eigenschaft, die chat-Abschlussantwortnachrichten hinzugefügt wurde, die vom Azure OpenAI-Dienst bei Verwendung des Erweiterungsverhaltens erstellt werden. Dazu gehören Absichts- und Zitatinformationen aus dem Feature "On Your Data".

Name	Typ	Beschreibung	Erforderlich
all_retrieved_documents	Objekt	Zusammenfassungsinformationen zu Dokumenten, die vom Datenempfangsvorgang abgerufen werden.	No
└– chunk_id	string	Die Block-ID für das Zitat.	No
└– Inhalt	string	Der Inhalt des Zitats.	No
└– Datenquellenindex	Ganzzahl	Der Index der Datenquelle, die für den Abruf verwendet wird.	No
└– Dateipfad	string	Der Dateipfad für das Zitat.	No
└– filter_begründung	enum	Falls zutreffend, geben Sie an, warum das Dokument gefiltert wurde. Mögliche Werte: `score`, `rerank`	No
└− original_search_score	number	Die ursprüngliche Suchbewertung für den Abruf.	No
└– rerank_score	number	Der Rerank-Score für den Abruf.	No
└– Suchanfragen	array	Die Zum Abrufen von Dokumenten ausgeführten Suchabfragen.	No
└– Titel	string	Der Titel für das Zitat.	No
└– URL	string	Die URL des Zitats.	No
Zitationen	array	Die Zitate, die vom Datenabruf erzeugt werden.	No
Absicht	string	Die erkannte Absicht aus dem Chatverlauf, der verwendet wird, um den Unterhaltungskontext zwischen Interaktionen zu tragen	No

AzureContentFilterBlocklistResult

Eine Sammlung von True/False-Filterergebnissen für konfigurierte benutzerdefinierte Blocklisten.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Details	array	Die Paare einzelner Blocklisten-IDs und ob sie zu einer Filteraktion geführt haben.	No
gefiltert	Boolescher Wert	Ein Wert, der angibt, ob eine der detaillierten Blocklisten zu einer Filteraktion führte.	Ja

AzureContentFilterCompletionTextSpan

Eine Darstellung einer Spanne von Abschlusstext, wie von Azure OpenAI-Inhaltsfilterergebnissen verwendet.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
completion_end_offset	Ganzzahl	Offset des ersten UTF32-Codepunkts, der von der Spanne ausgeschlossen ist. Dieses Feld ist immer gleich completion_start_offset für leere Spannen. Dieses Feld ist für nicht leere Spannen immer größer als completion_start_offset.	Ja
completion_start_offset	Ganzzahl	Offset des UTF32-Codepunkts, der die Spanne beginnt.	Ja

AzureContentFilterCompletionTextSpanDetectionResult

Name	Typ	Beschreibung	Erforderlich
Details	array	Detaillierte Informationen zu den erkannten Abschlusstextabschnitten.	Ja
erkannt	Boolescher Wert	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	Ja
gefiltert	Boolescher Wert	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	Ja

AzureContentFilterCustomTopicResult

Eine Sammlung von True/False-Filterergebnissen für konfigurierte benutzerdefinierte Themen.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Details	array	Die Paare einzelner Themen-IDs und ob sie erkannt werden.	No
gefiltert	Boolescher Wert	Ein Wert, der angibt, ob eines der detaillierten Themen zu einer Filteraktion geführt hat.	Ja

AzureContentFilterDetectionResult

Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt erkannt wurde und ob der Inhalt gefiltert wurde.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
erkannt	Boolescher Wert	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	Ja
gefiltert	Boolescher Wert	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	Ja

AzureContentFilterImagePromptResults

Ein Inhaltsfilterergebnis für den Eingabeanforderungsinhalt eines Bildgenerierungsvorgangs.

Name	Typ	Beschreibung	Erforderlich
custom_blocklists	Objekt	Eine Sammlung von True/False-Filterergebnissen für konfigurierte benutzerdefinierte Blocklisten.	No
└– Einzelheiten	array	Die Paare einzelner Blocklisten-IDs und ob sie zu einer Filteraktion geführt haben.	No
└- gefiltert	Boolescher Wert	Ein Wert, der angibt, ob eine der detaillierten Blocklisten zu einer Filteraktion führte.	No
custom_topics	Objekt	Eine Sammlung von True/False-Filterergebnissen für konfigurierte benutzerdefinierte Themen.	No
└– Einzelheiten	array	Die Paare einzelner Themen-IDs und ob sie erkannt werden.	No
└- gefiltert	Boolescher Wert	Ein Wert, der angibt, ob eines der detaillierten Themen zu einer Filteraktion geführt hat.	No
Jailbreak	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt erkannt wurde und ob der Inhalt gefiltert wurde.	Ja
└– erkannt	Boolescher Wert	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	No
Profanität	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt erkannt wurde und ob der Inhalt gefiltert wurde.	No
└– erkannt	Boolescher Wert	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	No

AzureContentFilterImageResponseResults

Ein Inhaltsfilterergebnis für den Ausgabeantwortinhalt eines Bildgenerierungsvorgangs.

Name	Typ	Beschreibung	Erforderlich
hate	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt gefiltert wurde und was der qualitative Schweregrad des Inhalts war, wie für die Inhaltsfilterkonfiguration für die Kategorie ausgewertet wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	No
└– Schweregrad	enum	Der schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	No
Selbstverletzung	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt gefiltert wurde und was der qualitative Schweregrad des Inhalts war, wie für die Inhaltsfilterkonfiguration für die Kategorie ausgewertet wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	No
└– Schweregrad	enum	Der schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	No
Sexuelle	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt gefiltert wurde und was der qualitative Schweregrad des Inhalts war, wie für die Inhaltsfilterkonfiguration für die Kategorie ausgewertet wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	No
└– Schweregrad	enum	Der schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	No
Gewalt	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt gefiltert wurde und was der qualitative Schweregrad des Inhalts war, wie für die Inhaltsfilterkonfiguration für die Kategorie ausgewertet wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	No
└– Schweregrad	enum	Der schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	No

AzureContentFilterResultForChoice

Ein Inhaltsfilterergebnis für ein einzelnes Antwortelement, das von einem generativen KI-System erzeugt wird.

Name	Typ	Beschreibung	Erforderlich
custom_blocklists	Objekt	Eine Sammlung von True/False-Filterergebnissen für konfigurierte benutzerdefinierte Blocklisten.	No
└– Einzelheiten	array	Die Paare einzelner Blocklisten-IDs und ob sie zu einer Filteraktion geführt haben.	No
└- gefiltert	Boolescher Wert	Ein Wert, der angibt, ob eine der detaillierten Blocklisten zu einer Filteraktion führte.	No
custom_topics	Objekt	Eine Sammlung von True/False-Filterergebnissen für konfigurierte benutzerdefinierte Themen.	No
└– Einzelheiten	array	Die Paare einzelner Themen-IDs und ob sie erkannt werden.	No
└- gefiltert	Boolescher Wert	Ein Wert, der angibt, ob eines der detaillierten Themen zu einer Filteraktion geführt hat.	No
Fehler	Objekt	Wenn vorhanden, details zu einem Fehler, der verhinderte, dass die Inhaltsfilterung ihre Auswertung abgeschlossen hat.	No
└– Code	Ganzzahl	Ein eindeutiger, maschinenlesbarer Code, der dem Fehler zugeordnet ist.	No
└– Nachricht	string	Eine lesbare Nachricht, die dem Fehler zugeordnet ist.	No
hate	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt gefiltert wurde und was der qualitative Schweregrad des Inhalts war, wie für die Inhaltsfilterkonfiguration für die Kategorie ausgewertet wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	No
└– Schweregrad	enum	Der schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	No
Profanität	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt erkannt wurde und ob der Inhalt gefiltert wurde.	No
└– erkannt	Boolescher Wert	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	No
protected_material_code	Objekt	Ein Erkennungsergebnis, das eine Übereinstimmung mit lizenziertem Code oder einem anderen geschützten Quellmaterial beschreibt.	No
└- Zitat	Objekt	Falls verfügbar, beschreiben die Zitatdetails die zugeordnete Lizenz und den zugehörigen Standort.	No
└– URL	string	Die mit der Lizenz verknüpfte URL.	No
└– Lizenz	string	Der Name oder die ID der Lizenz, die der Erkennung zugeordnet ist.	No
└– erkannt	Boolescher Wert	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	No
protected_material_text	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt erkannt wurde und ob der Inhalt gefiltert wurde.	No
└– erkannt	Boolescher Wert	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	No
Selbstverletzung	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt gefiltert wurde und was der qualitative Schweregrad des Inhalts war, wie für die Inhaltsfilterkonfiguration für die Kategorie ausgewertet wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	No
└– Schweregrad	enum	Der schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	No
Sexuelle	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt gefiltert wurde und was der qualitative Schweregrad des Inhalts war, wie für die Inhaltsfilterkonfiguration für die Kategorie ausgewertet wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	No
└– Schweregrad	enum	Der schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	No
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
Gewalt	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt gefiltert wurde und was der qualitative Schweregrad des Inhalts war, wie für die Inhaltsfilterkonfiguration für die Kategorie ausgewertet wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	No
└– Schweregrad	enum	Der schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	No

AzureContentFilterResultForPrompt

Ein Inhaltsfilterergebnis, das einem einzelnen Eingabeaufforderungselement in einem generativen KI-System zugeordnet ist.

Name	Typ	Beschreibung	Erforderlich
Content-Filtern-Egebnisse	Objekt	Die Inhaltsfilterkategoriedetails für das Ergebnis.	No
└– benutzerdefinierte Sperrlisten	Objekt	Eine Sammlung von True/False-Filterergebnissen für konfigurierte benutzerdefinierte Blocklisten.	No
└– Einzelheiten	array	Die Paare einzelner Blocklisten-IDs und ob sie zu einer Filteraktion geführt haben.	No
└- gefiltert	Boolescher Wert	Ein Wert, der angibt, ob eine der detaillierten Blocklisten zu einer Filteraktion führte.	No
└– custom_topics	Objekt	Eine Sammlung von True/False-Filterergebnissen für konfigurierte benutzerdefinierte Themen.	No
└– Einzelheiten	array	Die Paare einzelner Themen-IDs und ob sie erkannt werden.	No
└- gefiltert	Boolescher Wert	Ein Wert, der angibt, ob eines der detaillierten Themen zu einer Filteraktion geführt hat.	No
└– Fehler	Objekt	Wenn vorhanden, details zu einem Fehler, der verhinderte, dass die Inhaltsfilterung ihre Auswertung abgeschlossen hat.	No
└– Code	Ganzzahl	Ein eindeutiger, maschinenlesbarer Code, der dem Fehler zugeordnet ist.	No
└– Nachricht	string	Eine lesbare Nachricht, die dem Fehler zugeordnet ist.	No
└– Hass	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt gefiltert wurde und was der qualitative Schweregrad des Inhalts war, wie für die Inhaltsfilterkonfiguration für die Kategorie ausgewertet wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	No
└– Schweregrad	enum	Der schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	No
└– indirekter_Angriff	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt erkannt wurde und ob der Inhalt gefiltert wurde.	No
└– erkannt	Boolescher Wert	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	No
└– Entsperrung	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt erkannt wurde und ob der Inhalt gefiltert wurde.	No
└– erkannt	Boolescher Wert	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	No
└– Profanität	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt erkannt wurde und ob der Inhalt gefiltert wurde.	No
└– erkannt	Boolescher Wert	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	No
└– Selbstverletzung	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt gefiltert wurde und was der qualitative Schweregrad des Inhalts war, wie für die Inhaltsfilterkonfiguration für die Kategorie ausgewertet wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	No
└– Schweregrad	enum	Der schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	No
└─ sexuell	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt gefiltert wurde und was der qualitative Schweregrad des Inhalts war, wie für die Inhaltsfilterkonfiguration für die Kategorie ausgewertet wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	No
└– Schweregrad	enum	Der schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	No
└– Gewalt	Objekt	Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt gefiltert wurde und was der qualitative Schweregrad des Inhalts war, wie für die Inhaltsfilterkonfiguration für die Kategorie ausgewertet wurde.	No
└- gefiltert	Boolescher Wert	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	No
└– Schweregrad	enum	Der schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	No
prompt_index	Ganzzahl	Der Index der Eingabeaufforderung, die den zugehörigen Inhaltsfilterergebniskategorien zugeordnet ist.	No

AzureContentFilterSeverityResult

Ein beschriftetes Inhaltsfilterergebniselement, das angibt, ob der Inhalt gefiltert wurde und was der qualitative Schweregrad des Inhalts war, wie für die Inhaltsfilterkonfiguration für die Kategorie ausgewertet wurde.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
gefiltert	Boolescher Wert	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	Ja
severity	enum	Der schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	Ja

AzureCosmosDBChatDataSource

Stellt eine Datenquellenkonfiguration dar, die eine Azure CosmosDB-Ressource verwendet.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
parameters	Objekt	Die Parameterinformationen zum Steuern der Verwendung der Azure CosmosDB-Datenquelle.	Ja
└– erlaube_unvollständiges_Ergebnis	Boolescher Wert	Wenn dieser Wert auf "true" festgelegt ist, lässt das System die Verwendung von Teilsuchergebnissen zu, und die Anforderung schlägt fehl, wenn alle Teilabfragen fehlschlagen. Wenn sie nicht als "false" angegeben oder angegeben wurde, schlägt die Anforderung fehl, wenn eine Suchabfrage fehlschlägt.	No	Falsch
└– Authentifizierung	AzureChatDataSourceConnectionStringAuthenticationOptions		No
└– container_name	string		No
└– database_name	string		No
└– embedding_dependency	AzureChatDataSourceVectorizationSource	Eine Darstellung einer Datenvektorisierungsquelle, die als Einbettungsressource mit einer Datenquelle verwendet werden kann.	No
└– fields_mapping	Objekt		No
└– content_fields	array		No
└─ Inhalt_Feldtrenner	string		No
└– filepath_field	string		No
└– Titel_Feld	string		No
└– url_field	string		No
└─ Vektorfelder	array		No
└– in_scope	Boolescher Wert	Gibt an, ob Abfragen auf die Verwendung der indizierten Daten beschränkt werden sollen.	No
└– Kontexte_einschließen	array	Die Ausgabekontexteigenschaften, die in die Antwort eingeschlossen werden sollen. Standardmäßig werden Zitate und Absichten angefordert.	No	['Zitate', 'Absicht']
└– index_name	string		No
└– max_search_queries	Ganzzahl	Die maximale Anzahl neu geschriebener Abfragen, die für eine einzelne Benutzernachricht an den Suchanbieter gesendet werden sollen. Standardmäßig führt das System eine automatische Bestimmung durch.	No
└– Striktheit	Ganzzahl	Die konfigurierte Strenge der Suchrelevanzfilterung. Höhere Strenge erhöht die Genauigkeit, aber ein geringerer Rückruf der Antwort.	No
└– top_n_documents	Ganzzahl	Die konfigurierte Anzahl der Dokumente, die in der Abfrage bereitgestellt werden sollen.	No
type	enum	Der diskriminierte Typbezeichner, der immer "azure_cosmos_db" ist. Mögliche Werte: `azure_cosmos_db`	Ja

AzureCreateChatCompletionRequest

Das erweiterte Anforderungsmodell für Chatabschlusse mit dem Azure OpenAI-Dienst. Dadurch wird die Möglichkeit hinzugefügt, Datenquellen für das Feature "On Your Data" bereitzustellen.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Audio	Objekt	Parameter für die Audioausgabe. Erforderlich, wenn die Audioausgabe mit `modalities: ["audio"]`.	No
└─ Format	enum	Gibt das Ausgabeaudioformat an. Muss eine von , , , , `wav`oder `mp3`. `flacopuspcm16` Mögliche Werte: `wav`, , `aac`, `mp3flac`, , , `opuspcm16`	No
└– Stimme	Objekt		No
data_sources	array	Die Datenquellen, die für das Feature "On Your Data" verwendet werden sollen, ausschließlich für Azure OpenAI.	No
frequency_penalty	number	Zahl zwischen -2,0 und 2,0. Positive Werte bestrafen neue Token basierend auf ihrer vorhandenen Häufigkeit im Text bisher und verringern die Wahrscheinlichkeit, dass das Modell dieselbe Zeile wiederholt.	No	0
function_call	enum	Durch Angeben einer bestimmten Funktion wird `{"name": "my_function"}` das Modell gezwungen, diese Funktion aufzurufen. Mögliche Werte: `none`, `auto`	No
functions	array	Veraltet zugunsten von `tools`. Eine Liste der Funktionen, für die das Modell JSON-Eingaben generieren kann.	No
Logit-Bias	Objekt	Ändern Sie die Wahrscheinlichkeit, dass angegebene Token im Abschluss angezeigt werden. Akzeptiert ein JSON-Objekt, das Token (angegeben durch ihre Token-ID im Tokenizer) einem zugeordneten Bias-Wert von -100 bis 100 zuordnet. Mathematisch wird der vom Modell generierten Logits vor dem Sampling die Verzerrung hinzugefügt. Der genaue Effekt variiert je Modell, aber Werte zwischen -1 und 1 sollten die Wahrscheinlichkeit der Auswahl verringern oder erhöhen; Werte wie -100 oder 100 sollten zu einem Verbot oder einer exklusiven Auswahl des relevanten Tokens führen.	No	Nichts
logprobs	Boolescher Wert	Gibt an, ob Protokollwahrscheinlichkeiten der Ausgabetoken zurückgegeben werden sollen. Wenn wahr, gibt die Protokollwahrscheinlichkeit jedes Ausgabetokens zurück, das in der `content` von `message`.	No	Falsch
max_completion_tokens	Ganzzahl	Eine obere Grenze für die Anzahl der Token, die für einen Abschluss generiert werden können, einschließlich sichtbarer Ausgabetoken und Begründungstoken.	No
maximale_Anzahl_von_Tokens	Ganzzahl	Die maximale Anzahl von Token, die im Chatabschluss generiert werden können. Dieser Wert kann verwendet werden, um die Kosten für Text zu steuern, der über die API generiert wird. Dieser Wert ist jetzt zugunsten von `max_completion_tokens`" veraltet" und ist nicht mit o1-Serienmodellen kompatibel.	No
Nachrichten	array	Eine Liste der Nachrichten, die bisher aus der Unterhaltung bestehen. Abhängig vom verwendeten Modell werden verschiedene Nachrichtentypen (Modalitäten) unterstützt, z. B. Text, Bilder und Audio.	Ja
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
modalities	Objekt	Ausgabetypen, die vom Modell generiert werden sollen. Die meisten Modelle sind in der Lage, Text zu generieren. Dies ist die Standardeinstellung: `["text"]` Das `gpt-4o-audio-preview` Modell kann auch zum Generieren von Audio verwendet werden. Um anzufordern, dass dieses Modell sowohl Text- als auch Audioantworten generiert, können Sie Folgendes verwenden: `["text", "audio"]`	No
Modell	string	Der Modellbereitstellungsbezeichner, der für die Chatabschlussanforderung verwendet werden soll.	Ja
n	Ganzzahl	Wie viele Chatabschlussoptionen für jede Eingabenachricht generiert werden sollen. Beachten Sie, dass Sie basierend auf der Anzahl der generierten Token für alle Auswahlmöglichkeiten in Rechnung gestellt werden. Halten Sie sich `n` an die `1` Minimierung der Kosten.	No	1
Parallele Werkzeugaufrufe	Objekt	Gibt an, ob beim Verwenden des Tools parallele Funktionsaufrufe aktiviert werden sollen.	No
prediction	Objekt	Basisdarstellung der vorhergesagten Ausgabe eines Modells.	No
└– Typ	OpenAI.ChatOutputPredictionType		No
presence_penalty	number	Zahl zwischen -2,0 und 2,0. Positive Werte bestrafen neue Token basierend darauf, ob sie bisher im Text angezeigt werden, wodurch die Wahrscheinlichkeit erhöht wird, dass sie über neue Themen sprechen.	No	0
Denkanstrengung	Objekt	Nur o-Serienmodelle Beschränkt den Aufwand für die Begründung von Begründungsmodellen. Derzeit unterstützte Werte sind `low`, `medium`und `high`. Das Reduzieren von Gründen kann zu schnelleren Antworten und weniger Token führen, die bei der Begründung in einer Antwort verwendet werden.	No
Antwortformat	Objekt		No
└– Typ	enum	Mögliche Werte: `text`, , `json_objectjson_schema`	No
seed	Ganzzahl	Dieses Feature befindet sich in der Betaversion. Wenn angegeben, wird unser System eine optimale Leistung unternehmen, um deterministisch zu proben, sodass wiederholte Anforderungen mit demselben `seed` Und Parameter dasselbe Ergebnis zurückgeben sollten. Der Determinismus ist nicht garantiert, und Sie sollten auf den `system_fingerprint` Antwortparameter verweisen, um Änderungen im Back-End zu überwachen.	No
Stopp	Objekt	Nicht unterstützt mit den neuesten Begründungsmodellen `o3` und `o4-mini`. Bis zu 4 Sequenzen, bei denen die API keine weiteren Token mehr generiert. Der zurückgegebene Text enthält nicht die Stoppsequenz.	No
store	Boolescher Wert	Gibt an, ob die Ausgabe dieser Chatabschlussanforderung für die Verwendung in der Modelldestillation oder evalsierten Produkten gespeichert werden soll.	No	Falsch
stream	Boolescher Wert	Wenn dieser Wert auf "true" festgelegt ist, werden die Modellantwortdaten an den Client gestreamt, da sie mithilfe von Server gesendeten Ereignissen generiert wird.	No	Falsch
stream_options	Objekt	Optionen für die Streamingantwort. Legen Sie dies nur fest, wenn Sie festlegen `stream: true`.	No
└– include_usage	Boolescher Wert	Bei Festlegung wird ein zusätzlicher Block vor der `data: [DONE]` Nachricht gestreamt. Das `usage` Feld in diesem Abschnitt zeigt die Tokenverwendungsstatistiken für die gesamte Anforderung an, und das `choices` Feld ist immer ein leeres Array. Alle anderen Blöcke enthalten auch ein `usage` Feld, aber mit einem Nullwert. HINWEIS: Wenn der Datenstrom unterbrochen wird, erhalten Sie möglicherweise nicht den endgültigen Verwendungsabschnitt, der die gesamte Tokenverwendung für die Anforderung enthält.	No
Temperatur	number	Welche Probenahmetemperatur verwendet werden soll, zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Es wird in der Regel empfohlen, dies oder `top_p` nicht beides zu ändern.	No	1
tool_choice	OpenAI.ChatCompletionToolChoiceOption	Steuert, welches Tool (falls vorhanden) vom Modell aufgerufen wird. `none` bedeutet, dass das Modell kein Tool aufruft und stattdessen eine Nachricht generiert. `auto` bedeutet, dass das Modell zwischen dem Generieren einer Nachricht oder dem Aufrufen eines oder mehrerer Tools auswählen kann. `required` bedeutet, dass das Modell mindestens ein Tools aufrufen muss. Wenn Sie ein bestimmtes Tool über `{"type": "function", "function": {"name": "my_function"}}` das Modell angeben, wird das Modell gezwungen, dieses Tool aufzurufen. `none` ist die Standardeinstellung, wenn keine Tools vorhanden sind. `auto` ist die Standardeinstellung, wenn Tools vorhanden sind.	No
tools	array	Eine Liste der Tools, die das Modell aufrufen kann. Derzeit werden nur Funktionen als Tool unterstützt. Verwenden Sie diese Funktion, um eine Liste der Funktionen bereitzustellen, für die das Modell MÖGLICHERWEISE JSON-Eingaben generiert. Maximal 128 Funktionen werden unterstützt.	No
top_logprobs	Ganzzahl	Eine ganze Zahl zwischen 0 und 20, die die Anzahl der höchstwahrscheinlichen Token an jeder Tokenposition angibt, jeweils mit einer zugeordneten Protokollwahrscheinlichkeit.	No
top_p	number	Eine Alternative zur Probenahme mit Temperatur, die als Kernsampling bezeichnet wird, wobei das Modell die Ergebnisse der Token mit top_p Wahrscheinlichkeitsmasse berücksichtigt. 0,1 bedeutet also, dass nur die Token, die die obersten 10% Wahrscheinlichkeitsmasse umfassen, berücksichtigt werden. Es wird in der Regel empfohlen, dies oder `temperature` nicht beides zu ändern.	No	1
user	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der dazu beitragen kann, Missbrauch zu überwachen und zu erkennen.	No
user_security_context	AzureUserSecurityContext	Der Benutzersicherheitskontext enthält mehrere Parameter, die die Anwendung selbst beschreiben, und den Endbenutzer, der mit der Anwendung interagiert. Diese Felder unterstützen Ihre Sicherheitsteams, Sicherheitsvorfälle zu untersuchen und zu mindern, indem sie einen umfassenden Ansatz zum Schutz Ihrer KI-Anwendungen bieten. Learn more zum Schutz von KI-Anwendungen mit Microsoft Defender for Cloud.	No

AzureCreateChatCompletionResponse

Das erweiterte Antwortmodell für den Abschluss von Chats auf oberster Ebene für den Azure OpenAI-Dienst. Dieses Modell fügt Anmerkungen zum Verantwortlichen KI-Inhaltsfilter für die Eingabeaufforderung hinzu.This model adds Responsible AI content filter annotations for prompt input.

Name	Typ	Beschreibung	Erforderlich
Optionen	array		Ja
erstellt	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung des Chatabschlusses.	Ja
id	string	Ein eindeutiger Bezeichner für den Chatabschluss.	Ja
Modell	string	Das Modell, das für den Chatabschluss verwendet wird.	Ja
Objekt	enum	Der Objekttyp, der immer `chat.completion`ist. Mögliche Werte: `chat.completion`	Ja
prompt_filter_results	array	Die Anmerkungen zum Verantwortlichen KI-Inhaltsfilter, die mit Aufforderungseingaben in Chatabschlussen verknüpft sind.	No
Systemfingerabdruck	string	Dieser Fingerabdruck stellt die Back-End-Konfiguration dar, mit der das Modell ausgeführt wird. Kann in Verbindung mit dem Anforderungsparameter `seed` verwendet werden, um zu verstehen, wann Back-End-Änderungen vorgenommen wurden, die sich auf determinismus auswirken können.	No
Nutzung	OpenAI.CompletionUsage	Nutzungsstatistiken für die Abschlussanforderung.	No

AzureCreateChatCompletionStreamResponse

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Optionen	array	Eine Liste der Auswahlmöglichkeiten für den Chatabschluss. Kann mehr als ein Element enthalten, wenn `n` größer als 1 ist. Kann auch für den letzten Block leer sein, wenn Sie festlegen `stream_options: {"include_usage": true}`.	Ja
Content-Filtern-Egebnisse	AzureContentFilterResultForChoice	Ein Inhaltsfilterergebnis für ein einzelnes Antwortelement, das von einem generativen KI-System erzeugt wird.	No
erstellt	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung des Chatabschlusses. Jeder Block hat den gleichen Zeitstempel.	Ja
delta	AzureChatCompletionStreamResponseDelta	Das erweiterte Antwortmodell für eine Streaming-Chatantwortnachricht im Azure OpenAI-Dienst. Dieses Modell bietet Unterstützung für den Kontext von Chatnachrichten, die vom Feature "On Your Data" für Absichten, Zitate und andere Informationen im Zusammenhang mit der ausgeführten Generierung von Abruferweiterungen verwendet werden.	No
id	string	Ein eindeutiger Bezeichner für den Chatabschluss. Jeder Block weist die gleiche ID auf.	Ja
Modell	string	Das Modell, das den Abschluss generiert.	Ja
Objekt	enum	Der Objekttyp, der immer `chat.completion.chunk`ist. Mögliche Werte: `chat.completion.chunk`	Ja
Systemfingerabdruck	string	Dieser Fingerabdruck stellt die Back-End-Konfiguration dar, mit der das Modell ausgeführt wird. Kann in Verbindung mit dem Anforderungsparameter `seed` verwendet werden, um zu verstehen, wann Back-End-Änderungen vorgenommen wurden, die sich auf determinismus auswirken können.	No
Nutzung	Objekt	Nutzungsstatistiken für die Abschlussanforderung.	No
└– completion_tokens	Ganzzahl	Anzahl der Token im generierten Abschluss.	No	0
└– completion_tokens_details	Objekt	Aufschlüsselung der in einem Abschluss verwendeten Token.	No
└– akzeptierte_Vorhersage_Token	Ganzzahl	Bei Verwendung von "Vorhergesagte Ausgaben" gibt es die Anzahl der Token in der Vorhersage, die im Abschluss angezeigt wurde.	No	0
└– audio_tokens	Ganzzahl	Vom Modell generierte Audioeingabetoken.	No	0
└– reasoning_tokens	Ganzzahl	Vom Modell generierte Token zur Begründung.	No	0
└– rejected_prediction_tokens	Ganzzahl	Bei Verwendung von vorhergesagten Ausgaben wird die Anzahl der Token in der Vorhersage, die nicht im Abschluss angezeigt wurden. Wie aus Gründen versehene Token werden diese Token jedoch weiterhin in den Gesamtabschlusstoken für Abrechnungs-, Ausgabe- und Kontextfensterbeschränkungen gezählt.	No	0
└– prompt_tokens	Ganzzahl	Anzahl der Token in der Eingabeaufforderung.	No	0
└- prompt_tokens_details	Objekt	Aufschlüsselung der in der Eingabeaufforderung verwendeten Token.	No
└– audio_tokens	Ganzzahl	Audioeingabetoken, die in der Eingabeaufforderung vorhanden sind.	No	0
└– zwischengespeicherte_Token	Ganzzahl	Zwischengespeicherte Token, die in der Eingabeaufforderung vorhanden sind.	No	0
└– total_tokens	Ganzzahl	Die Gesamtzahl der in der Anforderung verwendeten Token (Aufforderung + Abschluss).	No	0

AzureCreateEmbeddingRequest

Name	Typ	Beschreibung	Erforderlich
Abmessungen	Ganzzahl	Die Anzahl der Dimensionen, die die resultierenden Ausgabeeinbettungen aufweisen sollen. Nur in `text-embedding-3` und späteren Modellen unterstützt.	No
encoding_format	enum	Das Format, in das die Einbettungen zurückgegeben werden sollen. Kann entweder `float` oder `base64`. Mögliche Werte: `float`, `base64`	No
input	Zeichenfolge oder Matrix		Ja
Modell	string	Das Modell, das für die Einbettungsanforderung verwendet werden soll.	Ja
user	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	No

AzureCreateFileRequestMultiPart

Name	Typ	Beschreibung	Erforderlich
expires_after	Objekt		Ja
└– Anker	AzureFileExpiryAnchor		No
└─ Sekunden	Ganzzahl		No
Datei	string		Ja
Zweck	enum	Der beabsichtigte Zweck der hochgeladenen Datei. Einer von: - `assistants`: Wird in der Assistenten-API `batch`verwendet - : Wird in der Batch-API verwendet - `fine-tune`: Wird zur Feinabstimmung verwendet - `evals`: Wird für eval-Datasets verwendet. Mögliche Werte: `assistants`, , `batch`, `fine-tuneevals`	Ja

AzureCreateImageEditRequestMultiPart

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Hintergrund	enum	Ermöglicht das Festlegen der Transparenz für den Hintergrund der generierten Bilder. Dieser Parameter wird nur für `gpt-image-1` Modelle unterstützt. Muss einer von `transparent`oder `opaqueauto` (Standardwert) sein. Wenn `auto` das Modell verwendet wird, bestimmt das Modell automatisch den besten Hintergrund für das Bild. Wenn `transparent`das Ausgabeformat Transparenz unterstützen muss, sollte es entweder auf `png` (Standardwert) oder `webp`festgelegt werden. Mögliche Werte: `transparent`, , `opaqueauto`	No
Bild	Zeichenfolge oder Matrix		Ja
mask	string		No
Modell	string	Die Modellbereitstellung, die für den Bildbearbeitungsvorgang verwendet werden soll.	Ja
n	Ganzzahl	Die Anzahl der zu generierenden Bilder. Muss zwischen 1 und 10 sein.	No	1
Ausgabekomprimierung	Ganzzahl	Die Komprimierungsebene (0-100%) für die generierten Bilder. Dieser Parameter wird nur für `gpt-image-1`-Serienmodelle mit den `webp` Formaten oder `jpeg` Ausgabeformaten unterstützt und ist standardmäßig auf 100 festgelegt.	No	100
Ausgabeformat	enum	Das Format, in dem die generierten Bilder zurückgegeben werden. Dieser Parameter wird nur für Modelle der `gpt-image-1`Serie unterstützt. Muss eine von `png`, `jpeg`, oder `webp`. Der Standardwert ist `png`. Mögliche Werte: `png`, , `jpegwebp`	No
Eingabeaufforderung	string	Eine Textbeschreibung der gewünschten Bilder. Die maximale Länge beträgt 1000 Zeichen für `dall-e-2`und 32000 Zeichen für `gpt-image-1`-Serienmodelle.	Ja
Qualität	enum	Die Qualität des Bilds, das generiert wird. `high`, `medium` und `low` werden nur für Modelle der `gpt-image-1`Serie unterstützt. `dall-e-2` unterstützt `standard` nur Qualität. Standardwert ist .`auto` Mögliche Werte: `standard`, , `lowmedium`, , `highauto`	No
Antwortformat	enum	Das Format, in dem die generierten Bilder zurückgegeben werden. Muss eine von `url` oder `b64_json`. URLs sind nur 60 Minuten lang gültig, nachdem das Bild generiert wurde. Dieser Parameter wird nur für `dall-e-2`"-series"-Modelle unterstützt, da `gpt-image-1`base64-codierte Bilder immer zurückgegeben werden. Mögliche Werte: `url`, `b64_json`	No
size	enum	Die Größe der generierten Bilder. Muss eines von `1024x1024`, `1536x1024` (Querformat), `1024x1536` (Hochformat) oder `auto` (Standardwert) für `gpt-image-1`-Serienmodelle und eines von `256x256`, `512x512`oder `1024x1024` für `dall-e-2`. Mögliche Werte: `256x256`, , `512x512`, `1024x10241536x1024`, , , `1024x1536auto`	No
user	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	No

AzureCreateImageRequest

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Hintergrund	enum	Ermöglicht das Festlegen der Transparenz für den Hintergrund der generierten Bilder. Dieser Parameter wird nur für `gpt-image-1` Modelle unterstützt. Muss einer von `transparent`oder `opaqueauto` (Standardwert) sein. Wenn `auto` das Modell verwendet wird, bestimmt das Modell automatisch den besten Hintergrund für das Bild. Wenn `transparent`das Ausgabeformat Transparenz unterstützen muss, sollte es entweder auf `png` (Standardwert) oder `webp`festgelegt werden. Mögliche Werte: `transparent`, , `opaqueauto`	No
Modell	string	Die Modellbereitstellung, die für die Imagegenerierung verwendet werden soll.	Ja
Moderation	enum	Steuern Sie die Inhaltsmoderationsebene für Bilder, die von `gpt-image-1`-Serienmodellen generiert werden. Muss entweder `low` für weniger restriktive Filterung oder `auto` (Standardwert) sein. Mögliche Werte: `low`, `auto`	No
n	Ganzzahl	Die Anzahl der zu generierenden Bilder. Muss zwischen 1 und 10 sein. Nur für `dall-e-3`, `n=1` wird unterstützt.	No	1
Ausgabekomprimierung	Ganzzahl	Die Komprimierungsebene (0-100%) für die generierten Bilder. Dieser Parameter wird nur für `gpt-image-1`-Serienmodelle mit den `webp` Formaten oder `jpeg` Ausgabeformaten unterstützt und ist standardmäßig auf 100 festgelegt.	No	100
Ausgabeformat	enum	Das Format, in dem die generierten Bilder zurückgegeben werden. Dieser Parameter wird nur für Modelle der `gpt-image-1`Serie unterstützt. Muss eine von `png`, `jpeg`, oder `webp`. Mögliche Werte: `png`, , `jpegwebp`	No
Eingabeaufforderung	string	Eine Textbeschreibung der gewünschten Bilder.	Ja
Qualität	enum	Die Qualität des Bilds, das generiert wird. - `auto` (Standardwert) wählt automatisch die beste Qualität für das angegebene Modell aus. - `high`, `medium` und `low` werden für Modelle der `gpt-image-1`Serie unterstützt. - `hd` und `standard` werden für `dall-e-3`. - `standard` ist die einzige Option für `dall-e-2`. Mögliche Werte: `standard`, , `hd`, `lowmedium`, , , `highauto`	No
Antwortformat	enum	Das Format, in dem generierte Bilder mit `dall-e-2` und `dall-e-3` zurückgegeben werden. Muss eine von `url` oder `b64_json`. URLs sind nur 60 Minuten lang gültig, nachdem das Bild generiert wurde. Dieser Parameter wird für `gpt-image-1`Modelle der Serie nicht unterstützt, die immer base64-codierte Bilder zurückgeben. Mögliche Werte: `url`, `b64_json`	No
size	enum	Die Größe der generierten Bilder. Muss eine von `1024x1024`, (Querformat), `1536x1024` (Hochformat) oder `1024x1536` (Standardwert) für `auto`-Serienmodelle, eines von `gpt-image-1`, `256x256`, oder `512x512` für `1024x1024`, und eine von `dall-e-2`, `1024x1024`oder `1792x1024` für `1024x1792dall-e-3` . Mögliche Werte: `auto`, , `1024x1024`, `1536x10241024x1536`, `256x256`, , `512x512`, `1792x10241024x1792`	No
Stil	enum	Die Formatvorlage der generierten Bilder. Dieser Parameter wird nur für `dall-e-3`. Muss eine von `vivid` oder `natural`. Lebendig bewirkt, dass sich das Modell auf die Erzeugung hyper realer und dramatischer Bilder stützt. Natürlich erzeugt das Modell natürlichere, weniger hyper reale Bilder. Mögliche Werte: `vivid`, `natural`	No
user	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	No

AzureCreateResponse

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Hintergrund	Boolescher Wert	Gibt an, ob die Modellantwort im Hintergrund ausgeführt werden soll.	No	Falsch
include	array	Geben Sie zusätzliche Ausgabedaten an, die in die Modellantwort eingeschlossen werden sollen. Derzeit unterstützte Werte sind: - `code_interpreter_call.outputs`: Enthält die Ausgaben der Python-Codeausführung in Codedolmetscher-Toolaufrufelemente. - `computer_call_output.output.image_url`: Schließen Sie Bild-URLs aus der Ausgabe des Computeraufrufs ein. - `file_search_call.results`: Schließen Sie die Suchergebnisse des Aufrufs des Dateisuchtools ein. - `message.input_image.image_url`: Fügen Sie Bild-URLs aus der Eingabenachricht ein. - `message.output_text.logprobs`: Fügen Sie Logprobs in Assistentennachrichten ein. - `reasoning.encrypted_content`: Enthält eine verschlüsselte Version von Begründungstoken bei der Ausgabe von Gründen für Elemente. Dies ermöglicht die Verwendung von Elementen in Multi-Turn-Unterhaltungen, wenn die Antwort-API zustandslos verwendet wird (z. B. wenn der `store` Parameter auf `false`" festgelegt ist" oder wenn eine Organisation im Aufbewahrungsprogramm für Nulldaten registriert ist).	No
input	Zeichenfolge oder Matrix		No
Anweisungen	string	Eine Systemnachricht (oder Entwicklernachricht), die in den Kontext des Modells eingefügt wurde. Bei Verwendung dieser `previous_response_id`Antwort werden die Anweisungen aus einer vorherigen Antwort nicht an die nächste Antwort übertragen. Dies erleichtert das Austauschen von Systemnachrichten (oder Entwicklernachrichten) in neuen Antworten.	No
max_output_tokens	Ganzzahl	Eine obere Grenze für die Anzahl der Token, die für eine Antwort generiert werden können, einschließlich sichtbarer Ausgabetoken und Begründungstoken	No
max_tool_calls	Ganzzahl	Die maximale Anzahl der Aufrufe an integrierte Tools, die in einer Antwort verarbeitet werden können. Diese maximale Anzahl gilt für alle integrierten Toolaufrufe, nicht pro einzelnes Tool. Alle weiteren Versuche, ein Tool durch das Modell aufzurufen, werden ignoriert.	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
Modell	string	Die Modellbereitstellung, die für die Erstellung dieser Antwort verwendet werden soll.	Ja
Parallele Werkzeugaufrufe	Boolescher Wert	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	No	Richtig
previous_response_id	string	Die eindeutige ID der vorherigen Antwort auf das Modell. Verwenden Sie diese Option, um Multi-Turn-Unterhaltungen zu erstellen.	No
Eingabeaufforderung	Objekt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	No
└– ID	string	Der eindeutige Bezeichner der zu verwendenden Eingabeaufforderungsvorlage.	No
└- Variablen	OpenAI.ResponsePromptVariables	Optionale Zuordnung von Werten, die durch Variablen in Ihrer Eingabeaufforderung ersetzt werden sollen. Die Ersetzungswerte können entweder Zeichenfolgen oder andere Antworteingabetypen wie Bilder oder Dateien sein.	No
└– Version	string	Optionale Version der Eingabeaufforderungsvorlage.	No
reasoning	Objekt	Nur o-Serienmodelle Konfigurationsoptionen für Begründungsmodelle.	No
└– Aufwand	OpenAI.ReasoningEffort	Nur o-Serienmodelle Beschränkt den Aufwand für die Begründung von Begründungsmodellen. Derzeit unterstützte Werte sind `low`, `medium`und `high`. Das Reduzieren von Gründen kann zu schnelleren Antworten und weniger Token führen, die bei der Begründung in einer Antwort verwendet werden.	No
└– generate_summary	enum	Veraltet: Verwenden Sie `summary` stattdessen. Eine Zusammenfassung der vom Modell durchgeführten Begründung. Dies kann hilfreich sein, um das Debuggen und Verstehen des Begründungsprozesses des Modells zu verstehen. Einer von `auto`, `concise`, oder `detailed`. Mögliche Werte: `auto`, , `concisedetailed`	No
└– Zusammenfassung	enum	Eine Zusammenfassung der vom Modell durchgeführten Begründung. Dies kann hilfreich sein, um das Debuggen und Verstehen des Begründungsprozesses des Modells zu verstehen. Einer von `auto`, `concise`, oder `detailed`. Mögliche Werte: `auto`, , `concisedetailed`	No
store	Boolescher Wert	Gibt an, ob die generierte Modellantwort für den späteren Abruf über die API gespeichert werden soll.	No	Richtig
stream	Boolescher Wert	Wenn dieser Wert auf "true" festgelegt ist, werden die Modellantwortdaten an den Client gestreamt, da sie mithilfe von Server gesendeten Ereignissen generiert wird.	No	Falsch
Temperatur	number	Welche Probenahmetemperatur verwendet werden soll, zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Es wird in der Regel empfohlen, dies oder `top_p` nicht beides zu ändern.	No	1
Text	Objekt	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann Nur-Text- oder strukturierte JSON-Daten sein.	No
└─ Format	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	Objekt	Steuert, welches Tool (falls vorhanden) vom Modell aufgerufen wird. `none` bedeutet, dass das Modell kein Tool aufruft und stattdessen eine Nachricht generiert. `auto` bedeutet, dass das Modell zwischen dem Generieren einer Nachricht oder dem Aufrufen eines oder mehrerer Tools auswählen kann. `required` bedeutet, dass das Modell mindestens ein Tools aufrufen muss.	No
└– Typ	OpenAI.ToolChoiceObjectType	Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll.	No
tools	array	Ein Array von Tools, die das Modell aufrufen kann, während eine Antwort generiert wird. Sie können angeben, welches Tool verwendet werden soll, indem Sie den `tool_choice` Parameter festlegen. Die beiden Kategorien von Tools, die Sie bereitstellen können, sind: - Integrierte Tools: Tools, die von OpenAI bereitgestellt werden, die die Funktionen des Modells erweitern, z. B. die Dateisuche. - Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, sodass das Modell Ihren eigenen Code aufrufen kann.	No
top_logprobs	Ganzzahl	Eine ganze Zahl zwischen 0 und 20, die die Anzahl der höchstwahrscheinlichen Token an jeder Tokenposition angibt, jeweils mit einer zugeordneten Protokollwahrscheinlichkeit.	No
top_p	number	Eine Alternative zur Probenahme mit Temperatur, die als Kernsampling bezeichnet wird, wobei das Modell die Ergebnisse der Token mit top_p Wahrscheinlichkeitsmasse berücksichtigt. 0,1 bedeutet also, dass nur die Token, die die obersten 10% Wahrscheinlichkeitsmasse umfassen, berücksichtigt werden. Es wird in der Regel empfohlen, dies oder `temperature` nicht beides zu ändern.	No	1
truncation	enum	Die Abkürzungsstrategie, die für die Modellantwort verwendet werden soll. - `auto`: Wenn der Kontext dieser Antwort und früherer Antworten die Größe des Kontextfensters des Modells überschreitet, schneidet das Modell die Antwort ab, um das Kontextfenster anzupassen, indem Eingabeelemente in der Mitte der Unterhaltung gelöscht werden. - `disabled` (Standard): Wenn eine Modellantwort die Kontextfenstergröße für ein Modell überschreitet, schlägt die Anforderung mit einem Fehler von 400 fehl. Mögliche Werte: `auto`, `disabled`	No
user	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	No

AzureCreateSpeechRequestMultiPart

Eine Darstellung der Anforderungsoptionen, die das Verhalten eines Text-zu-Sprache-Vorgangs steuern.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
input	string	Der Text, für den Audio generiert werden soll. Die maximale Länge beträgt 4096 Zeichen.	Ja
Anweisungen	string	Steuern Sie die Stimme Ihrer generierten Audiodaten mit zusätzlichen Anweisungen. Funktioniert nicht mit `tts-1` oder `tts-1-hd`.	No
Modell	string	Das Modell, das für diese Text-zu-Sprache-Anforderung verwendet werden soll.	Ja
Antwortformat	Objekt	Die unterstützten Audioausgabeformate für Text-zu-Sprache.	No
Geschwindigkeit	number	Die Geschwindigkeit der Spracherkennung für generierte Audiodaten. Werte sind im Bereich von 0,25 bis 4,0 gültig, wobei 1,0 die Standardwerte und höhere Werte, die schnelleren Spracherkennungen entsprechen.	No	1
stream_format	enum	Das Format, in das die Audiodaten gestreamt werden sollen. Unterstützte Formate sind `sse` und `audio`. `sse` wird für `tts-1` oder `tts-1-hd`. Mögliche Werte: `sse`, `audio`	No
Stimme	Objekt		Ja

AzureCreateTranscriptionRequestMultiPart

Die Konfigurationsinformationen für eine Audiotranskriptionsanforderung.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
chunking_strategy	Objekt		No
└– prefix_padding_ms	Ganzzahl	Die Menge der Audiodaten, die vor der erkannten VAD-Sprache (in Millisekunden) enthalten sein sollen.	No	300
└– Dauer_der_Stille_in_ms	Ganzzahl	Dauer der Stille zum Erkennen des Sprachstopps (in Millisekunden). Mit kürzeren Werten reagiert das Modell schneller, kann aber an kurzen Pausen vom Benutzer teilnehmen.	No	200
└– Schwellenwert	number	Vertraulichkeitsschwellenwert (0,0 bis 1,0) für die Sprachaktivitätserkennung. Eine höhere Schwelle erfordert lauteres Audio, um das Modell zu aktivieren, und kann daher in lauten Umgebungen besser funktionieren.	No	0,5
└– Typ	enum	Muss so festgelegt sein, dass `server_vad` manuelle Blöcke mithilfe der serverseitigen VAD aktiviert werden. Mögliche Werte: `server_vad`	No
Datei	string		Ja
filename	string	Der optionale Dateiname oder der beschreibende Bezeichner, der den Audiodaten zugeordnet werden soll.	No
include[]	array	Zusätzliche Informationen, die in die Transkriptionsantwort aufgenommen werden sollen. `logprobs` gibt die Protokollwahrscheinlichkeiten der Token in der Antwort zurück, um das Vertrauen des Modells in die Transkription zu verstehen. `logprobs` funktioniert nur mit response_format auf `json` und nur mit den Modellen `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, , `gpt-4o-mini-transcribe`und `gpt-4o-mini-transcribe-2025-12-15`.	No
language	string	Die Sprache des Eingabeaudios. Durch die Bereitstellung der Eingabesprache in ISO-639-1 (z. B. `en`) wird die Genauigkeit und Latenz verbessert.	No
Modell	string	Das Modell, das für diese Transkriptionsanforderung verwendet werden soll.	No
Eingabeaufforderung	string	Optionaler Text zum Leiten der Formatvorlage des Modells oder Fortsetzen eines vorherigen Audiosegments. Die Eingabeaufforderung sollte mit der Audiosprache übereinstimmen.	No
Antwortformat	Objekt		No
stream	Boolescher Wert	Wenn dieser Wert auf "true" festgelegt ist, werden die Modellantwortdaten an den Client gestreamt, da sie mithilfe von Server gesendeten Ereignissen generiert wird. Hinweis: Streaming wird für das `whisper-1` Modell nicht unterstützt und wird ignoriert.	No	Falsch
Temperatur	number	Die Probenahmetemperatur zwischen 0 und 1. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Bei Festlegung auf 0 verwendet das Modell die Protokollwahrscheinlichkeit , um die Temperatur automatisch zu erhöhen, bis bestimmte Schwellenwerte erreicht werden.	No	0
timestamp_granularities[]	array	Die Zeitstempel-Granularitäten, die für diese Transkription aufgefüllt werden sollen. `response_format` muss für die Verwendung von Timestamp-Granularitäten festgelegt `verbose_json` werden. Entweder oder beide dieser Optionen werden unterstützt: `word`oder `segment`. Hinweis: Es gibt keine zusätzliche Latenz für Segmentzeitstempel, aber das Generieren von Wortzeitstempeln verursacht zusätzliche Latenz.	No	['segment']

AzureCreateTranslationRequestMultiPart

Die Konfigurationsinformationen für eine Audiotranskriptionsanforderung.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Datei	string		Ja
filename	string	Optionaler Dateiname oder beschreibender Bezeichner, der den Audiodaten zugeordnet werden soll	No
Modell	string	Das Modell, das für diese Übersetzungsanforderung verwendet werden soll.	No
Eingabeaufforderung	string	Optionaler Text zum Leiten der Formatvorlage des Modells oder Fortsetzen eines vorherigen Audiosegments. Die Eingabeaufforderung sollte in Englisch sein.	No
Antwortformat	Objekt		No
Temperatur	number	Die Probenahmetemperatur zwischen 0 und 1. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Bei Festlegung auf 0 verwendet das Modell die Protokollwahrscheinlichkeit , um die Temperatur automatisch zu erhöhen, bis bestimmte Schwellenwerte erreicht werden.	No	0

AzureErrorResponse

Name	Typ	Beschreibung	Erforderlich
Fehler	Objekt	Die Fehlerdetails.	No
└– Code	string	Der eindeutige, vom Computer generierte Bezeichner für den Fehler.	No
└─ innerer_Fehler			No
└– Nachricht	string	Eine lesbare Nachricht, die dem Fehler zugeordnet ist.	No
└- param	string	Falls zutreffend, der dem Fehler zugeordnete Anforderungseingabeparameter	No
└– Typ	enum	Der Objekttyp, immer 'error'. Mögliche Werte: `error`	No

AzureEvalAPICompletionsSamplingParams

Name	Typ	Erforderlich
Parallele Werkzeugaufrufe	Boolescher Wert	No
Antwortformat	OpenAI.ResponseTextFormatConfiguration	No
tools	array	No

AzureEvalAPIModelSamplingParams

Name	Typ	Beschreibung	Erforderlich
maximale_Anzahl_von_Tokens	Ganzzahl	Die maximale Anzahl von Token in der generierten Ausgabe.	No
Denkanstrengung	enum	Steuert die Ebene der während der Generation angewendeten Gründe. Mögliche Werte: `low`, , `mediumhigh`	No
seed	Ganzzahl	Ein Ausgangswert zum Initialisieren der Zufallsmuster während der Probenahme.	No
Temperatur	number	Eine höhere Temperatur erhöht die Zufallszahlen in den Ausgaben.	No
top_p	number	Eine Alternative zur Temperatur für kernsampling; 1.0 enthält alle Token.	No

AzureEvalAPIResponseSamplingParams

Name	Typ	Erforderlich
Parallele Werkzeugaufrufe	Boolescher Wert	No
Antwortformat	OpenAI.ResponseTextFormatConfiguration	No
tools	array	No

AzureFileExpiryAnchor

Eigentum	Wert
Typ	string
Werte	`created_at`

AzureFineTuneReinforcementMethod

Name	Typ	Beschreibung	Erforderlich
Grader	Objekt	Ein StringCheckGrader-Objekt, das einen Zeichenfolgenvergleich zwischen Eingabe und Verweis mithilfe eines angegebenen Vorgangs durchführt.	Ja
└– calculate_output	string	Eine Formel zum Berechnen der Ausgabe basierend auf den Benotungsergebnissen.	No
└- Bewertungsmetrik	enum	Die zu verwendende Auswertungsmetrik. Einer von `fuzzy_match`, `bleu`, , `gleumeteor`, `rouge_1`, , `rouge_2`, `rouge_3`, `rouge_4`, , oder `rouge_5rouge_l`. Mögliche Werte: `fuzzy_match`, , `bleu`, `gleu`, `meteorrouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5rouge_l`	No
└– Noten	Objekt		No
└– Eingabe	array	Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten.	No
└─ Modell	string	Das Modell, das für die Auswertung verwendet werden soll.	No
└– Name	string	Der Name des Graders.	No
└─ Vorgang	enum	Der auszuführende Zeichenfolgenüberprüfungsvorgang. Einer von `eq`, `ne`, , `like`oder `ilike`. Mögliche Werte: `eq`, , `ne`, `likeilike`	No
└– Bereich	array	Der Bereich der Bewertung. Standardwert ist .`[0, 1]`	No
└– Referenz	string	Der Text, der abgestuft wird.	No
└– Stichprobenparameter		Die Samplingparameter für das Modell.	No
└– Typ	enum	Der Objekttyp, der immer `multi`ist. Mögliche Werte: `multi`	No
Hyperparameter	OpenAI.FineTuneReinforcementHyperparameters	Die Hyperparameter, die für den Verstärkungs-Feinabstimmungsauftrag verwendet werden.	No
Antwortformat	Objekt		No
└– json_schema	Objekt	JSON-Schema für das Antwortformat	No
└– Typ	enum	Typ des Antwortformats. Mögliche Werte: `json_schema`	No

AzureImage

Name	Typ	Beschreibung	Erforderlich
b64_json	string	Der base64-codierte JSON-Code des generierten Bilds. Standardwert für `gpt-image-1`-Serienmodelle und nur vorhanden, wenn `response_formatb64_jsondall-e-2` für und .`dall-e-3`	No
Content-Filtern-Egebnisse	AzureContentFilterImageResponseResults	Ein Inhaltsfilterergebnis für den Ausgabeantwortinhalt eines Bildgenerierungsvorgangs.	Ja
prompt_filter_results	AzureContentFilterImagePromptResults	Ein Inhaltsfilterergebnis für den Eingabeanforderungsinhalt eines Bildgenerierungsvorgangs.	Ja
überarbeitete_Aufforderung	string	Nur `dall-e-3` die überarbeitete Eingabeaufforderung, die zum Generieren des Bilds verwendet wurde.	No
url	string	Bei Verwendung `dall-e-2` oder `dall-e-3`, wenn die URL des generierten Bilds `response_format` festgelegt `url` ist (Standardwert). Wird für Modelle der `gpt-image-1`Serie nicht unterstützt.	No

AzureImagesResponse

Name	Typ	Beschreibung	Erforderlich
Hintergrund	enum	NUR GPT-image-1: Der Hintergrundparameter, der für die Bildgenerierung verwendet wird. Entweder `transparent` oder `opaque`. Mögliche Werte: `transparent`, `opaque`	No
erstellt	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung des Bilds.	Ja
data	array		No
Ausgabeformat	enum	Das Ausgabeformat der Bildgenerierung. Entweder `png`, , `webp`oder `jpeg`. Mögliche Werte: `png`, , `webpjpeg`	No
Qualität	enum	Die Qualität des generierten Bilds. Entweder `low`, , `medium`oder `high`. Mögliche Werte: `low`, , `mediumhigh`	No
size	enum	Die Größe des generierten Bilds. Entweder `1024x1024`, , `1024x1536`oder `1536x1024`. Mögliche Werte: `1024x1024`, , `1024x15361536x1024`	No
Nutzung	Objekt	Nur bei `gpt-image-1`Modellen der Serie werden die Tokenverwendungsinformationen für die Bildgenerierung angegeben.	No
└─ Eingabe-Tokens	Ganzzahl	Die Anzahl der Token (Bilder und Text) in der Eingabeaufforderung.	No
└– input_tokens_details	Objekt	Die Eingabetoken enthalten detaillierte Informationen für die Bildgenerierung.	No
└– image_tokens	Ganzzahl	Die Anzahl der Bildtoken in der Eingabeaufforderung.	No
└- text_tokens	Ganzzahl	Die Anzahl der Texttoken in der Eingabeaufforderung.	No
└– Ausgabe-Tokens	Ganzzahl	Die Anzahl der Bildtoken im Ausgabebild.	No
└– total_tokens	Ganzzahl	Die Gesamtzahl der Token (Bilder und Text), die für die Bildgenerierung verwendet werden.	No

AzureListFilesResponse

Name	Typ	Beschreibung	Erforderlich
data	array		Ja
first_id	string		Ja
has_more	Boolescher Wert		Ja
last_id	string		Ja
Objekt	enum	Mögliche Werte: `list`	Ja

AzureOpenAIFile

Name	Typ	Beschreibung	Erforderlich
Bytes	Ganzzahl	Die Größe der Datei in Byte.	Ja
erstellt_am	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) für den Zeitpunkt der Erstellung der Datei.	Ja
läuft_ab_am	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) für den Zeitpunkt, an dem die Datei abläuft.	No
filename	string	Der Name der Datei.	Ja
id	string	Der Dateibezeichner, auf den in den API-Endpunkten verwiesen werden kann.	Ja
Objekt	enum	Der Objekttyp, der immer `file`ist. Mögliche Werte: `file`	Ja
Zweck	enum	Der beabsichtigte Zweck der Datei. Unterstützte Werte sind `assistants`, , `assistants_output`, `batch`, `batch_outputfine-tune`und `fine-tune-results`. Mögliche Werte: `assistants`, , `assistants_output`, `batchbatch_output`, `fine-tune`, , , `fine-tune-resultsevals`	Ja
Status	enum	Mögliche Werte: `uploaded`, , `pending`, `runningprocessed`, `error`, , , `deletingdeleted`	Ja
status_details	string	Deprecated. Ausführliche Informationen dazu, warum bei der Überprüfung einer Feinabstimmungsdatei ein Fehler aufgetreten ist, finden Sie im `error` Feld zu `fine_tuning.job`.	No

AzureOpenAIVideoGenerationErrorResponse

Name	Typ	Beschreibung	Erforderlich
code	string	Der eindeutige, vom Computer generierte Bezeichner für den Fehler.	No
innerer Fehler	Objekt	Falls zutreffend, ein Upstreamfehler, der diesen Fehler verursacht hat.	No
└– Code	enum	Der code, der dem inneren Fehler zugeordnet ist. Mögliche Werte: `ResponsibleAIPolicyViolation`	No
└─ Fehlerdetails		Die Ergebnisdetails des Inhaltsfilters, die dem inneren Fehler zugeordnet sind.	No
└- revised_prompt	string	Falls zutreffend, wird die geänderte Aufforderung zur Generierung verwendet.	No
Nachricht	string	Eine lesbare Nachricht, die dem Fehler zugeordnet ist.	No
param	string	Falls zutreffend, der dem Fehler zugeordnete Anforderungseingabeparameter	No
type	string	Falls zutreffend, wird die dem Fehler zugeordnete Eingabezeilennummer zugeordnet.	No

AzureResponse

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Hintergrund	Boolescher Wert	Gibt an, ob die Modellantwort im Hintergrund ausgeführt werden soll.	No	Falsch
erstellt_am	Ganzzahl	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
Fehler	Objekt	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	Ja
└– Code	OpenAI.ResponseErrorCode	Der Fehlercode für die Antwort.	No
└– Nachricht	string	Eine lesbare Beschreibung des Fehlers.	No
id	string	Eindeutiger Bezeichner für diese Antwort.	Ja
incomplete_details	Objekt	Details dazu, warum die Antwort unvollständig ist.	Ja
└– Grund	enum	Der Grund, warum die Antwort unvollständig ist. Mögliche Werte: `max_output_tokens`, `content_filter`	No
Anweisungen	Zeichenfolge oder Matrix		Ja
max_output_tokens	Ganzzahl	Eine obere Grenze für die Anzahl der Token, die für eine Antwort generiert werden können, einschließlich sichtbarer Ausgabetoken und Begründungstoken	No
max_tool_calls	Ganzzahl	Die maximale Anzahl der Aufrufe an integrierte Tools, die in einer Antwort verarbeitet werden können. Diese maximale Anzahl gilt für alle integrierten Toolaufrufe, nicht pro einzelnes Tool. Alle weiteren Versuche, ein Tool durch das Modell aufzurufen, werden ignoriert.	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	Ja
Modell	string	Das Modell, das zum Generieren dieser Antwort verwendet wird.	Ja
Objekt	enum	Der Objekttyp dieser Ressource - immer auf .`response` Mögliche Werte: `response`	Ja
Ausgabe	array	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array hängt von der Antwort des Modells ab. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant` Nachricht mit dem vom Modell generierten Inhalt handelt, können Sie die Verwendung der `output_text` Eigenschaft, die in SDKs unterstützt wird, in Betracht ziehen.	Ja
output_text	string	Nur-SDK-Komforteigenschaft, die die aggregierte Textausgabe aller `output_text` Elemente im `output` Array enthält, sofern vorhanden. Unterstützt in den Python- und JavaScript-SDKs.	No
Parallele Werkzeugaufrufe	Boolescher Wert	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
previous_response_id	string	Die eindeutige ID der vorherigen Antwort auf das Modell. Verwenden Sie diese Option, um Multi-Turn-Unterhaltungen zu erstellen.	No
Eingabeaufforderung	Objekt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	No
└– ID	string	Der eindeutige Bezeichner der zu verwendenden Eingabeaufforderungsvorlage.	No
└- Variablen	OpenAI.ResponsePromptVariables	Optionale Zuordnung von Werten, die durch Variablen in Ihrer Eingabeaufforderung ersetzt werden sollen. Die Ersetzungswerte können entweder Zeichenfolgen oder andere Antworteingabetypen wie Bilder oder Dateien sein.	No
└– Version	string	Optionale Version der Eingabeaufforderungsvorlage.	No
reasoning	Objekt	Nur o-Serienmodelle Konfigurationsoptionen für Begründungsmodelle.	No
└– Aufwand	OpenAI.ReasoningEffort	Nur o-Serienmodelle Beschränkt den Aufwand für die Begründung von Begründungsmodellen. Derzeit unterstützte Werte sind `low`, `medium`und `high`. Das Reduzieren von Gründen kann zu schnelleren Antworten und weniger Token führen, die bei der Begründung in einer Antwort verwendet werden.	No
└– generate_summary	enum	Veraltet: Verwenden Sie `summary` stattdessen. Eine Zusammenfassung der vom Modell durchgeführten Begründung. Dies kann hilfreich sein, um das Debuggen und Verstehen des Begründungsprozesses des Modells zu verstehen. Einer von `auto`, `concise`, oder `detailed`. Mögliche Werte: `auto`, , `concisedetailed`	No
└– Zusammenfassung	enum	Eine Zusammenfassung der vom Modell durchgeführten Begründung. Dies kann hilfreich sein, um das Debuggen und Verstehen des Begründungsprozesses des Modells zu verstehen. Einer von `auto`, `concise`, oder `detailed`. Mögliche Werte: `auto`, , `concisedetailed`	No
Status	enum	Der Status der Antwortgenerierung. Einer von `completed`, `failed`, `in_progress`, , `cancelled`, , `queued`oder `incomplete`. Mögliche Werte: `completed`, , `failed`, `in_progresscancelled`, , , `queuedincomplete`	No
Temperatur	number	Welche Probenahmetemperatur verwendet werden soll, zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Es wird in der Regel empfohlen, dies oder `top_p` nicht beides zu ändern.	Ja
Text	Objekt	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann Nur-Text- oder strukturierte JSON-Daten sein.	No
└─ Format	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	Objekt	Steuert, welches Tool (falls vorhanden) vom Modell aufgerufen wird. `none` bedeutet, dass das Modell kein Tool aufruft und stattdessen eine Nachricht generiert. `auto` bedeutet, dass das Modell zwischen dem Generieren einer Nachricht oder dem Aufrufen eines oder mehrerer Tools auswählen kann. `required` bedeutet, dass das Modell mindestens ein Tools aufrufen muss.	No
└– Typ	OpenAI.ToolChoiceObjectType	Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll.	No
tools	array	Ein Array von Tools, die das Modell aufrufen kann, während eine Antwort generiert wird. Sie können angeben, welches Tool verwendet werden soll, indem Sie den `tool_choice` Parameter festlegen. Die beiden Kategorien von Tools, die Sie bereitstellen können, sind: - Integrierte Tools: Tools, die von OpenAI bereitgestellt werden, die die Funktionen des Modells erweitern.	No
top_logprobs	Ganzzahl	Eine ganze Zahl zwischen 0 und 20, die die Anzahl der höchstwahrscheinlichen Token an jeder Tokenposition angibt, jeweils mit einer zugeordneten Protokollwahrscheinlichkeit.	No
top_p	number	Eine Alternative zur Probenahme mit Temperatur, die als Kernsampling bezeichnet wird, wobei das Modell die Ergebnisse der Token mit top_p Wahrscheinlichkeitsmasse berücksichtigt. 0,1 bedeutet also, dass nur die Token, die die obersten 10% Wahrscheinlichkeitsmasse umfassen, berücksichtigt werden. Es wird in der Regel empfohlen, dies oder `temperature` nicht beides zu ändern.	Ja
truncation	enum	Die Abkürzungsstrategie, die für die Modellantwort verwendet werden soll. - `auto`: Wenn der Kontext dieser Antwort und früherer Antworten die Größe des Kontextfensters des Modells überschreitet, schneidet das Modell die Antwort ab, um das Kontextfenster anzupassen, indem Eingabeelemente in der Mitte der Unterhaltung gelöscht werden. - `disabled` (Standard): Wenn eine Modellantwort die Kontextfenstergröße für ein Modell überschreitet, schlägt die Anforderung mit einem Fehler von 400 fehl. Mögliche Werte: `auto`, `disabled`	No
Nutzung	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails wie Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken dar.	No
user	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	Ja

AzureSearchChatDataSource

Stellt eine Datenquellenkonfiguration dar, die eine Azure Suchressource verwendet.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
parameters	Objekt	Die Parameterinformationen zum Steuern der Verwendung der Azure Suchdatenquelle.	Ja
└– erlaube_unvollständiges_Ergebnis	Boolescher Wert	Wenn dieser Wert auf "true" festgelegt ist, lässt das System die Verwendung von Teilsuchergebnissen zu, und die Anforderung schlägt fehl, wenn alle Teilabfragen fehlschlagen. Wenn sie nicht als "false" angegeben oder angegeben wurde, schlägt die Anforderung fehl, wenn eine Suchabfrage fehlschlägt.	No	Falsch
└– Authentifizierung	Objekt		No
└─ Zugriffstoken	string		No
└– Schlüssel	string		No
└– managed_identity_resource_id	string		No
└– Typ	enum	Mögliche Werte: `access_token`	No
└– embedding_dependency	Objekt	Stellt eine Vektorisierungsquelle dar, die öffentliche Dienstaufrufe für eine Azure OpenAI-Einbettungsmodellbereitstellung ausführt.	No
└– Authentifizierung	AzureChatDataSourceApiKeyAuthenticationOptions oder AzureChatDataSourceAccessTokenAuthenticationOptions	Der Authentifizierungsmechanismus, der mit der endpunktbasierten Vektorisierungsquelle verwendet werden soll. Die Endpunktauthentifizierung unterstützt API-Schlüssel- und Zugriffstokenmechanismen.	No
└– deployment_name	string	Die Bereitstellung des Einbettungsmodells, die für die Vektorisierung verwendet werden soll. Diese Bereitstellung muss innerhalb derselben Azure OpenAI-Ressource vorhanden sein wie die Modellbereitstellung, die für Chatabschlusse verwendet wird.	No
└- Abmessungen	Ganzzahl	Die Anzahl der Dimensionen, die bei Einbettungen angefordert werden sollen. Wird nur in "text-embedding-3" und späteren Modellen unterstützt.	No
└– Endpunkt	string	Gibt die Ressourcenendpunkt-URL an, aus der Einbettungen abgerufen werden sollen. Er sollte im Format von: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Der Abfrageparameter der API-Version ist nicht zulässig.	No
└– Typ	enum	Der Typbezeichner, immer "integriert" für diesen Vektorisierungsquelltyp. Mögliche Werte: `integrated`	No
└– Endpunkt	string	Der absolute Endpunktpfad für die zu verwendende Azure Suchressource.	No
└– fields_mapping	Objekt	Die Feldzuordnungen, die mit der Azure Suchressource verwendet werden sollen.	No
└– content_fields	array	Die Namen von Indexfeldern, die als Inhalt behandelt werden sollen.	No
└─ Inhalt_Feldtrenner	string	Das Trennmuster, das Inhaltsfelder verwenden sollen.	No
└– filepath_field	string	Der Name des Indexfelds, das als Dateipfad verwendet werden soll.	No
└- image_vector_fields	array	Die Namen von Feldern, die Bildvektordaten darstellen.	No
└– Titel_Feld	string	Der Name des Indexfelds, das als Titel verwendet werden soll.	No
└– url_field	string	Der Name des Indexfelds, das als URL verwendet werden soll.	No
└─ Vektorfelder	array	Die Namen von Feldern, die Vektordaten darstellen.	No
└- Filter	string	Ein Filter, der auf die Suche angewendet werden soll.	No
└– in_scope	Boolescher Wert	Gibt an, ob Abfragen auf die Verwendung der indizierten Daten beschränkt werden sollen.	No
└– Kontexte_einschließen	array	Die Ausgabekontexteigenschaften, die in die Antwort eingeschlossen werden sollen. Standardmäßig werden Zitate und Absichten angefordert.	No	['Zitate', 'Absicht']
└– index_name	string	Der Name des zu verwendenden Indexes, wie in der Azure Suchressource angegeben.	No
└– max_search_queries	Ganzzahl	Die maximale Anzahl neu geschriebener Abfragen, die für eine einzelne Benutzernachricht an den Suchanbieter gesendet werden sollen. Standardmäßig führt das System eine automatische Bestimmung durch.	No
└– Abfragetyp	enum	Der Abfragetyp für die zu verwendende Azure Suchressource. Mögliche Werte: `simple`, , `semanticvector`, , `vector_simple_hybridvector_semantic_hybrid`	No
└─ semantische_Konfiguration	string	Zusätzliche semantische Konfiguration für die Abfrage.	No
└– Striktheit	Ganzzahl	Die konfigurierte Strenge der Suchrelevanzfilterung. Höhere Strenge erhöht die Genauigkeit, aber ein geringerer Rückruf der Antwort.	No
└– top_n_documents	Ganzzahl	Die konfigurierte Anzahl der Dokumente, die in der Abfrage bereitgestellt werden sollen.	No
type	enum	Der diskriminierte Typbezeichner, der immer "azure_search" ist. Mögliche Werte: `azure_search`	Ja

AzureUserSecurityContext

Der Benutzersicherheitskontext enthält mehrere Parameter, die die Anwendung selbst beschreiben, und den Endbenutzer, der mit der Anwendung interagiert. Diese Felder unterstützen Ihre Sicherheitsteams, Sicherheitsvorfälle zu untersuchen und zu mindern, indem sie einen umfassenden Ansatz zum Schutz Ihrer KI-Anwendungen bieten. Learn more zum Schutz von KI-Anwendungen mit Microsoft Defender for Cloud.

Name	Typ	Beschreibung	Erforderlich
application_name	string	Der Name der Anwendung. Vertrauliche persönliche Informationen sollten in diesem Feld nicht enthalten sein.	No
end_user_id	string	Dieser Bezeichner ist die Microsoft Entra ID (früher Azure Active Directory) Benutzerobjekt-ID, die zur Authentifizierung von Endbenutzern innerhalb der generativen KI-Anwendung verwendet wird. Vertrauliche persönliche Informationen sollten in diesem Feld nicht enthalten sein.	No
end_user_tenant_id	string	Die Microsoft 365 Mandanten-ID, zu der der Endbenutzer gehört. Es ist erforderlich, wenn die generative KI-Anwendung multitenant ist.	No
source_ip	string	Erfasst die IP-Adresse des ursprünglichen Clients.	No

ChatCompletionMessageToolCallsItem

Das Tool ruft vom Modell generierte Aufrufe auf, z. B. Funktionsaufrufe.

Array von: OpenAI.ChatCompletionMessageToolCall

CreateVideoGenerationRequest

Name	Typ	Beschreibung	Erforderlich	Vorgabe
height	Ganzzahl	Die Höhe des Videos. Die folgenden Dimensionen werden unterstützt: 480x480, 854x480, 720x720, 1280x720, 1080x1080 und 1920x1080 sowohl im Quer- als auch im Hochformat.	Ja
Modell	string	Der Name der Bereitstellung, die für diese Anforderung verwendet werden soll.	Ja
n_seconds	Ganzzahl	Die Dauer des Auftrags zur Videogenerierung. Muss zwischen 1 und 20 Sekunden betragen.	No	5
n_variants	Ganzzahl	Die Anzahl der Videos, die als Varianten für diesen Auftrag erstellt werden sollen. Muss zwischen 1 und 5 sein. Kleinere Abmessungen ermöglichen mehr Varianten.	No	1
Eingabeaufforderung	string	Die Aufforderung für diesen Auftrag zur Videogenerierung.	Ja
width	Ganzzahl	Die Breite des Videos. Die folgenden Dimensionen werden unterstützt: 480x480, 854x480, 720x720, 1280x720, 1080x1080 und 1920x1080 sowohl im Quer- als auch im Hochformat.	Ja

CreateVideoGenerationWithMediaRequestMultiPart

Die Eigenschaften einer Auftragsanforderung für die Videogenerierung mit Mediendateien.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
files	array		Ja
height	Ganzzahl	Die Höhe des Videos. Die folgenden Dimensionen werden unterstützt: 480x480, 854x480, 720x720, 1280x720, 1080x1080 und 1920x1080 sowohl im Quer- als auch im Hochformat.	Ja
inpaint_items	array	Optionale Inpaintingelemente für diesen Videogenerierungsauftrag.	No
Modell	string	Der Name der Bereitstellung, die für diese Anforderung verwendet werden soll.	Ja
n_seconds	Ganzzahl	Die Dauer des Auftrags zur Videogenerierung. Muss zwischen 1 und 20 Sekunden betragen.	No	5
n_variants	Ganzzahl	Die Anzahl der Videos, die als Varianten für diesen Auftrag erstellt werden sollen. Muss zwischen 1 und 5 sein. Kleinere Abmessungen ermöglichen mehr Varianten.	No	1
Eingabeaufforderung	string	Die Aufforderung für diesen Auftrag zur Videogenerierung.	Ja
width	Ganzzahl	Die Breite des Videos. Die folgenden Dimensionen werden unterstützt: 480x480, 854x480, 720x720, 1280x720, 1080x1080 und 1920x1080 sowohl im Quer- als auch im Hochformat.	Ja

CropBounds

Die Zuschneidegrenzen für ein inpaintierendes Element. Dadurch wird der Bereich des Medienelements angegeben, der für die Inpaintierung verwendet werden soll.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
bottom_fraction	number	Die untere Grenze des Zuschneidefelds, das als Bruch der Höhe des ursprünglichen Medienelements angegeben ist. Muss zwischen 0,0 und 1,0 sein. Verwenden Sie z. B. 0,5 für die Hälfte der Höhe des ursprünglichen Medienelements.	No	1
left_fraction	number	Die linke Begrenzung des Zuschneidefelds, das als Bruchteil der Breite des ursprünglichen Medienelements angegeben ist. Muss zwischen 0,0 und 1,0 sein. Verwenden Sie z. B. 0,5 für die Hälfte der Breite des ursprünglichen Medienelements.	No	0
right_fraction	number	Die rechte Begrenzung des Zuschneidefelds, das als Bruchteil der Breite des ursprünglichen Medienelements angegeben ist. Muss zwischen 0,0 und 1,0 sein. Verwenden Sie z. B. 0,5 für die Hälfte der Breite des ursprünglichen Medienelements.	No	1
top_fraction	number	Die obere Begrenzung des Zuschneidefelds, das als Bruchteil der Höhe des ursprünglichen Medienelements angegeben ist. Muss zwischen 0,0 und 1,0 sein. Verwenden Sie z. B. 0,5 für die Hälfte der Höhe des ursprünglichen Medienelements.	No	0

ElasticsearchChatDataSource

Name	Typ	Beschreibung	Erforderlich	Vorgabe
parameters	Objekt	Die Parameterinformationen zum Steuern der Verwendung der Elasticsearch-Datenquelle.	Ja
└– erlaube_unvollständiges_Ergebnis	Boolescher Wert	Wenn dieser Wert auf "true" festgelegt ist, lässt das System die Verwendung von Teilsuchergebnissen zu, und die Anforderung schlägt fehl, wenn alle Teilabfragen fehlschlagen. Wenn sie nicht als "false" angegeben oder angegeben wurde, schlägt die Anforderung fehl, wenn eine Suchabfrage fehlschlägt.	No	Falsch
└– Authentifizierung	Objekt		No
└– encoded_api_key	string		No
└– Schlüssel	string		No
└– key_id	string		No
└– Typ	enum	Mögliche Werte: `encoded_api_key`	No
└– embedding_dependency	AzureChatDataSourceVectorizationSource	Eine Darstellung einer Datenvektorisierungsquelle, die als Einbettungsressource mit einer Datenquelle verwendet werden kann.	No
└– Endpunkt	string		No
└– fields_mapping	Objekt		No
└– content_fields	array		No
└─ Inhalt_Feldtrenner	string		No
└– filepath_field	string		No
└– Titel_Feld	string		No
└– url_field	string		No
└─ Vektorfelder	array		No
└– in_scope	Boolescher Wert	Gibt an, ob Abfragen auf die Verwendung der indizierten Daten beschränkt werden sollen.	No
└– Kontexte_einschließen	array	Die Ausgabekontexteigenschaften, die in die Antwort eingeschlossen werden sollen. Standardmäßig werden Zitate und Absichten angefordert.	No	['Zitate', 'Absicht']
└– index_name	string		No
└– max_search_queries	Ganzzahl	Die maximale Anzahl neu geschriebener Abfragen, die für eine einzelne Benutzernachricht an den Suchanbieter gesendet werden sollen. Standardmäßig führt das System eine automatische Bestimmung durch.	No
└– Abfragetyp	enum	Mögliche Werte: `simple`, `vector`	No
└– Striktheit	Ganzzahl	Die konfigurierte Strenge der Suchrelevanzfilterung. Höhere Strenge erhöht die Genauigkeit, aber ein geringerer Rückruf der Antwort.	No
└– top_n_documents	Ganzzahl	Die konfigurierte Anzahl der Dokumente, die in der Abfrage bereitgestellt werden sollen.	No
type	enum	Der diskriminierte Typbezeichner, der immer "elasticsearch" ist. Mögliche Werte: `elasticsearch`	Ja

InpaintItem

Ein inpaintierendes Element für einen Auftrag zur Videogenerierung. Dadurch wird das Medienelement angegeben, das für die Inpaintierung in der Videogenerierung verwendet werden soll.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
crop_bounds	Objekt	Die Zuschneidegrenzen für ein inpaintierendes Element. Dadurch wird der Bereich des Medienelements angegeben, der für die Inpaintierung verwendet werden soll.	No
└– bottom_fraction	number	Die untere Grenze des Zuschneidefelds, das als Bruch der Höhe des ursprünglichen Medienelements angegeben ist. Muss zwischen 0,0 und 1,0 sein. Verwenden Sie z. B. 0,5 für die Hälfte der Höhe des ursprünglichen Medienelements.	No	1
└– left_fraction	number	Die linke Begrenzung des Zuschneidefelds, das als Bruchteil der Breite des ursprünglichen Medienelements angegeben ist. Muss zwischen 0,0 und 1,0 sein. Verwenden Sie z. B. 0,5 für die Hälfte der Breite des ursprünglichen Medienelements.	No	0
└– right_fraction	number	Die rechte Begrenzung des Zuschneidefelds, das als Bruchteil der Breite des ursprünglichen Medienelements angegeben ist. Muss zwischen 0,0 und 1,0 sein. Verwenden Sie z. B. 0,5 für die Hälfte der Breite des ursprünglichen Medienelements.	No	1
└- top_fraction	number	Die obere Begrenzung des Zuschneidefelds, das als Bruchteil der Höhe des ursprünglichen Medienelements angegeben ist. Muss zwischen 0,0 und 1,0 sein. Verwenden Sie z. B. 0,5 für die Hälfte der Höhe des ursprünglichen Medienelements.	No	0
file_name	string	Der Dateiname des Medienelements. Er muss mit dem Dateinamen einer Dateianlage in dieser Anforderung übereinstimmen.	Ja
frame_index	Ganzzahl	Der Frameindex für dieses Medienelement. Dadurch wird der Startframe im resultierenden generierten Video für dieses inpainting-Element angegeben.	Ja	0
type	Objekt	Der Typ des inpainting-Elements.	Ja

Arbeitsstatus

Der Status eines Auftrags zur Videogenerierung.

Eigentum	Wert
Beschreibung	Der Status eines Auftrags zur Videogenerierung.
Typ	string
Werte	`preprocessing` `queued` `running` `processing` `cancelled` `succeeded` `failed`

MediaItemType

Der Typ des inpainting-Elements.

Eigentum	Wert
Beschreibung	Der Typ des inpainting-Elements.
Typ	string
Werte	`image`

MongoDBChatDataSource

Name	Typ	Beschreibung	Erforderlich	Vorgabe
parameters	Objekt	Die Parameterinformationen zum Steuern der Verwendung der MongoDB-Datenquelle.	Ja
└– erlaube_unvollständiges_Ergebnis	Boolescher Wert	Wenn dieser Wert auf "true" festgelegt ist, lässt das System die Verwendung von Teilsuchergebnissen zu, und die Anforderung schlägt fehl, wenn alle Teilabfragen fehlschlagen. Wenn sie nicht als "false" angegeben oder angegeben wurde, schlägt die Anforderung fehl, wenn eine Suchabfrage fehlschlägt.	No	Falsch
└– app_name	string	Der Name der MongoDB-Anwendung.	No
└– Authentifizierung	Objekt		No
└– Kennwort	string		No
└– Typ	enum	Mögliche Werte: `username_and_password`	No
└– Benutzername	string		No
└- collection_name	string	Der Name der MongoDB-Auflistung.	No
└– database_name	string	Der Name der MongoDB-Datenbank.	No
└– embedding_dependency	Objekt	Stellt eine Vektorisierungsquelle dar, die öffentliche Dienstaufrufe für eine Azure OpenAI-Einbettungsmodellbereitstellung ausführt.	No
└– Authentifizierung	AzureChatDataSourceApiKeyAuthenticationOptions oder AzureChatDataSourceAccessTokenAuthenticationOptions	Der Authentifizierungsmechanismus, der mit der endpunktbasierten Vektorisierungsquelle verwendet werden soll. Die Endpunktauthentifizierung unterstützt API-Schlüssel- und Zugriffstokenmechanismen.	No
└– deployment_name	string	Die Bereitstellung des Einbettungsmodells, die für die Vektorisierung verwendet werden soll. Diese Bereitstellung muss innerhalb derselben Azure OpenAI-Ressource vorhanden sein wie die Modellbereitstellung, die für Chatabschlusse verwendet wird.	No
└- Abmessungen	Ganzzahl	Die Anzahl der Dimensionen, die bei Einbettungen angefordert werden sollen. Wird nur in "text-embedding-3" und späteren Modellen unterstützt.	No
└– Endpunkt	string	Gibt die Ressourcenendpunkt-URL an, aus der Einbettungen abgerufen werden sollen. Er sollte im Format von: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Der Abfrageparameter der API-Version ist nicht zulässig.	No
└– Typ	enum	Der Typbezeichner, immer "deployment_name" für diesen Vektorisierungsquelltyp. Mögliche Werte: `deployment_name`	No
└– Endpunkt	string	Der Name des MongoDB-Clusterendpunkts.	No
└– fields_mapping	Objekt	Feldzuordnungen, die auf daten angewendet werden, die von der MongoDB-Datenquelle verwendet werden. Beachten Sie, dass Für MongoDB Inhalts- und Vektorfeldzuordnungen erforderlich sind.	No
└– content_fields	array		No
└─ Inhalt_Feldtrenner	string		No
└– filepath_field	string		No
└– Titel_Feld	string		No
└– url_field	string		No
└─ Vektorfelder	array		No
└– in_scope	Boolescher Wert	Gibt an, ob Abfragen auf die Verwendung der indizierten Daten beschränkt werden sollen.	No
└– Kontexte_einschließen	array	Die Ausgabekontexteigenschaften, die in die Antwort eingeschlossen werden sollen. Standardmäßig werden Zitate und Absichten angefordert.	No	['Zitate', 'Absicht']
└– index_name	string	Der Name des MongoDB-Indexes.	No
└– max_search_queries	Ganzzahl	Die maximale Anzahl neu geschriebener Abfragen, die für eine einzelne Benutzernachricht an den Suchanbieter gesendet werden sollen. Standardmäßig führt das System eine automatische Bestimmung durch.	No
└– Striktheit	Ganzzahl	Die konfigurierte Strenge der Suchrelevanzfilterung. Höhere Strenge erhöht die Genauigkeit, aber ein geringerer Rückruf der Antwort.	No
└– top_n_documents	Ganzzahl	Die konfigurierte Anzahl der Dokumente, die in der Abfrage bereitgestellt werden sollen.	No
type	enum	Der diskriminierte Typbezeichner, der immer "mongo_db" ist. Mögliche Werte: `mongo_db`	Ja

OpenAI.Annotation

Diskriminator für OpenAI.Annotation

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`file_citation`	OpenAI.AnnotationFileCitation
`url_citation`	OpenAI.AnnotationUrlCitation
`file_path`	OpenAI.AnnotationFilePath

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.AnnotationType		Ja

OpenAI.AnnotationFileCitation

Ein Zitat für eine Datei.

Name	Typ	Beschreibung	Erforderlich
Datei-ID	string	Die ID der Datei.	Ja
filename	string	Der Dateiname der zitierten Datei.	Ja
index	Ganzzahl	Der Index der Datei in der Liste der Dateien.	Ja
type	enum	Der Typ des Dateizitats. Immer `file_citation`. Mögliche Werte: `file_citation`	Ja

OpenAI.AnnotationFilePath

Ein Pfad zu einer Datei.

Name	Typ	Beschreibung	Erforderlich
Datei-ID	string	Die ID der Datei.	Ja
index	Ganzzahl	Der Index der Datei in der Liste der Dateien.	Ja
type	enum	Der Typ des Dateipfads. Immer `file_path`. Mögliche Werte: `file_path`	Ja

OpenAI.AnnotationType

Eigentum	Wert
Typ	string
Werte	`file_citation` `url_citation` `file_path` `container_file_citation`

OpenAI.AnnotationUrlCitation

Ein Zitat für eine Webressource, das zum Generieren einer Modellantwort verwendet wird.

Name	Typ	Beschreibung	Erforderlich
end_index	Ganzzahl	Der Index des letzten Zeichens des URL-Zitats in der Nachricht.	Ja
start_index	Ganzzahl	Der Index des ersten Zeichens des URL-Zitats in der Nachricht.	Ja
title	string	Der Titel der Webressource.	Ja
type	enum	Der Typ des URL-Zitats. Immer `url_citation`. Mögliche Werte: `url_citation`	Ja
url	string	Die URL der Webressource.	Ja

OpenAI.ApproximateLocation

Name	Typ	Beschreibung	Erforderlich
Stadt	string		No
Land	string		No
region	string		No
timezone	string		No
type	enum	Mögliche Werte: `approximate`	Ja

OpenAI.AudioResponseFormat

Das Format der Ausgabe in einer der folgenden Optionen: json, , text, , srt, verbose_jsonoder vtt. Für gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, und gpt-4o-mini-transcribe-2025-12-15. Das einzige unterstützte Format ist json.

Eigentum	Wert
Beschreibung	Das Format der Ausgabe in einer der folgenden Optionen: `json`, , `text`, , `srt`, `verbose_json`oder `vtt`. Für `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, `gpt-4o-mini-transcribe`, und `gpt-4o-mini-transcribe-2025-12-15`. Das einzige unterstützte Format ist `json`.
Typ	string
Werte	`json` `text` `srt` `verbose_json` `vtt`

OpenAI.AutoChunkingStrategyRequestParam

Die Standardstrategie. Diese Strategie verwendet derzeit eine max_chunk_size_tokens von 800 und chunk_overlap_tokens von 400.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Immer `auto`. Mögliche Werte: `auto`	Ja

OpenAI.ChatCompletionFunctionCallOption

Durch Angeben einer bestimmten Funktion wird {"name": "my_function"} das Modell gezwungen, diese Funktion aufzurufen.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Name	string	Der Name der funktion, die aufgerufen werden soll.	Ja

OpenAI.ChatCompletionFunctions

Name	Typ	Beschreibung	Erforderlich
Beschreibung	string	Eine Beschreibung der Funktion, die vom Modell verwendet wird, um auszuwählen, wann und wie die Funktion aufgerufen wird.	No
Name	string	Der Name der funktion, die aufgerufen werden soll. Muss a-z, A-Z, 0-9 sein oder Unterstriche und Gedankenstriche enthalten, mit einer maximalen Länge von 64.	Ja
parameters		Die Parameter, die die Funktionen akzeptieren, die als JSON-Schemaobjekt beschrieben werden. Eine Dokumentation zum Format finden Sie in der JSON-Schemareferenz . Durch Weglassen `parameters` wird eine Funktion mit einer leeren Parameterliste definiert.	No

OpenAI.ChatCompletionMessageAudioChunk

Name	Typ	Erforderlich
data	string	No
läuft_ab_am	Ganzzahl	No
id	string	No
Abschrift	string	No

OpenAI.ChatCompletionMessageToolCall

Name	Typ	Beschreibung	Erforderlich
Funktion	Objekt	Die Funktion, die das Modell aufgerufen hat.	Ja
└- Argumente	string	Die Argumente, mit der die Funktion aufgerufen werden soll, wie vom Modell im JSON-Format generiert. Beachten Sie, dass das Modell nicht immer gültige JSON-Werte generiert und möglicherweise nicht durch Ihr Funktionsschema definierte Halluzinatenparameter enthält. Überprüfen Sie die Argumente im Code, bevor Sie Die Funktion aufrufen.	No
└– Name	string	Der Name der funktion, die aufgerufen werden soll.	No
id	string	Die ID des Toolaufrufs.	Ja
type	enum	Der Typ des Tools. Derzeit wird nur `function` unterstützt. Mögliche Werte: `function`	Ja

OpenAI.ChatCompletionMessageToolCallChunk

Name	Typ	Beschreibung	Erforderlich
Funktion	Objekt		No
└- Argumente	string	Die Argumente, mit der die Funktion aufgerufen werden soll, wie vom Modell im JSON-Format generiert. Beachten Sie, dass das Modell nicht immer gültige JSON-Werte generiert und möglicherweise nicht durch Ihr Funktionsschema definierte Halluzinatenparameter enthält. Überprüfen Sie die Argumente im Code, bevor Sie Die Funktion aufrufen.	No
└– Name	string	Der Name der funktion, die aufgerufen werden soll.	No
id	string	Die ID des Toolaufrufs.	No
index	Ganzzahl		Ja
type	enum	Der Typ des Tools. Derzeit wird nur `function` unterstützt. Mögliche Werte: `function`	No

OpenAI.ChatCompletionNamedToolChoice

Gibt ein Tool an, das das Modell verwenden soll. Wird verwendet, um zu erzwingen, dass das Modell eine bestimmte Funktion aufruft.

Name	Typ	Beschreibung	Erforderlich
Funktion	Objekt		Ja
└– Name	string	Der Name der funktion, die aufgerufen werden soll.	No
type	enum	Der Typ des Tools. Derzeit wird nur `function` unterstützt. Mögliche Werte: `function`	Ja

OpenAI.ChatCompletionRequestAssistantMessage

Nachrichten, die vom Modell als Reaktion auf Benutzernachrichten gesendet werden.

Name	Typ	Beschreibung	Erforderlich
Audio	Objekt	Daten zu einer vorherigen Audioantwort aus dem Modell.	No
└– ID	string	Eindeutiger Bezeichner für eine vorherige Audioantwort des Modells.	No
Inhalt	Zeichenfolge oder Matrix		No
function_call	Objekt	Veraltet und ersetzt durch `tool_calls`. Der Name und die Argumente einer Funktion, die aufgerufen werden soll, wie vom Modell generiert.	No
└- Argumente	string		No
└– Name	string		No
Name	string	Optionaler Name für den Teilnehmer. Stellt die Modellinformationen bereit, um zwischen den Teilnehmern derselben Rolle zu unterscheiden.	No
Weigerung	string	Die Ablehnungsnachricht des Assistenten.	No
Rolle	enum	Die Rolle des Autors von Nachrichten in diesem Fall `assistant`. Mögliche Werte: `assistant`	Ja
tool_calls	ChatCompletionMessageToolCallsItem	Das Tool ruft vom Modell generierte Aufrufe auf, z. B. Funktionsaufrufe.	No

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Name	Typ	Beschreibung	Erforderlich
Weigerung	string	Die vom Modell generierte Ablehnungsmeldung.	Ja
Text	string	Der Textinhalt.	Ja
type	enum	Der Typ des Inhaltsteils. Mögliche Werte: `refusal`	Ja

OpenAI.ChatCompletionRequestDeveloperMessage

Vom Entwickler bereitgestellte Anweisungen, die das Modell befolgen sollte, unabhängig von nachrichten, die vom Benutzer gesendet wurden. Bei o1-Modellen und neueren developer Nachrichten ersetzen Nachrichten die vorherigen system Nachrichten.

Name	Typ	Beschreibung	Erforderlich
Inhalt	Zeichenfolge oder Matrix		Ja
Name	string	Optionaler Name für den Teilnehmer. Stellt die Modellinformationen bereit, um zwischen den Teilnehmern derselben Rolle zu unterscheiden.	No
Rolle	enum	Die Rolle des Autors von Nachrichten in diesem Fall `developer`. Mögliche Werte: `developer`	Ja

OpenAI.ChatCompletionRequestFunctionMessage

Name	Typ	Beschreibung	Erforderlich
Inhalt	string	Der Inhalt der Funktionsmeldung.	Ja
Name	string	Der Name der funktion, die aufgerufen werden soll.	Ja
Rolle	enum	Die Rolle des Autors von Nachrichten in diesem Fall `function`. Mögliche Werte: `function`	Ja

OpenAI.ChatCompletionRequestMessage

Diskriminator für OpenAI.ChatCompletionRequestMessage

Diese Komponente verwendet die Eigenschaft role , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`system`	OpenAI.ChatCompletionRequestSystemMessage
`developer`	OpenAI.ChatCompletionRequestDeveloperMessage
`user`	OpenAI.ChatCompletionRequestUserMessage
`assistant`	OpenAI.ChatCompletionRequestAssistantMessage
`tool`	OpenAI.ChatCompletionRequestToolMessage
`function`	OpenAI.ChatCompletionRequestFunctionMessage

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Inhalt	Zeichenfolge oder Matrix		No
Rolle	Objekt	Die Rolle des Autors einer Nachricht	Ja

OpenAI.ChatCompletionRequestMessageContentPart

Diskriminator für OpenAI.ChatCompletionRequestMessageContentPart

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`text`	OpenAI.ChatCompletionRequestMessageContentPartText
`image_url`	OpenAI.ChatCompletionRequestMessageContentPartImage
`refusal`	OpenAI.ChatCompletionRequestMessageContentPartRefusal
`file`	OpenAI.ChatCompletionRequestMessageContentPartFile
`input_audio`	OpenAI.ChatCompletionRequestMessageContentPartAudio

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.ChatCompletionRequestMessageContentPartType		Ja

OpenAI.ChatCompletionRequestMessageContentPartAudio

Name	Typ	Beschreibung	Erforderlich
input_audio	Objekt		Ja
└– Daten	string	Base64-codierte Audiodaten.	No
└─ Format	enum	Das Format der codierten Audiodaten. Unterstützt derzeit "wav" und "mp3". Mögliche Werte: `wav`, `mp3`	No
type	enum	Der Typ des Inhaltsteils. Immer `input_audio`. Mögliche Werte: `input_audio`	Ja

OpenAI.ChatCompletionRequestMessageContentPartFile

Name	Typ	Beschreibung	Erforderlich
Datei	Objekt		Ja
└– file_data	string	Die base64-codierten Dateidaten, die beim Übergeben der Datei an das Modell als Zeichenfolge verwendet werden.	No
└– file_id	string	Die ID einer hochgeladenen Datei, die als Eingabe verwendet werden soll.	No
└– Dateiname	string	Der Name der Datei, die beim Übergeben der Datei an das Modell als Zeichenfolge verwendet wird.	No
type	enum	Der Typ des Inhaltsteils. Immer `file`. Mögliche Werte: `file`	Ja

OpenAI.ChatCompletionRequestMessageContentPartImage

Name	Typ	Beschreibung	Erforderlich
image_url	Objekt		Ja
└– Detail	enum	Gibt die Detailebene des Bilds an. Mögliche Werte: `auto`, , `lowhigh`	No
└– URL	string	Entweder eine URL des Bilds oder die base64-codierten Bilddaten.	No
type	enum	Der Typ des Inhaltsteils. Mögliche Werte: `image_url`	Ja

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Weigerung	string	Die vom Modell generierte Ablehnungsmeldung.	Ja
type	enum	Der Typ des Inhaltsteils. Mögliche Werte: `refusal`	Ja

OpenAI.ChatCompletionRequestMessageContentPartText

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Text	string	Der Textinhalt.	Ja
type	enum	Der Typ des Inhaltsteils. Mögliche Werte: `text`	Ja

OpenAI.ChatCompletionRequestMessageContentPartType

Eigentum	Wert
Typ	string
Werte	`text` `file` `input_audio` `image_url` `refusal`

OpenAI.ChatCompletionRequestSystemMessage

Vom Entwickler bereitgestellte Anweisungen, die das Modell befolgen sollte, unabhängig von nachrichten, die vom Benutzer gesendet wurden. Verwenden Sie developer mit o1-Modellen und neueren Nachrichten stattdessen Nachrichten.

Name	Typ	Beschreibung	Erforderlich
Inhalt	Zeichenfolge oder Matrix		Ja
Name	string	Optionaler Name für den Teilnehmer. Stellt die Modellinformationen bereit, um zwischen den Teilnehmern derselben Rolle zu unterscheiden.	No
Rolle	enum	Die Rolle des Autors von Nachrichten in diesem Fall `system`. Mögliche Werte: `system`	Ja

OpenAI.ChatCompletionRequestSystemMessageContentPart

Referenzen: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

Name	Typ	Beschreibung	Erforderlich
Inhalt	Zeichenfolge oder Matrix		Ja
Rolle	enum	Die Rolle des Autors von Nachrichten in diesem Fall `tool`. Mögliche Werte: `tool`	Ja
tool_call_id	string	Toolaufruf, auf den diese Nachricht reagiert.	Ja

OpenAI.ChatCompletionRequestToolMessageContentPart

Referenzen: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

Von einem Endbenutzer gesendete Nachrichten, die Eingabeaufforderungen oder zusätzliche Kontextinformationen enthalten.

Name	Typ	Beschreibung	Erforderlich
Inhalt	Zeichenfolge oder Matrix		Ja
Name	string	Optionaler Name für den Teilnehmer. Stellt die Modellinformationen bereit, um zwischen den Teilnehmern derselben Rolle zu unterscheiden.	No
Rolle	enum	Die Rolle des Autors von Nachrichten in diesem Fall `user`. Mögliche Werte: `user`	Ja

OpenAI.ChatCompletionRequestUserMessageContentPart

Name	Typ	Beschreibung	Erforderlich
Datei	Objekt		Ja
└– file_data	string	Die base64-codierten Dateidaten, die beim Übergeben der Datei an das Modell als Zeichenfolge verwendet werden.	No
└– file_id	string	Die ID einer hochgeladenen Datei, die als Eingabe verwendet werden soll.	No
└– Dateiname	string	Der Name der Datei, die beim Übergeben der Datei an das Modell als Zeichenfolge verwendet wird.	No
image_url	Objekt		Ja
└– Detail	enum	Gibt die Detailebene des Bilds an. Mögliche Werte: `auto`, , `lowhigh`	No
└– URL	string	Entweder eine URL des Bilds oder die base64-codierten Bilddaten.	No
input_audio	Objekt		Ja
└– Daten	string	Base64-codierte Audiodaten.	No
└─ Format	enum	Das Format der codierten Audiodaten. Unterstützt derzeit "wav" und "mp3". Mögliche Werte: `wav`, `mp3`	No
Text	string	Der Textinhalt.	Ja
type	enum	Der Typ des Inhaltsteils. Immer `file`. Mögliche Werte: `file`	Ja

OpenAI.ChatCompletionRole

Die Rolle des Autors einer Nachricht

Eigentum	Wert
Beschreibung	Die Rolle des Autors einer Nachricht
Typ	string
Werte	`system` `developer` `user` `assistant` `tool` `function`

OpenAI.ChatCompletionStreamOptions

Optionen für die Streamingantwort. Legen Sie dies nur fest, wenn Sie festlegen stream: true.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
include_usage	Boolescher Wert	Bei Festlegung wird ein zusätzlicher Block vor der `data: [DONE]` Nachricht gestreamt. Das `usage` Feld in diesem Abschnitt zeigt die Tokenverwendungsstatistiken für die gesamte Anforderung an, und das `choices` Feld ist immer ein leeres Array. Alle anderen Blöcke enthalten auch ein `usage` Feld, aber mit einem Nullwert. HINWEIS: Wenn der Datenstrom unterbrochen wird, erhalten Sie möglicherweise nicht den endgültigen Verwendungsabschnitt, der die gesamte Tokenverwendung für die Anforderung enthält.	No

OpenAI.ChatCompletionStreamResponseDelta

Ein Chat-Vervollständigungsdelta, das von streamten Modellantworten generiert wurde.

Name	Typ	Beschreibung	Erforderlich
Audio	Objekt		No
└– Daten	string		No
└– abläuft_am	Ganzzahl		No
└– ID	string		No
└– Transkript	string		No
Inhalt	string	Der Inhalt der Blocknachricht.	No
function_call	Objekt	Veraltet und ersetzt durch `tool_calls`. Der Name und die Argumente einer Funktion, die aufgerufen werden soll, wie vom Modell generiert.	No
└- Argumente	string		No
└– Name	string		No
Weigerung	string	Die vom Modell generierte Ablehnungsmeldung.	No
Rolle	Objekt	Die Rolle des Autors einer Nachricht	No
tool_calls	array		No

OpenAI.ChatCompletionTokenLogprob

Name	Typ	Beschreibung	Erforderlich
Bytes	array	Eine Liste der ganzzahligen Zahlen, die die UTF-8 Bytes-Darstellung des Tokens darstellen. Nützlich in Fällen, in denen Zeichen durch mehrere Token dargestellt werden, und ihre Bytedarstellungen müssen kombiniert werden, um die richtige Textdarstellung zu generieren. Kann sein `null` , wenn für das Token keine Bytedarstellung vorhanden ist.	Ja
logprob	number	Die Protokollwahrscheinlichkeit dieses Tokens, wenn es sich innerhalb der obersten 20 höchstwahrscheinlichen Token befindet. Andernfalls wird der Wert `-9999.0` verwendet, um zu kennzeichnen, dass das Token sehr unwahrscheinlich ist.	Ja
Token	string	Das Token.	Ja
top_logprobs	array	Liste der höchstwahrscheinlichen Token und deren Protokollwahrscheinlichkeit an dieser Tokenposition. In seltenen Fällen kann es weniger als die Anzahl der angeforderten `top_logprobs` Rückgaben geben.	Ja

OpenAI.ChatCompletionTool

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Funktion	OpenAI.FunctionObject		Ja
type	enum	Der Typ des Tools. Derzeit wird nur `function` unterstützt. Mögliche Werte: `function`	Ja

OpenAI.ChatCompletionToolChoiceOption

Steuert, welches Tool (falls vorhanden) vom Modell aufgerufen wird. none bedeutet, dass das Modell kein Tool aufruft und stattdessen eine Nachricht generiert. auto bedeutet, dass das Modell zwischen dem Generieren einer Nachricht oder dem Aufrufen eines oder mehrerer Tools auswählen kann. required bedeutet, dass das Modell mindestens ein Tools aufrufen muss. Wenn Sie ein bestimmtes Tool über {"type": "function", "function": {"name": "my_function"}} das Modell angeben, wird das Modell gezwungen, dieses Tool aufzurufen.

none ist die Standardeinstellung, wenn keine Tools vorhanden sind. auto ist die Standardeinstellung, wenn Tools vorhanden sind.

Name	Typ	Beschreibung	Erforderlich
Funktion	Objekt		Ja
└– Name	string	Der Name der funktion, die aufgerufen werden soll.	No
type	enum	Der Typ des Tools. Derzeit wird nur `function` unterstützt. Mögliche Werte: `function`	Ja

OpenAI.ChatOutputPrediction

Basisdarstellung der vorhergesagten Ausgabe eines Modells.

Diskriminator für OpenAI.ChatOutputPrediction

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`content`	OpenAI.ChatOutputPredictionContent

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.ChatOutputPredictionType		Ja

OpenAI.ChatOutputPredictionContent

Statischer vorhergesagter Ausgabeinhalt, z. B. der Inhalt einer Textdatei, die neu generiert wird.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Inhalt	Zeichenfolge oder Matrix		Ja
type	enum	Der Typ des vorhergesagten Inhalts, den Sie bereitstellen möchten. Dieser Typ ist derzeit immer `content`. Mögliche Werte: `content`	Ja

OpenAI.ChatOutputPredictionType

Eigentum	Wert
Typ	string
Werte	`content`

OpenAI.ChunkingStrategyRequestParam

Die Blockierungsstrategie, die verwendet wird, um die Datei(n) zu blöcken. Wenn sie nicht festgelegt ist, wird die auto Strategie verwendet.

Diskriminator für OpenAI.ChunkingStrategyRequestParam

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`static`	OpenAI.StaticChunkingStrategyRequestParam

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Die Art der Blockierungsstrategie. Mögliche Werte: `auto`, `static`	Ja

OpenAI.ChunkingStrategyResponseParam

Diskriminator für OpenAI.ChunkingStrategyResponseParam

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`other`	OpenAI.OtherChunkingStrategyResponseParam
`static`	OpenAI.StaticChunkingStrategyResponseParam

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Mögliche Werte: `static`, `other`	Ja

OpenAI.CodeInterpreterOutput

Diskriminator für OpenAI.CodeInterpreterOutput

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`image`	OpenAI.CodeInterpreterOutputImage
`logs`	OpenAI.CodeInterpreterOutputLogs

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.CodeInterpreterOutputType		Ja

OpenAI.CodeInterpreterOutputImage

Die Bildausgabe des Codedolmetschers.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Der Typ der Ausgabe. Immer „image“. Mögliche Werte: `image`	Ja
url	string	Die URL der Bildausgabe des Codedolmetschers.	Ja

OpenAI.CodeInterpreterOutputLogs

Die Protokolle werden vom Codedolmetscher ausgegeben.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
logs	string	Die Protokolle werden vom Codedolmetscher ausgegeben.	Ja
type	enum	Der Typ der Ausgabe. Immer „logs“. Mögliche Werte: `logs`	Ja

OpenAI.CodeInterpreterOutputType

Eigentum	Wert
Typ	string
Werte	`logs` `image`

OpenAI.CodeInterpreterTool

Ein Tool, das Python Code ausführt, um eine Antwort auf eine Eingabeaufforderung zu generieren.

Name	Typ	Beschreibung	Erforderlich
container	Objekt	Konfiguration für einen Codedolmetschercontainer. Geben Sie optional die IDs der Dateien an, für die der Code ausgeführt werden soll.	Ja
└– file_ids	array	Eine optionale Liste der hochgeladenen Dateien, die Ihrem Code zur Verfügung gestellt werden sollen.	No
└– Typ	enum	Immer `auto`. Mögliche Werte: `auto`	No
type	enum	Der Typ des Codedolmetschertools. Immer `code_interpreter`. Mögliche Werte: `code_interpreter`	Ja

OpenAI.CodeInterpreterToolAuto

Konfiguration für einen Codedolmetschercontainer. Geben Sie optional die IDs der Dateien an, für die der Code ausgeführt werden soll.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Datei-IDs	array	Eine optionale Liste der hochgeladenen Dateien, die Ihrem Code zur Verfügung gestellt werden sollen.	No
type	enum	Immer `auto`. Mögliche Werte: `auto`	Ja

OpenAI.CodeInterpreterToolCallItemParam

Ein Toolaufruf zum Ausführen von Code.

Name	Typ	Beschreibung	Erforderlich
code	string	Der auszuführende Code oder null, falls nicht verfügbar.	Ja
container_id	string	Die ID des Containers, der zum Ausführen des Codes verwendet wird.	Ja
Ergebnisse	array	Die vom Codedolmetscher generierten Ausgaben, z. B. Protokolle oder Bilder. Kann null sein, wenn keine Ausgaben verfügbar sind.	Ja
type	enum	Mögliche Werte: `code_interpreter_call`	Ja

OpenAI.CodeInterpreterToolCallItemResource

Ein Toolaufruf zum Ausführen von Code.

Name	Typ	Beschreibung	Erforderlich
code	string	Der auszuführende Code oder null, falls nicht verfügbar.	Ja
container_id	string	Die ID des Containers, der zum Ausführen des Codes verwendet wird.	Ja
Ergebnisse	array	Die vom Codedolmetscher generierten Ausgaben, z. B. Protokolle oder Bilder. Kann null sein, wenn keine Ausgaben verfügbar sind.	Ja
Status	enum	Mögliche Werte: `in_progress`, , `completedincomplete`, , `interpretingfailed`	Ja
type	enum	Mögliche Werte: `code_interpreter_call`	Ja

OpenAI.Vergleichsfilter

Ein Filter zum Vergleichen eines angegebenen Attributschlüssels mit einem bestimmten Wert mithilfe eines definierten Vergleichsvorgangs.

Name	Typ	Beschreibung	Erforderlich
Schlüssel	string	Der Schlüssel, der mit dem Wert verglichen werden soll.	Ja
type	enum	Gibt den Vergleichsoperator an: `eq`, `ne`, `gt`, `gte`, , . `ltlte` - `eq`: entspricht - `ne`: ungleich - `gt`: größer als - `gte`: größer oder gleich - `lt`: kleiner als - `lte`: kleiner oder gleich. Mögliche Werte: `eq`, , `ne`, `gtgte`, , , `ltlte`	Ja
value	Zeichenfolge oder Zahl oder boolescher Wert		Ja

OpenAI.CompletionUsage

Nutzungsstatistiken für die Abschlussanforderung.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
completion_tokens	Ganzzahl	Anzahl der Token im generierten Abschluss.	Ja	0
completion_tokens_details	Objekt	Aufschlüsselung der in einem Abschluss verwendeten Token.	No
└– akzeptierte_Vorhersage_Token	Ganzzahl	Bei Verwendung von "Vorhergesagte Ausgaben" gibt es die Anzahl der Token in der Vorhersage, die im Abschluss angezeigt wurde.	No	0
└– audio_tokens	Ganzzahl	Vom Modell generierte Audioeingabetoken.	No	0
└– reasoning_tokens	Ganzzahl	Vom Modell generierte Token zur Begründung.	No	0
└– rejected_prediction_tokens	Ganzzahl	Bei Verwendung von vorhergesagten Ausgaben wird die Anzahl der Token in der Vorhersage, die nicht im Abschluss angezeigt wurden. Wie aus Gründen versehene Token werden diese Token jedoch weiterhin in den Gesamtabschlusstoken für Abrechnungs-, Ausgabe- und Kontextfensterbeschränkungen gezählt.	No	0
prompt_tokens	Ganzzahl	Anzahl der Token in der Eingabeaufforderung.	Ja	0
prompt_tokens_details	Objekt	Aufschlüsselung der in der Eingabeaufforderung verwendeten Token.	No
└– audio_tokens	Ganzzahl	Audioeingabetoken, die in der Eingabeaufforderung vorhanden sind.	No	0
└– zwischengespeicherte_Token	Ganzzahl	Zwischengespeicherte Token, die in der Eingabeaufforderung vorhanden sind.	No	0
Gesamtanzahl Tokens	Ganzzahl	Die Gesamtzahl der in der Anforderung verwendeten Token (Aufforderung + Abschluss).	Ja	0

OpenAI.CompoundFilter

Kombinieren mehrerer Filter mit and oder or.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Filter	array	Array von Filtern, die kombiniert werden sollen. Elemente können sein `ComparisonFilter` oder `CompoundFilter`.	Ja
type	enum	Typ des Vorgangs: `and` oder `or`. Mögliche Werte: `and`, `or`	Ja

OpenAI.ComputerAction

Diskriminator für OpenAI.ComputerAction

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	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	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.ComputerActionType		Ja

OpenAI.ComputerActionClick

Eine Klickaktion.

Name	Typ	Beschreibung	Erforderlich
button	enum	Gibt an, welche Maustaste während des Klickens gedrückt wurde. Einer von `left`, `right`, `wheel`, , `back`oder `forward`. Mögliche Werte: `left`, , `rightwheel`, , `backforward`	Ja
type	enum	Gibt den Ereignistyp an. Für eine Klickaktion ist diese Eigenschaft immer auf .`click` Mögliche Werte: `click`	Ja
x	Ganzzahl	Die x-Koordinate, an der der Klick aufgetreten ist.	Ja
Y	Ganzzahl	Die y-Koordinate, an der der Klick aufgetreten ist.	Ja

OpenAI.ComputerActionDoubleClick

Eine Doppelklickaktion.

Name	Typ	Beschreibung	Erforderlich
type	enum	Gibt den Ereignistyp an. Bei einer Doppelklickaktion ist diese Eigenschaft immer auf .`double_click` Mögliche Werte: `double_click`	Ja
x	Ganzzahl	Die x-Koordinate, an der der Doppelklick aufgetreten ist.	Ja
Y	Ganzzahl	Die y-Koordinate, an der der Doppelklick aufgetreten ist.	Ja

OpenAI.ComputerActionDrag

Eine Ziehaktion.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
path	array	Ein Array von Koordinaten, die den Pfad der Ziehaktion darstellen. Koordinaten werden als Array von Objekten angezeigt, z. B.`{ x: 100, y: 200 }, { x: 200, y: 300 }`	Ja
type	enum	Gibt den Ereignistyp an. Bei einer Ziehaktion ist diese Eigenschaft immer auf .`drag` Mögliche Werte: `drag`	Ja

OpenAI.ComputerActionKeyPress

Eine Sammlung von Keypressen, die das Modell durchführen möchte.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
keys	array	Die Kombination von Tasten, die das Modell anfordert, zu drücken. Dies ist ein Array von Zeichenfolgen, die jeweils einen Schlüssel darstellen.	Ja
type	enum	Gibt den Ereignistyp an. Bei einer Keypress-Aktion wird diese Eigenschaft immer auf `keypress`. Mögliche Werte: `keypress`	Ja

OpenAI.ComputerActionMove

Eine Mausbewegungsaktion.

Name	Typ	Beschreibung	Erforderlich
type	enum	Gibt den Ereignistyp an. Bei einer Verschiebungsaktion ist diese Eigenschaft immer auf .`move` Mögliche Werte: `move`	Ja
x	Ganzzahl	Die x-Koordinate, zu der verschoben werden soll.	Ja
Y	Ganzzahl	Die y-Koordinate, zu der verschoben werden soll.	Ja

OpenAI.ComputerActionScreenshot

Screenshotaktion.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Gibt den Ereignistyp an. Für eine Screenshotaktion ist diese Eigenschaft immer auf .`screenshot` Mögliche Werte: `screenshot`	Ja

OpenAI.ComputerActionScroll

Eine Bildlaufaktion.

Name	Typ	Beschreibung	Erforderlich
scroll_x	Ganzzahl	Der horizontale Bildlaufabstand.	Ja
scroll_y	Ganzzahl	Der vertikale Bildlaufabstand.	Ja
type	enum	Gibt den Ereignistyp an. Bei einer Bildlaufaktion ist diese Eigenschaft immer auf .`scroll` Mögliche Werte: `scroll`	Ja
x	Ganzzahl	Die x-Koordinate, an der der Bildlauf aufgetreten ist.	Ja
Y	Ganzzahl	Die y-Koordinate, an der der Bildlauf aufgetreten ist.	Ja

OpenAI.ComputerActionType

Eigentum	Wert
Typ	string
Werte	`screenshot` `click` `double_click` `scroll` `type` `wait` `keypress` `drag` `move`

OpenAI.ComputerActionTypeKeys

Eine Aktion, die in Text eingegeben werden soll.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Text	string	Der einzugebende Text.	Ja
type	enum	Gibt den Ereignistyp an. Bei einer Typaktion ist diese Eigenschaft immer auf .`type` Mögliche Werte: `type`	Ja

OpenAI.ComputerActionWait

Eine Warteaktion.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Gibt den Ereignistyp an. Für eine Warteaktion ist diese Eigenschaft immer auf .`wait` Mögliche Werte: `wait`	Ja

OpenAI.ComputerToolCallItemParam

Ein Toolaufruf an einen Computer, der das Tool verwendet.

Name	Typ	Beschreibung	Erforderlich
action	OpenAI.ComputerAction		Ja
call_id	string	Ein Bezeichner, der beim Antworten auf den Toolaufruf mit Ausgabe verwendet wird.	Ja
pending_safety_checks	array	Die ausstehenden Sicherheitsprüfungen für den Computeranruf.	Ja
type	enum	Mögliche Werte: `computer_call`	Ja

OpenAI.ComputerToolCallItemResource

Ein Toolaufruf an einen Computer, der das Tool verwendet.

Name	Typ	Beschreibung	Erforderlich
action	OpenAI.ComputerAction		Ja
call_id	string	Ein Bezeichner, der beim Antworten auf den Toolaufruf mit Ausgabe verwendet wird.	Ja
pending_safety_checks	array	Die ausstehenden Sicherheitsprüfungen für den Computeranruf.	Ja
Status	enum	Der Status des Elements. Einer von `in_progress`, `completed`, oder `incomplete`. Aufgefüllt, wenn Elemente über DIE API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Mögliche Werte: `computer_call`	Ja

OpenAI.ComputerToolCallOutputItemOutput

Diskriminator für OpenAI.ComputerToolCallOutputItemOutput

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`computer_screenshot`	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.ComputerToolCallOutputItemOutputType	Ein Screenshotbild des Computers, das mit dem Computerverwendungstool verwendet wird.	Ja

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Name	Typ	Beschreibung	Erforderlich
Datei-ID	string		No
image_url	string		No
type	enum	Mögliche Werte: `computer_screenshot`	Ja

OpenAI.ComputerToolCallOutputItemOutputType

Ein Screenshotbild des Computers, das mit dem Computerverwendungstool verwendet wird.

Eigentum	Wert
Beschreibung	Ein Screenshotbild des Computers, das mit dem Computerverwendungstool verwendet wird.
Typ	string
Werte	`computer_screenshot`

OpenAI.ComputerToolCallOutputItemParam

Die Ausgabe eines Computertoolaufrufs.

Name	Typ	Beschreibung	Erforderlich
acknowledged_safety_checks	array	Die von der API gemeldeten Sicherheitskontrollen, die vom Entwickler bestätigt wurden.	No
call_id	string	Die ID des Computertoolaufrufs, der die Ausgabe erzeugt hat.	Ja
Ausgabe	OpenAI.ComputerToolCallOutputItemOutput		Ja
type	enum	Mögliche Werte: `computer_call_output`	Ja

OpenAI.ComputerToolCallOutputItemResource

Die Ausgabe eines Computertoolaufrufs.

Name	Typ	Beschreibung	Erforderlich
acknowledged_safety_checks	array	Die von der API gemeldeten Sicherheitskontrollen, die vom Entwickler bestätigt wurden.	No
call_id	string	Die ID des Computertoolaufrufs, der die Ausgabe erzeugt hat.	Ja
Ausgabe	OpenAI.ComputerToolCallOutputItemOutput		Ja
Status	enum	Der Status des Elements. Einer von `in_progress`, `completed`, oder `incomplete`. Aufgefüllt, wenn Elemente über DIE API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Mögliche Werte: `computer_call_output`	Ja

OpenAI.ComputerToolCallSafetyCheck

Eine ausstehende Sicherheitsüberprüfung für den Computeranruf.

Name	Typ	Beschreibung	Erforderlich
code	string	Der Typ der ausstehenden Sicherheitsüberprüfung.	Ja
id	string	Die ID der ausstehenden Sicherheitsüberprüfung.	Ja
Nachricht	string	Details zur ausstehenden Sicherheitsüberprüfung.	Ja

OpenAI.ComputerUsePreviewTool

Ein Tool, das einen virtuellen Computer steuert.

Name	Typ	Beschreibung	Erforderlich
Anzeigehöhe	Ganzzahl	Die Höhe der Computeranzeige.	Ja
Bildschirmbreite	Ganzzahl	Die Breite der Computeranzeige.	Ja
environment	enum	Der Typ der zu steuernden Computerumgebung. Mögliche Werte: `windows`, , `maclinux`, , `ubuntubrowser`	Ja
type	enum	Der Typ des Computerverwendungstools. Immer `computer_use_preview`. Mögliche Werte: `computer_use_preview`	Ja

OpenAI.Coordinate

Ein x/y-Koordinatenpaar, z. B. { x: 100, y: 200 }.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
x	Ganzzahl	Die x-Koordinate.	Ja
Y	Ganzzahl	Die y-Koordinate.	Ja

OpenAI.CreateEmbeddingResponse

Name	Typ	Beschreibung	Erforderlich
data	array	Die Liste der vom Modell generierten Einbettungen.	Ja
Modell	string	Der Name des Modells, das zum Generieren der Einbettung verwendet wird.	Ja
Objekt	enum	Der Objekttyp, der immer "liste" ist. Mögliche Werte: `list`	Ja
Nutzung	Objekt	Die Nutzungsinformationen für die Anforderung.	Ja
└– prompt_tokens	Ganzzahl	Die Anzahl der von der Eingabeaufforderung verwendeten Token.	No
└– total_tokens	Ganzzahl	Die Gesamtzahl der von der Anforderung verwendeten Token.	No

OpenAI.CreateEvalItem

Eine Chatnachricht, aus der die Eingabeaufforderung oder der Kontext besteht. Kann variable Verweise auf den item Namespace enthalten, also {{item.name}}.

Name	Typ	Beschreibung	Erforderlich
Inhalt	string oder OpenAI.EvalItemContent	Texteingaben für das Modell – können Vorlagenzeichenfolgen enthalten.	Ja
Rolle	enum	Die Rolle der Nachrichteneingabe. Einer von `user`, `assistant`, , `system`oder `developer`. Mögliche Werte: `user`, , `assistant`, `systemdeveloper`	Ja
type	enum	Der Typ der Nachrichteneingabe. Immer `message`. Mögliche Werte: `message`	No

OpenAI.CreateEvalRunRequest

Name	Typ	Beschreibung	Erforderlich
Datenquelle	Objekt		Ja
└– Typ	OpenAI.EvalRunDataSourceType		No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
Name	string	Der Name der Ausführung.	No

OpenAI.CreateFineTuningJobRequest

Gültige Modelle:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Hyperparameter	Objekt	Die hyperparameter, die für den Feinabstimmungsauftrag verwendet werden. Dieser Wert ist nun zugunsten des `method`Parameters veraltet und sollte unter dem `method` Parameter übergeben werden.	No
└- batch_size	enum	Mögliche Werte: `auto`	No
└– Lernraten-Multiplikator	enum	Mögliche Werte: `auto`	No
└– n_epochs	enum	Mögliche Werte: `auto`	No
Integrationen	array	Eine Liste der Integrationen, die Für Ihren Feinabstimmungsauftrag aktiviert werden sollen.	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
method	OpenAI.FineTuneMethod	Die Methode, die für die Feinabstimmung verwendet wird.	No
Modell	Zeichenfolge (siehe gültige Modelle unten)	Der Name des Modells, das optimiert werden soll.	Ja
seed	Ganzzahl	Der Seed steuert die Reproduzierbarkeit des Auftrags. Das Übergeben desselben Ausgangs- und Auftragsparameters sollte die gleichen Ergebnisse erzielen, kann sich aber in seltenen Fällen unterscheiden. Wenn kein Seed angegeben ist, wird ein Seed für Sie generiert.	No
Suffix	string	Eine Zeichenfolge von bis zu 64 Zeichen, die ihrem fein abgestimmten Modellnamen hinzugefügt werden. Beispielsweise würde ein `suffix` "custom-model-name" einen Modellnamen wie `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.	No	Nichts
Trainingsdatei	string	Die ID einer hochgeladenen Datei, die Schulungsdaten enthält. Ihr Dataset muss als JSONL-Datei formatiert werden. Darüber hinaus müssen Sie Ihre Datei mit dem Zweck `fine-tune`hochladen. Der Inhalt der Datei sollte je nachdem, ob das Modell das Chat-, Abschlussformat verwendet oder wenn die Feinabstimmungsmethode das Einstellungsformat verwendet.	Ja
Validierungsdatei	string	Die ID einer hochgeladenen Datei, die Überprüfungsdaten enthält. Wenn Sie diese Datei angeben, werden die Daten verwendet, um während der Feinabstimmung regelmäßig Validierungsmetriken zu generieren. Diese Metriken können in der Feinabstimmungsergebnisdatei angezeigt werden. Die gleichen Daten sollten nicht sowohl in Train- als auch in Validierungsdateien vorhanden sein. Ihr Dataset muss als JSONL-Datei formatiert werden. Sie müssen Ihre Datei mit dem Zweck `fine-tune`hochladen.	No

OpenAI.CreateFineTuningJobRequestIntegration

Diskriminator für OpenAI.CreateFineTuningJobRequestIntegration

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`wandb`	OpenAI.CreateFineTuningJobRequestWandbIntegration

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	Zeichenfolge (siehe gültige Modelle unten)		Ja

OpenAI.CreateFineTuningJobRequestWandbIntegration

Name	Typ	Beschreibung	Erforderlich
type	enum	Mögliche Werte: `wandb`	Ja
wandb	Objekt		Ja
└– Entität	string		No
└– Name	string		No
└– Projekt	string		No
└- Tags	array		No

OpenAI.CreateVectorStoreFileBatchRequest

Name	Typ	Beschreibung	Erforderlich
attributes	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen, Booleanen oder Zahlen.	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Die Blockierungsstrategie, die verwendet wird, um die Datei(n) zu blöcken. Wenn sie nicht festgelegt ist, wird die `auto` Strategie verwendet.	No
Datei-IDs	array	Eine Liste der Datei-IDs, die der Vektorspeicher verwenden soll. Nützlich für Tools wie `file_search` den Zugriff auf Dateien.	Ja

OpenAI.CreateVectorStoreFileRequest

Name	Typ	Beschreibung	Erforderlich
attributes	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen, Booleanen oder Zahlen.	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Die Blockierungsstrategie, die verwendet wird, um die Datei(n) zu blöcken. Wenn sie nicht festgelegt ist, wird die `auto` Strategie verwendet.	No
Datei-ID	string	Eine Datei-ID, die der Vektorspeicher verwenden soll. Nützlich für Tools wie `file_search` den Zugriff auf Dateien.	Ja

OpenAI.CreateVectorStoreRequest

Name	Typ	Beschreibung	Erforderlich
chunking_strategy	Objekt	Die Standardstrategie. Diese Strategie verwendet derzeit eine `max_chunk_size_tokens` von `800` und `chunk_overlap_tokens` von `400`.	No
└– statisch	OpenAI.StaticChunkingStrategy		No
└– Typ	enum	Immer `static`. Mögliche Werte: `static`	No
expires_after	OpenAI.VectorStoreExpirationAfter	Die Ablaufrichtlinie für einen Vektorspeicher.	No
Datei-IDs	array	Eine Liste der Datei-IDs, die der Vektorspeicher verwenden soll. Nützlich für Tools wie `file_search` den Zugriff auf Dateien.	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
Name	string	Der Name des Vektorspeichers.	No

OpenAI.DeleteFileResponse

Name	Typ	Beschreibung	Erforderlich
gelöscht	Boolescher Wert		Ja
id	string		Ja
Objekt	enum	Mögliche Werte: `file`	Ja

OpenAI.DeleteVectorStoreFileResponse

Name	Typ	Beschreibung	Erforderlich
gelöscht	Boolescher Wert		Ja
id	string		Ja
Objekt	enum	Mögliche Werte: `vector_store.file.deleted`	Ja

OpenAI.DeleteVectorStoreResponse

Name	Typ	Beschreibung	Erforderlich
gelöscht	Boolescher Wert		Ja
id	string		Ja
Objekt	enum	Mögliche Werte: `vector_store.deleted`	Ja

OpenAI.Embedding

Stellt einen einbettenden Vektor dar, der vom Einbettungsendpunkt zurückgegeben wird.

Name	Typ	Beschreibung	Erforderlich
Einbetten	Array oder Zeichenfolge		Ja
index	Ganzzahl	Der Index der Einbettung in der Liste der Einbettungen.	Ja
Objekt	enum	Der Objekttyp, der immer "einbetten" ist. Mögliche Werte: `embedding`	Ja

OpenAI.Eval

Ein Eval-Objekt mit einer Datenquellenkonfiguration und Testkriterien. Eine Eval stellt eine Aufgabe dar, die für Ihre LLM-Integration durchgeführt werden soll. Mögen:

Verbessern der Qualität meines Chatbots
Sehen Sie, wie gut mein Chatbot den Kundensupport verarbeitet
Überprüfen Sie, ob o4-mini bei meinem Usecase besser ist als gpt-4o

Name	Typ	Beschreibung	Erforderlich	Vorgabe
erstellt_am	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) für den Zeitpunkt der Erstellung des Evals.	Ja
Datenquellenkonfiguration	Objekt		Ja
└– Typ	OpenAI.EvalDataSourceConfigType		No
id	string	Eindeutiger Bezeichner für die Auswertung.	Ja
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	Ja
Name	string	Der Name der Auswertung.	Ja
Objekt	enum	Der Objekttyp. Mögliche Werte: `eval`	Ja
Testkriterien	array	Eine Liste der Testkriterien.	Ja	Nichts

OpenAI.EvalApiError

Ein Objekt, das eine Fehlerantwort der Eval-API darstellt.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
code	string	Der Fehlercode.	Ja
Nachricht	string	Die Fehlermeldung.	Ja

OpenAI.EvalCompletionsRunDataSourceParams

Ein CompletionsRunDataSource-Objekt, das eine Modellsamplingkonfiguration beschreibt.

Name	Typ	Beschreibung	Erforderlich
Eingabenachrichten	Objekt		No
└– item_reference	string	Ein Verweis auf eine Variable im `item` Namespace. d.h., „item.input_trajectory“	No
└- Vorlage	array	Eine Liste der Chatnachrichten, die die Eingabeaufforderung oder den Kontext bilden. Kann variable Verweise auf den `item` Namespace enthalten, also {{item.name}}.	No
└– Typ	enum	Der Typ der Eingabemeldungen. Immer `item_reference`. Mögliche Werte: `item_reference`	No
Modell	string	Der Name des Modells, das zum Generieren von Fertigstellungen verwendet werden soll (z. B. "o3-mini").	No
Parameter für Stichprobennahme	AzureEvalAPICompletionsSamplingParams		No
source	Objekt		Ja
└– Inhalt	array	Der Inhalt der JSONL-Datei.	No
└– erstellt_nach	Ganzzahl	Ein optionaler Unix-Zeitstempel zum Filtern von Elementen, die nach dieser Zeit erstellt wurden.	No
└– created_before	Ganzzahl	Ein optionaler Unix-Zeitstempel zum Filtern von Elementen, die vor dieser Zeit erstellt wurden.	No
└– ID	string	Der Bezeichner der Datei.	No
└– Grenzwert	Ganzzahl	Eine optionale maximale Anzahl von Elementen, die zurückgegeben werden sollen.	No
└- Metadaten	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
└─ Modell	string	Ein optionales Modell zum Filtern nach (z. B. "gpt-4o").	No
└– Typ	enum	Der Quelltyp. Immer `stored_completions`. Mögliche Werte: `stored_completions`	No
type	enum	Der Typ der Ausführungsdatenquelle. Immer `completions`. Mögliche Werte: `completions`	Ja

OpenAI.EvalCustomDataSourceConfigParams

Ein CustomDataSourceConfig -Objekt, das das Schema für die Datenquelle definiert, die für die Auswertung verwendet wird. Dieses Schema wird verwendet, um das Shape der Daten zu definieren, die folgendes sein werden:

Wird verwendet, um Ihre Testkriterien zu definieren und
Welche Daten beim Erstellen einer Ausführung erforderlich sind

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Beispielschema einfügen	Boolescher Wert	Gibt an, ob die Auswertung davon ausgehen soll, dass Sie den Beispielnamespace auffüllen (d. h. durch Generieren von Antworten aus Der Datenquelle)	No	Falsch
Artikel-Schema	Objekt	Das JSON-Schema für jede Zeile in der Datenquelle.	Ja
type	enum	Der Typ der Datenquelle. Immer `custom`. Mögliche Werte: `custom`	Ja

OpenAI.EvalCustomDataSourceConfigResource

Eine CustomDataSourceConfig, die das Schema Ihrer item und optional sample Namespaces angibt. Das Antwortschema definiert das Shape der Daten, die folgendes sein werden:

Wird verwendet, um Ihre Testkriterien zu definieren und
Welche Daten beim Erstellen einer Ausführung erforderlich sind

Name	Typ	Beschreibung	Erforderlich	Vorgabe
schema	Objekt	Das JSON-Schema für die Ausführen von Datenquellenelementen. Hier erfahren Sie, wie Sie JSON-Schemas erstellen.	Ja
type	enum	Der Typ der Datenquelle. Immer `custom`. Mögliche Werte: `custom`	Ja

OpenAI.EvalDataSourceConfigParams

Diskriminator für OpenAI.EvalDataSourceConfigParams

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`custom`	OpenAI.EvalCustomDataSourceConfigParams
`logs`	OpenAI.EvalLogsDataSourceConfigParams
`stored_completions`	OpenAI.EvalStoredCompletionsDataSourceConfigParams

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.EvalDataSourceConfigType		Ja

OpenAI.EvalDataSourceConfigResource

Diskriminator für OpenAI.EvalDataSourceConfigResource

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`custom`	OpenAI.EvalCustomDataSourceConfigResource
`stored_completions`	OpenAI.EvalStoredCompletionsDataSourceConfigResource
`logs`	OpenAI.EvalLogsDataSourceConfigResource

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.EvalDataSourceConfigType		Ja

OpenAI.EvalDataSourceConfigType

Eigentum	Wert
Typ	string
Werte	`custom` `logs` `stored_completions`

OpenAI.EvalGraderLabelModelParams

Ein LabelModelGrader -Objekt, das ein Modell verwendet, um jedem Element in der Auswertung Bezeichnungen zuzuweisen.

Name	Typ	Beschreibung	Erforderlich
input	array	Eine Liste der Chatnachrichten, die die Eingabeaufforderung oder den Kontext bilden. Kann variable Verweise auf den `item` Namespace enthalten, also {{item.name}}.	Ja
labels	array	Die Bezeichnungen, die für jedes Element in der Auswertung klassifiziert werden sollen.	Ja
Modell	string	Das Modell, das für die Auswertung verwendet werden soll. Muss strukturierte Ausgaben unterstützen.	Ja
Name	string	Der Name des Graders.	Ja
passing_labels	array	Die Beschriftungen, die ein übergebendes Ergebnis angeben. Muss eine Teilmenge von Bezeichnungen sein.	Ja
type	enum	Der Objekttyp, der immer `label_model`ist. Mögliche Werte: `label_model`	Ja

OpenAI.EvalGraderLabelModelResource

Name	Typ	Beschreibung	Erforderlich
input	array		Ja
labels	array	Die Bezeichnungen, die jedem Element in der Auswertung zugewiesen werden sollen.	Ja
Modell	string	Das Modell, das für die Auswertung verwendet werden soll. Muss strukturierte Ausgaben unterstützen.	Ja
Name	string	Der Name des Graders.	Ja
passing_labels	array	Die Beschriftungen, die ein übergebendes Ergebnis angeben. Muss eine Teilmenge von Bezeichnungen sein.	Ja
type	enum	Der Objekttyp, der immer `label_model`ist. Mögliche Werte: `label_model`	Ja

OpenAI.EvalGraderParams

Diskriminator für OpenAI.EvalGraderParams

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`label_model`	OpenAI.EvalGraderLabelModelParams
`string_check`	OpenAI.EvalGraderStringCheckParams
`text_similarity`	OpenAI.EvalGraderTextSimilarityParams
`python`	OpenAI.EvalGraderPythonParams
`score_model`	OpenAI.EvalGraderScoreModelParams

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.GraderType		Ja

OpenAI.EvalGraderPythonParams

Name	Typ	Beschreibung	Erforderlich
image_tag	string	Das Bildtag, das für das Python-Skript verwendet werden soll.	No
Name	string	Der Name des Graders.	Ja
Schwellenwert erreichen	number	Der Schwellenwert für die Bewertung.	No
source	string	Der Quellcode des Python-Skripts.	Ja
type	enum	Der Objekttyp, der immer `python`ist. Mögliche Werte: `python`	Ja

OpenAI.EvalGraderPythonResource

Name	Typ	Beschreibung	Erforderlich
image_tag	string	Das Bildtag, das für das Python-Skript verwendet werden soll.	No
Name	string	Der Name des Graders.	Ja
Schwellenwert erreichen	number	Der Schwellenwert für die Bewertung.	No
source	string	Der Quellcode des Python-Skripts.	Ja
type	enum	Der Objekttyp, der immer `python`ist. Mögliche Werte: `python`	Ja

OpenAI.EvalGraderResource

Diskriminator für OpenAI.EvalGraderResource

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`label_model`	OpenAI.EvalGraderLabelModelResource
`text_similarity`	OpenAI.EvalGraderTextSimilarityResource
`python`	OpenAI.EvalGraderPythonResource
`score_model`	OpenAI.EvalGraderScoreModelResource

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.GraderType		Ja

OpenAI.EvalGraderScoreModelParams

Name	Typ	Beschreibung	Erforderlich
input	array	Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten.	Ja
Modell	string	Das Modell, das für die Auswertung verwendet werden soll.	Ja
Name	string	Der Name des Graders.	Ja
Schwellenwert erreichen	number	Der Schwellenwert für die Bewertung.	No
Bereich	array	Der Bereich der Bewertung. Standardwert ist .`[0, 1]`	No
Parameter für Stichprobennahme		Die Samplingparameter für das Modell.	No
type	enum	Der Objekttyp, der immer `score_model`ist. Mögliche Werte: `score_model`	Ja

OpenAI.EvalGraderScoreModelResource

Name	Typ	Beschreibung	Erforderlich
input	array	Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten.	Ja
Modell	string	Das Modell, das für die Auswertung verwendet werden soll.	Ja
Name	string	Der Name des Graders.	Ja
Schwellenwert erreichen	number	Der Schwellenwert für die Bewertung.	No
Bereich	array	Der Bereich der Bewertung. Standardwert ist .`[0, 1]`	No
Parameter für Stichprobennahme		Die Samplingparameter für das Modell.	No
type	enum	Der Objekttyp, der immer `score_model`ist. Mögliche Werte: `score_model`	Ja

OpenAI.EvalGraderStringCheckParams

Name	Typ	Beschreibung	Erforderlich
input	string	Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten.	Ja
Name	string	Der Name des Graders.	Ja
operation	enum	Der auszuführende Zeichenfolgenüberprüfungsvorgang. Einer von `eq`, `ne`, , `like`oder `ilike`. Mögliche Werte: `eq`, , `ne`, `likeilike`	Ja
Referenz	string	Der Bezugstext. Dies kann Vorlagenzeichenfolgen enthalten.	Ja
type	enum	Der Objekttyp, der immer `string_check`ist. Mögliche Werte: `string_check`	Ja

OpenAI.EvalGraderTextSimilarityParams

Name	Typ	Beschreibung	Erforderlich
Bewertungsmetrik	enum	Die zu verwendende Auswertungsmetrik. Einer von `fuzzy_match`, `bleu`, , `gleumeteor`, `rouge_1`, , `rouge_2`, `rouge_3`, `rouge_4`, , oder `rouge_5rouge_l`. Mögliche Werte: `fuzzy_match`, , `bleu`, `gleu`, `meteorrouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5rouge_l`	Ja
input	string	Der Text, der benotet wird.	Ja
Name	string	Der Name des Graders.	Ja
Schwellenwert erreichen	number	Der Schwellenwert für die Bewertung.	Ja
Referenz	string	Der Text, der abgestuft wird.	Ja
type	enum	Der Typ des Graders. Mögliche Werte: `text_similarity`	Ja

OpenAI.EvalGraderTextSimilarityResource

Name	Typ	Beschreibung	Erforderlich
Bewertungsmetrik	enum	Die zu verwendende Auswertungsmetrik. Einer von `fuzzy_match`, `bleu`, , `gleumeteor`, `rouge_1`, , `rouge_2`, `rouge_3`, `rouge_4`, , oder `rouge_5rouge_l`. Mögliche Werte: `fuzzy_match`, , `bleu`, `gleu`, `meteorrouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5rouge_l`	Ja
input	string	Der Text, der benotet wird.	Ja
Name	string	Der Name des Graders.	Ja
Schwellenwert erreichen	number	Der Schwellenwert für die Bewertung.	Ja
Referenz	string	Der Text, der abgestuft wird.	Ja
type	enum	Der Typ des Graders. Mögliche Werte: `text_similarity`	Ja

OpenAI.EvalItem

Eine Meldungseingabe für das Modell mit einer Rolle, die die folgende Hierarchie angibt. Anweisungen, die mit der developer Rolle angegeben werden, system haben Vorrang vor Anweisungen, die mit der user Rolle angegeben werden. Nachrichten mit der assistant Rolle werden davon ausgegangen, dass sie vom Modell in früheren Interaktionen generiert wurden.

Name	Typ	Beschreibung	Erforderlich
Inhalt	Objekt		Ja
└– Typ	OpenAI.EvalItemContentType		No
Rolle	enum	Die Rolle der Nachrichteneingabe. Einer von `user`, `assistant`, , `system`oder `developer`. Mögliche Werte: `user`, , `assistant`, `systemdeveloper`	Ja
type	enum	Der Typ der Nachrichteneingabe. Immer `message`. Mögliche Werte: `message`	No

OpenAI.EvalItemContent

Diskriminator für OpenAI.EvalItemContent

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`input_text`	OpenAI.EvalItemContentInputText
`output_text`	OpenAI.EvalItemContentOutputText

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.EvalItemContentType		Ja

OpenAI.EvalItemContentInputText

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Text	string		Ja
type	enum	Mögliche Werte: `input_text`	Ja

OpenAI.EvalItemContentOutputText

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Text	string		Ja
type	enum	Mögliche Werte: `output_text`	Ja

OpenAI.EvalItemContentType

Eigentum	Wert
Typ	string
Werte	`input_text` `output_text`

OpenAI.EvalJsonlRunDataSourceParams

Ein JsonlRunDataSource-Objekt mit dem eine JSONL-Datei angibt, die dem Eval entspricht

Name	Typ	Beschreibung	Erforderlich
source	Objekt		Ja
└– Inhalt	array	Der Inhalt der JSONL-Datei.	No
└– ID	string	Der Bezeichner der Datei.	No
└– Typ	enum	Der Typ der JSONL-Quelle. Immer `file_id`. Mögliche Werte: `file_id`	No
type	enum	Der Typ der Datenquelle. Immer `jsonl`. Mögliche Werte: `jsonl`	Ja

OpenAI.EvalList

Ein Objekt, das eine Liste von Evals darstellt.

Name	Typ	Beschreibung	Erforderlich
data	array	Ein Array von Eval-Objekten.	Ja
first_id	string	Der Bezeichner der ersten Auswertung im Datenarray.	Ja
has_more	Boolescher Wert	Gibt an, ob weitere Auswertungen verfügbar sind.	Ja
last_id	string	Der Bezeichner der letzten Auswertung im Datenarray.	Ja
Objekt	enum	Der Typ dieses Objekts. Es ist immer auf "liste" festgelegt. Mögliche Werte: `list`	Ja

OpenAI.EvalLogsDataSourceConfigParams

Eine Datenquellenkonfiguration, die die Metadateneigenschaft Ihrer Protokollabfrage angibt. Dies ist in der Regel Metadaten wie usecase=chatbot oder prompt-version=v2usw.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
type	enum	Der Typ der Datenquelle. Immer `logs`. Mögliche Werte: `logs`	Ja

OpenAI.EvalLogsDataSourceConfigResource

Eine LogsDataSourceConfig, die die Metadateneigenschaft Ihrer Protokollabfrage angibt. Dies ist in der Regel Metadaten wie usecase=chatbot oder prompt-version=v2usw. Das von dieser Datenquellenkonfiguration zurückgegebene Schema wird verwendet, um zu definieren, welche Variablen in Ihren Auswertungen verfügbar sind. item und sample sind beide definiert, wenn sie diese Datenquellenkonfiguration verwenden.

Name	Typ	Beschreibung	Erforderlich
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	Ja
schema	Objekt	Das JSON-Schema für die Ausführen von Datenquellenelementen. Hier erfahren Sie, wie Sie JSON-Schemas erstellen.	Ja
type	enum	Der Typ der Datenquelle. Immer `logs`. Mögliche Werte: `logs`	Ja

OpenAI.EvalResponsesRunDataSourceParams

Ein ResponsesRunDataSource-Objekt, das eine Modellsamplingkonfiguration beschreibt.

Name	Typ	Beschreibung	Erforderlich
Eingabenachrichten	Objekt		No
└– item_reference	string	Ein Verweis auf eine Variable im `item` Namespace. Das heißt, "item.name"	No
└- Vorlage	array	Eine Liste der Chatnachrichten, die die Eingabeaufforderung oder den Kontext bilden. Kann variable Verweise auf den `item` Namespace enthalten, also {{item.name}}.	No
└– Typ	enum	Der Typ der Eingabemeldungen. Immer `item_reference`. Mögliche Werte: `item_reference`	No
Modell	string	Der Name des Modells, das zum Generieren von Fertigstellungen verwendet werden soll (z. B. "o3-mini").	No
Parameter für Stichprobennahme	AzureEvalAPIResponseSamplingParams		No
source	Objekt		Ja
└– Inhalt	array	Der Inhalt der JSONL-Datei.	No
└– erstellt_nach	Ganzzahl	Nur Elemente enthalten, die nach diesem Zeitstempel (einschließlich) erstellt wurden. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
└– created_before	Ganzzahl	Nur Elemente enthalten, die vor diesem Zeitstempel (einschließlich) erstellt wurden. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
└– ID	string	Der Bezeichner der Datei.	No
└– instructions_search	string	Optionale Zeichenfolge zum Durchsuchen des Felds "Anweisungen". Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
└- Metadaten	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
└─ Modell	string	Der Name des Modells, für das Antworten gesucht werden sollen. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
└– reasoning_effort	OpenAI.ReasoningEffort	Optionaler Argumentierungsaufwandsparameter. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
└– Temperatur	number	Die Temperatur für die Stichprobenentnahme. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
└- Werkzeuge	array	Liste der Toolnamen. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
└– top_p	number	Kernsamplingparameter. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
└– Typ	enum	Der Typ der Ausführungsdatenquelle. Immer `responses`. Mögliche Werte: `responses`	No
└– Benutzer	array	Liste der Benutzerbezeichner. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
type	enum	Der Typ der Ausführungsdatenquelle. Immer `responses`. Mögliche Werte: `responses`	Ja

OpenAI.EvalRun

Ein Schema, das eine Auswertungsausführung darstellt.

Name	Typ	Beschreibung	Erforderlich
erstellt_am	Ganzzahl	Unix-Zeitstempel (in Sekunden) beim Erstellen des Auswertungslaufs.	Ja
Datenquelle	Objekt		Ja
└– Typ	OpenAI.EvalRunDataSourceType		No
Fehler	OpenAI.EvalApiError	Ein Objekt, das eine Fehlerantwort der Eval-API darstellt.	Ja
eval_id	string	Der Bezeichner der zugeordneten Auswertung.	Ja
id	string	Eindeutiger Bezeichner für die Auswertungsausführung.	Ja
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	Ja
Modell	string	Das Modell, das ausgewertet wird, falls zutreffend.	Ja
Name	string	Der Name der Auswertungsausführung.	Ja
Objekt	enum	Der Typ des Objekts. Immer „eval.run“ Mögliche Werte: `eval.run`	Ja
pro_Modell_Nutzung	array	Nutzungsstatistiken für jedes Modell während der Auswertungsausführung.	Ja
Ergebnisse_pro_Testkriterien	array	Ergebnisse pro Testkriterien, die während der Auswertungsausführung angewendet werden.	Ja
report_url	string	Die URL zum gerenderten Auswertungsausführungsbericht im UI-Dashboard.	Ja
Ergebnisanzahl	Objekt	Indikatoren, die die Ergebnisse der Auswertungsausführung zusammenfassen.	Ja
└– fehler	Ganzzahl	Anzahl der Ausgabeelemente, die zu einem Fehler geführt haben.	No
└– fehlgeschlagen	Ganzzahl	Anzahl der Ausgabeelemente, die die Auswertung nicht bestanden haben.	No
└– bestanden	Ganzzahl	Anzahl der Ausgabeelemente, die die Auswertung bestanden haben.	No
└– Gesamtsumme	Ganzzahl	Gesamtanzahl der ausgeführten Ausgabeelemente.	No
Status	string	Der Status der Auswertungsausführung.	Ja

OpenAI.EvalRunDataContentSource

Diskriminator für OpenAI.EvalRunDataContentSource

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`file_id`	OpenAI.EvalRunFileIdDataContentSource
`stored_completions`	OpenAI.EvalRunStoredCompletionsDataContentSource
`responses`	OpenAI.EvalRunResponsesDataContentSource

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.EvalRunDataContentSourceType		Ja

OpenAI.EvalRunDataContentSourceType

Eigentum	Wert
Typ	string
Werte	`file_id` `file_content` `stored_completions` `responses`

OpenAI.EvalRunDataSourceCompletionsResource

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Mögliche Werte: `completions`	Ja

OpenAI.EvalRunDataSourceJsonlResource

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Mögliche Werte: `jsonl`	Ja

OpenAI.EvalRunDataSourceParams

Diskriminator für OpenAI.EvalRunDataSourceParams

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`jsonl`	OpenAI.EvalJsonlRunDataSourceParams
`completions`	OpenAI.EvalCompletionsRunDataSourceParams
`responses`	OpenAI.EvalResponsesRunDataSourceParams

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.EvalRunDataSourceType		Ja

OpenAI.EvalRunDataSourceResource

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.EvalRunDataSourceType		Ja

OpenAI.EvalRunDataSourceResponsesResource

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Mögliche Werte: `responses`	Ja

OpenAI.EvalRunDataSourceType

Eigentum	Wert
Typ	string
Werte	`jsonl` `completions` `responses`

OpenAI.EvalRunFileContentDataContentSource

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Inhalt	array	Der Inhalt der JSONL-Datei.	Ja
type	enum	Der Typ der JSONL-Quelle. Immer `file_content`. Mögliche Werte: `file_content`	Ja

OpenAI.EvalRunFileIdDataContentSource

Name	Typ	Beschreibung	Erforderlich	Vorgabe
id	string	Der Bezeichner der Datei.	Ja
type	enum	Der Typ der JSONL-Quelle. Immer `file_id`. Mögliche Werte: `file_id`	Ja

OpenAI.EvalRunList

Ein Objekt, das eine Liste von Läufen für eine Auswertung darstellt.

Name	Typ	Beschreibung	Erforderlich
data	array	Ein Array von eval run objects.	Ja
first_id	string	Der Bezeichner des ersten Eval-Vorgangs im Datenarray.	Ja
has_more	Boolescher Wert	Gibt an, ob weitere Auswertungen verfügbar sind.	Ja
last_id	string	Der Bezeichner der letzten Ausführung der Eval im Datenarray.	Ja
Objekt	enum	Der Typ dieses Objekts. Es ist immer auf "liste" festgelegt. Mögliche Werte: `list`	Ja

OpenAI.EvalRunOutputItem

Ein Schema, das ein Ausgabeelement für die Auswertungsausführung darstellt.

Name	Typ	Beschreibung	Erforderlich
erstellt_am	Ganzzahl	Unix-Zeitstempel (in Sekunden) beim Erstellen des Auswertungslaufs.	Ja
Datenquellenobjekt	Objekt	Details des Eingabedatenquellelements.	Ja
datasource_item_id	Ganzzahl	Der Bezeichner für das Datenquellenelement.	Ja
eval_id	string	Der Bezeichner der Auswertungsgruppe.	Ja
id	string	Eindeutiger Bezeichner für das Ausgabeelement für die Auswertungsausführung.	Ja
Objekt	enum	Der Typ des Objekts. Immer „eval.run.output_item“ Mögliche Werte: `eval.run.output_item`	Ja
results	array	Eine Liste der Ergebnisse aus der Auswertungsausführung.	Ja
run_id	string	Der Bezeichner der Auswertungsausführung, die diesem Ausgabeelement zugeordnet ist.	Ja
Beispiel	Objekt	Ein Beispiel, das die Eingabe und Ausgabe des Auswertungslaufs enthält.	Ja
└– Fehler	OpenAI.EvalApiError	Ein Objekt, das eine Fehlerantwort der Eval-API darstellt.	No
└- finish_reason	string	Der Grund, warum die Beispielgenerierung abgeschlossen wurde.	No
└– Eingabe	array	Ein Array von Eingabemeldungen.	No
└– max_completion_tokens	Ganzzahl	Die maximale Anzahl von Token, die für den Abschluss zulässig sind.	No
└─ Modell	string	Das Modell, das zum Generieren des Beispiels verwendet wird.	No
└─ Ausgabe	array	Ein Array von Ausgabemeldungen.	No
└- Samen	Ganzzahl	Der zum Generieren der Probe verwendete Ausgangswert.	No
└– Temperatur	number	Die verwendete Probenahmetemperatur.	No
└– top_p	number	Der top_p Wert, der für das Sampling verwendet wird.	No
└– Nutzung	Objekt	Details zur Tokenverwendung für das Beispiel.	No
└– zwischengespeicherte_Token	Ganzzahl	Die Anzahl der Token, die aus dem Cache abgerufen wurden.	No
└– completion_tokens	Ganzzahl	Die Anzahl der generierten Abschlusstoken.	No
└– prompt_tokens	Ganzzahl	Die Anzahl der verwendeten Eingabeaufforderungstoken.	No
└– total_tokens	Ganzzahl	Die Gesamtzahl der verwendeten Token.	No
Status	string	Der Status der Auswertungsausführung.	Ja

OpenAI.EvalRunOutputItemList

Ein Objekt, das eine Liste der Ausgabeelemente für eine Auswertungsausführung darstellt.

Name	Typ	Beschreibung	Erforderlich
data	array	Ein Array von eval run Output Item Objects.	Ja
first_id	string	Der Bezeichner des ersten Ausgabeelements "eval run" im Datenarray.	Ja
has_more	Boolescher Wert	Gibt an, ob mehr Ausgabeelemente für die Auswertung verfügbar sind.	Ja
last_id	string	Der Bezeichner des letzten Ausgabeelements der Eval-Ausführung im Datenarray.	Ja
Objekt	enum	Der Typ dieses Objekts. Es ist immer auf "liste" festgelegt. Mögliche Werte: `list`	Ja

OpenAI.EvalRunResponsesDataContentSource

Ein EvalResponsesSource-Objekt, das eine Run-Datenquellenkonfiguration beschreibt.

Name	Typ	Beschreibung	Erforderlich
created_after	Ganzzahl	Nur Elemente enthalten, die nach diesem Zeitstempel (einschließlich) erstellt wurden. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
erstellt_vor	Ganzzahl	Nur Elemente enthalten, die vor diesem Zeitstempel (einschließlich) erstellt wurden. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
instructions_search	string	Optionale Zeichenfolge zum Durchsuchen des Felds "Anweisungen". Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
Modell	string	Der Name des Modells, für das Antworten gesucht werden sollen. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
Denkanstrengung	Objekt	Nur o-Serienmodelle Beschränkt den Aufwand für die Begründung von Begründungsmodellen. Derzeit unterstützte Werte sind `low`, `medium`und `high`. Das Reduzieren von Gründen kann zu schnelleren Antworten und weniger Token führen, die bei der Begründung in einer Antwort verwendet werden.	No
Temperatur	number	Die Temperatur für die Stichprobenentnahme. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
tools	array	Liste der Toolnamen. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
top_p	number	Kernsamplingparameter. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No
type	enum	Der Typ der Ausführungsdatenquelle. Immer `responses`. Mögliche Werte: `responses`	Ja
users	array	Liste der Benutzerbezeichner. Dies ist ein Abfrageparameter, der zum Auswählen von Antworten verwendet wird.	No

OpenAI.EvalRunStoredCompletionsDataContentSource

Eine StoredCompletionsRunDataSource-Konfiguration, die eine Gruppe von Filtern beschreibt

Name	Typ	Beschreibung	Erforderlich
created_after	Ganzzahl	Ein optionaler Unix-Zeitstempel zum Filtern von Elementen, die nach dieser Zeit erstellt wurden.	No
erstellt_vor	Ganzzahl	Ein optionaler Unix-Zeitstempel zum Filtern von Elementen, die vor dieser Zeit erstellt wurden.	No
Begrenzung	Ganzzahl	Eine optionale maximale Anzahl von Elementen, die zurückgegeben werden sollen.	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	Ja
Modell	string	Ein optionales Modell zum Filtern nach (z. B. "gpt-4o").	No
type	enum	Der Quelltyp. Immer `stored_completions`. Mögliche Werte: `stored_completions`	Ja

OpenAI.EvalStoredCompletionsDataSourceConfigParams

Veraltet zugunsten von LogsDataSourceConfig.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
metadata	Objekt	Metadatenfilter für die gespeicherte Abschlussdatenquelle.	No
type	enum	Der Typ der Datenquelle. Immer `stored_completions`. Mögliche Werte: `stored_completions`	Ja

OpenAI.EvalStoredCompletionsDataSourceConfigResource

Veraltet zugunsten von LogsDataSourceConfig.

Name	Typ	Beschreibung	Erforderlich
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	Ja
schema	Objekt	Das JSON-Schema für die Ausführen von Datenquellenelementen. Hier erfahren Sie, wie Sie JSON-Schemas erstellen.	Ja
type	enum	Der Typ der Datenquelle. Immer `stored_completions`. Mögliche Werte: `stored_completions`	Ja

OpenAI.FileSearchTool

Ein Tool, das nach relevanten Inhalten aus hochgeladenen Dateien sucht.

Name	Typ	Beschreibung	Erforderlich
Filter	Objekt		No
max_anzahl_ergebnisse	Ganzzahl	Die maximale Anzahl der zurückzugebenden Ergebnisse. Diese Zahl sollte zwischen 1 und 50 (einschließlich) liegen.	No
Ranglistenoptionen	Objekt		No
└– Ranker	enum	Der Rangfolger, der für die Dateisuche verwendet werden soll. Mögliche Werte: `auto`, `default-2024-11-15`	No
└─ Punktschwelle	number	Der Schwellenwert für die Bewertung für die Dateisuche, eine Zahl zwischen 0 und 1. Zahlen, die näher an 1 sind, versuchen, nur die relevantesten Ergebnisse zurückzugeben, können aber weniger Ergebnisse zurückgeben.	No
type	enum	Der Typ des Dateisuchtools. Immer `file_search`. Mögliche Werte: `file_search`	Ja
vector_store_ids	array	Die IDs der zu durchsuchenden Vektorspeicher.	Ja

OpenAI.FileSearchToolCallItemParam

Die Ergebnisse eines Dateisuchtoolaufrufs.

Name	Typ	Beschreibung	Erforderlich
Abfragen	array	Die Zum Suchen nach Dateien verwendeten Abfragen.	Ja
results	array	Die Ergebnisse des Aufrufs des Dateisuchtools.	No
type	enum	Mögliche Werte: `file_search_call`	Ja

OpenAI.FileSearchToolCallItemResource

Die Ergebnisse eines Dateisuchtoolaufrufs.

Name	Typ	Beschreibung	Erforderlich
Abfragen	array	Die Zum Suchen nach Dateien verwendeten Abfragen.	Ja
results	array	Die Ergebnisse des Aufrufs des Dateisuchtools.	No
Status	enum	Der Status des Dateisuchtoolaufrufs. Einer von `in_progress`, `searching`, `incomplete` oder `failed`. Mögliche Werte: `in_progress`, , `searchingcompleted`, , `incompletefailed`	Ja
type	enum	Mögliche Werte: `file_search_call`	Ja

OpenAI.Filters

Name	Typ	Beschreibung	Erforderlich
Filter	array	Array von Filtern, die kombiniert werden sollen. Elemente können sein `ComparisonFilter` oder `CompoundFilter`.	Ja
Schlüssel	string	Der Schlüssel, der mit dem Wert verglichen werden soll.	Ja
type	enum	Typ des Vorgangs: `and` oder `or`. Mögliche Werte: `and`, `or`	Ja
value	Zeichenfolge oder Zahl oder boolescher Wert	Der Wert, der mit dem Attributschlüssel verglichen werden soll; unterstützt Zeichenfolgen-, Zahlen- oder boolesche Typen.	Ja

OpenAI.FineTuneDPOHyperparameters

Die hyperparameter, die für den DPO-Feinabstimmungsauftrag verwendet werden.

Name	Typ	Beschreibung	Erforderlich
Batch-Größe	enum	Mögliche Werte: `auto`	No
Beta	enum	Mögliche Werte: `auto`	No
Lernratenmultiplikator	enum	Mögliche Werte: `auto`	No
n_epochs	enum	Mögliche Werte: `auto`	No

OpenAI.FineTuneDPOMethod

Konfiguration für die DPO-Feinabstimmungsmethode.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Hyperparameter	OpenAI.FineTuneDPOHyperparameters	Die hyperparameter, die für den DPO-Feinabstimmungsauftrag verwendet werden.	No

OpenAI.FineTuneMethod

Die Methode, die für die Feinabstimmung verwendet wird.

Name	Typ	Beschreibung	Erforderlich
Dsb	OpenAI.FineTuneDPOMethod	Konfiguration für die DPO-Feinabstimmungsmethode.	No
Verstärkung	AzureFineTuneReinforcementMethod		No
überwacht	OpenAI.FineTuneSupervisedMethod	Konfiguration für die überwachte Feinabstimmungsmethode.	No
type	enum	Der Typ der Methode. Ist entweder `supervised`, , `dpo`oder `reinforcement`. Mögliche Werte: `supervised`, , `dporeinforcement`	Ja

OpenAI.FineTuneReinforcementHyperparameters

Die Hyperparameter, die für den Verstärkungs-Feinabstimmungsauftrag verwendet werden.

Name	Typ	Beschreibung	Erforderlich
Batch-Größe	enum	Mögliche Werte: `auto`	No
compute_multiplier	enum	Mögliche Werte: `auto`	No
eval_interval	enum	Mögliche Werte: `auto`	No
eval_samples	enum	Mögliche Werte: `auto`	No
Lernratenmultiplikator	enum	Mögliche Werte: `auto`	No
n_epochs	enum	Mögliche Werte: `auto`	No
Denkanstrengung	enum	Ebene des Grundaufwands. Mögliche Werte: `default`, , `low`, `mediumhigh`	No

OpenAI.FineTuneSupervisedHyperparameters

Die hyperparameter, die für den Feinabstimmungsauftrag verwendet werden.

Name	Typ	Beschreibung	Erforderlich
Batch-Größe	enum	Mögliche Werte: `auto`	No
Lernratenmultiplikator	enum	Mögliche Werte: `auto`	No
n_epochs	enum	Mögliche Werte: `auto`	No

OpenAI.FineTuneSupervisedMethod

Konfiguration für die überwachte Feinabstimmungsmethode.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Hyperparameter	OpenAI.FineTuneSupervisedHyperparameters	Die hyperparameter, die für den Feinabstimmungsauftrag verwendet werden.	No

OpenAI.FineTuningIntegration

Diskriminator für OpenAI.FineTuningIntegration

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`wandb`	OpenAI.FineTuningIntegrationWandb

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	Zeichenfolge (siehe gültige Modelle unten)		Ja

OpenAI.FineTuningIntegrationWandb

Name	Typ	Beschreibung	Erforderlich
type	enum	Der Typ der Integration, die für den Feinabstimmungsauftrag aktiviert wird. Mögliche Werte: `wandb`	Ja
wandb	Objekt	Die Einstellungen für Ihre Integration mit Gewichtungen und Biases. Diese Nutzlast gibt das Projekt an, an das Metriken gesendet werden. Optional können Sie einen expliziten Anzeigenamen für Ihre Ausführung festlegen, Ihrer Ausführung Tags hinzufügen und eine Standardentität (Team, Benutzername usw.) festlegen, die Ihrer Ausführung zugeordnet werden soll.	Ja
└– Entität	string	Die Entität, die für die Ausführung verwendet werden soll. Auf diese Weise können Sie das Team oder den Benutzernamen des WandB-Benutzers festlegen, den Sie der Ausführung zuordnen möchten. Wenn nicht festgelegt, wird die Standardentität für den registrierten WandB-API-Schlüssel verwendet.	No
└– Name	string	Ein Anzeigename, der für die Ausführung festgelegt werden soll. Wenn nicht festgelegt, verwenden wir die Auftrags-ID als Namen.	No
└– Projekt	string	Der Name des Projekts, unter dem die neue Ausführung erstellt wird.	No
└- Tags	array	Eine Liste der Tags, die an die neu erstellte Ausführung angefügt werden sollen. Diese Tags werden direkt an WandB weitergeleitet. Einige Standardtags werden von OpenAI generiert: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".	No

OpenAI.FineTuningJob

Das fine_tuning.job Objekt stellt einen Feinabstimmungsauftrag dar, der über die API erstellt wurde.

Name	Typ	Beschreibung	Erforderlich
erstellt_am	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) für die Erstellung des Feinabstimmungsauftrags.	Ja
Fehler	Objekt	Bei Feinabstimmungsaufträgen, die über `failed`verfügen, enthält dies weitere Informationen zur Ursache des Fehlers.	Ja
└– Code	string	Ein computerlesbarer Fehlercode.	No
└– Nachricht	string	Eine für Menschen lesbare Fehlermeldung.	No
└- param	string	Der Parameter, der ungültig war, in der Regel `training_file` oder `validation_file`. Dieses Feld ist NULL, wenn der Fehler nicht parameterspezifisch war.	No
geschätzte Fertigstellung	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) für den Abschluss des Feinabstimmungsauftrags. Der Wert ist NULL, wenn der Feinabstimmungsauftrag nicht ausgeführt wird.	No
fine_tuned_model	string	Der Name des fein abgestimmten Modells, das erstellt wird. Der Wert ist NULL, wenn der Feinabstimmungsauftrag noch ausgeführt wird.	Ja
finished_at	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) für den Abschluss des Feinabstimmungsauftrags. Der Wert ist NULL, wenn der Feinabstimmungsauftrag noch ausgeführt wird.	Ja
Hyperparameter	Objekt	Die hyperparameter, die für den Feinabstimmungsauftrag verwendet werden. Dieser Wert wird nur zurückgegeben, wenn Aufträge ausgeführt `supervised` werden.	Ja
└- batch_size	enum	Mögliche Werte: `auto`	No
└– Lernraten-Multiplikator	enum	Mögliche Werte: `auto`	No
└– n_epochs	enum	Mögliche Werte: `auto`	No
id	string	Der Objektbezeichner, auf den in den API-Endpunkten verwiesen werden kann.	Ja
Integrationen	array	Eine Liste der Integrationen, die für diesen Feinabstimmungsauftrag aktiviert werden sollen.	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	Ja
method	OpenAI.FineTuneMethod	Die Methode, die für die Feinabstimmung verwendet wird.	No
Modell	string	Das Basismodell, das fein abgestimmt wird.	Ja
Objekt	enum	Der Objekttyp, der immer "fine_tuning.job" ist. Mögliche Werte: `fine_tuning.job`	Ja
organization_id	string	Die Organisation, die den Feinabstimmungsauftrag besitzt.	Ja
Ergebnisdateien	array	Die kompilierten Ergebnisdatei-ID(n) für den Feinabstimmungsauftrag. Sie können die Ergebnisse mit der Datei-API abrufen.	Ja
seed	Ganzzahl	Der für den Feinabstimmungsauftrag verwendete Seed.	Ja
Status	enum	Der aktuelle Status des Feinabstimmungsauftrags, der entweder `validating_files`, , `queued`, `running`, , `succeeded`, oder `failedcancelled`. Mögliche Werte: `validating_files`, , `queued`, `runningsucceeded`, , , `failedcancelled`	Ja
trainierte Token	Ganzzahl	Die Gesamtzahl der token, die von diesem Feinabstimmungsauftrag verarbeitet werden. Der Wert ist NULL, wenn der Feinabstimmungsauftrag noch ausgeführt wird.	Ja
Trainingsdatei	string	Die datei-ID, die für die Schulung verwendet wird. Sie können die Schulungsdaten mit der Dateien-API abrufen.	Ja
user_provided_suffix	string	Das beschreibende Suffix, das auf den Auftrag angewendet wurde, wie in der Auftragserstellungsanforderung angegeben.	No
Validierungsdatei	string	Die zur Überprüfung verwendete Datei-ID. Sie können die Validierungsergebnisse mit der Datei-API abrufen.	Ja

OpenAI.FineTuningJobCheckpoint

Das fine_tuning.job.checkpoint Objekt stellt einen Modellprüfpunkt für einen Feinabstimmungsauftrag dar, der zur Verwendung bereit ist.

Name	Typ	Beschreibung	Erforderlich
erstellt_am	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) für den Zeitpunkt der Erstellung des Prüfpunkts.	Ja
fine_tuned_model_checkpoint	string	Der Name des erstellten fein abgestimmten Prüfpunktmodells.	Ja
fine_tuning_job_id	string	Der Name des Feinabstimmungsauftrags, aus dem dieser Prüfpunkt erstellt wurde.	Ja
id	string	Der Prüfpunktbezeichner, auf den in den API-Endpunkten verwiesen werden kann.	Ja
metrics	Objekt	Metriken bei der Schrittnummer während des Feinabstimmungsauftrags.	Ja
└– full_valid_loss	number		No
└– Durchschnittliche Token-Genauigkeit für die gültigen vollständigen Daten	number		No
└– Schritt	number		No
└– train_loss	number		No
└– train_mean_token_accuracy	number		No
└– valid_loss	number		No
└– valid_mean_token_accuracy	number		No
Objekt	enum	Der Objekttyp, der immer "fine_tuning.job.checkpoint" ist. Mögliche Werte: `fine_tuning.job.checkpoint`	Ja
Schrittnummer	Ganzzahl	Die Schrittnummer, an der der Prüfpunkt erstellt wurde.	Ja

OpenAI.FineTuningJobEvent

Feinabstimmung des Auftragsereignisobjekts

Name	Typ	Beschreibung	Erforderlich
erstellt_am	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) für die Erstellung des Feinabstimmungsauftrags.	Ja
data		Die dem Ereignis zugeordneten Daten.	No
id	string	Der Objektbezeichner.	Ja
Ebene	enum	Die Protokollebene des Ereignisses. Mögliche Werte: `info`, , `warnerror`	Ja
Nachricht	string	Die Nachricht des Ereignisses.	Ja
Objekt	enum	Der Objekttyp, der immer "fine_tuning.job.event" ist. Mögliche Werte: `fine_tuning.job.event`	Ja
type	enum	Der Ereignistyp. Mögliche Werte: `message`, `metrics`	No

OpenAI.FunctionObject

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Beschreibung	string	Eine Beschreibung der Funktion, die vom Modell verwendet wird, um auszuwählen, wann und wie die Funktion aufgerufen wird.	No
Name	string	Der Name der funktion, die aufgerufen werden soll. Muss a-z, A-Z, 0-9 sein oder Unterstriche und Gedankenstriche enthalten, mit einer maximalen Länge von 64.	Ja
parameters		Die Parameter, die die Funktionen akzeptieren, die als JSON-Schemaobjekt beschrieben werden.	No
strict	Boolescher Wert	Gibt an, ob die strikte Schematreue beim Generieren des Funktionsaufrufs aktiviert werden soll. Wenn dieser Wert auf "true" festgelegt ist, folgt das Modell dem genauen Schema, das `parameters` im Feld definiert ist. Es wird nur eine Teilmenge des JSON-Schemas unterstützt, wenn `strict` dies der Zeitpunkt ist `true`.	No	Falsch

OpenAI.FunctionTool

Definiert eine Funktion in Ihrem eigenen Code, die das Modell aufrufen kann.

Name	Typ	Beschreibung	Erforderlich
Beschreibung	string	Eine Beschreibung der Funktion. Wird vom Modell verwendet, um zu bestimmen, ob die Funktion aufgerufen werden soll.	No
Name	string	Der Name der funktion, die aufgerufen werden soll.	Ja
parameters		Ein JSON-Schemaobjekt, das die Parameter der Funktion beschreibt.	Ja
strict	Boolescher Wert	Gibt an, ob die strenge Parameterüberprüfung erzwungen werden soll. Standard `true`.	Ja
type	enum	Der Typ des Funktionstools. Immer `function`. Mögliche Werte: `function`	Ja

OpenAI.FunctionToolCallItemParam

Ein Toolaufruf zum Ausführen einer Funktion.

Name	Typ	Beschreibung	Erforderlich
Argumente	string	Eine JSON-Zeichenfolge der Argumente, die an die Funktion übergeben werden sollen.	Ja
call_id	string	Die eindeutige ID des vom Modell generierten Funktionstoolaufrufs.	Ja
Name	string	Der Name der auszuführenden Funktion.	Ja
type	enum	Mögliche Werte: `function_call`	Ja

OpenAI.FunctionToolCallItemResource

Ein Toolaufruf zum Ausführen einer Funktion.

Name	Typ	Beschreibung	Erforderlich
Argumente	string	Eine JSON-Zeichenfolge der Argumente, die an die Funktion übergeben werden sollen.	Ja
call_id	string	Die eindeutige ID des vom Modell generierten Funktionstoolaufrufs.	Ja
Name	string	Der Name der auszuführenden Funktion.	Ja
Status	enum	Der Status des Elements. Einer von `in_progress`, `completed`, oder `incomplete`. Aufgefüllt, wenn Elemente über DIE API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Mögliche Werte: `function_call`	Ja

OpenAI.FunctionToolCallOutputItemParam

Die Ausgabe eines Funktionstoolaufrufs.

Name	Typ	Beschreibung	Erforderlich
call_id	string	Die eindeutige ID des vom Modell generierten Funktionstoolaufrufs.	Ja
Ausgabe	string	Eine JSON-Zeichenfolge der Ausgabe des Funktionstoolaufrufs.	Ja
type	enum	Mögliche Werte: `function_call_output`	Ja

OpenAI.FunctionToolCallOutputItemResource

Die Ausgabe eines Funktionstoolaufrufs.

Name	Typ	Beschreibung	Erforderlich
call_id	string	Die eindeutige ID des vom Modell generierten Funktionstoolaufrufs.	Ja
Ausgabe	string	Eine JSON-Zeichenfolge der Ausgabe des Funktionstoolaufrufs.	Ja
Status	enum	Der Status des Elements. Einer von `in_progress`, `completed`, oder `incomplete`. Aufgefüllt, wenn Elemente über DIE API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Mögliche Werte: `function_call_output`	Ja

OpenAI.Grader

Diskriminator für OpenAI.Grader

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`label_model`	OpenAI.GraderLabelModel
`text_similarity`	OpenAI.GraderTextSimilarity
`python`	OpenAI.GraderPython
`score_model`	OpenAI.GraderScoreModel
`multi`	OpenAI.GraderMulti

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.GraderType		Ja

OpenAI.GraderLabelModel

Ein LabelModelGrader -Objekt, das ein Modell verwendet, um jedem Element in der Auswertung Bezeichnungen zuzuweisen.

Name	Typ	Beschreibung	Erforderlich
input	array		Ja
labels	array	Die Bezeichnungen, die jedem Element in der Auswertung zugewiesen werden sollen.	Ja
Modell	string	Das Modell, das für die Auswertung verwendet werden soll. Muss strukturierte Ausgaben unterstützen.	Ja
Name	string	Der Name des Graders.	Ja
passing_labels	array	Die Beschriftungen, die ein übergebendes Ergebnis angeben. Muss eine Teilmenge von Bezeichnungen sein.	Ja
type	enum	Der Objekttyp, der immer `label_model`ist. Mögliche Werte: `label_model`	Ja

OpenAI.GraderMulti

Ein MultiGrader-Objekt kombiniert die Ausgabe mehrerer Grader, um eine einzelne Bewertung zu erzeugen.

Name	Typ	Beschreibung	Erforderlich
calculate_output	string	Eine Formel zum Berechnen der Ausgabe basierend auf den Benotungsergebnissen.	Ja
Grader	Objekt		Ja
Name	string	Der Name des Graders.	Ja
type	enum	Der Objekttyp, der immer `multi`ist. Mögliche Werte: `multi`	Ja

OpenAI.GraderPython

Ein PythonGrader-Objekt, das ein Python-Skript für die Eingabe ausführt.

Name	Typ	Beschreibung	Erforderlich
image_tag	string	Das Bildtag, das für das Python-Skript verwendet werden soll.	No
Name	string	Der Name des Graders.	Ja
source	string	Der Quellcode des Python-Skripts.	Ja
type	enum	Der Objekttyp, der immer `python`ist. Mögliche Werte: `python`	Ja

OpenAI.GraderScoreModel

Ein ScoreModelGrader-Objekt, das ein Modell verwendet, um der Eingabe eine Bewertung zuzuweisen.

Name	Typ	Beschreibung	Erforderlich
input	array	Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten.	Ja
Modell	string	Das Modell, das für die Auswertung verwendet werden soll.	Ja
Name	string	Der Name des Graders.	Ja
Bereich	array	Der Bereich der Bewertung. Standardwert ist .`[0, 1]`	No
Parameter für Stichprobennahme		Die Samplingparameter für das Modell.	No
type	enum	Der Objekttyp, der immer `score_model`ist. Mögliche Werte: `score_model`	Ja

OpenAI.GraderStringCheck

Ein StringCheckGrader-Objekt, das einen Zeichenfolgenvergleich zwischen Eingabe und Verweis mithilfe eines angegebenen Vorgangs durchführt.

Name	Typ	Beschreibung	Erforderlich
input	string	Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten.	Ja
Name	string	Der Name des Graders.	Ja
operation	enum	Der auszuführende Zeichenfolgenüberprüfungsvorgang. Einer von `eq`, `ne`, , `like`oder `ilike`. Mögliche Werte: `eq`, , `ne`, `likeilike`	Ja
Referenz	string	Der Bezugstext. Dies kann Vorlagenzeichenfolgen enthalten.	Ja
type	enum	Der Objekttyp, der immer `string_check`ist. Mögliche Werte: `string_check`	Ja

OpenAI.GraderTextSimilarity

Ein TextSimilarityGrader -Objekt, das Text basierend auf Ähnlichkeitsmetriken benotet.

Name	Typ	Beschreibung	Erforderlich
Bewertungsmetrik	enum	Die zu verwendende Auswertungsmetrik. Einer von `fuzzy_match`, `bleu`, , `gleumeteor`, `rouge_1`, , `rouge_2`, `rouge_3`, `rouge_4`, , oder `rouge_5rouge_l`. Mögliche Werte: `fuzzy_match`, , `bleu`, `gleu`, `meteorrouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5rouge_l`	Ja
input	string	Der Text, der benotet wird.	Ja
Name	string	Der Name des Graders.	Ja
Referenz	string	Der Text, der abgestuft wird.	Ja
type	enum	Der Typ des Graders. Mögliche Werte: `text_similarity`	Ja

OpenAI.GraderType

Eigentum	Wert
Typ	string
Werte	`string_check` `text_similarity` `score_model` `label_model` `python` `multi`

OpenAI.ImageGenTool

Ein Tool, das Bilder mithilfe eines Modells wie gpt-image-1.5.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Hintergrund	enum	NUR GPT-image-1: Hintergrundtyp für das generierte Bild. Einer von `transparent`, `opaque`, oder `auto`. Standard: `auto`. Mögliche Werte: `transparent`, , `opaqueauto`	No
input_image_mask	Objekt	Optionale Maske für die Bemalung. Enthält `image_url` (Zeichenfolge, optional) und `file_id` (Zeichenfolge, optional).	No
└– file_id	string	Datei-ID für das Maskenbild.	No
└– image_url	string	Base64-codiertes Maskenbild.	No
Modell	enum	Das zu verwendende Modell der Bildgenerierung. Standard: `gpt-image-1`. Mögliche Werte: `gpt-image-1`, , `gpt-image-1.5gpt-image-2`	No
Moderation	enum	Moderationsebene für das generierte Bild. Standard: `auto`. Mögliche Werte: `auto`, `low`	No
Ausgabekomprimierung	Ganzzahl	Komprimierungsebene für das Ausgabebild. Standard: 100.	No	100
Ausgabeformat	enum	Das Ausgabeformat des generierten Bilds. Einer von `png`, `webp`, oder `jpeg`. Standard: `png`. Mögliche Werte: `png`, , `webpjpeg`	No
unvollständige Bilder	Ganzzahl	Anzahl der Teilbilder, die im Streamingmodus generiert werden sollen, von 0 (Standardwert) bis 3.	No	0
Qualität	enum	Die Qualität des generierten Bilds. Einer von `low`, `medium`, , `high`oder `auto`. Standard: `auto`. Mögliche Werte: `low`, , `medium`, `highauto`	No
size	enum	Die Größe des generierten Bilds. Einer von `1024x1024`, `1024x1536`, , `1536x1024`oder `auto`. Standard: `auto`. Mögliche Werte: `1024x1024`, , `1024x1536`, `1536x1024auto`	No
type	enum	Der Typ des Tools zur Bildgenerierung. Immer `image_generation`. Mögliche Werte: `image_generation`	Ja

OpenAI.ImageGenToolCallItemParam

Eine Vom Modell vorgenommene Anforderung zur Bildgenerierung.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
result	string	Das generierte Bild, das in Base64 codiert wurde.	Ja
type	enum	Mögliche Werte: `image_generation_call`	Ja

OpenAI.ImageGenToolCallItemResource

Eine Vom Modell vorgenommene Anforderung zur Bildgenerierung.

Name	Typ	Beschreibung	Erforderlich
result	string	Das generierte Bild, das in Base64 codiert wurde.	Ja
Status	enum	Mögliche Werte: `in_progress`, , `completed`, `generatingfailed`	Ja
type	enum	Mögliche Werte: `image_generation_call`	Ja

OpenAI.ImplicitUserMessage

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Inhalt	Zeichenfolge oder Matrix		Ja

OpenAI.Includable

Geben Sie zusätzliche Ausgabedaten an, die in die Modellantwort eingeschlossen werden sollen. Derzeit unterstützte Werte sind:

code_interpreter_call.outputs: Enthält die Ausgaben der Python-Codeausführung in Codedolmetscher-Toolaufrufelemente.
computer_call_output.output.image_url: Schließen Sie Bild-URLs aus der Ausgabe des Computeraufrufs ein.
file_search_call.results: Schließen Sie die Suchergebnisse des Aufrufs des Dateisuchtools ein.
message.input_image.image_url: Fügen Sie Bild-URLs aus der Eingabenachricht ein.
message.output_text.logprobs: Fügen Sie Logprobs in Assistentennachrichten ein.
reasoning.encrypted_content: Enthält eine verschlüsselte Version von Begründungstoken bei der Ausgabe von Gründen für Elemente. Dies ermöglicht die Verwendung von Elementen in Multi-Turn-Unterhaltungen, wenn die Antwort-API zustandslos verwendet wird (z. B. wenn der store Parameter auf false" festgelegt ist" oder wenn eine Organisation im Aufbewahrungsprogramm für Nulldaten registriert ist).

Eigentum	Wert
Beschreibung	Geben Sie zusätzliche Ausgabedaten an, die in die Modellantwort eingeschlossen werden sollen. Derzeit unterstützte Werte sind: - `code_interpreter_call.outputs`: Enthält die Ausgaben der Python-Codeausführung in Codedolmetscher-Toolaufrufelemente. - `computer_call_output.output.image_url`: Schließen Sie Bild-URLs aus der Ausgabe des Computeraufrufs ein. - `file_search_call.results`: Schließen Sie die Suchergebnisse des Aufrufs des Dateisuchtools ein. - `message.input_image.image_url`: Fügen Sie Bild-URLs aus der Eingabenachricht ein. - `message.output_text.logprobs`: Fügen Sie Logprobs in Assistentennachrichten ein. - `reasoning.encrypted_content`: Enthält eine verschlüsselte Version von Begründungstoken bei der Ausgabe von Gründen für Elemente. Dies ermöglicht die Verwendung von Elementen in Multi-Turn-Unterhaltungen, wenn die Antwort-API zustandslos verwendet wird (z. B. wenn der `store` Parameter auf `false`" festgelegt ist" oder wenn eine Organisation im Aufbewahrungsprogramm für Nulldaten registriert ist).
Typ	string
Werte	`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

Diskriminator für OpenAI.ItemContent

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	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	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.ItemContentType	Mehr modaler Eingabe- und Ausgabeinhalt.	Ja

OpenAI.ItemContentInputAudio

Eine Audioeingabe für das Modell.

Name	Typ	Beschreibung	Erforderlich
data	string	Base64-codierte Audiodaten.	Ja
Format	enum	Das Format der Audiodaten. Derzeit unterstützte Formate sind `mp3` und `wav`. Mögliche Werte: `mp3`, `wav`	Ja
type	enum	Der Typ des Eingabeelements. Immer `input_audio`. Mögliche Werte: `input_audio`	Ja

OpenAI.ItemContentInputFile

Eine Dateieingabe für das Modell.

Name	Typ	Beschreibung	Erforderlich
file_data	string	Der Inhalt der Datei, die an das Modell gesendet werden soll.	No
Datei-ID	string	Die ID der Datei, die an das Modell gesendet werden soll.	No
filename	string	Der Name der Datei, die an das Modell gesendet werden soll.	No
type	enum	Der Typ des Eingabeelements. Immer `input_file`. Mögliche Werte: `input_file`	Ja

OpenAI.ItemContentInputImage

Eine Bildeingabe für das Modell.

Name	Typ	Beschreibung	Erforderlich
detail	enum	Die Detailebene des Bilds, das an das Modell gesendet werden soll. Einer von `high`, `low`, oder `auto`. Standardwert ist .`auto` Mögliche Werte: `low`, , `highauto`	No
Datei-ID	string	Die ID der Datei, die an das Modell gesendet werden soll.	No
image_url	string	Die URL des Bilds, das an das Modell gesendet werden soll. Ein vollqualifiziertes URL- oder base64-codiertes Bild in einer Daten-URL.	No
type	enum	Der Typ des Eingabeelements. Immer `input_image`. Mögliche Werte: `input_image`	Ja

OpenAI.ItemContentInputText

Eine Texteingabe für das Modell.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Text	string	Die Texteingabe für das Modell.	Ja
type	enum	Der Typ des Eingabeelements. Immer `input_text`. Mögliche Werte: `input_text`	Ja

OpenAI.ItemContentOutputAudio

Eine Audioausgabe aus dem Modell.

Name	Typ	Beschreibung	Erforderlich
data	string	Base64-codierte Audiodaten aus dem Modell.	Ja
Abschrift	string	Die Transkription der Audiodaten aus dem Modell.	Ja
type	enum	Der Typ des Ausgabeaudios. Immer `output_audio`. Mögliche Werte: `output_audio`	Ja

OpenAI.ItemContentOutputText

Eine Textausgabe aus dem Modell.

Name	Typ	Beschreibung	Erforderlich
annotations	array	Die Anmerkungen der Textausgabe.	Ja
logprobs	array		No
Text	string	Die Textausgabe aus dem Modell.	Ja
type	enum	Der Typ des Ausgabetexts. Immer `output_text`. Mögliche Werte: `output_text`	Ja

OpenAI.ItemContentRefusal

Eine Ablehnung des Modells.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Weigerung	string	Die Erklärung zur Ablehnung des Modells.	Ja
type	enum	Die Art der Ablehnung. Immer `refusal`. Mögliche Werte: `refusal`	Ja

OpenAI.ItemContentType

Mehr modaler Eingabe- und Ausgabeinhalt.

Eigentum	Wert
Beschreibung	Mehr modaler Eingabe- und Ausgabeinhalt.
Typ	string
Werte	`input_text` `input_audio` `input_image` `input_file` `output_text` `output_audio` `refusal`

OpenAI.ItemParam

Inhaltselement, das zum Generieren einer Antwort verwendet wird.

Diskriminator für OpenAI.ItemParam

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	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	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.ItemType		Ja

OpenAI.ItemReferenceItemParam

Ein interner Bezeichner für ein Element, auf das verwiesen werden soll.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
id	string	Auf die vom Dienst stammte ID des zuvor generierten Antwortelements, auf das verwiesen wird.	Ja
type	enum	Mögliche Werte: `item_reference`	Ja

OpenAI.ItemResource

Inhaltselement, das zum Generieren einer Antwort verwendet wird.

Diskriminator für OpenAI.ItemResource

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	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	Typ	Beschreibung	Erforderlich	Vorgabe
id	string		Ja
type	OpenAI.ItemType		Ja

OpenAI.ItemType

Eigentum	Wert
Typ	string
Werte	`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	Typ	Beschreibung	Erforderlich
data	array		Ja
first_id	string		No
has_more	Boolescher Wert		Ja
last_id	string		No
Objekt	enum	Mögliche Werte: `list`	Ja

OpenAI.ListFineTuningJobEventsResponse

Name	Typ	Beschreibung	Erforderlich
data	array		Ja
has_more	Boolescher Wert		Ja
Objekt	enum	Mögliche Werte: `list`	Ja

OpenAI.ListModelsResponse

Name	Typ	Beschreibung	Erforderlich	Vorgabe
data	array		Ja
Objekt	enum	Mögliche Werte: `list`	Ja

OpenAI.ListPaginatedFineTuningJobsResponse

Name	Typ	Beschreibung	Erforderlich
data	array		Ja
has_more	Boolescher Wert		Ja
Objekt	enum	Mögliche Werte: `list`	Ja

OpenAI.ListVectorStoreFilesFilter

Eigentum	Wert
Typ	string
Werte	`in_progress` `completed` `failed` `cancelled`

OpenAI.ListVectorStoreFilesResponse

Name	Typ	Beschreibung	Erforderlich
data	array		Ja
first_id	string		Ja
has_more	Boolescher Wert		Ja
last_id	string		Ja
Objekt	enum	Mögliche Werte: `list`	Ja

OpenAI.ListVectorStoresResponse

Name	Typ	Beschreibung	Erforderlich
data	array		Ja
first_id	string		Ja
has_more	Boolescher Wert		Ja
last_id	string		Ja
Objekt	enum	Mögliche Werte: `list`	Ja

OpenAI.LocalShellExecAction

Führen Sie einen Shellbefehl auf dem Server aus.

Name	Typ	Beschreibung	Erforderlich
Befehl	array	Der auszuführende Befehl.	Ja
env	Objekt	Umgebungsvariablen, die für den Befehl festgelegt werden sollen.	Ja
timeout_ms	Ganzzahl	Optionaler Timeout in Millisekunden für den Befehl.	No
type	enum	Der Typ der lokalen Shellaktion. Immer `exec`. Mögliche Werte: `exec`	Ja
user	string	Optionaler Benutzer zum Ausführen des Befehls als.	No
working_directory	string	Optionales Arbeitsverzeichnis zum Ausführen des Befehls in.	No

OpenAI.LocalShellTool

Ein Tool, mit dem das Modell Shellbefehle in einer lokalen Umgebung ausführen kann.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Der Typ des lokalen Shelltools. Immer `local_shell`. Mögliche Werte: `local_shell`	Ja

OpenAI.LocalShellToolCallItemParam

Ein Toolaufruf zum Ausführen eines Befehls auf der lokalen Shell.

Name	Typ	Beschreibung	Erforderlich
action	OpenAI.LocalShellExecAction	Führen Sie einen Shellbefehl auf dem Server aus.	Ja
call_id	string	Die eindeutige ID des vom Modell generierten aufrufs des lokalen Shelltools.	Ja
type	enum	Mögliche Werte: `local_shell_call`	Ja

OpenAI.LocalShellToolCallItemResource

Ein Toolaufruf zum Ausführen eines Befehls auf der lokalen Shell.

Name	Typ	Beschreibung	Erforderlich
action	OpenAI.LocalShellExecAction	Führen Sie einen Shellbefehl auf dem Server aus.	Ja
call_id	string	Die eindeutige ID des vom Modell generierten aufrufs des lokalen Shelltools.	Ja
Status	enum	Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Mögliche Werte: `local_shell_call`	Ja

OpenAI.LocalShellToolCallOutputItemParam

Die Ausgabe eines Aufrufs eines lokalen Shell-Tools.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Ausgabe	string	Eine JSON-Zeichenfolge der Ausgabe des aufrufs des lokalen Shell-Tools.	Ja
type	enum	Mögliche Werte: `local_shell_call_output`	Ja

OpenAI.LocalShellToolCallOutputItemResource

Die Ausgabe eines Aufrufs eines lokalen Shell-Tools.

Name	Typ	Beschreibung	Erforderlich
Ausgabe	string	Eine JSON-Zeichenfolge der Ausgabe des aufrufs des lokalen Shell-Tools.	Ja
Status	enum	Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Mögliche Werte: `local_shell_call_output`	Ja

OpenAI.Location

Diskriminator für OpenAI.Location

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`approximate`	OpenAI.ApproximateLocation

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.LocationType		Ja

OpenAI.LocationType

Eigentum	Wert
Typ	string
Werte	`approximate`

OpenAI.LogProb

Die Protokollwahrscheinlichkeit eines Tokens.

Name	Typ	Erforderlich
Bytes	array	Ja
logprob	number	Ja
Token	string	Ja
top_logprobs	array	Ja

OpenAI.MCPApprovalRequestItemParam

Ein Antrag auf menschliche Genehmigung eines Werkzeugaufrufs.

Name	Typ	Beschreibung	Erforderlich
Argumente	string	Eine JSON-Zeichenfolge mit Argumenten für das Tool.	Ja
Name	string	Der Name des auszuführenden Tools.	Ja
Serverbeschriftung	string	Die Bezeichnung des MCP-Servers, der die Anforderung vornimmt.	Ja
type	enum	Mögliche Werte: `mcp_approval_request`	Ja

OpenAI.MCPApprovalRequestItemResource

Ein Antrag auf menschliche Genehmigung eines Werkzeugaufrufs.

Name	Typ	Beschreibung	Erforderlich
Argumente	string	Eine JSON-Zeichenfolge mit Argumenten für das Tool.	Ja
Name	string	Der Name des auszuführenden Tools.	Ja
Serverbeschriftung	string	Die Bezeichnung des MCP-Servers, der die Anforderung vornimmt.	Ja
type	enum	Mögliche Werte: `mcp_approval_request`	Ja

OpenAI.MCPApprovalResponseItemParam

Eine Antwort auf eine MCP-Genehmigungsanforderung.

Name	Typ	Beschreibung	Erforderlich
approval_request_id	string	Die ID der Genehmigungsanforderung, die beantwortet wird.	Ja
Genehmigen	Boolescher Wert	Gibt an, ob die Anforderung genehmigt wurde.	Ja
Grund	string	Optionaler Grund für die Entscheidung.	No
type	enum	Mögliche Werte: `mcp_approval_response`	Ja

OpenAI.MCPApprovalResponseItemResource

Eine Antwort auf eine MCP-Genehmigungsanforderung.

Name	Typ	Beschreibung	Erforderlich
approval_request_id	string	Die ID der Genehmigungsanforderung, die beantwortet wird.	Ja
Genehmigen	Boolescher Wert	Gibt an, ob die Anforderung genehmigt wurde.	Ja
Grund	string	Optionaler Grund für die Entscheidung.	No
type	enum	Mögliche Werte: `mcp_approval_response`	Ja

OpenAI.MCPCallItemParam

Ein Aufruf eines Tools auf einem MCP-Server.

Name	Typ	Beschreibung	Erforderlich
Argumente	string	Eine JSON-Zeichenfolge der Argumente, die an das Tool übergeben werden.	Ja
Fehler	string	Der Fehler des Toolaufrufs( falls vorhanden).	No
Name	string	Der Name des tools, das ausgeführt wurde.	Ja
Ausgabe	string	Die Ausgabe des Toolaufrufs.	No
Serverbeschriftung	string	Die Bezeichnung des MCP-Servers, auf dem das Tool ausgeführt wird.	Ja
type	enum	Mögliche Werte: `mcp_call`	Ja

OpenAI.MCPCallItemResource

Ein Aufruf eines Tools auf einem MCP-Server.

Name	Typ	Beschreibung	Erforderlich
Argumente	string	Eine JSON-Zeichenfolge der Argumente, die an das Tool übergeben werden.	Ja
Fehler	string	Der Fehler des Toolaufrufs( falls vorhanden).	No
Name	string	Der Name des tools, das ausgeführt wurde.	Ja
Ausgabe	string	Die Ausgabe des Toolaufrufs.	No
Serverbeschriftung	string	Die Bezeichnung des MCP-Servers, auf dem das Tool ausgeführt wird.	Ja
type	enum	Mögliche Werte: `mcp_call`	Ja

OpenAI.MCPListToolsItemParam

Eine Liste der auf einem MCP-Server verfügbaren Tools.

Name	Typ	Beschreibung	Erforderlich
Fehler	string	Fehlermeldung, wenn der Server keine Tools auflisten konnte.	No
Serverbeschriftung	string	Die Bezeichnung des MCP-Servers.	Ja
tools	array	Die auf dem Server verfügbaren Tools.	Ja
type	enum	Mögliche Werte: `mcp_list_tools`	Ja

OpenAI.MCPListToolsItemResource

Eine Liste der auf einem MCP-Server verfügbaren Tools.

Name	Typ	Beschreibung	Erforderlich
Fehler	string	Fehlermeldung, wenn der Server keine Tools auflisten konnte.	No
Serverbeschriftung	string	Die Bezeichnung des MCP-Servers.	Ja
tools	array	Die auf dem Server verfügbaren Tools.	Ja
type	enum	Mögliche Werte: `mcp_list_tools`	Ja

OpenAI.MCPListToolsTool

Ein Tool, das auf einem MCP-Server verfügbar ist.

Name	Typ	Beschreibung	Erforderlich
annotations		Zusätzliche Anmerkungen zum Tool.	No
Beschreibung	string	Die Beschreibung des Tools.	No
input_schema		Das JSON-Schema, das die Eingabe des Tools beschreibt.	Ja
Name	string	Der Name des Tools.	Ja

OpenAI.MCPTool

Gewähren Sie dem Modell Zugriff auf zusätzliche Tools über MCP-Server (Remote Model Context Protocol).

Name	Typ	Beschreibung	Erforderlich
erlaubte_Werkzeuge	Objekt		No
└– tool_names	array	Liste der zulässigen Toolnamen.	No
headers	Objekt	Optionale HTTP-Header, die an den MCP-Server gesendet werden sollen. Wird für die Authentifizierung oder andere Zwecke verwendet.	No
Genehmigung erforderlich	-Objekt (siehe gültige Modelle unten)	Geben Sie an, welche Tools des MCP-Servers eine Genehmigung erfordern.	No
Serverbeschriftung	string	Eine Bezeichnung für diesen MCP-Server, die verwendet wird, um sie in Toolaufrufen zu identifizieren.	Ja
server_url	string	Die URL für den MCP-Server.	Ja
type	enum	Der Typ des MCP-Tools. Immer `mcp`. Mögliche Werte: `mcp`	Ja

OpenAI.MetadataPropertyForRequest

Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No

OpenAI.Model

Beschreibt ein OpenAI-Modellangebot, das mit der API verwendet werden kann.

Name	Typ	Beschreibung	Erforderlich
erstellt	Ganzzahl	Der Unix-Zeitstempel (in Sekunden), als das Modell erstellt wurde.	Ja
id	string	Der Modellbezeichner, auf den in den API-Endpunkten verwiesen werden kann.	Ja
Objekt	enum	Der Objekttyp, der immer "Modell" ist. Mögliche Werte: `model`	Ja
owned_by	string	Die Organisation, die das Modell besitzt.	Ja

OpenAI.OtherChunkingStrategyResponseParam

Dies wird zurückgegeben, wenn die Blockierungsstrategie unbekannt ist. In der Regel liegt dies daran, dass die Datei indiziert wurde, bevor das chunking_strategy Konzept in der API eingeführt wurde.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Immer `other`. Mögliche Werte: `other`	Ja

OpenAI.ParallelToolCalls

Gibt an, ob beim Verwenden des Tools parallele Funktionsaufrufe aktiviert werden sollen.

Typ: boolean

OpenAI.Prompt

Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.

Name	Typ	Beschreibung	Erforderlich
id	string	Der eindeutige Bezeichner der zu verwendenden Eingabeaufforderungsvorlage.	Ja
variables	Objekt	Optionale Zuordnung von Werten, die durch Variablen in Ihrer Eingabeaufforderung ersetzt werden sollen. Die Ersetzungswerte können entweder Zeichenfolgen oder andere Antworteingabetypen wie Bilder oder Dateien sein.	No
Version	string	Optionale Version der Eingabeaufforderungsvorlage.	No

OpenAI.RankingOptions

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Bewerter	enum	Der Rangfolger, der für die Dateisuche verwendet werden soll. Mögliche Werte: `auto`, `default-2024-11-15`	No
score-threshold	number	Der Schwellenwert für die Bewertung für die Dateisuche, eine Zahl zwischen 0 und 1. Zahlen, die näher an 1 sind, versuchen, nur die relevantesten Ergebnisse zurückzugeben, können aber weniger Ergebnisse zurückgeben.	No

OpenAI.Reasoning

Nur o-Serienmodelle

Name	Typ	Beschreibung	Erforderlich
effort	Objekt	Nur o-Serienmodelle Beschränkt den Aufwand für die Begründung von Begründungsmodellen. Derzeit unterstützte Werte sind `low`, `medium`und `high`. Das Reduzieren von Gründen kann zu schnelleren Antworten und weniger Token führen, die bei der Begründung in einer Antwort verwendet werden.	No
generate_summary	enum	Veraltet: Verwenden Sie `summary` stattdessen. Eine Zusammenfassung der vom Modell durchgeführten Begründung. Dies kann hilfreich sein, um das Debuggen und Verstehen des Begründungsprozesses des Modells zu verstehen. Einer von `auto`, `concise`, oder `detailed`. Mögliche Werte: `auto`, , `concisedetailed`	No
summary	enum	Eine Zusammenfassung der vom Modell durchgeführten Begründung. Dies kann hilfreich sein, um das Debuggen und Verstehen des Begründungsprozesses des Modells zu verstehen. Einer von `auto`, `concise`, oder `detailed`. Mögliche Werte: `auto`, , `concisedetailed`	No

OpenAI.ReasoningEffort

Nur o-Serienmodelle

Beschränkt den Aufwand für die Begründung von Begründungsmodellen. Derzeit unterstützte Werte sind low, mediumund high. Das Reduzieren von Gründen kann zu schnelleren Antworten und weniger Token führen, die bei der Begründung in einer Antwort verwendet werden.

Eigentum	Wert
Beschreibung	Nur o-Serienmodelle Beschränkt den Aufwand für die Begründung von Begründungsmodellen. Derzeit unterstützte Werte sind `low`, `medium`und `high`. Das Reduzieren von Gründen kann zu schnelleren Antworten und weniger Token führen, die bei der Begründung in einer Antwort verwendet werden.
Typ	string
Werte	`low` `medium` `high`

OpenAI.ReasoningItemParam

Eine Beschreibung der Gedankenkette, die von einem Begründungsmodell beim Generieren einer Antwort verwendet wird. Achten Sie darauf, diese Elemente in die input Antwort-API für nachfolgende Wendungen einer Unterhaltung einzuschließen, wenn Sie den Kontext manuell verwalten.

Name	Typ	Beschreibung	Erforderlich
encrypted_content	string	Der verschlüsselte Inhalt des Begründungselements – aufgefüllt, wenn eine Antwort im `reasoning.encrypted_contentinclude` Parameter generiert wird.	No
summary	array	Textinhalt wird mit Gründen versehen.	Ja
type	enum	Mögliche Werte: `reasoning`	Ja

OpenAI.ReasoningItemResource

Name	Typ	Beschreibung	Erforderlich
encrypted_content	string	Der verschlüsselte Inhalt des Begründungselements – aufgefüllt, wenn eine Antwort im `reasoning.encrypted_contentinclude` Parameter generiert wird.	No
summary	array	Textinhalt wird mit Gründen versehen.	Ja
type	enum	Mögliche Werte: `reasoning`	Ja

OpenAI.ReasoningItemSummaryPart

Diskriminator für OpenAI.ReasoningItemSummaryPart

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`summary_text`	OpenAI.ReasoningItemSummaryTextPart

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.ReasoningItemSummaryPartType		Ja

OpenAI.ReasoningItemSummaryPartType

Eigentum	Wert
Typ	string
Werte	`summary_text`

OpenAI.ReasoningItemSummaryTextPart

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Text	string		Ja
type	enum	Mögliche Werte: `summary_text`	Ja

OpenAI.Response

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Hintergrund	Boolescher Wert	Gibt an, ob die Modellantwort im Hintergrund ausgeführt werden soll.	No	Falsch
erstellt_am	Ganzzahl	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
Fehler	Objekt	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	Ja
└– Code	OpenAI.ResponseErrorCode	Der Fehlercode für die Antwort.	No
└– Nachricht	string	Eine lesbare Beschreibung des Fehlers.	No
id	string	Eindeutiger Bezeichner für diese Antwort.	Ja
incomplete_details	Objekt	Details dazu, warum die Antwort unvollständig ist.	Ja
└– Grund	enum	Der Grund, warum die Antwort unvollständig ist. Mögliche Werte: `max_output_tokens`, `content_filter`	No
Anweisungen	Zeichenfolge oder Matrix		Ja
max_output_tokens	Ganzzahl	Eine obere Grenze für die Anzahl der Token, die für eine Antwort generiert werden können, einschließlich sichtbarer Ausgabetoken und Begründungstoken	No
max_tool_calls	Ganzzahl	Die maximale Anzahl der Aufrufe an integrierte Tools, die in einer Antwort verarbeitet werden können. Diese maximale Anzahl gilt für alle integrierten Toolaufrufe, nicht pro einzelnes Tool. Alle weiteren Versuche, ein Tool durch das Modell aufzurufen, werden ignoriert.	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	Ja
Objekt	enum	Der Objekttyp dieser Ressource - immer auf .`response` Mögliche Werte: `response`	Ja
Ausgabe	array	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array hängt von der Antwort des Modells ab. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant` Nachricht mit dem vom Modell generierten Inhalt handelt, können Sie die Verwendung der `output_text` Eigenschaft, die in SDKs unterstützt wird, in Betracht ziehen.	Ja
output_text	string	Nur-SDK-Komforteigenschaft, die die aggregierte Textausgabe aller `output_text` Elemente im `output` Array enthält, sofern vorhanden. Unterstützt in den Python- und JavaScript-SDKs.	No
Parallele Werkzeugaufrufe	Boolescher Wert	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
previous_response_id	string	Die eindeutige ID der vorherigen Antwort auf das Modell. Verwenden Sie diese Option, um Multi-Turn-Unterhaltungen zu erstellen.	No
Eingabeaufforderung	Objekt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	No
└– ID	string	Der eindeutige Bezeichner der zu verwendenden Eingabeaufforderungsvorlage.	No
└- Variablen	OpenAI.ResponsePromptVariables	Optionale Zuordnung von Werten, die durch Variablen in Ihrer Eingabeaufforderung ersetzt werden sollen. Die Ersetzungswerte können entweder Zeichenfolgen oder andere Antworteingabetypen wie Bilder oder Dateien sein.	No
└– Version	string	Optionale Version der Eingabeaufforderungsvorlage.	No
reasoning	Objekt	Nur o-Serienmodelle Konfigurationsoptionen für Begründungsmodelle.	No
└– Aufwand	OpenAI.ReasoningEffort	Nur o-Serienmodelle Beschränkt den Aufwand für die Begründung von Begründungsmodellen. Derzeit unterstützte Werte sind `low`, `medium`und `high`. Das Reduzieren von Gründen kann zu schnelleren Antworten und weniger Token führen, die bei der Begründung in einer Antwort verwendet werden.	No
└– generate_summary	enum	Veraltet: Verwenden Sie `summary` stattdessen. Eine Zusammenfassung der vom Modell durchgeführten Begründung. Dies kann hilfreich sein, um das Debuggen und Verstehen des Begründungsprozesses des Modells zu verstehen. Einer von `auto`, `concise`, oder `detailed`. Mögliche Werte: `auto`, , `concisedetailed`	No
└– Zusammenfassung	enum	Eine Zusammenfassung der vom Modell durchgeführten Begründung. Dies kann hilfreich sein, um das Debuggen und Verstehen des Begründungsprozesses des Modells zu verstehen. Einer von `auto`, `concise`, oder `detailed`. Mögliche Werte: `auto`, , `concisedetailed`	No
Status	enum	Der Status der Antwortgenerierung. Einer von `completed`, `failed`, `in_progress`, , `cancelled`, , `queued`oder `incomplete`. Mögliche Werte: `completed`, , `failed`, `in_progresscancelled`, , , `queuedincomplete`	No
Temperatur	number	Welche Probenahmetemperatur verwendet werden soll, zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Es wird in der Regel empfohlen, dies oder `top_p` nicht beides zu ändern.	Ja
Text	Objekt	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann Nur-Text- oder strukturierte JSON-Daten sein.	No
└─ Format	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	Objekt	Steuert, welches Tool (falls vorhanden) vom Modell aufgerufen wird. `none` bedeutet, dass das Modell kein Tool aufruft und stattdessen eine Nachricht generiert. `auto` bedeutet, dass das Modell zwischen dem Generieren einer Nachricht oder dem Aufrufen eines oder mehrerer Tools auswählen kann. `required` bedeutet, dass das Modell mindestens ein Tools aufrufen muss.	No
└– Typ	OpenAI.ToolChoiceObjectType	Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll.	No
tools	array	Ein Array von Tools, die das Modell aufrufen kann, während eine Antwort generiert wird. Sie können angeben, welches Tool verwendet werden soll, indem Sie den `tool_choice` Parameter festlegen. Die beiden Kategorien von Tools, die Sie bereitstellen können, sind: - Integrierte Tools: Tools, die von OpenAI bereitgestellt werden, die die Funktionen des Modells erweitern.	No
top_logprobs	Ganzzahl	Eine ganze Zahl zwischen 0 und 20, die die Anzahl der höchstwahrscheinlichen Token an jeder Tokenposition angibt, jeweils mit einer zugeordneten Protokollwahrscheinlichkeit.	No
top_p	number	Eine Alternative zur Probenahme mit Temperatur, die als Kernsampling bezeichnet wird, wobei das Modell die Ergebnisse der Token mit top_p Wahrscheinlichkeitsmasse berücksichtigt. 0,1 bedeutet also, dass nur die Token, die die obersten 10% Wahrscheinlichkeitsmasse umfassen, berücksichtigt werden. Es wird in der Regel empfohlen, dies oder `temperature` nicht beides zu ändern.	Ja
truncation	enum	Die Abkürzungsstrategie, die für die Modellantwort verwendet werden soll. - `auto`: Wenn der Kontext dieser Antwort und früherer Antworten die Größe des Kontextfensters des Modells überschreitet, schneidet das Modell die Antwort ab, um das Kontextfenster anzupassen, indem Eingabeelemente in der Mitte der Unterhaltung gelöscht werden. - `disabled` (Standard): Wenn eine Modellantwort die Kontextfenstergröße für ein Modell überschreitet, schlägt die Anforderung mit einem Fehler von 400 fehl. Mögliche Werte: `auto`, `disabled`	No
Nutzung	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails wie Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken dar.	No
user	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	Ja

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Wird ausgegeben, wenn ein partieller Codeausschnitt vom Codedolmetscher gestreamt wird.

Name	Typ	Beschreibung	Erforderlich
delta	string	Der partielle Codeausschnitt, der vom Codedolmetscher gestreamt wird.	Ja
item_id	string	Der eindeutige Bezeichner des Codedolmetscher-Toolaufrufelements.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements in der Antwort, für die der Code gestreamt wird.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.code_interpreter_call_code.delta`. Mögliche Werte: `response.code_interpreter_call_code.delta`	Ja

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Wird ausgegeben, wenn der Codeausschnitt vom Codedolmetscher abgeschlossen wird.

Name	Typ	Beschreibung	Erforderlich
code	string	Die endgültige Codeausschnittausgabe des Codedolmetschers.	Ja
item_id	string	Der eindeutige Bezeichner des Codedolmetscher-Toolaufrufelements.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements in der Antwort, für die der Code abgeschlossen ist.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.code_interpreter_call_code.done`. Mögliche Werte: `response.code_interpreter_call_code.done`	Ja

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Wird ausgegeben, wenn der Codedolmetscheraufruf abgeschlossen ist.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Der eindeutige Bezeichner des Codedolmetscher-Toolaufrufelements.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements in der Antwort, für die der Codedolmetscheraufruf abgeschlossen ist.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.code_interpreter_call.completed`. Mögliche Werte: `response.code_interpreter_call.completed`	Ja

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Wird ausgegeben, wenn ein Codedolmetscheraufruf ausgeführt wird.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Der eindeutige Bezeichner des Codedolmetscher-Toolaufrufelements.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements in der Antwort, für die der Codedolmetscheraufruf ausgeführt wird.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.code_interpreter_call.in_progress`. Mögliche Werte: `response.code_interpreter_call.in_progress`	Ja

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Wird ausgegeben, wenn der Codedolmetscher den Codeausschnitt aktiv interpretiert.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Der eindeutige Bezeichner des Codedolmetscher-Toolaufrufelements.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements in der Antwort, für die der Codedolmetscher Code interpretiert.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.code_interpreter_call.interpreting`. Mögliche Werte: `response.code_interpreter_call.interpreting`	Ja

OpenAI.ResponseCompletedEvent

Wird ausgegeben, wenn die Modellantwort abgeschlossen ist.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
response	Objekt		Ja
└– Hintergrund	Boolescher Wert	Gibt an, ob die Modellantwort im Hintergrund ausgeführt werden soll.	No	Falsch
└– created_at	Ganzzahl	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	No
└– Fehler	OpenAI.ResponseError	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	No
└– ID	string	Eindeutiger Bezeichner für diese Antwort.	No
└─ unvollständige_Details	Objekt	Details dazu, warum die Antwort unvollständig ist.	No
└– Grund	enum	Der Grund, warum die Antwort unvollständig ist. Mögliche Werte: `max_output_tokens`, `content_filter`	No
└– Anweisungen	Zeichenfolge oder Matrix	Eine Systemnachricht (oder Entwicklernachricht), die in den Kontext des Modells eingefügt wurde. Bei Verwendung dieser `previous_response_id`Antwort werden die Anweisungen aus einer vorherigen Antwort nicht an die nächste Antwort übertragen. Dies erleichtert das Austauschen von Systemnachrichten (oder Entwicklernachrichten) in neuen Antworten.	No
└– max_output_tokens	Ganzzahl	Eine obere Grenze für die Anzahl der Token, die für eine Antwort generiert werden können, einschließlich sichtbarer Ausgabetoken und Begründungstoken	No
└– max_tool_calls	Ganzzahl	Die maximale Anzahl der Aufrufe an integrierte Tools, die in einer Antwort verarbeitet werden können. Diese maximale Anzahl gilt für alle integrierten Toolaufrufe, nicht pro einzelnes Tool. Alle weiteren Versuche, ein Tool durch das Modell aufzurufen, werden ignoriert.	No
└- Metadaten	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
└- Objekt	enum	Der Objekttyp dieser Ressource - immer auf .`response` Mögliche Werte: `response`	No
└─ Ausgabe	array	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array hängt von der Antwort des Modells ab. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant` Nachricht mit dem vom Modell generierten Inhalt handelt, können Sie die Verwendung der `output_text` Eigenschaft, die in SDKs unterstützt wird, in Betracht ziehen.	No
└─ Ausgabentext	string	Nur-SDK-Komforteigenschaft, die die aggregierte Textausgabe aller `output_text` Elemente im `output` Array enthält, sofern vorhanden. Unterstützt in den Python- und JavaScript-SDKs.	No
└─ parallele_Werkzeugaufrufe	Boolescher Wert	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	No	Richtig
└– vorherige_Antwort_ID	string	Die eindeutige ID der vorherigen Antwort auf das Modell. Verwenden Sie diese Option, um Multi-Turn-Unterhaltungen zu erstellen.	No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	No
└– Begründung	OpenAI.Reasoning	Nur o-Serienmodelle Konfigurationsoptionen für Begründungsmodelle.	No
└─ Status	enum	Der Status der Antwortgenerierung. Einer von `completed`, `failed`, `in_progress`, , `cancelled`, , `queued`oder `incomplete`. Mögliche Werte: `completed`, , `failed`, `in_progresscancelled`, , , `queuedincomplete`	No
└– Temperatur	number	Welche Probenahmetemperatur verwendet werden soll, zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Es wird in der Regel empfohlen, dies oder `top_p` nicht beides zu ändern.	No
└– Text	Objekt	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann Nur-Text- oder strukturierte JSON-Daten sein.	No
└─ Format	OpenAI.ResponseTextFormatConfiguration		No
└─ Werkzeugwahl	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceObject	Wie das Modell auswählen soll, welches Tool (oder welche Tools) beim Generieren einer Antwort verwendet werden soll. Sehen Sie sich den `tools` Parameter an, um zu sehen, wie Sie angeben, welche Tools das Modell aufrufen kann.	No
└- Werkzeuge	array	Ein Array von Tools, die das Modell aufrufen kann, während eine Antwort generiert wird. Sie können angeben, welches Tool verwendet werden soll, indem Sie den `tool_choice` Parameter festlegen. Die beiden Kategorien von Tools, die Sie bereitstellen können, sind: - Integrierte Tools: Tools, die von OpenAI bereitgestellt werden, die die Funktionen des Modells erweitern.	No
└– top_logprobs	Ganzzahl	Eine ganze Zahl zwischen 0 und 20, die die Anzahl der höchstwahrscheinlichen Token an jeder Tokenposition angibt, jeweils mit einer zugeordneten Protokollwahrscheinlichkeit.	No
└– top_p	number	Eine Alternative zur Probenahme mit Temperatur, die als Kernsampling bezeichnet wird, wobei das Modell die Ergebnisse der Token mit top_p Wahrscheinlichkeitsmasse berücksichtigt. 0,1 bedeutet also, dass nur die Token, die die obersten 10% Wahrscheinlichkeitsmasse umfassen, berücksichtigt werden. Es wird in der Regel empfohlen, dies oder `temperature` nicht beides zu ändern.	No
└– Abschneiden	enum	Die Abkürzungsstrategie, die für die Modellantwort verwendet werden soll. - `auto`: Wenn der Kontext dieser Antwort und früherer Antworten die Größe des Kontextfensters des Modells überschreitet, schneidet das Modell die Antwort ab, um das Kontextfenster anzupassen, indem Eingabeelemente in der Mitte der Unterhaltung gelöscht werden. - `disabled` (Standard): Wenn eine Modellantwort die Kontextfenstergröße für ein Modell überschreitet, schlägt die Anforderung mit einem Fehler von 400 fehl. Mögliche Werte: `auto`, `disabled`	No
└– Nutzung	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails wie Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken dar.	No
└– Benutzer	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	No
type	enum	Der Typ des Ereignisses. Immer `response.completed`. Mögliche Werte: `response.completed`	Ja

OpenAI.ResponseContentPartAddedEvent

Wird ausgegeben, wenn ein neuer Inhaltsteil hinzugefügt wird.

Name	Typ	Beschreibung	Erforderlich
content_index	Ganzzahl	Der Index des hinzugefügten Inhaltsteils.	Ja
item_id	string	Die ID des Ausgabeelements, dem der Inhaltsteil hinzugefügt wurde.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, dem der Inhaltsteil hinzugefügt wurde.	Ja
part	Objekt		Ja
└– Typ	OpenAI.ItemContentType	Mehr modaler Eingabe- und Ausgabeinhalt.	No
type	enum	Der Typ des Ereignisses. Immer `response.content_part.added`. Mögliche Werte: `response.content_part.added`	Ja

OpenAI.ResponseContentPartDoneEvent

Wird ausgegeben, wenn ein Inhaltsteil abgeschlossen ist.

Name	Typ	Beschreibung	Erforderlich
content_index	Ganzzahl	Der Index des Inhaltsteils, der abgeschlossen ist.	Ja
item_id	string	Die ID des Ausgabeelements, dem der Inhaltsteil hinzugefügt wurde.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, dem der Inhaltsteil hinzugefügt wurde.	Ja
part	Objekt		Ja
└– Typ	OpenAI.ItemContentType	Mehr modaler Eingabe- und Ausgabeinhalt.	No
type	enum	Der Typ des Ereignisses. Immer `response.content_part.done`. Mögliche Werte: `response.content_part.done`	Ja

OpenAI.ResponseCreatedEvent

Ein Ereignis, das beim Erstellen einer Antwort ausgegeben wird.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
response	Objekt		Ja
└– Hintergrund	Boolescher Wert	Gibt an, ob die Modellantwort im Hintergrund ausgeführt werden soll.	No	Falsch
└– created_at	Ganzzahl	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	No
└– Fehler	OpenAI.ResponseError	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	No
└– ID	string	Eindeutiger Bezeichner für diese Antwort.	No
└─ unvollständige_Details	Objekt	Details dazu, warum die Antwort unvollständig ist.	No
└– Grund	enum	Der Grund, warum die Antwort unvollständig ist. Mögliche Werte: `max_output_tokens`, `content_filter`	No
└– Anweisungen	Zeichenfolge oder Matrix	Eine Systemnachricht (oder Entwicklernachricht), die in den Kontext des Modells eingefügt wurde. Bei Verwendung dieser `previous_response_id`Antwort werden die Anweisungen aus einer vorherigen Antwort nicht an die nächste Antwort übertragen. Dies erleichtert das Austauschen von Systemnachrichten (oder Entwicklernachrichten) in neuen Antworten.	No
└– max_output_tokens	Ganzzahl	Eine obere Grenze für die Anzahl der Token, die für eine Antwort generiert werden können, einschließlich sichtbarer Ausgabetoken und Begründungstoken	No
└– max_tool_calls	Ganzzahl	Die maximale Anzahl der Aufrufe an integrierte Tools, die in einer Antwort verarbeitet werden können. Diese maximale Anzahl gilt für alle integrierten Toolaufrufe, nicht pro einzelnes Tool. Alle weiteren Versuche, ein Tool durch das Modell aufzurufen, werden ignoriert.	No
└- Metadaten	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
└- Objekt	enum	Der Objekttyp dieser Ressource - immer auf .`response` Mögliche Werte: `response`	No
└─ Ausgabe	array	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array hängt von der Antwort des Modells ab. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant` Nachricht mit dem vom Modell generierten Inhalt handelt, können Sie die Verwendung der `output_text` Eigenschaft, die in SDKs unterstützt wird, in Betracht ziehen.	No
└─ Ausgabentext	string	Nur-SDK-Komforteigenschaft, die die aggregierte Textausgabe aller `output_text` Elemente im `output` Array enthält, sofern vorhanden. Unterstützt in den Python- und JavaScript-SDKs.	No
└─ parallele_Werkzeugaufrufe	Boolescher Wert	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	No	Richtig
└– vorherige_Antwort_ID	string	Die eindeutige ID der vorherigen Antwort auf das Modell. Verwenden Sie diese Option, um Multi-Turn-Unterhaltungen zu erstellen.	No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	No
└– Begründung	OpenAI.Reasoning	Nur o-Serienmodelle Konfigurationsoptionen für Begründungsmodelle.	No
└─ Status	enum	Der Status der Antwortgenerierung. Einer von `completed`, `failed` `in_progress`, `cancelled`, `queued`, oder `incomplete`. Mögliche Werte: `completed`, , `failed`, `in_progresscancelled`, , , `queuedincomplete`	No
└– Temperatur	number	Welche Probenahmetemperatur verwendet werden soll, zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Es wird in der Regel empfohlen, dies oder `top_p` nicht beides zu ändern.	No
└– Text	Objekt	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann Nur-Text- oder strukturierte JSON-Daten sein.	No
└─ Format	OpenAI.ResponseTextFormatConfiguration		No
└─ Werkzeugwahl	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceObject	Wie das Modell auswählen soll, welches Tool (oder welche Tools) beim Generieren einer Antwort verwendet werden soll. Sehen Sie sich den `tools` Parameter an, um zu sehen, wie Sie angeben, welche Tools das Modell aufrufen kann.	No
└- Werkzeuge	array	Ein Array von Tools, die das Modell aufrufen kann, während eine Antwort generiert wird. Sie können angeben, welches Tool verwendet werden soll, indem Sie den `tool_choice` Parameter festlegen. Die beiden Kategorien von Tools, die Sie bereitstellen können, sind: - Integrierte Tools: Tools, die von OpenAI bereitgestellt werden, die die Funktionen des Modells erweitern.	No
└– top_logprobs	Ganzzahl	Eine ganze Zahl zwischen 0 und 20, die die Anzahl der höchstwahrscheinlichen Token an jeder Tokenposition angibt, jeweils mit einer zugeordneten Protokollwahrscheinlichkeit.	No
└– top_p	number	Eine Alternative zur Probenahme mit Temperatur, die als Kernsampling bezeichnet wird, wobei das Modell die Ergebnisse der Token mit top_p Wahrscheinlichkeitsmasse berücksichtigt. 0,1 bedeutet also, dass nur die Token, die die obersten 10% Wahrscheinlichkeitsmasse umfassen, berücksichtigt werden. Es wird in der Regel empfohlen, dies oder `temperature` nicht beides zu ändern.	No
└– Abschneiden	enum	Die Abkürzungsstrategie, die für die Modellantwort verwendet werden soll. - `auto`: Wenn der Kontext dieser Antwort und früherer Antworten die Größe des Kontextfensters des Modells überschreitet, schneidet das Modell die Antwort ab, um das Kontextfenster anzupassen, indem Eingabeelemente in der Mitte der Unterhaltung gelöscht werden. - `disabled` (Standard): Wenn eine Modellantwort die Kontextfenstergröße für ein Modell überschreitet, schlägt die Anforderung mit einem Fehler von 400 fehl. Mögliche Werte: `auto`, `disabled`	No
└– Nutzung	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails wie Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken dar.	No
└– Benutzer	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	No
type	enum	Der Typ des Ereignisses. Immer `response.created`. Mögliche Werte: `response.created`	Ja

OpenAI.ResponseError

Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
code	OpenAI.ResponseErrorCode	Der Fehlercode für die Antwort.	Ja
Nachricht	string	Eine lesbare Beschreibung des Fehlers.	Ja

OpenAI.ResponseErrorCode

Der Fehlercode für die Antwort.

Eigentum	Wert
Beschreibung	Der Fehlercode für die Antwort.
Typ	string
Werte	`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

Wird ausgegeben, wenn ein Fehler auftritt.

Name	Typ	Beschreibung	Erforderlich
code	string	Der Fehlercode.	Ja
Nachricht	string	Die Fehlermeldung.	Ja
param	string	Der Fehlerparameter.	Ja
type	enum	Der Typ des Ereignisses. Immer `error`. Mögliche Werte: `error`	Ja

OpenAI.ResponseFailedEvent

Ein Ereignis, das ausgegeben wird, wenn eine Antwort fehlschlägt.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
response	Objekt		Ja
└– Hintergrund	Boolescher Wert	Gibt an, ob die Modellantwort im Hintergrund ausgeführt werden soll.	No	Falsch
└– created_at	Ganzzahl	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	No
└– Fehler	OpenAI.ResponseError	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	No
└– ID	string	Eindeutiger Bezeichner für diese Antwort.	No
└─ unvollständige_Details	Objekt	Details dazu, warum die Antwort unvollständig ist.	No
└– Grund	enum	Der Grund, warum die Antwort unvollständig ist. Mögliche Werte: `max_output_tokens`, `content_filter`	No
└– Anweisungen	Zeichenfolge oder Matrix	Eine Systemnachricht (oder Entwicklernachricht), die in den Kontext des Modells eingefügt wurde. Bei Verwendung dieser `previous_response_id`Antwort werden die Anweisungen aus einer vorherigen Antwort nicht an die nächste Antwort übertragen. Dies erleichtert das Austauschen von Systemnachrichten (oder Entwicklernachrichten) in neuen Antworten.	No
└– max_output_tokens	Ganzzahl	Eine obere Grenze für die Anzahl der Token, die für eine Antwort generiert werden können, einschließlich sichtbarer Ausgabetoken und Begründungstoken	No
└– max_tool_calls	Ganzzahl	Die maximale Anzahl der Aufrufe an integrierte Tools, die in einer Antwort verarbeitet werden können. Diese maximale Anzahl gilt für alle integrierten Toolaufrufe, nicht pro einzelnes Tool. Alle weiteren Versuche, ein Tool durch das Modell aufzurufen, werden ignoriert.	No
└- Metadaten	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
└- Objekt	enum	Der Objekttyp dieser Ressource - immer auf .`response` Mögliche Werte: `response`	No
└─ Ausgabe	array	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array hängt von der Antwort des Modells ab. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant` Nachricht mit dem vom Modell generierten Inhalt handelt, können Sie die Verwendung der `output_text` Eigenschaft, die in SDKs unterstützt wird, in Betracht ziehen.	No
└─ Ausgabentext	string	Nur-SDK-Komforteigenschaft, die die aggregierte Textausgabe aller `output_text` Elemente im `output` Array enthält, sofern vorhanden. Unterstützt in den Python- und JavaScript-SDKs.	No
└─ parallele_Werkzeugaufrufe	Boolescher Wert	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	No	Richtig
└– vorherige_Antwort_ID	string	Die eindeutige ID der vorherigen Antwort auf das Modell. Verwenden Sie diese Option, um Multi-Turn-Unterhaltungen zu erstellen.	No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	No
└– Begründung	OpenAI.Reasoning	Nur o-Serienmodelle Konfigurationsoptionen für Begründungsmodelle.	No
└─ Status	enum	Der Status der Antwortgenerierung. Einer von `completed`, `failed`, `in_progress`, , `cancelled`, , `queued`oder `incomplete`. Mögliche Werte: `completed`, , `failed`, `in_progresscancelled`, , , `queuedincomplete`	No
└– Temperatur	number	Welche Probenahmetemperatur verwendet werden soll, zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Es wird in der Regel empfohlen, dies oder `top_p` nicht beides zu ändern.	No
└– Text	Objekt	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann Nur-Text- oder strukturierte JSON-Daten sein.	No
└─ Format	OpenAI.ResponseTextFormatConfiguration		No
└─ Werkzeugwahl	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceObject	Wie das Modell auswählen soll, welches Tool (oder welche Tools) beim Generieren einer Antwort verwendet werden soll. Sehen Sie sich den `tools` Parameter an, um zu sehen, wie Sie angeben, welche Tools das Modell aufrufen kann.	No
└- Werkzeuge	array	Ein Array von Tools, die das Modell aufrufen kann, während eine Antwort generiert wird. Sie können angeben, welches Tool verwendet werden soll, indem Sie den `tool_choice` Parameter festlegen. Die beiden Kategorien von Tools, die Sie bereitstellen können, sind: - Integrierte Tools: Tools, die von OpenAI bereitgestellt werden, die die Funktionen des Modells erweitern.	No
└– top_logprobs	Ganzzahl	Eine ganze Zahl zwischen 0 und 20, die die Anzahl der höchstwahrscheinlichen Token an jeder Tokenposition angibt, jeweils mit einer zugeordneten Protokollwahrscheinlichkeit.	No
└– top_p	number	Eine Alternative zur Probenahme mit Temperatur, die als Kernsampling bezeichnet wird, wobei das Modell die Ergebnisse der Token mit top_p Wahrscheinlichkeitsmasse berücksichtigt. 0,1 bedeutet also, dass nur die Token, die die obersten 10% Wahrscheinlichkeitsmasse umfassen, berücksichtigt werden. Es wird in der Regel empfohlen, dies oder `temperature` nicht beides zu ändern.	No
└– Abschneiden	enum	Die Abkürzungsstrategie, die für die Modellantwort verwendet werden soll. - `auto`: Wenn der Kontext dieser Antwort und früherer Antworten die Größe des Kontextfensters des Modells überschreitet, schneidet das Modell die Antwort ab, um das Kontextfenster anzupassen, indem Eingabeelemente in der Mitte der Unterhaltung gelöscht werden. - `disabled` (Standard): Wenn eine Modellantwort die Kontextfenstergröße für ein Modell überschreitet, schlägt die Anforderung mit einem Fehler von 400 fehl. Mögliche Werte: `auto`, `disabled`	No
└– Nutzung	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails wie Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken dar.	No
└– Benutzer	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	No
type	enum	Der Typ des Ereignisses. Immer `response.failed`. Mögliche Werte: `response.failed`	Ja

OpenAI.ResponseFileSearchCallCompletedEvent

Wird ausgegeben, wenn ein Dateisuchaufruf abgeschlossen ist (Ergebnisse gefunden).

Name	Typ	Beschreibung	Erforderlich
item_id	string	Die ID des Ausgabeelements, das der Dateisuchaufruf initiiert wird.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, das der Dateisuchaufruf initiiert wird.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.file_search_call.completed`. Mögliche Werte: `response.file_search_call.completed`	Ja

OpenAI.ResponseFileSearchCallInProgressEvent

Wird ausgegeben, wenn ein Dateisuchaufruf initiiert wird.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Die ID des Ausgabeelements, das der Dateisuchaufruf initiiert wird.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, das der Dateisuchaufruf initiiert wird.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.file_search_call.in_progress`. Mögliche Werte: `response.file_search_call.in_progress`	Ja

OpenAI.ResponseFileSearchCallSearchingEvent

Wird ausgegeben, wenn eine Dateisuche zurzeit durchsucht wird.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Die ID des Ausgabeelements, das der Dateisuchaufruf initiiert wird.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, nach dem der Dateisuchaufruf durchsucht wird.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.file_search_call.searching`. Mögliche Werte: `response.file_search_call.searching`	Ja

OpenAI.ResponseFormat

Diskriminator für OpenAI.ResponseFormat

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`text`	OpenAI.ResponseFormatText
`json_object`	OpenAI.ResponseFormatJsonObject
`json_schema`	OpenAI.ResponseFormatJsonSchema

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Mögliche Werte: `text`, , `json_objectjson_schema`	Ja

OpenAI.ResponseFormatJsonObject

JSON-Objektantwortformat. Eine ältere Methode zum Generieren von JSON-Antworten. Die Verwendung json_schema wird für Modelle empfohlen, die sie unterstützen. Beachten Sie, dass das Modell keine JSON ohne System- oder Benutzermeldung generiert, in der es dazu angewiesen wird.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Der Typ des zu definierenden Antwortformats. Immer `json_object`. Mögliche Werte: `json_object`	Ja

OpenAI.ResponseFormatJsonSchema

JSON-Schemaantwortformat. Wird verwendet, um strukturierte JSON-Antworten zu generieren.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
JSON-Schema	Objekt	Konfigurationsoptionen für strukturierte Ausgaben, einschließlich eines JSON-Schemas.	Ja
└– Beschreibung	string	Eine Beschreibung des Antwortformats, für das das Modell verwendet wird, um zu bestimmen, wie das Format reagiert.	No
└– Name	string	Der Name des Antwortformats. Muss a-z, A-Z, 0-9 sein oder Unterstriche und Gedankenstriche enthalten, mit einer maximalen Länge von 64.	No
└- Schema	OpenAI.ResponseFormatJsonSchemaSchema	Das Schema für das Antwortformat, das als JSON-Schemaobjekt beschrieben wird. Hier erfahren Sie, wie Sie JSON-Schemas erstellen.	No
└– streng	Boolescher Wert	Gibt an, ob die strikte Schematreue beim Generieren der Ausgabe aktiviert werden soll. Bei Festlegung auf "true" folgt das Modell immer dem genauen Schema, das `schema` im Feld definiert ist. Es wird nur eine Teilmenge des JSON-Schemas unterstützt, wenn `strict` dies der Zeitpunkt ist `true`.	No	Falsch
type	enum	Der Typ des zu definierenden Antwortformats. Immer `json_schema`. Mögliche Werte: `json_schema`	Ja

OpenAI.ResponseFormatJsonSchemaSchema

Das Schema für das Antwortformat, das als JSON-Schemaobjekt beschrieben wird. Hier erfahren Sie, wie Sie JSON-Schemas erstellen.

Typ: Objekt

OpenAI.ResponseFormatText

Standardantwortformat. Wird verwendet, um Textantworten zu generieren.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Der Typ des zu definierenden Antwortformats. Immer `text`. Mögliche Werte: `text`	Ja

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Wird ausgegeben, wenn ein partielles Funktionsaufrufargumentdelta vorhanden ist.

Name	Typ	Beschreibung	Erforderlich
delta	string	Die hinzugefügten Funktionsaufrufargumente.	Ja
item_id	string	Die ID des Ausgabeelements, dem die Funktionsaufrufargumente delta hinzugefügt werden.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, dem die Funktionsaufrufargumente delta hinzugefügt werden.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.function_call_arguments.delta`. Mögliche Werte: `response.function_call_arguments.delta`	Ja

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Wird ausgegeben, wenn Funktionsaufrufargumente abgeschlossen werden.

Name	Typ	Beschreibung	Erforderlich
Argumente	string	Die Funktionsaufrufargumente.	Ja
item_id	string	Die ID des Elements.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements.	Ja
type	enum	Mögliche Werte: `response.function_call_arguments.done`	Ja

OpenAI.ResponseImageGenCallCompletedEvent

Wird ausgegeben, wenn ein Aufruf des Tools zur Bildgenerierung abgeschlossen ist und das endgültige Bild verfügbar ist.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Der eindeutige Bezeichner des verarbeiteten Bildgenerierungselements.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
type	enum	Der Typ des Ereignisses. Immer „response.image_generation_call.completed”. Mögliche Werte: `response.image_generation_call.completed`	Ja

OpenAI.ResponseImageGenCallGeneratingEvent

Wird ausgegeben, wenn ein Aufruf des Tools zur Bildgenerierung aktiv ein Bild (Zwischenzustand) generiert.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Der eindeutige Bezeichner des verarbeiteten Bildgenerierungselements.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
type	enum	Der Typ des Ereignisses. Immer „response.image_generation_call.generating. Mögliche Werte: `response.image_generation_call.generating`	Ja

OpenAI.ResponseImageGenCallInProgressEvent

Wird ausgegeben, wenn ein Aufruf des Tools zur Bildgenerierung ausgeführt wird.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Der eindeutige Bezeichner des verarbeiteten Bildgenerierungselements.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
type	enum	Der Typ des Ereignisses. Immer „response.image_generation_call.in_progress”. Mögliche Werte: `response.image_generation_call.in_progress`	Ja

OpenAI.ResponseImageGenCallPartialImageEvent

Wird ausgegeben, wenn ein Teilbild während des Streamings der Bildgenerierung verfügbar ist.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Der eindeutige Bezeichner des verarbeiteten Bildgenerierungselements.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
partial_image_b64	string	Base64-codierte Teilbilddaten, die für das Rendern als Bild geeignet sind.	Ja
partial_image_index	Ganzzahl	0-basierter Index für das Teilbild (Back-End ist 1-basiert, dies ist jedoch 0-basiert für den Benutzer).	Ja
type	enum	Der Typ des Ereignisses. Immer „response.image_generation_call.partial_image”. Mögliche Werte: `response.image_generation_call.partial_image`	Ja

OpenAI.ResponseInProgressEvent

Wird ausgegeben, wenn die Antwort ausgeführt wird.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
response	Objekt		Ja
└– Hintergrund	Boolescher Wert	Gibt an, ob die Modellantwort im Hintergrund ausgeführt werden soll.	No	Falsch
└– created_at	Ganzzahl	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	No
└– Fehler	OpenAI.ResponseError	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	No
└– ID	string	Eindeutiger Bezeichner für diese Antwort.	No
└─ unvollständige_Details	Objekt	Details dazu, warum die Antwort unvollständig ist.	No
└– Grund	enum	Der Grund, warum die Antwort unvollständig ist. Mögliche Werte: `max_output_tokens`, `content_filter`	No
└– Anweisungen	Zeichenfolge oder Matrix	Eine Systemnachricht (oder Entwicklernachricht), die in den Kontext des Modells eingefügt wurde. Bei Verwendung dieser `previous_response_id`Antwort werden die Anweisungen aus einer vorherigen Antwort nicht an die nächste Antwort übertragen. Dies erleichtert das Austauschen von Systemnachrichten (oder Entwicklernachrichten) in neuen Antworten.	No
└– max_output_tokens	Ganzzahl	Eine obere Grenze für die Anzahl der Token, die für eine Antwort generiert werden können, einschließlich sichtbarer Ausgabetoken und Begründungstoken	No
└– max_tool_calls	Ganzzahl	Die maximale Anzahl der Aufrufe an integrierte Tools, die in einer Antwort verarbeitet werden können. Diese maximale Anzahl gilt für alle integrierten Toolaufrufe, nicht pro einzelnes Tool. Alle weiteren Versuche, ein Tool durch das Modell aufzurufen, werden ignoriert.	No
└- Metadaten	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
└- Objekt	enum	Der Objekttyp dieser Ressource - immer auf .`response` Mögliche Werte: `response`	No
└─ Ausgabe	array	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array hängt von der Antwort des Modells ab. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant` Nachricht mit dem vom Modell generierten Inhalt handelt, können Sie die Verwendung der `output_text` Eigenschaft, die in SDKs unterstützt wird, in Betracht ziehen.	No
└─ Ausgabentext	string	Nur-SDK-Komforteigenschaft, die die aggregierte Textausgabe aller `output_text` Elemente im `output` Array enthält, sofern vorhanden. Unterstützt in den Python- und JavaScript-SDKs.	No
└─ parallele_Werkzeugaufrufe	Boolescher Wert	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	No	Richtig
└– vorherige_Antwort_ID	string	Die eindeutige ID der vorherigen Antwort auf das Modell. Verwenden Sie diese Option, um Multi-Turn-Unterhaltungen zu erstellen.	No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	No
└– Begründung	OpenAI.Reasoning	Nur o-Serienmodelle Konfigurationsoptionen für Begründungsmodelle.	No
└─ Status	enum	Der Status der Antwortgenerierung. Einer von `completed`, `failed`, `in_progress`, , `cancelled`, , `queued`oder `incomplete`. Mögliche Werte: `completed`, , `failed`, `in_progresscancelled`, , , `queuedincomplete`	No
└– Temperatur	number	Welche Probenahmetemperatur verwendet werden soll, zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Es wird in der Regel empfohlen, dies oder `top_p` nicht beides zu ändern.	No
└– Text	Objekt	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann Nur-Text- oder strukturierte JSON-Daten sein.	No
└─ Format	OpenAI.ResponseTextFormatConfiguration		No
└─ Werkzeugwahl	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceObject	Wie das Modell auswählen soll, welches Tool (oder welche Tools) beim Generieren einer Antwort verwendet werden soll. Sehen Sie sich den `tools` Parameter an, um zu sehen, wie Sie angeben, welche Tools das Modell aufrufen kann.	No
└- Werkzeuge	array	Ein Array von Tools, die das Modell aufrufen kann, während eine Antwort generiert wird. Sie können angeben, welches Tool verwendet werden soll, indem Sie den `tool_choice` Parameter festlegen. Die beiden Kategorien von Tools, die Sie bereitstellen können, sind: - Integrierte Tools: Tools, die von OpenAI bereitgestellt werden, die die Funktionen des Modells erweitern.	No
└– top_logprobs	Ganzzahl	Eine ganze Zahl zwischen 0 und 20, die die Anzahl der höchstwahrscheinlichen Token an jeder Tokenposition angibt, jeweils mit einer zugeordneten Protokollwahrscheinlichkeit.	No
└– top_p	number	Eine Alternative zur Probenahme mit Temperatur, die als Kernsampling bezeichnet wird, wobei das Modell die Ergebnisse der Token mit top_p Wahrscheinlichkeitsmasse berücksichtigt. 0,1 bedeutet also, dass nur die Token, die die obersten 10% Wahrscheinlichkeitsmasse umfassen, berücksichtigt werden. Es wird in der Regel empfohlen, dies oder `temperature` nicht beides zu ändern.	No
└– Abschneiden	enum	Die Abkürzungsstrategie, die für die Modellantwort verwendet werden soll. - `auto`: Wenn der Kontext dieser Antwort und früherer Antworten die Größe des Kontextfensters des Modells überschreitet, schneidet das Modell die Antwort ab, um das Kontextfenster anzupassen, indem Eingabeelemente in der Mitte der Unterhaltung gelöscht werden. - `disabled` (Standard): Wenn eine Modellantwort die Kontextfenstergröße für ein Modell überschreitet, schlägt die Anforderung mit einem Fehler von 400 fehl. Mögliche Werte: `auto`, `disabled`	No
└– Nutzung	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails wie Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken dar.	No
└– Benutzer	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	No
type	enum	Der Typ des Ereignisses. Immer `response.in_progress`. Mögliche Werte: `response.in_progress`	Ja

OpenAI.ResponseIncompleteEvent

Ein Ereignis, das ausgegeben wird, wenn eine Antwort als unvollständig abgeschlossen ist.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
response	Objekt		Ja
└– Hintergrund	Boolescher Wert	Gibt an, ob die Modellantwort im Hintergrund ausgeführt werden soll.	No	Falsch
└– created_at	Ganzzahl	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	No
└– Fehler	OpenAI.ResponseError	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	No
└– ID	string	Eindeutiger Bezeichner für diese Antwort.	No
└─ unvollständige_Details	Objekt	Details dazu, warum die Antwort unvollständig ist.	No
└– Grund	enum	Der Grund, warum die Antwort unvollständig ist. Mögliche Werte: `max_output_tokens`, `content_filter`	No
└– Anweisungen	Zeichenfolge oder Matrix	Eine Systemnachricht (oder Entwicklernachricht), die in den Kontext des Modells eingefügt wurde. Bei Verwendung dieser `previous_response_id`Antwort werden die Anweisungen aus einer vorherigen Antwort nicht an die nächste Antwort übertragen. Dies erleichtert das Austauschen von Systemnachrichten (oder Entwicklernachrichten) in neuen Antworten.	No
└– max_output_tokens	Ganzzahl	Eine obere Grenze für die Anzahl der Token, die für eine Antwort generiert werden können, einschließlich sichtbarer Ausgabetoken und Begründungstoken	No
└– max_tool_calls	Ganzzahl	Die maximale Anzahl der Aufrufe an integrierte Tools, die in einer Antwort verarbeitet werden können. Diese maximale Anzahl gilt für alle integrierten Toolaufrufe, nicht pro einzelnes Tool. Alle weiteren Versuche, ein Tool durch das Modell aufzurufen, werden ignoriert.	No
└- Metadaten	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
└- Objekt	enum	Der Objekttyp dieser Ressource - immer auf .`response` Mögliche Werte: `response`	No
└─ Ausgabe	array	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array hängt von der Antwort des Modells ab. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant` Nachricht mit dem vom Modell generierten Inhalt handelt, können Sie die Verwendung der `output_text` Eigenschaft, die in SDKs unterstützt wird, in Betracht ziehen.	No
└─ Ausgabentext	string	Nur-SDK-Komforteigenschaft, die die aggregierte Textausgabe aller `output_text` Elemente im `output` Array enthält, sofern vorhanden. Unterstützt in den Python- und JavaScript-SDKs.	No
└─ parallele_Werkzeugaufrufe	Boolescher Wert	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	No	Richtig
└– vorherige_Antwort_ID	string	Die eindeutige ID der vorherigen Antwort auf das Modell. Verwenden Sie diese Option, um Multi-Turn-Unterhaltungen zu erstellen.	No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	No
└– Begründung	OpenAI.Reasoning	Nur o-Serienmodelle Konfigurationsoptionen für Begründungsmodelle.	No
└─ Status	enum	Der Status der Antwortgenerierung. Einer von `completed`, `failed`, `in_progress`, , `cancelled`, , `queued`oder `incomplete`. Mögliche Werte: `completed`, , `failed`, `in_progresscancelled`, , , `queuedincomplete`	No
└– Temperatur	number	Welche Probenahmetemperatur verwendet werden soll, zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Es wird in der Regel empfohlen, dies oder `top_p` nicht beides zu ändern.	No
└– Text	Objekt	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann Nur-Text- oder strukturierte JSON-Daten sein.	No
└─ Format	OpenAI.ResponseTextFormatConfiguration		No
└─ Werkzeugwahl	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceObject	Wie das Modell auswählen soll, welches Tool (oder welche Tools) beim Generieren einer Antwort verwendet werden soll. Sehen Sie sich den `tools` Parameter an, um zu sehen, wie Sie angeben, welche Tools das Modell aufrufen kann.	No
└- Werkzeuge	array	Ein Array von Tools, die das Modell aufrufen kann, während eine Antwort generiert wird. Sie können angeben, welches Tool verwendet werden soll, indem Sie den `tool_choice` Parameter festlegen. Die beiden Kategorien von Tools, die Sie bereitstellen können, sind: - Integrierte Tools: Tools, die von OpenAI bereitgestellt werden, die die Funktionen des Modells erweitern.	No
└– top_logprobs	Ganzzahl	Eine ganze Zahl zwischen 0 und 20, die die Anzahl der höchstwahrscheinlichen Token an jeder Tokenposition angibt, jeweils mit einer zugeordneten Protokollwahrscheinlichkeit.	No
└– top_p	number	Eine Alternative zur Probenahme mit Temperatur, die als Kernsampling bezeichnet wird, wobei das Modell die Ergebnisse der Token mit top_p Wahrscheinlichkeitsmasse berücksichtigt. 0,1 bedeutet also, dass nur die Token, die die obersten 10% Wahrscheinlichkeitsmasse umfassen, berücksichtigt werden. Es wird in der Regel empfohlen, dies oder `temperature` nicht beides zu ändern.	No
└– Abschneiden	enum	Die Abkürzungsstrategie, die für die Modellantwort verwendet werden soll. - `auto`: Wenn der Kontext dieser Antwort und früherer Antworten die Größe des Kontextfensters des Modells überschreitet, schneidet das Modell die Antwort ab, um das Kontextfenster anzupassen, indem Eingabeelemente in der Mitte der Unterhaltung gelöscht werden. - `disabled` (Standard): Wenn eine Modellantwort die Kontextfenstergröße für ein Modell überschreitet, schlägt die Anforderung mit einem Fehler von 400 fehl. Mögliche Werte: `auto`, `disabled`	No
└– Nutzung	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails wie Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken dar.	No
└– Benutzer	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	No
type	enum	Der Typ des Ereignisses. Immer `response.incomplete`. Mögliche Werte: `response.incomplete`	Ja

OpenAI.ResponseItemList

Eine Liste der Antwortelemente.

Name	Typ	Beschreibung	Erforderlich
data	array	Eine Liste der Elemente, die zum Generieren dieser Antwort verwendet werden.	Ja
first_id	string	Die ID des ersten Elements in der Liste.	Ja
has_more	Boolescher Wert	Gibt an, ob weitere Elemente verfügbar sind.	Ja
last_id	string	Die ID des letzten Elements in der Liste.	Ja
Objekt	enum	Der Typ des zurückgegebenen Objekts muss sein `list`. Mögliche Werte: `list`	Ja

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Wird ausgegeben, wenn ein Delta (partielle Aktualisierung) für die Argumente eines MCP-Toolaufrufs vorhanden ist.

Name	Typ	Beschreibung	Erforderlich
delta		Die teilweise Aktualisierung der Argumente für den MCP-Toolaufruf.	Ja
item_id	string	Der eindeutige Bezeichner des verarbeiteten MCP-Toolaufrufelements.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
type	enum	Der Typ des Ereignisses. Immer „response.mcp_call.arguments_delta”. Mögliche Werte: `response.mcp_call.arguments_delta`	Ja

OpenAI.ResponseMCPCallArgumentsDoneEvent

Wird ausgegeben, wenn die Argumente für einen MCP-Toolaufruf abgeschlossen werden.

Name	Typ	Beschreibung	Erforderlich
Argumente		Die abgeschlossenen Argumente für den MCP-Toolaufruf.	Ja
item_id	string	Der eindeutige Bezeichner des verarbeiteten MCP-Toolaufrufelements.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
type	enum	Der Typ des Ereignisses. Immer „response.mcp_call.arguments_done”. Mögliche Werte: `response.mcp_call.arguments_done`	Ja

OpenAI.ResponseMCPCallCompletedEvent

Wird ausgegeben, wenn ein MCP-Toolaufruf erfolgreich abgeschlossen wurde.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Der Typ des Ereignisses. Immer „response.mcp_call.completed“. Mögliche Werte: `response.mcp_call.completed`	Ja

OpenAI.ResponseMCPCallFailedEvent

Wird ausgegeben, wenn ein MCP-Toolaufruf fehlgeschlagen ist.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Der Typ des Ereignisses. Immer „response.mcp_call.failed“. Mögliche Werte: `response.mcp_call.failed`	Ja

OpenAI.ResponseMCPCallInProgressEvent

Wird ausgegeben, wenn ein MCP-Toolaufruf ausgeführt wird.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Der eindeutige Bezeichner des verarbeiteten MCP-Toolaufrufelements.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
type	enum	Der Typ des Ereignisses. Immer „response.mcp_call.in_progress”. Mögliche Werte: `response.mcp_call.in_progress`	Ja

OpenAI.ResponseMCPListToolsCompletedEvent

Wird ausgegeben, wenn die Liste der verfügbaren MCP-Tools erfolgreich abgerufen wurde.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Der Typ des Ereignisses. Immer „response.mcp_list_tools.completed”. Mögliche Werte: `response.mcp_list_tools.completed`	Ja

OpenAI.ResponseMCPListToolsFailedEvent

Wird ausgegeben, wenn der Versuch, die verfügbaren MCP-Tools auflisten, fehlgeschlagen ist.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Der Typ des Ereignisses. Immer „response.mcp_list_tools.failed”. Mögliche Werte: `response.mcp_list_tools.failed`	Ja

OpenAI.ResponseMCPListToolsInProgressEvent

Wird ausgegeben, wenn sich das System im Prozess des Abrufens der Liste der verfügbaren MCP-Tools befindet.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Der Typ des Ereignisses. Immer „response.mcp_list_tools.in_progress”. Mögliche Werte: `response.mcp_list_tools.in_progress`	Ja

OpenAI.ResponseOutputItemAddedEvent

Wird ausgegeben, wenn ein neues Ausgabeelement hinzugefügt wird.

Name	Typ	Beschreibung	Erforderlich
item	Objekt	Inhaltselement, das zum Generieren einer Antwort verwendet wird.	Ja
└– ID	string		No
└– Typ	OpenAI.ItemType		No
output_index	Ganzzahl	Der Index des Ausgabeelements, das hinzugefügt wurde.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.output_item.added`. Mögliche Werte: `response.output_item.added`	Ja

OpenAI.ResponseOutputItemDoneEvent

Wird ausgegeben, wenn ein Ausgabeelement als erledigt markiert wird.

Name	Typ	Beschreibung	Erforderlich
item	Objekt	Inhaltselement, das zum Generieren einer Antwort verwendet wird.	Ja
└– ID	string		No
└– Typ	OpenAI.ItemType		No
output_index	Ganzzahl	Der Index des Ausgabeelements, das als erledigt markiert wurde.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.output_item.done`. Mögliche Werte: `response.output_item.done`	Ja

OpenAI.ResponsePromptVariables

Optionale Zuordnung von Werten, die durch Variablen in Ihrer Eingabeaufforderung ersetzt werden sollen. Die Ersetzungswerte können entweder Zeichenfolgen oder andere Antworteingabetypen wie Bilder oder Dateien sein.

Typ: Objekt

OpenAI.ResponseQueuedEvent

Wird ausgegeben, wenn eine Antwort in die Warteschlange gestellt wird und darauf wartet, verarbeitet zu werden.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
response	Objekt		Ja
└– Hintergrund	Boolescher Wert	Gibt an, ob die Modellantwort im Hintergrund ausgeführt werden soll.	No	Falsch
└– created_at	Ganzzahl	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	No
└– Fehler	OpenAI.ResponseError	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	No
└– ID	string	Eindeutiger Bezeichner für diese Antwort.	No
└─ unvollständige_Details	Objekt	Details dazu, warum die Antwort unvollständig ist.	No
└– Grund	enum	Der Grund, warum die Antwort unvollständig ist. Mögliche Werte: `max_output_tokens`, `content_filter`	No
└– Anweisungen	Zeichenfolge oder Matrix	Eine Systemnachricht (oder Entwicklernachricht), die in den Kontext des Modells eingefügt wurde. Bei Verwendung dieser `previous_response_id`Antwort werden die Anweisungen aus einer vorherigen Antwort nicht an die nächste Antwort übertragen. Dies erleichtert das Austauschen von Systemnachrichten (oder Entwicklernachrichten) in neuen Antworten.	No
└– max_output_tokens	Ganzzahl	Eine obere Grenze für die Anzahl der Token, die für eine Antwort generiert werden können, einschließlich sichtbarer Ausgabetoken und Begründungstoken	No
└– max_tool_calls	Ganzzahl	Die maximale Anzahl der Aufrufe an integrierte Tools, die in einer Antwort verarbeitet werden können. Diese maximale Anzahl gilt für alle integrierten Toolaufrufe, nicht pro einzelnes Tool. Alle weiteren Versuche, ein Tool durch das Modell aufzurufen, werden ignoriert.	No
└- Metadaten	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
└- Objekt	enum	Der Objekttyp dieser Ressource - immer auf .`response` Mögliche Werte: `response`	No
└─ Ausgabe	array	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array hängt von der Antwort des Modells ab. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant` Nachricht mit dem vom Modell generierten Inhalt handelt, können Sie die Verwendung der `output_text` Eigenschaft, die in SDKs unterstützt wird, in Betracht ziehen.	No
└─ Ausgabentext	string	Nur-SDK-Komforteigenschaft, die die aggregierte Textausgabe aller `output_text` Elemente im `output` Array enthält, sofern vorhanden. Unterstützt in den Python- und JavaScript-SDKs.	No
└─ parallele_Werkzeugaufrufe	Boolescher Wert	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	No	Richtig
└– vorherige_Antwort_ID	string	Die eindeutige ID der vorherigen Antwort auf das Modell. Verwenden Sie diese Option, um Multi-Turn-Unterhaltungen zu erstellen.	No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	No
└– Begründung	OpenAI.Reasoning	Nur o-Serienmodelle Konfigurationsoptionen für Begründungsmodelle.	No
└─ Status	enum	Der Status der Antwortgenerierung. Einer von `completed`, `failed`, `in_progress`, , `cancelled`, , `queued`oder `incomplete`. Mögliche Werte: `completed`, , `failed`, `in_progresscancelled`, , , `queuedincomplete`	No
└– Temperatur	number	Welche Probenahmetemperatur verwendet werden soll, zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Es wird in der Regel empfohlen, dies oder `top_p` nicht beides zu ändern.	No
└– Text	Objekt	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann Nur-Text- oder strukturierte JSON-Daten sein.	No
└─ Format	OpenAI.ResponseTextFormatConfiguration		No
└─ Werkzeugwahl	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceObject	Wie das Modell auswählen soll, welches Tool (oder welche Tools) beim Generieren einer Antwort verwendet werden soll. Sehen Sie sich den `tools` Parameter an, um zu sehen, wie Sie angeben, welche Tools das Modell aufrufen kann.	No
└- Werkzeuge	array	Ein Array von Tools, die das Modell aufrufen kann, während eine Antwort generiert wird. Sie können angeben, welches Tool verwendet werden soll, indem Sie den `tool_choice` Parameter festlegen. Die beiden Kategorien von Tools, die Sie bereitstellen können, sind: - Integrierte Tools: Tools, die von OpenAI bereitgestellt werden, die die Funktionen des Modells erweitern.	No
└– top_logprobs	Ganzzahl	Eine ganze Zahl zwischen 0 und 20, die die Anzahl der höchstwahrscheinlichen Token an jeder Tokenposition angibt, jeweils mit einer zugeordneten Protokollwahrscheinlichkeit.	No
└– top_p	number	Eine Alternative zur Probenahme mit Temperatur, die als Kernsampling bezeichnet wird, wobei das Modell die Ergebnisse der Token mit top_p Wahrscheinlichkeitsmasse berücksichtigt. 0,1 bedeutet also, dass nur die Token, die die obersten 10% Wahrscheinlichkeitsmasse umfassen, berücksichtigt werden. Es wird in der Regel empfohlen, dies oder `temperature` nicht beides zu ändern.	No
└– Abschneiden	enum	Die Abkürzungsstrategie, die für die Modellantwort verwendet werden soll. - `auto`: Wenn der Kontext dieser Antwort und früherer Antworten die Größe des Kontextfensters des Modells überschreitet, schneidet das Modell die Antwort ab, um das Kontextfenster anzupassen, indem Eingabeelemente in der Mitte der Unterhaltung gelöscht werden. - `disabled` (Standard): Wenn eine Modellantwort die Kontextfenstergröße für ein Modell überschreitet, schlägt die Anforderung mit einem Fehler von 400 fehl. Mögliche Werte: `auto`, `disabled`	No
└– Nutzung	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails wie Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken dar.	No
└– Benutzer	string	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen.	No
type	enum	Der Typ des Ereignisses. Immer „response.queued”. Mögliche Werte: `response.queued`	Ja

OpenAI.ResponseReasoningDeltaEvent

Wird ausgegeben, wenn ein Delta (teilweise Aktualisierung) für den Grundinhalt vorhanden ist.

Name	Typ	Beschreibung	Erforderlich
content_index	Ganzzahl	Der Index des Grundinhaltsteils innerhalb des Ausgabeelements.	Ja
delta		Das partielle Update auf den Inhalt der Begründung.	Ja
item_id	string	Der eindeutige Bezeichner des Elements, für das die Ursache aktualisiert wird.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
type	enum	Der Typ des Ereignisses. Immer „response.reasoning.delta”. Mögliche Werte: `response.reasoning.delta`	Ja

OpenAI.ResponseReasoningDoneEvent

Wird ausgegeben, wenn der Grundinhalt für ein Element abgeschlossen ist.

Name	Typ	Beschreibung	Erforderlich
content_index	Ganzzahl	Der Index des Grundinhaltsteils innerhalb des Ausgabeelements.	Ja
item_id	string	Der eindeutige Bezeichner des Elements, für das die Begründung abgeschlossen ist.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
Text	string	Der abschließende Text für die Begründung.	Ja
type	enum	Der Typ des Ereignisses. Immer „response.reasoning.delta”. Mögliche Werte: `response.reasoning.done`	Ja

OpenAI.ResponseReasoningSummaryDeltaEvent

Wird ausgegeben, wenn ein Delta (teilweise Aktualisierung) für den Zusammenfassungsinhalt der Gründe vorhanden ist.

Name	Typ	Beschreibung	Erforderlich
delta		Die partielle Aktualisierung des Zusammenfassungsinhalts für die Begründung.	Ja
item_id	string	Der eindeutige Bezeichner des Elements, für das die Zusammenfassung der Gründe aktualisiert wird.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
summary_index	Ganzzahl	Der Index des Zusammenfassungsteils innerhalb des Ausgabeelements.	Ja
type	enum	Der Typ des Ereignisses. Immer „response.reasoning_summary.delta”. Mögliche Werte: `response.reasoning_summary.delta`	Ja

OpenAI.ResponseReasoningSummaryDoneEvent

Wird ausgegeben, wenn der Zusammenfassungsinhalt der Gründe für ein Element abgeschlossen ist.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Der eindeutige Bezeichner des Elements, für das die Zusammenfassung der Gründe abgeschlossen ist.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
summary_index	Ganzzahl	Der Index des Zusammenfassungsteils innerhalb des Ausgabeelements.	Ja
Text	string	Der abschließende Zusammenfassungstext für die Begründung.	Ja
type	enum	Der Typ des Ereignisses. Immer „response.reasoning_summary.done”. Mögliche Werte: `response.reasoning_summary.done`	Ja

OpenAI.ResponseReasoningSummaryPartAddedEvent

Wird ausgegeben, wenn ein neuer Zusammenfassungsteil für die Begründung hinzugefügt wird.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Die ID des Elements, dem dieser Zusammenfassungsteil zugeordnet ist.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, dem dieser Zusammenfassungsteil zugeordnet ist.	Ja
part	Objekt		Ja
└– Typ	OpenAI.ReasoningItemSummaryPartType		No
summary_index	Ganzzahl	Der Index des Zusammenfassungsteils innerhalb der Zusammenfassung der Begründung.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.reasoning_summary_part.added`. Mögliche Werte: `response.reasoning_summary_part.added`	Ja

OpenAI.ResponseReasoningSummaryPartDoneEvent

Wird ausgegeben, wenn ein Zusammenfassungsteil für die Begründung abgeschlossen ist.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Die ID des Elements, dem dieser Zusammenfassungsteil zugeordnet ist.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, dem dieser Zusammenfassungsteil zugeordnet ist.	Ja
part	Objekt		Ja
└– Typ	OpenAI.ReasoningItemSummaryPartType		No
summary_index	Ganzzahl	Der Index des Zusammenfassungsteils innerhalb der Zusammenfassung der Begründung.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.reasoning_summary_part.done`. Mögliche Werte: `response.reasoning_summary_part.done`	Ja

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Wird ausgegeben, wenn ein Delta zu einem Zusammenfassungstext für die Begründung hinzugefügt wird.

Name	Typ	Beschreibung	Erforderlich
delta	string	Das Textdelta, das der Zusammenfassung hinzugefügt wurde.	Ja
item_id	string	Die ID des Elements, dem dieses Zusammenfassungstextdelta zugeordnet ist.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, dem dieses Zusammenfassungstextdelta zugeordnet ist.	Ja
summary_index	Ganzzahl	Der Index des Zusammenfassungsteils innerhalb der Zusammenfassung der Begründung.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.reasoning_summary_text.delta`. Mögliche Werte: `response.reasoning_summary_text.delta`	Ja

OpenAI.ResponseReasoningSummaryTextDoneEvent

Wird ausgegeben, wenn ein Grundübersichtstext abgeschlossen ist.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Die ID des Elements, dem dieser Zusammenfassungstext zugeordnet ist.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, dem dieser Zusammenfassungstext zugeordnet ist.	Ja
summary_index	Ganzzahl	Der Index des Zusammenfassungsteils innerhalb der Zusammenfassung der Begründung.	Ja
Text	string	Der vollständige Text der vollständigen Zusammenfassung der Begründung.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.reasoning_summary_text.done`. Mögliche Werte: `response.reasoning_summary_text.done`	Ja

OpenAI.ResponseRefusalDeltaEvent

Wird ausgegeben, wenn ein Teilverweigerungstext vorhanden ist.

Name	Typ	Beschreibung	Erforderlich
content_index	Ganzzahl	Der Index des Inhaltsteils, dem der Ablehnungstext hinzugefügt wird.	Ja
delta	string	Der Verweigerungstext, der hinzugefügt wird.	Ja
item_id	string	Die ID des Ausgabeelements, dem der Ablehnungstext hinzugefügt wird.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, dem der Ablehnungstext hinzugefügt wird.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.refusal.delta`. Mögliche Werte: `response.refusal.delta`	Ja

OpenAI.ResponseRefusalDoneEvent

Wird ausgegeben, wenn der Ablehnungstext abgeschlossen ist.

Name	Typ	Beschreibung	Erforderlich
content_index	Ganzzahl	Der Index des Inhaltsteils, den der Ablehnungstext abgeschlossen hat.	Ja
item_id	string	Die ID des Ausgabeelements, für das der Ablehnungstext abgeschlossen ist.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, für das der Ablehnungstext abgeschlossen ist.	Ja
Weigerung	string	Der Verweigerungstext, der abgeschlossen ist.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.refusal.done`. Mögliche Werte: `response.refusal.done`	Ja

OpenAI.ResponseStreamEvent

Diskriminator für OpenAI.ResponseStreamEvent

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	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	Typ	Beschreibung	Erforderlich	Vorgabe
sequence_number	Ganzzahl	Die Sequenznummer für dieses Ereignis.	Ja
type	OpenAI.ResponseStreamEventType		Ja

OpenAI.ResponseStreamEventType

Eigentum Wert

Typ string

Werte 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

Wird ausgegeben, wenn ein zusätzliches Textdelta vorhanden ist.

Name	Typ	Beschreibung	Erforderlich
content_index	Ganzzahl	Der Index des Inhaltsteils, dem das Textdelta hinzugefügt wurde.	Ja
delta	string	Das Textdelta, das hinzugefügt wurde.	Ja
item_id	string	Die ID des Ausgabeelements, dem das Textdelta hinzugefügt wurde.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, dem das Textdelta hinzugefügt wurde.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.output_text.delta`. Mögliche Werte: `response.output_text.delta`	Ja

OpenAI.ResponseTextDoneEvent

Wird ausgegeben, wenn Der Textinhalt abgeschlossen ist.

Name	Typ	Beschreibung	Erforderlich
content_index	Ganzzahl	Der Index des Inhaltsteils, den der Textinhalt abgeschlossen hat.	Ja
item_id	string	Die ID des Ausgabeelements, das der Textinhalt abgeschlossen ist.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, für das der Textinhalt abgeschlossen ist.	Ja
Text	string	Der textinhalt, der abgeschlossen ist.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.output_text.done`. Mögliche Werte: `response.output_text.done`	Ja

OpenAI.ResponseTextFormatConfiguration

Diskriminator für OpenAI.ResponseTextFormatConfiguration

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`text`	OpenAI.ResponseTextFormatConfigurationText
`json_object`	OpenAI.ResponseTextFormatConfigurationJsonObject
`json_schema`	OpenAI.ResponseTextFormatConfigurationJsonSchema

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.ResponseTextFormatConfigurationType	Ein Objekt, das das Format angibt, das das Modell ausgeben muss. Durch das Konfigurieren von `{ "type": "json_schema" }` strukturierten Ausgaben wird sichergestellt, dass das Modell mit Ihrem bereitgestellten JSON-Schema übereinstimmt. Das Standardformat ist `{ "type": "text" }` ohne zusätzliche Optionen verfügbar. Nicht empfohlen für gpt-4o und neuere Modelle: Einstellung, um den älteren JSON-Modus zu `{ "type": "json_object" }` aktivieren, wodurch sichergestellt wird, dass die Nachricht, die das Modell generiert, gültig JSON ist. Die Verwendung `json_schema` wird für Modelle bevorzugt, die sie unterstützen.	Ja

OpenAI.ResponseTextFormatConfigurationJsonObject

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Mögliche Werte: `json_object`	Ja

OpenAI.ResponseTextFormatConfigurationJsonSchema

JSON-Schemaantwortformat. Wird verwendet, um strukturierte JSON-Antworten zu generieren.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Beschreibung	string	Eine Beschreibung des Antwortformats, für das das Modell verwendet wird, um zu bestimmen, wie das Format reagiert.	No
Name	string	Der Name des Antwortformats. Muss a-z, A-Z, 0-9 sein oder Unterstriche und Gedankenstriche enthalten, mit einer maximalen Länge von 64.	Ja
schema	OpenAI.ResponseFormatJsonSchemaSchema	Das Schema für das Antwortformat, das als JSON-Schemaobjekt beschrieben wird. Hier erfahren Sie, wie Sie JSON-Schemas erstellen.	Ja
strict	Boolescher Wert	Gibt an, ob die strikte Schematreue beim Generieren der Ausgabe aktiviert werden soll. Bei Festlegung auf "true" folgt das Modell immer dem genauen Schema, das `schema` im Feld definiert ist. Es wird nur eine Teilmenge des JSON-Schemas unterstützt, wenn `strict` dies der Zeitpunkt ist `true`.	No	Falsch
type	enum	Der Typ des zu definierenden Antwortformats. Immer `json_schema`. Mögliche Werte: `json_schema`	Ja

OpenAI.ResponseTextFormatConfigurationText

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Mögliche Werte: `text`	Ja

OpenAI.ResponseTextFormatConfigurationType

Ein Objekt, das das Format angibt, das das Modell ausgeben muss.

Durch das Konfigurieren von { "type": "json_schema" } strukturierten Ausgaben wird sichergestellt, dass das Modell mit Ihrem bereitgestellten JSON-Schema übereinstimmt.

Das Standardformat ist { "type": "text" } ohne zusätzliche Optionen verfügbar.

Nicht empfohlen für gpt-4o und neuere Modelle:

Einstellung, um den älteren JSON-Modus zu { "type": "json_object" } aktivieren, wodurch sichergestellt wird, dass die Nachricht, die das Modell generiert, gültig JSON ist. Die Verwendung json_schema wird für Modelle bevorzugt, die sie unterstützen.

Eigentum	Wert
Beschreibung	Ein Objekt, das das Format angibt, das das Modell ausgeben muss.

Durch das Konfigurieren von { "type": "json_schema" } strukturierten Ausgaben wird sichergestellt, dass das Modell mit Ihrem bereitgestellten JSON-Schema übereinstimmt.

Das Standardformat ist { "type": "text" } ohne zusätzliche Optionen verfügbar.

Nicht empfohlen für gpt-4o und neuere Modelle:

Einstellung, um den älteren JSON-Modus zu { "type": "json_object" } aktivieren, wodurch sichergestellt wird, dass die Nachricht, die das Modell generiert, gültig JSON ist. Die Verwendung json_schemawird für Modelle bevorzugt, die sie unterstützen.

OpenAI.ResponseUsage

Stellt Tokenverwendungsdetails wie Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken dar.

Name	Typ	Beschreibung	Erforderlich
input_tokens	Ganzzahl	Die Anzahl der Eingabetoken.	Ja
input_tokens_details	Objekt	Eine detaillierte Aufschlüsselung der Eingabetoken.	Ja
└– zwischengespeicherte_Token	Ganzzahl	Die Anzahl der Token, die aus dem Cache abgerufen wurden.	No
output_tokens	Ganzzahl	Die Anzahl der Ausgabetoken.	Ja
output_tokens_details	Objekt	Eine detaillierte Aufschlüsselung der Ausgabetoken.	Ja
└– reasoning_tokens	Ganzzahl	Die Anzahl der Gründe für Token.	No
Gesamtanzahl Tokens	Ganzzahl	Die Gesamtzahl der verwendeten Token.	Ja

OpenAI.ResponseWebSearchCallCompletedEvent

Hinweis: web_search ist noch nicht über Azure OpenAI verfügbar.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Eindeutige ID für das Ausgabeelement, das dem Websuchaufruf zugeordnet ist.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, dem der Websuchaufruf zugeordnet ist.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.web_search_call.completed`. Mögliche Werte: `response.web_search_call.completed`	Ja

OpenAI.ResponseWebSearchCallInProgressEvent

Hinweis: web_search ist noch nicht über Azure OpenAI verfügbar.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Eindeutige ID für das Ausgabeelement, das dem Websuchaufruf zugeordnet ist.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, dem der Websuchaufruf zugeordnet ist.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.web_search_call.in_progress`. Mögliche Werte: `response.web_search_call.in_progress`	Ja

OpenAI.ResponseWebSearchCallSearchingEvent

Hinweis: web_search ist noch nicht über Azure OpenAI verfügbar.

Name	Typ	Beschreibung	Erforderlich
item_id	string	Eindeutige ID für das Ausgabeelement, das dem Websuchaufruf zugeordnet ist.	Ja
output_index	Ganzzahl	Der Index des Ausgabeelements, dem der Websuchaufruf zugeordnet ist.	Ja
type	enum	Der Typ des Ereignisses. Immer `response.web_search_call.searching`. Mögliche Werte: `response.web_search_call.searching`	Ja

OpenAI.ResponsesAssistantMessageItemParam

Ein Nachrichtenparameterelement mit der assistant Rolle.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Inhalt	array	Der inhalt, der der Nachricht zugeordnet ist.	Ja
Rolle	enum	Die Rolle der Nachricht, die immer `assistant`ist. Mögliche Werte: `assistant`	Ja

OpenAI.ResponsesAssistantMessageItemResource

Ein Nachrichtenressourcenelement mit der assistant Rolle.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Inhalt	array	Der inhalt, der der Nachricht zugeordnet ist.	Ja
Rolle	enum	Die Rolle der Nachricht, die immer `assistant`ist. Mögliche Werte: `assistant`	Ja

OpenAI.ResponsesDeveloperMessageItemParam

Ein Nachrichtenparameterelement mit der developer Rolle.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Inhalt	array	Der inhalt, der der Nachricht zugeordnet ist.	Ja
Rolle	enum	Die Rolle der Nachricht, die immer `developer`ist. Mögliche Werte: `developer`	Ja

OpenAI.ResponsesDeveloperMessageItemResource

Ein Nachrichtenressourcenelement mit der developer Rolle.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Inhalt	array	Der inhalt, der der Nachricht zugeordnet ist.	Ja
Rolle	enum	Die Rolle der Nachricht, die immer `developer`ist. Mögliche Werte: `developer`	Ja

OpenAI.ResponsesMessageItemParam

Ein Antwortnachrichtelement, das eine Rolle und einen Inhalt darstellt, wie als Clientanforderungsparameter angegeben.

Diskriminator für OpenAI.ResponsesMessageItemParam

Diese Komponente verwendet die Eigenschaft role , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`user`	OpenAI.ResponsesUserMessageItemParam
`system`	OpenAI.ResponsesSystemMessageItemParam
`developer`	OpenAI.ResponsesDeveloperMessageItemParam
`assistant`	OpenAI.ResponsesAssistantMessageItemParam

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Rolle	Objekt	Die Sammlung gültiger Rollen für Antwortnachrichtenelemente.	Ja
type	enum	Der Typ des Antwortelements, das immer "Nachricht" ist. Mögliche Werte: `message`	Ja

OpenAI.ResponsesMessageItemResource

Ein Ressourcenelement für Antwortnachrichten, das eine Rolle und inhalte darstellt, wie in Dienstantworten angegeben.

Diskriminator für OpenAI.ResponsesMessageItemResource

Diese Komponente verwendet die Eigenschaft role , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`user`	OpenAI.ResponsesUserMessageItemResource
`system`	OpenAI.ResponsesSystemMessageItemResource
`developer`	OpenAI.ResponsesDeveloperMessageItemResource
`assistant`	OpenAI.ResponsesAssistantMessageItemResource

Name	Typ	Beschreibung	Erforderlich
Rolle	Objekt	Die Sammlung gültiger Rollen für Antwortnachrichtenelemente.	Ja
Status	enum	Der Status des Elements. Einer von `in_progress`, `completed`, oder `incomplete`. Aufgefüllt, wenn Elemente über DIE API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Der Typ des Antwortelements, das immer "Nachricht" ist. Mögliche Werte: `message`	Ja

OpenAI.ResponsesMessageRole

Die Sammlung gültiger Rollen für Antwortnachrichtenelemente.

Eigentum	Wert
Beschreibung	Die Sammlung gültiger Rollen für Antwortnachrichtenelemente.
Typ	string
Werte	`system` `developer` `user` `assistant`

OpenAI.ResponsesSystemMessageItemParam

Ein Nachrichtenparameterelement mit der system Rolle.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Inhalt	array	Der inhalt, der der Nachricht zugeordnet ist.	Ja
Rolle	enum	Die Rolle der Nachricht, die immer `system`ist. Mögliche Werte: `system`	Ja

OpenAI.ResponsesSystemMessageItemResource

Ein Nachrichtenressourcenelement mit der system Rolle.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Inhalt	array	Der inhalt, der der Nachricht zugeordnet ist.	Ja
Rolle	enum	Die Rolle der Nachricht, die immer `system`ist. Mögliche Werte: `system`	Ja

OpenAI.ResponsesUserMessageItemParam

Ein Nachrichtenparameterelement mit der user Rolle.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Inhalt	array	Der inhalt, der der Nachricht zugeordnet ist.	Ja
Rolle	enum	Die Rolle der Nachricht, die immer `user`ist. Mögliche Werte: `user`	Ja

OpenAI.ResponsesUserMessageItemResource

Ein Nachrichtenressourcenelement mit der user Rolle.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Inhalt	array	Der inhalt, der der Nachricht zugeordnet ist.	Ja
Rolle	enum	Die Rolle der Nachricht, die immer `user`ist. Mögliche Werte: `user`	Ja

OpenAI.RunGraderRequest

Name	Typ	Beschreibung	Erforderlich
Grader	Objekt	Ein StringCheckGrader-Objekt, das einen Zeichenfolgenvergleich zwischen Eingabe und Verweis mithilfe eines angegebenen Vorgangs durchführt.	Ja
└– calculate_output	string	Eine Formel zum Berechnen der Ausgabe basierend auf den Benotungsergebnissen.	No
└- Bewertungsmetrik	enum	Die zu verwendende Auswertungsmetrik. Einer von `fuzzy_match`, `bleu`, , `gleumeteor`, `rouge_1`, , `rouge_2`, `rouge_3`, `rouge_4`, , oder `rouge_5rouge_l`. Mögliche Werte: `fuzzy_match`, , `bleu`, `gleu`, `meteorrouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5rouge_l`	No
└– Noten	Objekt		No
└– image_tag	string	Das Bildtag, das für das Python-Skript verwendet werden soll.	No
└– Eingabe	array	Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten.	No
└─ Modell	string	Das Modell, das für die Auswertung verwendet werden soll.	No
└– Name	string	Der Name des Graders.	No
└─ Vorgang	enum	Der auszuführende Zeichenfolgenüberprüfungsvorgang. Einer von `eq`, `ne`, , `like`oder `ilike`. Mögliche Werte: `eq`, , `ne`, `likeilike`	No
└– Bereich	array	Der Bereich der Bewertung. Standardwert ist .`[0, 1]`	No
└– Referenz	string	Der Text, der abgestuft wird.	No
└– Stichprobenparameter		Die Samplingparameter für das Modell.	No
└- Quelle	string	Der Quellcode des Python-Skripts.	No
└– Typ	enum	Der Objekttyp, der immer `multi`ist. Mögliche Werte: `multi`	No
item		Das Datasetelement, das dem Grader bereitgestellt wird. Dies wird verwendet, um den `item` Namespace aufzufüllen.	No
model_sample	string	Das zu bewertende Modellbeispiel. Dieser Wert wird verwendet, um den `sample` Namespace aufzufüllen. Die `output_json` Variable wird aufgefüllt, wenn das Modellbeispiel eine gültige JSON-Zeichenfolge ist.	Ja

OpenAI.RunGraderResponse

Name	Typ	Erforderlich
metadata	Objekt	Ja
└– Fehler	Objekt	No
└– Formelauswertungsfehler	Boolescher Wert	No
└– ungültiger_Variablenfehler	Boolescher Wert	No
└– model_grader_parse_error	Boolescher Wert	No
└– model_grader_refusal_error	Boolescher Wert	No
└– model_grader_server_error	Boolescher Wert	No
└– model_grader_server_error_details	string	No
└– other_error	Boolescher Wert	No
└– python_grader_runtime_error	Boolescher Wert	No
└– python_grader_runtime_error_details	string	No
└– python_grader_server_error	Boolescher Wert	No
└– python_grader_server_error_type	string	No
└– sample_parse_error	Boolescher Wert	No
└─ abgeschnittener_Beobachtungsfehler	Boolescher Wert	No
└– nicht-reaktionsfähiger_Belohnungsfehler	Boolescher Wert	No
└– Ausführungszeit	number	No
└– Name	string	No
└- sampled_model_name	string	No
└– Wertungen		No
└– Tokenverwendung	Ganzzahl	No
└– Typ	string	No
model_grader_token_usage_per_model		Ja
Belohnung	number	Ja
sub_rewards		Ja

OpenAI.StaticChunkingStrategy

Name	Typ	Beschreibung	Erforderlich	Vorgabe
chunk_overlap_tokens	Ganzzahl	Die Anzahl der Token, die sich zwischen Blöcken überlappen. Der Standardwert ist `400`. Beachten Sie, dass die Überlappung nicht die Hälfte von `max_chunk_size_tokens`.	Ja
max_chunk_size_tokens	Ganzzahl	Die maximale Anzahl von Token in jedem Block. Der Standardwert ist `800`. Der Minimalwert ist `100` und der Maximalwert ist `4096`.	Ja

OpenAI.StaticChunkingStrategyRequestParam

Passen Sie Ihre eigene Blockierungsstrategie an, indem Sie die Blockgröße und den Block überlappen.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Statisch	OpenAI.StaticChunkingStrategy		Ja
type	enum	Immer `static`. Mögliche Werte: `static`	Ja

OpenAI.StaticChunkingStrategyResponseParam

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Statisch	OpenAI.StaticChunkingStrategy		Ja
type	enum	Immer `static`. Mögliche Werte: `static`	Ja

OpenAI.StopConfiguration

Nicht unterstützt mit den neuesten Begründungsmodellen o3 und o4-mini.

Bis zu 4 Sequenzen, bei denen die API keine weiteren Token mehr generiert. Der zurückgegebene Text enthält nicht die Stoppsequenz.

Dieses Schema akzeptiert einen der folgenden Typen:

Zeichenfolge
Anordnung

OpenAI.Tool

Diskriminator für OpenAI.Tool

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	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	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.ToolType	Ein Tool, das zum Generieren einer Antwort verwendet werden kann.	Ja

OpenAI.ToolChoiceObject

Diskriminator für OpenAI.ToolChoiceObject

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	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	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.ToolChoiceObjectType	Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll.	Ja

OpenAI.ToolChoiceObjectCodeInterpreter

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Mögliche Werte: `code_interpreter`	Ja

OpenAI.ToolChoiceObjectComputer

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Mögliche Werte: `computer_use_preview`	Ja

OpenAI.ToolChoiceObjectFileSearch

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Mögliche Werte: `file_search`	Ja

OpenAI.ToolChoiceObjectFunction

Verwenden Sie diese Option, um zu erzwingen, dass das Modell eine bestimmte Funktion aufruft.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Name	string	Der Name der funktion, die aufgerufen werden soll.	Ja
type	enum	Bei Funktionsaufrufen ist der Typ immer `function`. Mögliche Werte: `function`	Ja

OpenAI.ToolChoiceObjectImageGen

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Mögliche Werte: `image_generation`	Ja

OpenAI.ToolChoiceObjectMCP

Verwenden Sie diese Option, um zu erzwingen, dass das Modell ein bestimmtes Tool auf einem Remote-MCP-Server aufruft.

Name	Typ	Beschreibung	Erforderlich
Name	string	Der Name des Tools, das auf dem Server aufgerufen werden soll.	No
Serverbeschriftung	string	Die Bezeichnung des zu verwendenden MCP-Servers.	Ja
type	enum	Bei MCP-Tools ist der Typ immer `mcp`. Mögliche Werte: `mcp`	Ja

OpenAI.ToolChoiceObjectType

Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll.

Eigentum	Wert
Beschreibung	Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll.

Typ	string
Werte	`file_search` `function` `computer_use_preview` `web_search_preview` `image_generation` `code_interpreter` `mcp`

OpenAI.ToolChoiceObjectWebSearch

Hinweis: web_search ist noch nicht über Azure OpenAI verfügbar.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Mögliche Werte: `web_search_preview`	Ja

OpenAI.ToolChoiceOptions

Steuert, welches Tool (falls vorhanden) vom Modell aufgerufen wird.

none bedeutet, dass das Modell kein Tool aufruft und stattdessen eine Nachricht generiert.

auto bedeutet, dass das Modell zwischen dem Generieren einer Nachricht oder dem Aufrufen eines oder mehrerer Tools auswählen kann.

required bedeutet, dass das Modell mindestens ein Tools aufrufen muss.

Eigentum	Wert
Beschreibung	Steuert, welches Tool (falls vorhanden) vom Modell aufgerufen wird. `none` bedeutet, dass das Modell kein Tool aufruft und stattdessen eine Nachricht generiert. `auto` bedeutet, dass das Modell zwischen dem Generieren einer Nachricht oder dem Aufrufen eines oder mehrerer Tools auswählen kann. `required` bedeutet, dass das Modell mindestens ein Tools aufrufen muss.
Typ	string
Werte	`none` `auto` `required`

OpenAI.ToolType

Ein Tool, das zum Generieren einer Antwort verwendet werden kann.

Eigentum	Wert
Beschreibung	Ein Tool, das zum Generieren einer Antwort verwendet werden kann.
Typ	string
Werte	`file_search` `function` `computer_use_preview` `web_search_preview` `mcp` `code_interpreter` `image_generation` `local_shell`

OpenAI.TopLogProb

Die oberste Protokollwahrscheinlichkeit eines Tokens.

Name	Typ	Erforderlich
Bytes	array	Ja
logprob	number	Ja
Token	string	Ja

OpenAI.TranscriptionAudioResponseFormat

Referenzen: OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

Eigentum	Wert
Typ	string
Werte	`logprobs`

OpenAI.TranscriptionSegment

Name	Typ	Beschreibung	Erforderlich
avg_logprob	number	Durchschnittliche Protokollprob des Segments. Wenn der Wert niedriger als -1 ist, sollten Sie die Logprobs nicht berücksichtigen.	Ja
Kompressionsverhältnis	number	Komprimierungsverhältnis des Segments. Wenn der Wert größer als 2,4 ist, sollten Sie die Komprimierung als fehlgeschlagen betrachten.	Ja
end	number	Endzeit des Segments in Sekunden.	Ja
id	Ganzzahl	Eindeutiger Bezeichner des Segments.	Ja
no_speech_prob	number	Die Wahrscheinlichkeit, dass kein Wort im Segment gesprochen wird. Wenn der Wert höher als 1,0 ist und der `avg_logprob` Wert unter -1 liegt, sollten Sie dieses Segment unbeaufsichtigt betrachten.	Ja
seek	Ganzzahl	Suchversatz des Segments.	Ja
start	number	Startzeit des Abschnitts in Sekunden.	Ja
Temperatur	number	Temperaturparameter, der zum Generieren des Segments verwendet wird.	Ja
Text	string	Textinhalt des Segments.	Ja
tokens	array	Array von Token-IDs für den Textinhalt.	Ja

OpenAI.TranscriptionWord

Name	Typ	Beschreibung	Erforderlich
end	number	Endzeit des Worts in Sekunden.	Ja
start	number	Startzeit des Worts in Sekunden.	Ja
word	string	Der Textinhalt des Worts.	Ja

OpenAI.TranslationAudioResponseFormat

Referenzen: OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

Name	Typ	Beschreibung	Erforderlich	Vorgabe
attributes	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen, Booleanen oder Zahlen.	Ja

OpenAI.UpdateVectorStoreRequest

Name	Typ	Beschreibung	Erforderlich
expires_after	Objekt	Die Ablaufrichtlinie für einen Vektorspeicher.	No
└– Anker	enum	Ankerzeitstempel, nach dem die Ablaufrichtlinie angewendet wird. Unterstützte Anker: `last_active_at`. Mögliche Werte: `last_active_at`	No
└– Tage	Ganzzahl	Die Anzahl der Tage nach ablaufen der Verankerungszeit des Vektorspeichers.	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
Name	string	Der Name des Vektorspeichers.	No

OpenAI.VadConfig

Name	Typ	Beschreibung	Erforderlich	Vorgabe
prefix_padding_ms	Ganzzahl	Die Menge der Audiodaten, die vor der erkannten VAD-Sprache (in Millisekunden) enthalten sein sollen.	No	300
Stille_Dauer_ms	Ganzzahl	Dauer der Stille zum Erkennen des Sprachstopps (in Millisekunden). Mit kürzeren Werten reagiert das Modell schneller, kann aber an kurzen Pausen vom Benutzer teilnehmen.	No	200
threshold	number	Vertraulichkeitsschwellenwert (0,0 bis 1,0) für die Sprachaktivitätserkennung. Eine höhere Schwelle erfordert lauteres Audio, um das Modell zu aktivieren, und kann daher in lauten Umgebungen besser funktionieren.	No	0,5
type	enum	Muss so festgelegt sein, dass `server_vad` manuelle Blöcke mithilfe der serverseitigen VAD aktiviert werden. Mögliche Werte: `server_vad`	Ja

OpenAI.ValidateGraderRequest

Name	Typ	Beschreibung	Erforderlich
Grader	Objekt	Ein StringCheckGrader-Objekt, das einen Zeichenfolgenvergleich zwischen Eingabe und Verweis mithilfe eines angegebenen Vorgangs durchführt.	Ja
└– calculate_output	string	Eine Formel zum Berechnen der Ausgabe basierend auf den Benotungsergebnissen.	No
└- Bewertungsmetrik	enum	Die zu verwendende Auswertungsmetrik. Einer von `fuzzy_match`, `bleu`, , `gleumeteor`, `rouge_1`, , `rouge_2`, `rouge_3`, `rouge_4`, , oder `rouge_5rouge_l`. Mögliche Werte: `fuzzy_match`, , `bleu`, `gleu`, `meteorrouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5rouge_l`	No
└– Noten	Objekt		No
└– image_tag	string	Das Bildtag, das für das Python-Skript verwendet werden soll.	No
└– Eingabe	array	Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten.	No
└─ Modell	string	Das Modell, das für die Auswertung verwendet werden soll.	No
└– Name	string	Der Name des Graders.	No
└─ Vorgang	enum	Der auszuführende Zeichenfolgenüberprüfungsvorgang. Einer von `eq`, `ne`, , `like`oder `ilike`. Mögliche Werte: `eq`, , `ne`, `likeilike`	No
└– Bereich	array	Der Bereich der Bewertung. Standardwert ist .`[0, 1]`	No
└– Referenz	string	Der Text, der abgestuft wird.	No
└– Stichprobenparameter		Die Samplingparameter für das Modell.	No
└- Quelle	string	Der Quellcode des Python-Skripts.	No
└– Typ	enum	Der Objekttyp, der immer `multi`ist. Mögliche Werte: `multi`	No

OpenAI.ValidateGraderResponse

Name	Typ	Beschreibung	Erforderlich
Grader	Objekt	Ein StringCheckGrader-Objekt, das einen Zeichenfolgenvergleich zwischen Eingabe und Verweis mithilfe eines angegebenen Vorgangs durchführt.	No
└– calculate_output	string	Eine Formel zum Berechnen der Ausgabe basierend auf den Benotungsergebnissen.	No
└- Bewertungsmetrik	enum	Die zu verwendende Auswertungsmetrik. Einer von `fuzzy_match`, `bleu`, , `gleumeteor`, `rouge_1`, , `rouge_2`, `rouge_3`, `rouge_4`, , oder `rouge_5rouge_l`. Mögliche Werte: `fuzzy_match`, , `bleu`, `gleu`, `meteorrouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5rouge_l`	No
└– Noten	Objekt		No
└– image_tag	string	Das Bildtag, das für das Python-Skript verwendet werden soll.	No
└– Eingabe	array	Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten.	No
└─ Modell	string	Das Modell, das für die Auswertung verwendet werden soll.	No
└– Name	string	Der Name des Graders.	No
└─ Vorgang	enum	Der auszuführende Zeichenfolgenüberprüfungsvorgang. Einer von `eq`, `ne`, , `like`oder `ilike`. Mögliche Werte: `eq`, , `ne`, `likeilike`	No
└– Bereich	array	Der Bereich der Bewertung. Standardwert ist .`[0, 1]`	No
└– Referenz	string	Der Text, der abgestuft wird.	No
└– Stichprobenparameter		Die Samplingparameter für das Modell.	No
└- Quelle	string	Der Quellcode des Python-Skripts.	No
└– Typ	enum	Der Objekttyp, der immer `multi`ist. Mögliche Werte: `multi`	No

OpenAI.VectorStoreExpirationAfter

Die Ablaufrichtlinie für einen Vektorspeicher.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Anker	enum	Ankerzeitstempel, nach dem die Ablaufrichtlinie angewendet wird. Unterstützte Anker: `last_active_at`. Mögliche Werte: `last_active_at`	Ja
Tage	Ganzzahl	Die Anzahl der Tage nach ablaufen der Verankerungszeit des Vektorspeichers.	Ja

OpenAI.VectorStoreFileAttributes

Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen, Booleanen oder Zahlen.

Typ: Objekt

OpenAI.VectorStoreFileBatchObject

Ein Batch von Dateien, die an einen Vektorspeicher angefügt sind.

Name	Typ	Beschreibung	Erforderlich
erstellt_am	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) für die Erstellung des Batches für Vektorspeicherdateien.	Ja
file_counts	Objekt		Ja
└– abgebrochen	Ganzzahl	Die Anzahl der Dateien, die abgebrochen wurden.	No
└– abgeschlossen	Ganzzahl	Die Anzahl der Dateien, die verarbeitet wurden.	No
└– fehlgeschlagen	Ganzzahl	Die Anzahl der Dateien, die nicht verarbeitet werden konnten.	No
└─ in Bearbeitung	Ganzzahl	Die Anzahl der Dateien, die derzeit verarbeitet werden.	No
└– Gesamtsumme	Ganzzahl	Die Gesamtanzahl der Dateien.	No
id	string	Der Bezeichner, auf den in API-Endpunkten verwiesen werden kann.	Ja
Objekt	enum	Der Objekttyp, der immer `vector_store.file_batch`ist. Mögliche Werte: `vector_store.files_batch`	Ja
Status	enum	Der Status des Vektorspeicherdateien-Batches, der entweder `in_progress`, , oder `completedcancelledfailed`. Mögliche Werte: `in_progress`, , `completed`, `cancelledfailed`	Ja
vector_store_id	string	Die ID des Vektorspeichers, an den die Datei angefügt ist.	Ja

OpenAI.VectorStoreFileObject

Eine Liste von Dateien, die an einen Vektorspeicher angefügt sind.

Name	Typ	Beschreibung	Erforderlich
attributes	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen, Booleanen oder Zahlen.	No
chunking_strategy	Objekt		No
└– Typ	enum	Mögliche Werte: `static`, `other`	No
erstellt_am	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) für den Zeitpunkt der Erstellung der Vektorspeicherdatei.	Ja
id	string	Der Bezeichner, auf den in API-Endpunkten verwiesen werden kann.	Ja
last_error	Objekt	Der letzte Fehler, der dieser Vektorspeicherdatei zugeordnet ist. `null` Wenn keine Fehler vorhanden sind.	Ja
└– Code	enum	Einer von `server_error` oder `rate_limit_exceeded`. Mögliche Werte: `server_error`, , `unsupported_fileinvalid_file`	No
└– Nachricht	string	Eine lesbare Beschreibung des Fehlers.	No
Objekt	enum	Der Objekttyp, der immer `vector_store.file`ist. Mögliche Werte: `vector_store.file`	Ja
Status	enum	Der Status der Vektorspeicherdatei, die entweder `in_progress`, , `completedcancelled`oder `failed`. Der Status `completed` gibt an, dass die Vektorspeicherdatei einsatzbereit ist. Mögliche Werte: `in_progress`, , `completed`, `cancelledfailed`	Ja
usage_bytes	Ganzzahl	Die Gesamtauslastung des Vektorspeichers in Byte. Beachten Sie, dass sich dies möglicherweise von der ursprünglichen Dateigröße unterscheidet.	Ja
vector_store_id	string	Die ID des Vektorspeichers, an den die Datei angefügt ist.	Ja

OpenAI.VectorStoreObject

Ein Vektorspeicher ist eine Sammlung von verarbeiteten Dateien, die file_search vom Tool verwendet werden können.

Name	Typ	Beschreibung	Erforderlich
erstellt_am	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) für den Zeitpunkt der Erstellung des Vektorspeichers.	Ja
expires_after	OpenAI.VectorStoreExpirationAfter	Die Ablaufrichtlinie für einen Vektorspeicher.	No
läuft_ab_am	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) für den Ablauf des Vektorspeichers.	No
file_counts	Objekt		Ja
└– abgebrochen	Ganzzahl	Die Anzahl der Dateien, die abgebrochen wurden.	No
└– abgeschlossen	Ganzzahl	Die Anzahl der Dateien, die erfolgreich verarbeitet wurden.	No
└– fehlgeschlagen	Ganzzahl	Die Anzahl der Dateien, die nicht verarbeitet werden konnten.	No
└─ in Bearbeitung	Ganzzahl	Die Anzahl der Dateien, die derzeit verarbeitet werden.	No
└– Gesamtsumme	Ganzzahl	Die Gesamtanzahl der Dateien.	No
id	string	Der Bezeichner, auf den in API-Endpunkten verwiesen werden kann.	Ja
last_active_at	Ganzzahl	Der Unix-Zeitstempel (in Sekunden) für den Zeitpunkt, zu dem der Vektorspeicher zuletzt aktiv war.	Ja
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	Ja
Name	string	Der Name des Vektorspeichers.	Ja
Objekt	enum	Der Objekttyp, der immer `vector_store`ist. Mögliche Werte: `vector_store`	Ja
Status	enum	Der Status des Vektorspeichers, der entweder `expired`, , `in_progress`oder `completed`. Der Status gibt `completed` an, dass der Vektorspeicher einsatzbereit ist. Mögliche Werte: `expired`, , `in_progresscompleted`	Ja
usage_bytes	Ganzzahl	Die Gesamtzahl der Bytes, die von den Dateien im Vektorspeicher verwendet werden.	Ja

OpenAI.VoiceIdsShared

Eigentum	Wert
Typ	string
Werte	`alloy` `ash` `ballad` `coral` `echo` `fable` `onyx` `nova` `sage` `shimmer` `verse`

OpenAI.WebSearchAction

Diskriminator für OpenAI.WebSearchAction

Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:

Typwert	Schema
`find`	OpenAI.WebSearchActionFind
`open_page`	OpenAI.WebSearchActionOpenPage
`search`	OpenAI.WebSearchActionSearch

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	OpenAI.WebSearchActionType		Ja

OpenAI.WebSearchActionFind

Aktionstyp "suchen": Sucht innerhalb einer geladenen Seite nach einem Muster.

Name	Typ	Beschreibung	Erforderlich
Muster	string	Das Muster oder der Text, nach dem innerhalb der Seite gesucht werden soll.	Ja
type	enum	Der Aktionstyp. Mögliche Werte: `find`	Ja
url	string	Die URL der Seite, die nach dem Muster gesucht wurde.	Ja

OpenAI.WebSearchActionOpenPage

Aktionstyp "open_page" – Öffnet eine bestimmte URL aus Suchergebnissen.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
type	enum	Der Aktionstyp. Mögliche Werte: `open_page`	Ja
url	string	Die URL, die vom Modell geöffnet wurde.	Ja

OpenAI.WebSearchActionSearch

Aktionstyp "suche" – Führt eine Websuchabfrage aus.

Name	Typ	Beschreibung	Erforderlich	Vorgabe
Anfrage	string	Die Suchabfrage.	Ja
type	enum	Der Aktionstyp. Mögliche Werte: `search`	Ja

OpenAI.WebSearchActionType

Eigentum	Wert
Typ	string
Werte	`search` `open_page` `find`

OpenAI.WebSearchPreviewTool

Hinweis: web_search ist noch nicht über Azure OpenAI verfügbar.

Name	Typ	Beschreibung	Erforderlich
Suchkontextgröße	enum	Allgemeine Anleitung für die Menge des Kontextfensterbereichs, der für die Suche verwendet werden soll. Einer von `low`, `medium`, oder `high`. `medium` ist der Standardwert. Mögliche Werte: `low`, , `mediumhigh`	No
type	enum	Der Typ des Websuchtools. Einer von `web_search_preview` oder `web_search_preview_2025_03_11`. Mögliche Werte: `web_search_preview`	Ja
Benutzerstandort	Objekt		No
└– Typ	OpenAI.LocationType		No

OpenAI.WebSearchToolCallItemParam

Hinweis: web_search ist noch nicht über Azure OpenAI verfügbar.

Name	Typ	Beschreibung	Erforderlich
action	Objekt		Ja
└– Typ	OpenAI.WebSearchActionType		No
type	enum	Mögliche Werte: `web_search_call`	Ja

OpenAI.WebSearchToolCallItemResource

Hinweis: web_search ist noch nicht über Azure OpenAI verfügbar.

Name	Typ	Beschreibung	Erforderlich
action	Objekt		Ja
└– Typ	OpenAI.WebSearchActionType		No
Status	enum	Der Status des Aufrufs des Websuchtools. Mögliche Werte: `in_progress`, , `searching`, `completedfailed`	Ja
type	enum	Mögliche Werte: `web_search_call`	Ja

PineconeChatDataSource

Name	Typ	Beschreibung	Erforderlich	Vorgabe
parameters	Objekt	Die Parameterinformationen zum Steuern der Verwendung der Pinecone-Datenquelle.	Ja
└– erlaube_unvollständiges_Ergebnis	Boolescher Wert	Wenn dieser Wert auf "true" festgelegt ist, lässt das System die Verwendung von Teilsuchergebnissen zu, und die Anforderung schlägt fehl, wenn alle Teilabfragen fehlschlagen. Wenn sie nicht als "false" angegeben oder angegeben wurde, schlägt die Anforderung fehl, wenn eine Suchabfrage fehlschlägt.	No	Falsch
└– Authentifizierung	Objekt		No
└– Schlüssel	string		No
└– Typ	enum	Mögliche Werte: `api_key`	No
└– embedding_dependency	Objekt	Eine Darstellung einer Datenvektorisierungsquelle, die als Einbettungsressource mit einer Datenquelle verwendet werden kann.	No
└– Typ	AzureChatDataSourceVectorizationSourceType	Der Unterscheidungsbezeichner für die konkrete Vektorisierungsquelle.	No
└– Umwelt	string	Der Mit Pinecone zu verwendende Umgebungsname.	No
└– fields_mapping	Objekt	Feldzuordnungen, die auf daten angewendet werden, die von der Pinecone-Datenquelle verwendet werden. Beachten Sie, dass Inhaltsfeldzuordnungen für Pinecone erforderlich sind.	No
└– content_fields	array		No
└─ Inhalt_Feldtrenner	string		No
└– filepath_field	string		No
└– Titel_Feld	string		No
└– url_field	string		No
└– in_scope	Boolescher Wert	Gibt an, ob Abfragen auf die Verwendung der indizierten Daten beschränkt werden sollen.	No
└– Kontexte_einschließen	array	Die Ausgabekontexteigenschaften, die in die Antwort eingeschlossen werden sollen. Standardmäßig werden Zitate und Absichten angefordert.	No	['Zitate', 'Absicht']
└– index_name	string	Der Name des zu verwendenden Pinecone-Datenbankindex.	No
└– max_search_queries	Ganzzahl	Die maximale Anzahl neu geschriebener Abfragen, die für eine einzelne Benutzernachricht an den Suchanbieter gesendet werden sollen. Standardmäßig führt das System eine automatische Bestimmung durch.	No
└– Striktheit	Ganzzahl	Die konfigurierte Strenge der Suchrelevanzfilterung. Höhere Strenge erhöht die Genauigkeit, aber ein geringerer Rückruf der Antwort.	No
└– top_n_documents	Ganzzahl	Die konfigurierte Anzahl der Dokumente, die in der Abfrage bereitgestellt werden sollen.	No
type	enum	Der diskriminierte Typbezeichner, der immer "Pinecone" ist. Mögliche Werte: `pinecone`	Ja

Quality

Die Qualität des abzurufenden Videoinhalts. Dadurch wird die Qualität des Videoinhalts angegeben, der zurückgegeben werden soll.

Eigentum	Wert
Beschreibung	Die Qualität des abzurufenden Videoinhalts. Dadurch wird die Qualität des Videoinhalts angegeben, der zurückgegeben werden soll.
Typ	string
Werte	`high` `low`

ResponseFormatJSONSchemaRequest

Name	Typ	Beschreibung	Erforderlich	Vorgabe
JSON-Schema	Objekt	JSON-Schema für das Antwortformat	Ja
type	enum	Typ des Antwortformats Mögliche Werte: `json_schema`	Ja

ResponseModalities

Ausgabetypen, die vom Modell generiert werden sollen. Die meisten Modelle sind in der Lage, Text zu generieren. Dies ist die Standardeinstellung:

["text"]

Das gpt-4o-audio-preview Modell kann auch zum Generieren von Audio verwendet werden. Um anzufordern, dass dieses Modell sowohl Text- als auch Audioantworten generiert, können Sie Folgendes verwenden:

["text", "audio"]

Array von: Zeichenfolge

SpeechGenerationResponseFormat

Die unterstützten Audioausgabeformate für Text-zu-Sprache.

Diese Komponente kann eine der folgenden Sein:

VideoGeneration

Ergebnis der Videogenerierung.

Name	Typ	Beschreibung	Erforderlich
erstellt_am	Ganzzahl	Die Zeit, zu der die Videogenerierung erstellt wurde.	Ja
height	Ganzzahl	Die Höhe des Videos.	Ja
id	string	Die ID der Videogenerierung.	Ja
job_id	string	Die ID des Videogenerierungsauftrags für dieses Video.	Ja
n_seconds	Ganzzahl	Die Dauer der Videogenerierung.	Ja
Objekt	enum	Mögliche Werte: `video.generation`	Ja
Eingabeaufforderung	string	Die Aufforderung für diese Videogenerierung.	Ja
width	Ganzzahl	Die Breite des Videos.	Ja

VideoGenerationJob

Ein Auftrag zur Videogenerierung.

Name	Typ	Beschreibung	Erforderlich
erstellt_am	Ganzzahl	Der Zeitpunkt, zu dem der Auftrag erstellt wurde.	Ja
läuft_ab_am	Ganzzahl	Der Zeitpunkt, zu dem der Auftrag automatisch aus dem Dienst gelöscht wird. Der Videoinhalt und die Metadaten des Auftrags sollten vor diesem Datum gespeichert werden, um Datenverluste zu vermeiden.	No
failure_reason	Zeichenfolge (siehe gültige Modelle unten)		No
finished_at	Ganzzahl	Die Zeit, zu der der Auftrag mit allen Videogenerationen abgeschlossen wurde.	No
Generationen	array	Die generierten Videos für diesen Auftrag. Die Zahl hängt von der angegebenen n_variants und dem Erfolg der Generationen ab.	No
height	Ganzzahl	Die Höhe des Videos.	Ja
id	string	Die ID des Auftrags.	Ja
inpaint_items	array	Optionale Inpaintingelemente für diesen Videogenerierungsauftrag.	No
Modell	string	Der Name der Bereitstellung, die für diesen Auftrag zur Videogenerierung verwendet werden soll.	Ja
n_seconds	Ganzzahl	Die Dauer des Auftrags zur Videogenerierung.	Ja
n_variants	Ganzzahl	Die Anzahl der Videos, die als Varianten für diesen Auftrag zur Videogenerierung erstellt werden sollen.	Ja
Objekt	enum	Mögliche Werte: `video.generation.job`	Ja
Eingabeaufforderung	string	Die Aufforderung für diesen Auftrag zur Videogenerierung.	Ja
Status	Objekt	Der Status eines Auftrags zur Videogenerierung.	Ja
width	Ganzzahl	Die Höhe des Videos.	Ja

VideoGenerationJobList

Eine Liste der Aufträge zur Videogenerierung.

Name	Typ	Beschreibung	Erforderlich
data	array	Die Liste der Aufträge zur Videogenerierung.	Ja
first_id	string	Die ID des ersten Auftrags auf der aktuellen Seite, falls verfügbar.	No
has_more	Boolescher Wert	Ein Kennzeichen, das angibt, ob nach der Liste weitere Aufträge verfügbar sind.	Ja
last_id	string	Die ID des letzten Auftrags auf der aktuellen Seite, falls verfügbar.	No
Objekt	enum	Mögliche Werte: `list`	Ja

Nächste Schritte

Erfahren Sie mehr über Modelle und feinabstimmungen mit der REST-API. Erfahren Sie mehr über die modelle underlying that power Azure OpenAI.

Feedback

War diese Seite hilfreich?

Last updated on 2026-05-21