Azure OpenAI Chat

API-Version: v1

Server:{endpoint}/openai/v1 — Azure AI Foundry Models APIs

Servervariablen:

Variable	Vorgabe	Description
endpoint		Ein unterstütztes Azure AI Foundry Models APIs-Endpunkt, einschließlich Protokoll und Hostname. Beispiel: https://westus.api.cognitive.microsoft.com).

Authentifizierung

ApiKeyAuth (API-Schlüssel)

Gib deinen API-Schlüssel in den Header api-key .

ApiKeyAuth_ (API-Schlüssel)

Gib deinen API-Schlüssel in den Header authorization .

OAuth2Auth (OAuth 2.0)

Fluss: implizit

Autorisierungs-URL:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche:

https://cognitiveservices.azure.com/.default

Sicherheitsanforderungen

Endpunkte akzeptieren eine der folgenden Authentifizierungsmethoden:

ApiKeyAuth
ApiKeyAuth_
OAuth2Auth (Scopes: https://cognitiveservices.azure.com/.default)

Chatabschluss erstellen

POST {endpoint}/openai/v1/chat/completions

Erstellt eine Chatvervollständigung.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	server	Ja	Schnur	Ein unterstütztes Azure AI Foundry Models APIs-Endpunkt, einschließlich Protokoll und Hostname. Beispiel: https://westus.api.cognitive.microsoft.com).
API-Version	query	No	Schnur Mögliche Werte: `v1`, `preview`	Die explizite API-Version der Azure AI Foundry Models-API, die für diese Anforderung verwendet werden soll. `v1` wenn nicht anders angegeben.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required
Audio	OpenAI.CreateChatCompletionRequestAudio oder null	Parameter für die Audioausgabe. Erforderlich, wenn die Audioausgabe mit `modalities: ["audio"]`.	No
frequency_penalty	Zahl oder Null	Zahl zwischen -2,0 und 2,0. Positive Werte bestrafen neue Token basierend auf ihrer bisherigen Häufigkeit im Text, wodurch die Modellzahlen verringert werden Wahrscheinlichkeit, dass dieselbe Zeile wiederholt wird. Einschränkungen: Min: -2, Max: 2	No
function_call	String oder OpenAI.ChatCompletionFunctionCallOption (veraltet)	Veraltet zugunsten von `tool_choice`. Steuert, welche Funktion (falls vorhanden) vom Modell aufgerufen wird. `none` bedeutet, dass das Modell keine Funktion aufruft und stattdessen eine Nachricht. `auto` bedeutet, dass das Modell zwischen dem Generieren einer Nachricht oder dem Aufrufen einer Nachricht auswählen kann Funktion. Angeben einer bestimmten Funktion über `{"name": "my_function"}` Kräfte Modell zum Aufrufen dieser Funktion. `none` ist der Standardwert, wenn keine Funktionen vorhanden sind. `auto` ist die Standardeinstellung wenn Funktionen vorhanden sind.	No
functions	Array von OpenAI.ChatCompletionFunctions (veraltet)	Veraltet zugunsten von `tools`. Eine Liste der Funktionen, für die das Modell JSON-Eingaben generieren kann. Einschränkungen: minItems: 1, maxItems: 128	No
Logit-Bias	-Objekt oder Null	Ändern Sie die Wahrscheinlichkeit, dass angegebene Token im Abschluss angezeigt werden. Akzeptiert ein JSON-Objekt, das Token (angegeben durch ihre Token-ID im Tokenizer) mit einem zugehörigen Bias-Wert von -100 bis 100. Mathematisch die Verzerrung wird vor dem Sampling zu den logits hinzugefügt, die vom Modell generiert wurden. Der genaue Effekt variiert je nach Modell, aber Werte sollten zwischen -1 und 1 liegen. Verringern oder Erhöhen der Wahrscheinlichkeit der Auswahl; Werte wie -100 oder 100 sollte dies zu einem Verbot oder einer exklusiven Auswahl des betreffenden Tokens führen.	No
logprobs	Boolescher Wert oder Null	Gibt an, ob Protokollwahrscheinlichkeiten der Ausgabetoken zurückgegeben werden sollen. Wenn wahr, gibt die Protokollwahrscheinlichkeiten jedes Ausgabetokens zurück, das zurückgegeben wird in der `content` von `message`.	No
max_completion_tokens	ganze Zahl oder Null	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 oder Null (veraltet)	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 veraltet zugunsten von `max_completion_tokens`, und ist nicht kompatibel mit o1-Serienmodellen.	No
Nachrichten	Array von OpenAI.ChatCompletionRequestMessage	Eine Liste der Nachrichten, die bisher aus der Unterhaltung bestehen. Abhängig von Abhängig vom Modell, das Sie verwenden, werden verschiedene Nachrichtentypen (Modalitäten) unterstützt. wie Text, Bilder und Audio. Einschränkungen: minItems: 1	Ja
metadata	OpenAI.Metadata oder NULL		No
modalities	OpenAI.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 verwendet werden, um Audio generieren. So fordern Sie an, dass dieses Modell generiert wird Sie können sowohl Text- als auch Audioantworten verwenden: `["text", "audio"]`	No
model	Schnur	Modell-ID, die zum Generieren der Antwort verwendet wird, z `gpt-4o` . B. oder `o3`. OpenAI bietet eine breite Palette von Modellen mit unterschiedlichen Funktionen, Leistung Merkmale und Preispunkte. Weitere Informationen finden Sie in der Modellanleitung um verfügbare Modelle zu durchsuchen und zu vergleichen.	Ja
n	ganze Zahl oder Null	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. Einschränkungen: Min: 1, Max: 128	No
Parallele Werkzeugaufrufe	OpenAI.ParallelToolCalls	Gibt an, ob beim Verwenden des Tools parallele Funktionsaufrufe aktiviert werden sollen.	No
prediction	OpenAI.PredictionContent	Statischer vorhergesagter Ausgabeinhalt, z. B. der Inhalt einer Textdatei, die wird neu generiert.	No
└– Inhalt	Zeichenfolge oder Array von OpenAI.ChatCompletionRequestMessageContentPartText	Der Inhalt, der beim Generieren einer Modellantwort abgeglichen werden soll. Wenn generierte Token mit diesem Inhalt übereinstimmen würden, würde die gesamte Modellantwort kann viel schneller zurückgegeben werden.	Ja
└– Typ	enum	Der Typ des vorhergesagten Inhalts, den Sie bereitstellen möchten. Dieser Typ ist aktuell immer `content`. Mögliche Werte: `content`	Ja
presence_penalty	Zahl oder Null	Zahl zwischen -2,0 und 2,0. Positive Werte bestrafen neue Token basierend auf ob sie bisher im Text angezeigt werden, wodurch die Wahrscheinlichkeit des Modells erhöht wird um über neue Themen zu sprechen. Einschränkungen: Min: -2, Max: 2	No
prompt_cache_key	Schnur	Wird von OpenAI verwendet, um Antworten für ähnliche Anforderungen zwischenzuspeichern, um ihre Cachetreffraten zu optimieren. Ersetzt das `user` Feld. Erfahren Sie mehr.	No
prompt_cache_retention	Zeichenfolge oder null		No
Denkanstrengung	OpenAI.ReasoningEffort	Schränkt den Aufwand für die Begründung ein Begründungsmodelle. Derzeit unterstützte Werte sind `none`, , `minimal`, `low`, `medium`, `high`und `xhigh`. Reduzieren Der Denkaufwand kann zu schnelleren Antworten und weniger genutzten Token führen. die bei der Begründung in einer Antwort verwendet werden. - `gpt-5.1` Standardwert ist `none`, was keine Begründung ausführt. Die unterstützten Grundwerte sind `gpt-5.1none`, , `low`, `medium`und `high`. Toolaufrufe werden für alle Gründe in gpt-5.1 unterstützt. - Alle Modelle vor `gpt-5.1` der Standardeinstellung des `medium` Grundaufwands und nicht unterstützen `none`. - Das `gpt-5-pro` Modell ist standardmäßig auf (und nur unterstützt) `high` Grunderlegungsaufwand festgelegt. - `xhigh` wird für alle Modelle nach `gpt-5.1-codex-max`.	No
Antwortformat	OpenAI.CreateChatCompletionRequestResponseFormat	Ein Objekt, das das Format angibt, das das Modell ausgeben muss. Einstellung für `{ "type": "json_schema", "json_schema": {...} }` aktiviert Strukturierte Ausgaben, die sicherstellen, dass das Modell mit deinem bereitgestellten JSON übereinstimmt Schema. Weitere Informationen in den strukturierten Ausgaben Guide. Einstellung auf `{ "type": "json_object" }` ermöglicht den älteren JSON-Modus, der stellt sicher, dass die Nachricht, die das Modell generiert, gültiger JSON-Code ist. Verwenden von `json_schema` wird für Modelle bevorzugt, die es unterstützen.	No
└– Typ	OpenAI.CreateChatCompletionRequestResponseFormatType		Ja
safety_identifier	Schnur	Ein stabiler Bezeichner, der verwendet wird, um Benutzer Ihrer Anwendung zu erkennen, die möglicherweise die Nutzungsrichtlinien von OpenAI verletzen. Die IDs sollten eine Zeichenfolge sein, die jeden Benutzer eindeutig identifiziert. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Erfahren Sie mehr.	No
seed	Ganzzahl oder Null (veraltet)	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	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. Das Der zurückgegebene Text enthält die Stoppsequenz nicht.	No
abspeichern	Boolescher Wert oder Null	Ob die Ausgabe dieser Chat-Anfrage dieser Chatabschlussanforderung für die Verwendung in Modelldestillation oder Bewertungsprodukten gespeichert werden soll oder nicht.	No
stream	Boolescher Wert oder Null	Bei Festlegung auf "true" werden die Modellantwortdaten an den Client gestreamt. da sie mithilfe von server-sent-Ereignissen generiert werden.	No
stream_options	OpenAI.ChatCompletionStreamOptions oder NULL		No
Temperatur	Zahl oder Null		No
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 von OpenAI.ChatCompletionTool oder OpenAI.CustomToolChatCompletions	Eine Liste der Tools, die das Modell aufrufen kann. Sie können eine der beiden Optionen bereitstellen Benutzerdefinierte Tools oder Funktionstools.	No
top_logprobs	ganze Zahl oder Null		No
top_p	Zahl oder Null		No
user	Zeichenfolge (veraltet)	Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt und dem Benutzer helfen kann, Überwachen und Erkennen von Missbrauch.	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
Ausführlichkeit	OpenAI.Verbosity	Beschränkt die Ausführlichkeit der Antwort des Modells. Niedrigere Werte führen zu präzisere Antworten, während höhere Werte zu ausführlicheren Antworten führen. Derzeit unterstützte Werte sind `low`, `medium`und `high`.	No

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt oder Objekt

Antwortheader:

Header	Typ	Description
apim-request-id	Schnur	Eine Anforderungs-ID, die für Problembehandlungszwecke verwendet wird.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt

Name	Typ	Required
Programmcode	Zeichenfolge oder null	Ja
innerer Fehler		No
message	Schnur	Ja
param	Zeichenfolge oder null	Ja
type	Schnur	Ja

Antwortheader:

Header	Typ	Description
apim-request-id	Schnur	Eine Anforderungs-ID, die für Problembehandlungszwecke verwendet wird.

Examples

Example

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

POST {endpoint}/openai/v1/chat/completions?api-version=latest&azure-beta=v1=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

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

Components

AzureAIFoundryModelsApiVersion

Property	Wert
Typ	Schnur
Werte	`v1` `preview`

AzureContentFilterBlocklistResult

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

Name	Typ	Description	Required	Vorgabe
details	Objektarray	Die Paare einzelner Blocklisten-IDs und ob sie zu einer Filteraktion geführt haben.	No
gefiltert	boolean	Ein Wert, der angibt, ob eine der detaillierten Blocklisten zu einer Filteraktion führte.	Ja

AzureContentFilterCompletionTextSpan

Eine Darstellung eines Abschnitts von Abschlusstext, wie er in Azure OpenAI-Inhaltsfilterergebnissen verwendet wird.

Name	Typ	Description	Required	Vorgabe
completion_end_offset	ganze Zahl (int32)	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	ganze Zahl (int32)	Offset des UTF32-Codepunkts, der die Spanne beginnt.	Ja

AzureContentFilterCompletionTextSpanDetectionResult

Name	Typ	Description	Required
details	Array von AzureContentFilterCompletionTextSpan	Detaillierte Informationen zu den erkannten Abschlusstextabschnitten.	Ja
erkannt	boolean	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	Ja
gefiltert	boolean	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	Description	Required	Vorgabe
details	Objektarray	Die Paare einzelner Themen-IDs und ob sie erkannt werden.	No
gefiltert	boolean	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	Description	Required	Vorgabe
erkannt	boolean	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	Ja
gefiltert	boolean	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	Ja

AzureContentFilterPersonallyIdentifiableInformationResult

Ein Ergebnis der Inhaltsfiltererkennung für personenbezogene Informationen, die Erweiterungen schaden.

Name	Typ	Description	Required
erkannt	boolean	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	Ja
gefiltert	boolean	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	Ja
redacted_text	Schnur	Der geschwenkte Text mit pii-Informationen wurde entfernt oder maskiert.	No
sub_categories	Array von AzurePiiSubCategoryResult	Detaillierte Ergebnisse für einzelne PIIHarmSubCategory(n).	No

AzureContentFilterResultForChoice

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

Name	Typ	Description	Required
custom_blocklists	AzureContentFilterBlocklistResult	Eine Sammlung von True/False-Filterergebnissen für konfigurierte benutzerdefinierte Blocklisten.	No
└– Einzelheiten	Objektarray	Die Paare einzelner Blocklisten-IDs und ob sie zu einer Filteraktion geführt haben.	No
└- gefiltert	boolean	Ein Wert, der angibt, ob die Blockliste eine Filteraktion erzeugt hat.	Ja
└– ID	Schnur	Die ID der benutzerdefinierten Blockliste ausgewertet.	Ja
└- gefiltert	boolean	Ein Wert, der angibt, ob eine der detaillierten Blocklisten zu einer Filteraktion führte.	Ja
custom_topics	AzureContentFilterCustomTopicResult	Eine Sammlung von True/False-Filterergebnissen für konfigurierte benutzerdefinierte Themen.	No
└– Einzelheiten	Objektarray	Die Paare einzelner Themen-IDs und ob sie erkannt werden.	No
└– erkannt	boolean	Ein Wert, der angibt, ob das Thema erkannt wird.	Ja
└– ID	Schnur	Die ID des benutzerdefinierten Themas ausgewertet.	Ja
└- gefiltert	boolean	Ein Wert, der angibt, ob eines der detaillierten Themen zu einer Filteraktion geführt hat.	Ja
Fehler	Objekt	Wenn vorhanden, Details zu einem Fehler, der verhinderte, dass die Inhaltsfilterung ihre Bewertung abgeschlossen hat.	No
└– Code	ganze Zahl (int32)	Ein eindeutiger, maschinenlesbarer Code, der dem Fehler zugeordnet ist.	Ja
└– Nachricht	Schnur	Eine lesbare Nachricht, die dem Fehler zugeordnet ist.	Ja
hate	AzureContentFilterSeverityResult	Ein beschriftetes Ergebnis eines Inhaltsfilters, das angibt, ob der Inhalt gefiltert wurde und welches das qualitative Ergebnis war. Schweregrad des Inhalts entsprechend der Auswertung anhand der Inhaltsfilterkonfiguration für die Kategorie.	No
└- gefiltert	boolean	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	Ja
└– Schweregrad	enum	Der markierte Schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	Ja
personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Ein Ergebnis der Inhaltsfiltererkennung für personenbezogene Informationen, die Erweiterungen schaden.	No
└– redacted_text	Schnur	Der geschwenkte Text mit pii-Informationen wurde entfernt oder maskiert.	No
└─ Unterkategorien	Array von AzurePiiSubCategoryResult	Detaillierte Ergebnisse für einzelne PIIHarmSubCategory(n).	No
Profanität	AzureContentFilterDetectionResult	Ein mit Bezeichnung versehenes Inhaltsfilterergebniselement, das angibt, ob der Inhalt erkannt wurde und ob der Inhalt vorhanden war. gefiltert.	No
└– erkannt	boolean	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	Ja
└- gefiltert	boolean	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	Ja
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, geben die Zitatdetails die zugehörige Lizenz und deren Standort an.	No
└– URL	Zeichenfolge (URI)	Die mit der Lizenz verknüpfte URL.	No
└– Lizenz	Schnur	Der Name oder die ID der Lizenz, die der Erkennung zugeordnet ist.	No
└– erkannt	boolean	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	Ja
└- gefiltert	boolean	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	Ja
protected_material_text	AzureContentFilterDetectionResult	Ein mit Bezeichnung versehenes Inhaltsfilterergebniselement, das angibt, ob der Inhalt erkannt wurde und ob der Inhalt vorhanden war. gefiltert.	No
└– erkannt	boolean	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	Ja
└- gefiltert	boolean	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	Ja
Selbstverletzung	AzureContentFilterSeverityResult	Ein beschriftetes Ergebnis eines Inhaltsfilters, das angibt, ob der Inhalt gefiltert wurde und welches das qualitative Ergebnis war. Schweregrad des Inhalts entsprechend der Auswertung anhand der Inhaltsfilterkonfiguration für die Kategorie.	No
└- gefiltert	boolean	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	Ja
└– Schweregrad	enum	Der markierte Schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	Ja
Sexuelle	AzureContentFilterSeverityResult	Ein beschriftetes Ergebnis eines Inhaltsfilters, das angibt, ob der Inhalt gefiltert wurde und welches das qualitative Ergebnis war. Schweregrad des Inhalts entsprechend der Auswertung anhand der Inhaltsfilterkonfiguration für die Kategorie.	No
└- gefiltert	boolean	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	Ja
└– Schweregrad	enum	Der markierte Schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	Ja
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
Gewalt	AzureContentFilterSeverityResult	Ein beschriftetes Ergebnis eines Inhaltsfilters, das angibt, ob der Inhalt gefiltert wurde und welches das qualitative Ergebnis war. Schweregrad des Inhalts entsprechend der Auswertung anhand der Inhaltsfilterkonfiguration für die Kategorie.	No
└- gefiltert	boolean	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	Ja
└– Schweregrad	enum	Der markierte Schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	Ja

AzureContentFilterResultForPrompt

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

Name	Typ	Description	Required
Content-Filtern-Egebnisse	Objekt	Die Inhaltsfilterkategoriedetails für das Ergebnis.	No
└– benutzerdefinierte Sperrlisten	AzureContentFilterBlocklistResult	Eine Sammlung von True/False-Filterergebnissen für konfigurierte benutzerdefinierte Blocklisten.	No
└– Einzelheiten	Objektarray	Die Paare einzelner Blocklisten-IDs und ob sie zu einer Filteraktion geführt haben.	No
└- gefiltert	boolean	Ein Wert, der angibt, ob die Blockliste eine Filteraktion erzeugt hat.	Ja
└– ID	Schnur	Die ID der benutzerdefinierten Blockliste ausgewertet.	Ja
└- gefiltert	boolean	Ein Wert, der angibt, ob eine der detaillierten Blocklisten zu einer Filteraktion führte.	Ja
└– custom_topics	AzureContentFilterCustomTopicResult	Eine Sammlung von True/False-Filterergebnissen für konfigurierte benutzerdefinierte Themen.	No
└– Einzelheiten	Objektarray	Die Paare einzelner Themen-IDs und ob sie erkannt werden.	No
└– erkannt	boolean	Ein Wert, der angibt, ob das Thema erkannt wird.	Ja
└– ID	Schnur	Die ID des benutzerdefinierten Themas ausgewertet.	Ja
└- gefiltert	boolean	Ein Wert, der angibt, ob eines der detaillierten Themen zu einer Filteraktion geführt hat.	Ja
└– Fehler	Objekt	Wenn vorhanden, Details zu einem Fehler, der verhinderte, dass die Inhaltsfilterung ihre Bewertung abgeschlossen hat.	No
└– Code	ganze Zahl (int32)	Ein eindeutiger, maschinenlesbarer Code, der dem Fehler zugeordnet ist.	Ja
└– Nachricht	Schnur	Eine lesbare Nachricht, die dem Fehler zugeordnet ist.	Ja
└– Hass	AzureContentFilterSeverityResult	Ein beschriftetes Ergebnis eines Inhaltsfilters, das angibt, ob der Inhalt gefiltert wurde und welches das qualitative Ergebnis war. Schweregrad des Inhalts entsprechend der Auswertung anhand der Inhaltsfilterkonfiguration für die Kategorie.	No
└- gefiltert	boolean	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	Ja
└– Schweregrad	enum	Der markierte Schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	Ja
└– indirekter_Angriff	AzureContentFilterDetectionResult	Ein mit Bezeichnung versehenes Inhaltsfilterergebniselement, das angibt, ob der Inhalt erkannt wurde und ob der Inhalt vorhanden war. gefiltert.	Ja
└– erkannt	boolean	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	Ja
└- gefiltert	boolean	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	Ja
└– Entsperrung	AzureContentFilterDetectionResult	Ein mit Bezeichnung versehenes Inhaltsfilterergebniselement, das angibt, ob der Inhalt erkannt wurde und ob der Inhalt vorhanden war. gefiltert.	Ja
└– erkannt	boolean	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	Ja
└- gefiltert	boolean	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	Ja
└– Profanität	AzureContentFilterDetectionResult	Ein mit Bezeichnung versehenes Inhaltsfilterergebniselement, das angibt, ob der Inhalt erkannt wurde und ob der Inhalt vorhanden war. gefiltert.	No
└– erkannt	boolean	Gibt an, ob die Bezeichnungsinhaltskategorie im Inhalt erkannt wurde.	Ja
└- gefiltert	boolean	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion geführt hat.	Ja
└– Selbstverletzung	AzureContentFilterSeverityResult	Ein beschriftetes Ergebnis eines Inhaltsfilters, das angibt, ob der Inhalt gefiltert wurde und welches das qualitative Ergebnis war. Schweregrad des Inhalts entsprechend der Auswertung anhand der Inhaltsfilterkonfiguration für die Kategorie.	No
└- gefiltert	boolean	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	Ja
└– Schweregrad	enum	Der markierte Schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	Ja
└─ sexuell	AzureContentFilterSeverityResult	Ein beschriftetes Ergebnis eines Inhaltsfilters, das angibt, ob der Inhalt gefiltert wurde und welches das qualitative Ergebnis war. Schweregrad des Inhalts entsprechend der Auswertung anhand der Inhaltsfilterkonfiguration für die Kategorie.	No
└- gefiltert	boolean	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	Ja
└– Schweregrad	enum	Der markierte Schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	Ja
└– Gewalt	AzureContentFilterSeverityResult	Ein beschriftetes Ergebnis eines Inhaltsfilters, das angibt, ob der Inhalt gefiltert wurde und welches das qualitative Ergebnis war. Schweregrad des Inhalts entsprechend der Auswertung anhand der Inhaltsfilterkonfiguration für die Kategorie.	No
└- gefiltert	boolean	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	Ja
└– Schweregrad	enum	Der markierte Schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	Ja
prompt_index	ganze Zahl (int32)	Der Index der Eingabeaufforderung, die den zugehörigen Inhaltsfilterergebniskategorien zugeordnet ist.	No

AzureContentFilterSeverityResult

Ein markiertes Inhaltsfilterergebniselement, das angibt, ob der Inhalt gefiltert wurde und wie der qualitative Schweregrad des Inhalts gemäß der Konfiguration des Inhaltsfilters für die Kategorie bewertet wurde.

Name	Typ	Description	Required	Vorgabe
gefiltert	boolean	Gibt an, ob der Schweregrad des Inhalts zu einer Inhaltsfilteraktion geführt hat.	Ja
severity	enum	Der markierte Schweregrad des Inhalts. Mögliche Werte: `safe`, , `low`, `mediumhigh`	Ja

AzurePiiSubCategoryResult

Ergebnisdetails für einzelne PIIHarmSubCategory(n).

Name	Typ	Description	Required
erkannt	boolean	Gibt an, ob die Bezeichnungsinhaltsunterkategorie im Inhalt erkannt wurde.	Ja
gefiltert	boolean	Gibt an, ob die Inhaltserkennung zu einer Inhaltsfilteraktion für diese Unterkategorie geführt hat.	Ja
Redigiert	boolean	Gibt an, ob der Inhalt für diese Unterkategorie redagiert wurde.	Ja
sub_category	Schnur	Die PIIHarmSubCategory, die ausgewertet wurde.	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	Description	Required
application_name	Schnur	Der Name der Anwendung. Vertrauliche persönliche Informationen sollten in diesem Feld nicht enthalten sein.	No
end_user_id	Schnur	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	Schnur	Die Mandanten-ID von Microsoft 365, zu der der Endbenutzer gehört. Es ist erforderlich, wenn die generative KI-Anwendung multitenant ist.	No
source_ip	Schnur	Erfasst die IP-Adresse des ursprünglichen Clients.	No

OpenAI.ChatCompletionAllowedTools

Zulässige Tools

Beschränkt die tools, die für das Modell verfügbar sind, auf einen vordefinierten Satz.

Name	Typ	Description	Required	Vorgabe
mode	enum	Beschränkt die tools, die für das Modell verfügbar sind, auf einen vordefinierten Satz. `auto` ermöglicht es dem Modell, zwischen den zulässigen Tools zu wählen und eine Nachricht. `required` erfordert, dass das Modell mindestens eins der zulässigen Tools aufruft. Mögliche Werte: `auto`, `required`	Ja
tools	Objektarray	Eine Liste der Tooldefinitionen, die das Modell aufrufen darf. Für die Api für Chatabschlusse kann die Liste der Tooldefinitionen wie folgt aussehen: `json<br> [<br> { "type": "function", "function": { "name": "get_weather" } },<br> { "type": "function", "function": { "name": "get_time" } }<br> ]<br>`	Ja

OpenAI.ChatCompletionAllowedToolsChoice

Zulässige Tools

Beschränkt die tools, die für das Modell verfügbar sind, auf einen vordefinierten Satz.

Name	Typ	Description	Required	Vorgabe
erlaubte_Werkzeuge	OpenAI.ChatCompletionAllowedTools	Beschränkt die tools, die für das Modell verfügbar sind, auf einen vordefinierten Satz.	Ja
type	enum	Zulässiger Toolkonfigurationstyp. Immer `allowed_tools`. Mögliche Werte: `allowed_tools`	Ja

OpenAI.ChatCompletionFunctionCallOption

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

Name	Typ	Description	Required	Vorgabe
Name	Schnur	Der Name der funktion, die aufgerufen werden soll.	Ja

OpenAI.ChatCompletionFunctions

Name	Typ	Description	Required
description	Schnur	Eine Beschreibung der Funktion, die vom Modell verwendet wird, um auszuwählen, wann und wie die Funktion aufgerufen wird.	No
Name	Schnur	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	OpenAI.FunctionParameters	Die Parameter, die die Funktionen akzeptieren, die als JSON-Schemaobjekt beschrieben werden. Siehe den Leitfaden für Beispiele und die JSON-Schema-Referenz für die Dokumentation zum Format. Durch Weglassen `parameters` wird eine Funktion mit einer leeren Parameterliste definiert.	No

OpenAI.ChatCompletionMessageCustomToolCall

Benutzerdefinierter Werkzeugaufruf

Ein Aufruf eines benutzerdefinierten Tools, das vom Modell erstellt wurde.

Name	Typ	Description	Required
custom	OpenAI.ChatCompletionMessageCustomToolCallCustom		Ja
└– Eingabe	Schnur		Ja
└– Name	Schnur		Ja
id	Schnur	Die ID des Toolaufrufs.	Ja
type	enum	Der Typ des Tools. Immer `custom`. Mögliche Werte: `custom`	Ja

OpenAI.ChatCompletionMessageCustomToolCallCustom

Name	Typ	Description	Required	Vorgabe
input	Schnur		Ja
Name	Schnur		Ja

OpenAI.ChatCompletionMessageToolCall

Funktionswerkzeugaufruf

Ein Aufruf eines Funktionstools, das vom Modell erstellt wurde.

Name	Typ	Description	Required
Funktion	OpenAI.ChatCompletionMessageToolCallFunction		Ja
└- Argumente	Schnur		Ja
└– Name	Schnur		Ja
id	Schnur	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	Description	Required
Funktion	OpenAI.ChatCompletionMessageToolCallChunkFunction		No
id	Schnur	Die ID des Toolaufrufs.	No
index	integer		Ja
type	enum	Der Typ des Tools. Derzeit wird nur `function` unterstützt. Mögliche Werte: `function`	No

OpenAI.ChatCompletionMessageToolCallChunkFunction

Name	Typ	Description	Required	Vorgabe
Argumente	Schnur		No
Name	Schnur		No

OpenAI.ChatCompletionMessageToolCallFunction

Name	Typ	Description	Required	Vorgabe
Argumente	Schnur		Ja
Name	Schnur		Ja

OpenAI.ChatCompletionMessageToolCalls

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

OpenAI.ChatCompletionMessageToolCallsItem

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

OpenAI.ChatCompletionNamedToolChoice

Funktionswerkzeugwahl

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

Name	Typ	Description	Required	Vorgabe
Funktion	OpenAI.ChatCompletionNamedToolChoiceFunction		Ja
type	enum	Bei Funktionsaufrufen ist der Typ immer `function`. Mögliche Werte: `function`	Ja

OpenAI.ChatCompletionNamedToolChoiceCustom

Individuelle Werkzeugwahl

Gibt ein Tool an, das das Modell verwenden soll. Wird verwendet, um zu erzwingen, dass das Modell ein bestimmtes benutzerdefiniertes Tool aufruft.

Name	Typ	Description	Required	Vorgabe
custom	OpenAI.ChatCompletionNamedToolChoiceCustomCustom		Ja
type	enum	Für benutzerdefinierte Toolaufrufe ist der Typ immer `custom`. Mögliche Werte: `custom`	Ja

OpenAI.ChatCompletionNamedToolChoiceCustomCustom

Name	Typ	Description	Required	Vorgabe
Name	Schnur		Ja

OpenAI.ChatCompletionNamedToolChoiceFunction

Name	Typ	Description	Required	Vorgabe
Name	Schnur		Ja

OpenAI.ChatCompletionRequestAssistantMessage

Assistentennachricht

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

Name	Typ	Description	Required
Audio	OpenAI.ChatCompletionRequestAssistantMessageAudio oder null	Daten zu einer vorherigen Audioantwort aus dem Modell.	No
Inhalt	String oder Array von OpenAI.ChatCompletionRequestAssistantMessageContentPart oder null		No
function_call	OpenAI.ChatCompletionRequestAssistantMessageFunctionCall oder null		No
Name	Schnur	Optionaler Name für den Teilnehmer. Stellt die Modellinformationen bereit, um zwischen den Teilnehmern derselben Rolle zu unterscheiden.	No
Weigerung	Zeichenfolge oder null		No
Rolle	enum	Die Rolle des Autors von Nachrichten in diesem Fall `assistant`. Mögliche Werte: `assistant`	Ja
tool_calls	OpenAI.ChatCompletionMessageToolCalls	Das Tool ruft vom Modell generierte Aufrufe auf, z. B. Funktionsaufrufe.	No

OpenAI.ChatCompletionRequestAssistantMessageAudio

Name	Typ	Description	Required	Vorgabe
id	Schnur		Ja

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Diskriminator für OpenAI.ChatCompletionRequestAssistantMessageContentPart

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

Typwert	Schema
`refusal`	OpenAI.ChatCompletionRequestMessageContentPartRefusal
`text`	OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ChatCompletionRequestAssistantMessageContentPartType		Ja

OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText

Textinhaltsteil

Erfahren Sie mehr über Texteingaben.

Name	Typ	Description	Required	Vorgabe
Text	Schnur	Der Textinhalt.	Ja
type	enum	Der Typ des Inhaltsteils. Mögliche Werte: `text`	Ja

OpenAI.ChatCompletionRequestAssistantMessageContentPartType

Property	Wert
Typ	Schnur
Werte	`text` `refusal`

OpenAI.ChatCompletionRequestAssistantMessageFunctionCall

Name	Typ	Description	Required	Vorgabe
Argumente	Schnur		Ja
Name	Schnur		Ja

OpenAI.ChatCompletionRequestDeveloperMessage

Entwickler-Botschaft

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	Description	Required
Inhalt	Zeichenfolge oder Array von OpenAI.ChatCompletionRequestMessageContentPartText	Der Inhalt der Entwicklernachricht.	Ja
Name	Schnur	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

Funktionsnachricht

Name	Typ	Description	Required
Inhalt	Zeichenfolge oder null		Ja
Name	Schnur	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
`assistant`	OpenAI.ChatCompletionRequestAssistantMessage
`developer`	OpenAI.ChatCompletionRequestDeveloperMessage
`function`	OpenAI.ChatCompletionRequestFunctionMessage
`system`	OpenAI.ChatCompletionRequestSystemMessage
`user`	OpenAI.ChatCompletionRequestUserMessage
`tool`	OpenAI.ChatCompletionRequestToolMessage

Name	Typ	Description	Required	Vorgabe
Rolle	OpenAI.ChatCompletionRequestMessageType		Ja

OpenAI.ChatCompletionRequestMessageContentPartAudio

Audioinhaltsteil

Name	Typ	Description	Required	Vorgabe
input_audio	OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudio		Ja
type	enum	Der Typ des Inhaltsteils. Immer `input_audio`. Mögliche Werte: `input_audio`	Ja

OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudio

Name	Typ	Description	Required	Vorgabe
data	Schnur		Ja
format	enum	Mögliche Werte: `wav`, `mp3`	Ja

OpenAI.ChatCompletionRequestMessageContentPartFile

Dateiinhaltsteil

Erfahren Sie mehr über Dateieingaben für die Textgenerierung.

Name	Typ	Description	Required
file	OpenAI.ChatCompletionRequestMessageContentPartFileFile		Ja
└– file_data	Schnur		No
└– file_id	Schnur		No
└– Dateiname	Schnur		No
type	enum	Der Typ des Inhaltsteils. Immer `file`. Mögliche Werte: `file`	Ja

OpenAI.ChatCompletionRequestMessageContentPartFileFile

Name	Typ	Required
file_data	Schnur	No
Datei-ID	Schnur	No
filename	Schnur	No

OpenAI.ChatCompletionRequestMessageContentPartImage

Bildinhaltsteil

Name	Typ	Description	Required	Vorgabe
image_url	OpenAI.ChatCompletionRequestMessageContentPartImageUrl		Ja
type	enum	Der Typ des Inhaltsteils. Mögliche Werte: `image_url`	Ja

OpenAI.ChatCompletionRequestMessageContentPartImageUrl

Name	Typ	Description	Required	Vorgabe
detail	enum	Mögliche Werte: `auto`, , `lowhigh`	No	auto
url	Zeichenfolge (URI)		Ja

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Teil zum Ablehnungsinhalt

Name	Typ	Description	Required	Vorgabe
Weigerung	Schnur	Die vom Modell generierte Ablehnungsmeldung.	Ja
type	enum	Der Typ des Inhaltsteils. Mögliche Werte: `refusal`	Ja

OpenAI.ChatCompletionRequestMessageContentPartText

Textinhaltsteil

Name	Typ	Description	Required	Vorgabe
Text	Schnur	Der Textinhalt.	Ja
type	enum	Der Typ des Inhaltsteils. Mögliche Werte: `text`	Ja

OpenAI.ChatCompletionRequestMessageType

Property	Wert
Typ	Schnur
Werte	`developer` `system` `user` `assistant` `tool` `function`

OpenAI.ChatCompletionRequestSystemMessage

Systemnachricht

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

Name	Typ	Description	Required
Inhalt	Zeichenfolge oder Array von OpenAI.ChatCompletionRequestSystemMessageContentPart	Der Inhalt der Systemnachricht.	Ja
Name	Schnur	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

Werkzeugnachricht

Name	Typ	Description	Required
Inhalt	Zeichenfolge oder Array von OpenAI.ChatCompletionRequestToolMessageContentPart	Der Inhalt der Toolnachricht.	Ja
Rolle	enum	Die Rolle des Autors von Nachrichten in diesem Fall `tool`. Mögliche Werte: `tool`	Ja
tool_call_id	Schnur	Toolaufruf, auf den diese Nachricht reagiert.	Ja

OpenAI.ChatCompletionRequestToolMessageContentPart

Referenzen: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

Benutzernachricht

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

Name	Typ	Description	Required
Inhalt	Zeichenfolge oder Array von OpenAI.ChatCompletionRequestUserMessageContentPart	Der Inhalt der Benutzernachricht.	Ja
Name	Schnur	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

Diskriminator für OpenAI.ChatCompletionRequestUserMessageContentPart

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

Typwert	Schema
`image_url`	OpenAI.ChatCompletionRequestMessageContentPartImage
`input_audio`	OpenAI.ChatCompletionRequestMessageContentPartAudio
`file`	OpenAI.ChatCompletionRequestMessageContentPartFile
`text`	OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ChatCompletionRequestUserMessageContentPartType		Ja

OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText

Textinhaltsteil

Erfahren Sie mehr über Texteingaben.

Name	Typ	Description	Required	Vorgabe
Text	Schnur	Der Textinhalt.	Ja
type	enum	Der Typ des Inhaltsteils. Mögliche Werte: `text`	Ja

OpenAI.ChatCompletionRequestUserMessageContentPartType

Property	Wert
Typ	Schnur
Werte	`text` `image_url` `input_audio` `file`

OpenAI.ChatCompletionResponseMessage

Wenn die Audioausgabemodalitäten angefordert werden, enthält dieses Objekt Daten zur Audioantwort des Modells.

Name	Typ	Description	Required
annotations	Array von OpenAI.ChatCompletionResponseMessageAnnotations	Anmerkungen für die Nachricht, falls zutreffend, wie bei Verwendung Websuchtool.	No
Audio	OpenAI.ChatCompletionResponseMessageAudio oder null		No
Inhalt	Zeichenfolge oder null		Ja
function_call	OpenAI.ChatCompletionResponseMessageFunctionCall (veraltet)		No
└- Argumente	Schnur		Ja
└– Name	Schnur		Ja
reasoning_content	Schnur	Eine Azure-spezifische Erweiterungseigenschaft, die generierte Begründungsinhalte aus unterstützten Modellen enthält.	No
Weigerung	Zeichenfolge oder null		Ja
Rolle	enum	Die Rolle des Autors dieser Nachricht. Mögliche Werte: `assistant`	Ja
tool_calls	OpenAI.ChatCompletionMessageToolCallsItem	Das Tool ruft vom Modell generierte Aufrufe auf, z. B. Funktionsaufrufe.	No

OpenAI.ChatCompletionResponseMessageAnnotations

Name	Typ	Description	Required	Vorgabe
type	enum	Mögliche Werte: `url_citation`	Ja
url_citation	OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation		Ja

OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation

Name	Typ	Required
end_index	integer	Ja
start_index	integer	Ja
title	Schnur	Ja
url	Schnur	Ja

OpenAI.ChatCompletionResponseMessageAudio

Name	Typ	Required
data	Schnur	Ja
läuft_ab_am	Ganzzahl (Unixtime)	Ja
id	Schnur	Ja
Abschrift	Schnur	Ja

OpenAI.ChatCompletionResponseMessageFunctionCall

Name	Typ	Description	Required	Vorgabe
Argumente	Schnur		Ja
Name	Schnur		Ja

OpenAI.ChatCompletionStreamOptions

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

Name	Typ	Description	Required	Vorgabe
include_obfuscation	boolean	Wenn true, wird die Stream-Verschleierung aktiviert. Stream-Verschleierung fügt hinzu Zufällige Zeichen für ein `obfuscation` Feld bei Streaming-Delta-Ereignissen normalisieren Sie Nutzlastgrößen als Gegenmaßnahme für bestimmte Seitenkanalangriffe. Diese Verschleierungsfelder sind standardmäßig enthalten, fügen jedoch einen kleinen Betrag hinzu. mehr Aufwand für den Datenstrom. Sie können auf `include_obfuscation` false, um die Bandbreite zu optimieren, wenn Sie den Netzwerkverbindungen zwischen Ihre Anwendung und die OpenAI-API.	No
include_usage	boolean	Falls festgelegt, wird ein zusätzlicher Abschnitt vor dem `data: [DONE]` gestreamt. Nachricht. Das `usage` Feld in diesem Abschnitt zeigt die Tokenverwendungsstatistiken an. für die gesamte Anforderung, und das `choices` Feld ist immer ein leerer Array. Alle anderen Blöcke enthalten auch ein `usage` Feld, aber mit null Wert. ANMERKUNG: Wenn der Datenstrom unterbrochen wird, erhalten Sie möglicherweise nicht den letzter 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	Description	Required
Inhalt	Zeichenfolge oder null		No
function_call	OpenAI.ChatCompletionStreamResponseDeltaFunctionCall (veraltet)		No
└- Argumente	Schnur		No
└– Name	Schnur		No
reasoning_content	Schnur	Eine Azure-spezifische Erweiterungseigenschaft, die generierte Begründungsinhalte aus unterstützten Modellen enthält.	No
Weigerung	Zeichenfolge oder null		No
Rolle	enum	Die Rolle des Autors dieser Nachricht. Mögliche Werte: `developer`, , `systemuser`, , `assistanttool`	No
tool_calls	Array von OpenAI.ChatCompletionMessageToolCallChunk		No

OpenAI.ChatCompletionStreamResponseDeltaFunctionCall

Name	Typ	Description	Required	Vorgabe
Argumente	Schnur		No
Name	Schnur		No

OpenAI.ChatCompletionTokenLogprob

Name	Typ	Description	Required
Byte	Array einer ganzen Zahl oder null		Ja
logprob	Zahl	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	Schnur	Das Token.	Ja
top_logprobs	Array von OpenAI.ChatCompletionTokenLogprobTopLogprobs	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.ChatCompletionTokenLogprobTopLogprobs

Name	Typ	Required
Byte	Array einer ganzen Zahl oder null	Ja
logprob	Zahl	Ja
token	Schnur	Ja

OpenAI.ChatCompletionTool

Funktionswerkzeug

Ein Funktionstool, das zum Generieren einer Antwort verwendet werden kann.

Name	Typ	Description	Required	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.

Typ: Zeichenfolge oder OpenAI.ChatCompletionAllowedToolsChoice oder OpenAI.ChatCompletionNamedToolChoice oder OpenAI.ChatCompletionNamedToolChoiceCustom

OpenAI.CompletionUsage

Nutzungsstatistiken für die Abschlussanforderung.

Name	Typ	Description	Required
completion_tokens	integer	Anzahl der Token im generierten Abschluss.	Ja
completion_tokens_details	OpenAI.CompletionUsageCompletionTokensDetails		No
└– akzeptierte_Vorhersage_Token	integer		No
└– audio_tokens	integer		No
└– reasoning_tokens	integer		No
└– rejected_prediction_tokens	integer		No
prompt_tokens	integer	Anzahl der Token in der Eingabeaufforderung.	Ja
prompt_tokens_details	OpenAI.CompletionUsagePromptTokensDetails		No
└– audio_tokens	integer		No
└– zwischengespeicherte_Token	integer		No
Gesamtanzahl Tokens	integer	Die Gesamtzahl der in der Anforderung verwendeten Token (Aufforderung + Abschluss).	Ja

OpenAI.CompletionUsageCompletionTokensDetails

Name	Typ	Required
accepted_prediction_tokens	integer	No
audio_tokens	integer	No
Begründungs_Token	integer	No
rejected_prediction_tokens	integer	No

OpenAI.CompletionUsagePromptTokensDetails

Name	Typ	Description	Required	Vorgabe
audio_tokens	integer		No
cached_tokens	integer		No

OpenAI.CreateChatCompletionRequestAudio

Name	Typ	Description	Required	Vorgabe
format	enum	Mögliche Werte: `wav`, , `aac`, `mp3flac`, , , `opuspcm16`	Ja
Stimme	OpenAI.VoiceIdsShared		Ja

OpenAI.CreateChatCompletionRequestResponseFormat

Ein Objekt, das das Format angibt, das das Modell ausgeben muss. Einstellung, um strukturierte Ausgaben zu { "type": "json_schema", "json_schema": {...} } ermöglichen, wodurch sichergestellt wird, dass das Modell ihrem bereitgestellten JSON-Schema entspricht. Erfahren Sie mehr im Structured Outputs Leitfaden. Durch das Festlegen auf { "type": "json_object" } wird der ältere JSON-Modus aktiviert. Dadurch wird sichergestellt, dass die vom Modell generierte Meldung gültiger JSON-Code ist. Die Verwendung json_schema wird für Modelle bevorzugt, die sie unterstützen.

Diskriminator für OpenAI.CreateChatCompletionRequestResponseFormat

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

Typwert	Schema
`json_schema`	OpenAI.ResponseFormatJsonSchema
`text`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatResponseFormatText
`json_object`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatResponseFormatJsonObject

Name	Typ	Description	Required	Vorgabe
type	OpenAI.CreateChatCompletionRequestResponseFormatType		Ja

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatResponseFormatJsonObject

JSON-Objekt

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	Description	Required	Vorgabe
type	enum	Der Typ des zu definierenden Antwortformats. Immer `json_object`. Mögliche Werte: `json_object`	Ja

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatResponseFormatText

Text

Standardantwortformat. Wird verwendet, um Textantworten zu generieren.

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

OpenAI.CreateChatCompletionRequestResponseFormatType

Property	Wert
Typ	Schnur
Werte	`text` `json_schema` `json_object`

OpenAI.CreateChatCompletionResponseChoices

Name	Typ	Description	Required
Content-Filtern-Egebnisse	AzureContentFilterResultForChoice	Ein Inhaltsfilterergebnis für ein einzelnes Antwortelement, das von einem generativen KI-System erzeugt wird.	No
Beendigungsgrund	enum	Mögliche Werte: `stop`, , `lengthtool_calls`, , `content_filterfunction_call`	Ja
index	integer		Ja
logprobs	OpenAI.CreateChatCompletionResponseChoicesLogprobs oder NULL		Ja
message	OpenAI.ChatCompletionResponseMessage	Wenn die Audioausgabemodalitäten angefordert werden, enthält dieses Objekt Daten. informationen zur Audioantwort des Modells.	Ja

OpenAI.CreateChatCompletionResponseChoicesLogprobs

Name	Typ	Description	Required	Vorgabe
Inhalt	Array von OpenAI.ChatCompletionTokenLogprob oder NULL		Ja
Weigerung	Array von OpenAI.ChatCompletionTokenLogprob oder NULL		Ja

OpenAI.CreateChatCompletionStreamResponseChoices

Name	Typ	Description	Required
delta	OpenAI.ChatCompletionStreamResponseDelta	Ein Chat-Vervollständigungsdelta, das von streamten Modellantworten generiert wurde.	Ja
Beendigungsgrund	Zeichenfolge oder null		Ja
index	integer		Ja
logprobs	OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs oder NULL		No

OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs

Name	Typ	Description	Required	Vorgabe
Inhalt	Array von OpenAI.ChatCompletionTokenLogprob oder NULL		Ja
Weigerung	Array von OpenAI.ChatCompletionTokenLogprob oder NULL		Ja

OpenAI.CustomToolChatCompletions

Benutzerdefiniertes Werkzeug

Ein benutzerdefiniertes Tool, das Eingaben mithilfe eines angegebenen Formats verarbeitet.

Name	Typ	Description	Required
custom	OpenAI.CustomToolChatCompletionsCustom		Ja
└– Beschreibung	Schnur		No
└─ Format	OpenAI.CustomToolChatCompletionsCustomFormatText oder OpenAI.CustomToolChatCompletionsCustomFormatGrammar		No
└– Name	Schnur		Ja
type	enum	Der Typ des benutzerdefinierten Tools. Immer `custom`. Mögliche Werte: `custom`	Ja

OpenAI.CustomToolChatCompletionsCustom

Name	Typ	Required
description	Schnur	No
format	OpenAI.CustomToolChatCompletionsCustomFormatText oder OpenAI.CustomToolChatCompletionsCustomFormatGrammar	No
Name	Schnur	Ja

OpenAI.CustomToolChatCompletionsCustomFormatGrammar

Name	Typ	Description	Required
Grammatik	OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar		Ja
└- Definition	Schnur		Ja
└– Syntax	enum	Mögliche Werte: `lark`, `regex`	Ja
type	enum	Mögliche Werte: `grammar`	Ja

OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar

Name	Typ	Description	Required	Vorgabe
Definition	Schnur		Ja
Syntax	enum	Mögliche Werte: `lark`, `regex`	Ja

OpenAI.CustomToolChatCompletionsCustomFormatText

Name	Typ	Description	Required	Vorgabe
type	enum	Mögliche Werte: `text`	Ja

OpenAI.FunctionObject

Name	Typ	Description	Required
description	Schnur	Eine Beschreibung der Funktion, die vom Modell verwendet wird, um auszuwählen, wann und wie die Funktion aufgerufen wird.	No
Name	Schnur	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	OpenAI.FunctionParameters	Die Parameter, die die Funktionen akzeptieren, die als JSON-Schemaobjekt beschrieben werden. Siehe den Leitfaden für Beispiele und die JSON-Schema-Referenz für die Dokumentation zum Format. Durch Weglassen `parameters` wird eine Funktion mit einer leeren Parameterliste definiert.	No
strict	Boolescher Wert oder Null		No

OpenAI.FunctionParameters

Die Parameter, die die Funktionen akzeptieren, die als JSON-Schemaobjekt beschrieben werden. Siehe den Leitfaden für Beispiele und die JSON-Schema-Referenz für die Dokumentation zum Format. Durch Weglassen parameters wird eine Funktion mit einer leeren Parameterliste definiert.

Typ: Objekt

OpenAI.Metadata

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.

Typ: Objekt

OpenAI.ParallelToolCalls

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

Typ: boolean

OpenAI.PredictionContent

Statischer Inhalt

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

Name	Typ	Description	Required	Vorgabe
Inhalt	Zeichenfolge oder Array von OpenAI.ChatCompletionRequestMessageContentPartText	Der Inhalt, der beim Generieren einer Modellantwort abgeglichen werden soll. Wenn generierte Token mit diesem Inhalt übereinstimmen würden, würde die gesamte Modellantwort kann viel schneller zurückgegeben werden.	Ja
type	enum	Der Typ des vorhergesagten Inhalts, den Sie bereitstellen möchten. Dieser Typ ist aktuell immer `content`. Mögliche Werte: `content`	Ja

OpenAI.ReasoningEffort

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

gpt-5.1 Standardwert ist none, was keine Begründung ausführt. Die unterstützten Grundwerte sind gpt-5.1none, , low, mediumund high. Toolaufrufe werden für alle Gründe in gpt-5.1 unterstützt.
Alle Modelle vor gpt-5.1 der Standardeinstellung für medium Diesuchaufwand und unterstützen nicht none.
Das gpt-5-pro Modell ist standardmäßig auf (und nur unterstützt) high Denkaufwand für die Begründung.
xhigh wird für alle Modelle nach gpt-5.1-codex-max.

Property	Wert
Beschreibung	Beschränkt den Aufwand für die Begründung von Begründungsmodellen. Derzeit unterstützte Werte sind `none`, , `minimal`, `low`, `medium`, `high`und `xhigh`. Das Reduzieren von Gründen kann zu schnelleren Antworten und weniger Token führen, die bei der Begründung in einer Antwort verwendet werden. - `gpt-5.1` Standardwert ist `none`, was keine Begründung ausführt. Die unterstützten Grundwerte sind `gpt-5.1none`, , `low`, `medium`und `high`. Toolaufrufe werden für alle Gründe in gpt-5.1 unterstützt. - Alle Modelle vor `gpt-5.1` der Standardeinstellung des `medium` Grundaufwands und nicht unterstützen `none`. - Das `gpt-5-pro` Modell ist standardmäßig auf (und nur unterstützt) `high` Grunderlegungsaufwand festgelegt. - `xhigh` wird für alle Modelle nach `gpt-5.1-codex-max`.
Typ	Schnur
Werte	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ResponseFormatJsonSchema

JSON-Schema

JSON-Schemaantwortformat. Wird verwendet, um strukturierte JSON-Antworten zu generieren. Erfahren Sie mehr über Structured Outputs.

Name	Typ	Description	Required
JSON-Schema	OpenAI.ResponseFormatJsonSchemaJsonSchema		Ja
└– Beschreibung	Schnur		No
└– Name	Schnur		Ja
└- 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 oder Null		No
type	enum	Der Typ des zu definierenden Antwortformats. Immer `json_schema`. Mögliche Werte: `json_schema`	Ja

OpenAI.ResponseFormatJsonSchemaJsonSchema

Name	Typ	Description	Required
description	Schnur		No
Name	Schnur		Ja
schema	OpenAI.ResponseFormatJsonSchemaSchema	Das Schema für das Antwortformat, das als JSON-Schemaobjekt beschrieben wird. Hier erfahren Sie, wie Sie JSON-Schemas erstellen.	No
strict	Boolescher Wert oder Null		No

OpenAI.ResponseFormatJsonSchemaSchema

JSON-Schema

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

Typ: Objekt

OpenAI.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"]

Dieses Schema akzeptiert einen der folgenden Typen:

Anordnung
null

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:

Anordnung
null

OpenAI.Verbosity

Beschränkt die Ausführlichkeit der Antwort des Modells. Niedrigere Werte führen zu präziseren Antworten, während höhere Werte ausführlichere Antworten ergeben. Derzeit unterstützte Werte sind low, mediumund high.

Property	Wert
Beschreibung	Beschränkt die Ausführlichkeit der Antwort des Modells. Niedrigere Werte führen zu präziseren Antworten, während höhere Werte ausführlichere Antworten ergeben. Derzeit unterstützte Werte sind `low`, `medium`und `high`.
Typ	Schnur
Werte	`low` `medium` `high`

OpenAI.VoiceIdsShared

Property	Wert
Typ	Schnur
Werte	`alloy` `ash` `ballad` `coral` `echo` `sage` `shimmer` `verse` `marin` `cedar`

Last updated on 2026-06-12