Azure OpenAI responses

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).

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)

Antwort erstellen

POST {endpoint}/openai/v1/responses

Erstellt eine Modellantwort.

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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
Hintergrund	Boolescher Wert oder Null		No
context_management	array von OpenAI.ContextManagementParam oder null	Kontextmanagement-Konfiguration für diese Anfrage.	No
Gespräch	OpenAI.ConversationParam oder NULL		No
einschließen	Array von OpenAI.IncludeEnum oder NULL		No
input	OpenAI.InputParam	Text-, Bild- oder Dateieingaben für das Modell, die zum Generieren einer Antwort verwendet werden. Erfahren Sie mehr: - Texteingaben und -ausgaben - Bildeingaben - Dateieingaben - Gesprächszustand - Funktionsaufruf	No
instructions	Zeichenfolge oder null		No
max_output_tokens	ganze Zahl oder Null		No
max_tool_calls	ganze Zahl oder Null		No
metadata	OpenAI.Metadata oder NULL		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. Siehe die Modellanleitung um verfügbare Modelle zu durchsuchen und zu vergleichen.	No
Parallele Werkzeugaufrufe	Boolescher Wert oder Null		No
previous_response_id	Zeichenfolge oder null		No
Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	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.	No
prompt_cache_retention	Zeichenfolge oder null		No
reasoning	OpenAI.Reasoning oder NULL		No
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 Zeichenkette sein, die jeden Benutzer eindeutig identifiziert, mit einer maximalen Länge von 64 Zeichen. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Einschränkungen: maxLänge: 64	No
abspeichern	Boolescher Wert oder Null		No
stream	Boolescher Wert oder Null		No
stream_options	OpenAI.ResponseStreamOptions oder NULL		No
Temperatur	Zahl oder Null		No
Text	OpenAI.ResponseTextParam	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann einfach sein Text- oder strukturierte JSON-Daten. Erfahren Sie mehr: - Texteingaben und -ausgaben - Strukturierte Ausgaben	No
tool_choice	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	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. Sie können die beiden folgenden Kategorien von Tools bereitstellen: - Integrierte Tools: Tools, die von OpenAI zur Erweiterung von Funktionen bereitgestellt werden Die Funktionen des Modells, z. B. die Dateisuche. - Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, Ermöglichen, dass das Modell Ihren eigenen Code ausführt.	No
top_logprobs	ganze Zahl oder Null		No
top_p	Zahl oder Null		No
truncation	Zeichenfolge oder null		No
user	Zeichenfolge (veraltet)	Dieses Feld wird durch `safety_identifier` und `prompt_cache_key`. Verwenden Sie `prompt_cache_key` stattdessen die Zwischenspeicherungsoptimierungen. Ein stabiler Bezeichner für Ihre Endbenutzer. Wird verwendet, um Die Trefferraten des Caches zu erhöhen, indem ähnliche Anforderungen besser zusammengefasst werden, und um OpenAI dabei zu helfen, Missbrauch zu erkennen und zu verhindern.	No

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt
text/event-stream	Objekt

Name	Typ	Description	Required	Vorgabe
Hintergrund	Boolescher Wert oder Null		No
abgeschlossen_am	Zeichenfolge oder null		No
content_filters	Array von AzureContentFilterForResponsesAPI	Der Inhaltsfilter ergibt sich aus RAI.	No
Gespräch	OpenAI.ConversationReference oder NULL		No
erstellt_am	Ganzzahl (Unixtime)	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
Fehler	OpenAI.ResponseError oder NULL		Ja
id	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
incomplete_details	OpenAI.ResponseIncompleteDetails oder NULL		Ja
instructions	Zeichenfolge oder Array von OpenAI.InputItem oder NULL		Ja
max_output_tokens	ganze Zahl oder Null		No
max_tool_calls	ganze Zahl oder Null		No
metadata	OpenAI.Metadata oder NULL		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. Siehe die Modellanleitung um verfügbare Modelle zu durchsuchen und zu vergleichen.	No
Objekt	enum	Der Objekttyp dieser Ressource, immer auf `response` festgelegt. Mögliche Werte: `response`	Ja
Ausgabe	Array von OpenAI.OutputItem	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array ist abhängig von der Antwort des Modells. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant`-Nachricht mit dem Inhalt handelt, der vom Modell generiert wurde, können Sie ggf. die Eigenschaft `output_text` verwenden, sofern dies in SDKs unterstützt wird.	Ja
output_text	Zeichenfolge oder null		No
Parallele Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
previous_response_id	Zeichenfolge oder null		No
Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	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.	No
prompt_cache_retention	Zeichenfolge oder null		No
reasoning	OpenAI.Reasoning oder NULL		No
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 Zeichenkette sein, die jeden Benutzer eindeutig identifiziert, mit einer maximalen Länge von 64 Zeichen. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Einschränkungen: maxLänge: 64	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	Zahl oder Null		No
Text	OpenAI.ResponseTextParam	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann einfach sein Text- oder strukturierte JSON-Daten. Erfahren Sie mehr: - Texteingaben und -ausgaben - Strukturierte Ausgaben	No
tool_choice	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	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. Wir unterstützen die folgenden Kategorien von Tools: - Integrierte Tools: Tools, die von OpenAI zur Erweiterung von Funktionen bereitgestellt werden Die Fähigkeiten des Modells, wie die Websuche, Oder Dateisuche. Weitere Informationen zu eingebaute Werkzeuge. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Werkzeuge. - Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, Aktivieren des Modells zum Aufrufen ihres eigenen Codes mit stark typierten Argumenten und Ausgaben. Weitere Informationen zu Funktionsaufruf. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
top_logprobs	ganze Zahl oder Null		No
top_p	Zahl oder Null		No
truncation	Zeichenfolge oder null		No
usage	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails dar, einschließlich Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken.	No
user	Zeichenfolge (veraltet)	Dieses Feld wird durch `safety_identifier` und `prompt_cache_key`. Verwenden Sie `prompt_cache_key` stattdessen die Zwischenspeicherungsoptimierungen. Ein stabiler Bezeichner für Ihre Endbenutzer. Wird verwendet, um Die Trefferraten des Caches zu erhöhen, indem ähnliche Anforderungen besser zusammengefasst werden, und um OpenAI dabei zu helfen, Missbrauch zu erkennen und zu verhindern.	No

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	No
type	Schnur	No

Antwortheader:

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

Examples

Example

Erstellen einer Modellantwort

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

Antwort abrufen

GET {endpoint}/openai/v1/responses/{response_id}

Ruft eine Modellantwort mit der angegebenen ID ab.

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
response_id	path	Ja	Schnur
include[]	query	No	array	Zusätzliche Felder, die in die Antwort eingeschlossen werden sollen. Weitere Informationen finden Sie im Include-Parameter für die Erstellung von Antworten oben.
stream	query	No	boolean	Wenn dieser Wert auf "true" festgelegt ist, werden die Modellantwortdaten an den Client gestreamt, da sie mithilfe von Server gesendeten Ereignissen generiert wird. Serialisierung: explodieren: falsch
starting_after	query	No	ganze Zahl (int32)	Die Sequenznummer des Ereignisses, nach dem streaming gestartet werden soll. Serialisierung: explodieren: falsch
include_obfuscation	query	No	boolean	Wenn true, wird die Stream-Verschleierung aktiviert. Stream-Verschleierung fügt einem `obfuscation` Feld bei Streaming-Delta-Ereignissen zufällige Zeichen hinzu, um Nutzlastgrößen als Gegenmaßnahme für bestimmte Querkanalangriffe zu normalisieren. Diese Verschleierungsfelder sind standardmäßig enthalten, fügen jedoch dem Datenstrom einen geringen Mehraufwand hinzu. Sie können auf "false" festlegen `include_obfuscation` , um die Bandbreite zu optimieren, wenn Sie den Netzwerkverbindungen zwischen Ihrer Anwendung und der OpenAI-API vertrauen. Serialisierung: explodieren: falsch

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt

Name	Typ	Description	Required	Vorgabe
Hintergrund	Boolescher Wert oder Null		No
abgeschlossen_am	Zeichenfolge oder null		No
content_filters	Array von AzureContentFilterForResponsesAPI	Der Inhaltsfilter ergibt sich aus RAI.	No
Gespräch	OpenAI.ConversationReference oder NULL		No
erstellt_am	Ganzzahl (Unixtime)	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
Fehler	OpenAI.ResponseError oder NULL		Ja
id	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
incomplete_details	OpenAI.ResponseIncompleteDetails oder NULL		Ja
instructions	Zeichenfolge oder Array von OpenAI.InputItem oder NULL		Ja
max_output_tokens	ganze Zahl oder Null		No
max_tool_calls	ganze Zahl oder Null		No
metadata	OpenAI.Metadata oder NULL		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. Siehe die Modellanleitung um verfügbare Modelle zu durchsuchen und zu vergleichen.	No
Objekt	enum	Der Objekttyp dieser Ressource, immer auf `response` festgelegt. Mögliche Werte: `response`	Ja
Ausgabe	Array von OpenAI.OutputItem	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array ist abhängig von der Antwort des Modells. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant`-Nachricht mit dem Inhalt handelt, der vom Modell generiert wurde, können Sie ggf. die Eigenschaft `output_text` verwenden, sofern dies in SDKs unterstützt wird.	Ja
output_text	Zeichenfolge oder null		No
Parallele Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
previous_response_id	Zeichenfolge oder null		No
Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	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.	No
prompt_cache_retention	Zeichenfolge oder null		No
reasoning	OpenAI.Reasoning oder NULL		No
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 Zeichenkette sein, die jeden Benutzer eindeutig identifiziert, mit einer maximalen Länge von 64 Zeichen. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Einschränkungen: maxLänge: 64	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	Zahl oder Null		No
Text	OpenAI.ResponseTextParam	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann einfach sein Text- oder strukturierte JSON-Daten. Erfahren Sie mehr: - Texteingaben und -ausgaben - Strukturierte Ausgaben	No
tool_choice	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	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. Wir unterstützen die folgenden Kategorien von Tools: - Integrierte Tools: Tools, die von OpenAI zur Erweiterung von Funktionen bereitgestellt werden Die Fähigkeiten des Modells, wie die Websuche, Oder Dateisuche. Weitere Informationen zu eingebaute Werkzeuge. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Werkzeuge. - Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, Aktivieren des Modells zum Aufrufen ihres eigenen Codes mit stark typierten Argumenten und Ausgaben. Weitere Informationen zu Funktionsaufruf. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
top_logprobs	ganze Zahl oder Null		No
top_p	Zahl oder Null		No
truncation	Zeichenfolge oder null		No
usage	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails dar, einschließlich Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken.	No
user	Zeichenfolge (veraltet)	Dieses Feld wird durch `safety_identifier` und `prompt_cache_key`. Verwenden Sie `prompt_cache_key` stattdessen die Zwischenspeicherungsoptimierungen. Ein stabiler Bezeichner für Ihre Endbenutzer. Wird verwendet, um Die Trefferraten des Caches zu erhöhen, indem ähnliche Anforderungen besser zusammengefasst werden, und um OpenAI dabei zu helfen, Missbrauch zu erkennen und zu verhindern.	No

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	No
type	Schnur	No

Antwortheader:

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

Antwort löschen

DELETE {endpoint}/openai/v1/responses/{response_id}

Löscht eine Antwort nach ID.

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
response_id	path	Ja	Schnur

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt

Name	Typ	Description	Required
gelöscht	enum	Mögliche Werte: `True`	Ja
id	Schnur		Ja
Objekt	enum	Mögliche Werte: `response.deleted`	Ja

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	No
type	Schnur	No

Antwortheader:

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

Antwort abbrechen

POST {endpoint}/openai/v1/responses/{response_id}/cancel

Bricht eine Modellantwort mit der angegebenen ID ab. Es können nur Antworten abgebrochen werden, die mit dem auf "true" festgelegten Hintergrundparameter erstellt wurden.

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
response_id	path	Ja	Schnur

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt

Name	Typ	Description	Required	Vorgabe
Hintergrund	Boolescher Wert oder Null		No
abgeschlossen_am	Zeichenfolge oder null		No
content_filters	Array von AzureContentFilterForResponsesAPI	Der Inhaltsfilter ergibt sich aus RAI.	No
Gespräch	OpenAI.ConversationReference oder NULL		No
erstellt_am	Ganzzahl (Unixtime)	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
Fehler	OpenAI.ResponseError oder NULL		Ja
id	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
incomplete_details	OpenAI.ResponseIncompleteDetails oder NULL		Ja
instructions	Zeichenfolge oder Array von OpenAI.InputItem oder NULL		Ja
max_output_tokens	ganze Zahl oder Null		No
max_tool_calls	ganze Zahl oder Null		No
metadata	OpenAI.Metadata oder NULL		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. Siehe die Modellanleitung um verfügbare Modelle zu durchsuchen und zu vergleichen.	No
Objekt	enum	Der Objekttyp dieser Ressource, immer auf `response` festgelegt. Mögliche Werte: `response`	Ja
Ausgabe	Array von OpenAI.OutputItem	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array ist abhängig von der Antwort des Modells. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant`-Nachricht mit dem Inhalt handelt, der vom Modell generiert wurde, können Sie ggf. die Eigenschaft `output_text` verwenden, sofern dies in SDKs unterstützt wird.	Ja
output_text	Zeichenfolge oder null		No
Parallele Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
previous_response_id	Zeichenfolge oder null		No
Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	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.	No
prompt_cache_retention	Zeichenfolge oder null		No
reasoning	OpenAI.Reasoning oder NULL		No
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 Zeichenkette sein, die jeden Benutzer eindeutig identifiziert, mit einer maximalen Länge von 64 Zeichen. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Einschränkungen: maxLänge: 64	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	Zahl oder Null		No
Text	OpenAI.ResponseTextParam	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann einfach sein Text- oder strukturierte JSON-Daten. Erfahren Sie mehr: - Texteingaben und -ausgaben - Strukturierte Ausgaben	No
tool_choice	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	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. Wir unterstützen die folgenden Kategorien von Tools: - Integrierte Tools: Tools, die von OpenAI zur Erweiterung von Funktionen bereitgestellt werden Die Fähigkeiten des Modells, wie die Websuche, Oder Dateisuche. Weitere Informationen zu eingebaute Werkzeuge. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Werkzeuge. - Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, Aktivieren des Modells zum Aufrufen ihres eigenen Codes mit stark typierten Argumenten und Ausgaben. Weitere Informationen zu Funktionsaufruf. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
top_logprobs	ganze Zahl oder Null		No
top_p	Zahl oder Null		No
truncation	Zeichenfolge oder null		No
usage	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails dar, einschließlich Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken.	No
user	Zeichenfolge (veraltet)	Dieses Feld wird durch `safety_identifier` und `prompt_cache_key`. Verwenden Sie `prompt_cache_key` stattdessen die Zwischenspeicherungsoptimierungen. Ein stabiler Bezeichner für Ihre Endbenutzer. Wird verwendet, um Die Trefferraten des Caches zu erhöhen, indem ähnliche Anforderungen besser zusammengefasst werden, und um OpenAI dabei zu helfen, Missbrauch zu erkennen und zu verhindern.	No

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	No
type	Schnur	No

Antwortheader:

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

Listeneingabeelemente

GET {endpoint}/openai/v1/responses/{response_id}/input_items

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

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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
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.
response_id	path	Ja	Schnur
Limit	query	No	ganze Zahl (int32)	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen. Der Standardwert ist 20. Serialisierung: explodieren: falsch
order	query	No	Schnur Mögliche Werte: `asc`, `desc`	Sortierreihenfolge nach dem `created_at` Zeitstempel der Objekte. `asc` für aufsteigende Reihenfolge und`desc` für absteigende Reihenfolge. Serialisierung: explodieren: falsch
Nach	query	No	Schnur	Ein Cursor für die Verwendung in der Paginierung. `after` ist eine Objekt-ID, die Ihren Platz in der Liste definiert. Wenn Sie beispielsweise eine Listenanforderung stellen und 100 Objekte empfangen, die mit obj_foo enden, Nachfolgende Aufrufe können after=obj_foo enthalten, um die nächste Seite der Liste abzurufen. Serialisierung: explodieren: falsch
before	query	No	Schnur	Ein Cursor für die Verwendung in der Paginierung. `before` ist eine Objekt-ID, die Ihren Platz in der Liste definiert. Wenn Sie beispielsweise eine Listenanforderung stellen und 100 Objekte empfangen, die mit obj_foo enden, Nachfolgende Aufrufe können before=obj_foo enthalten, um die vorherige Seite der Liste abzurufen. Serialisierung: explodieren: falsch

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.ResponseItemList

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	No
type	Schnur	No

Antwortheader:

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

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

AzureContentFilterForResponsesAPI

Name	Typ	Description	Required
Blockiert	boolean	Geben Sie an, ob die Antwort blockiert ist.	Ja
content_filter_offsets	AzureContentFilterResultOffsets		Ja
Content-Filtern-Egebnisse	AzureContentFilterResultsForResponsesAPI		Ja
└– benutzerdefinierte Sperrlisten	AzureContentFilterBlocklistResult	Eine Sammlung von binären Filterergebnissen für konfigurierte benutzerdefinierte Blocklisten.	No
└– custom_topics	AzureContentFilterCustomTopicResult	Eine Sammlung von binären Filterergebnissen für konfigurierte benutzerdefinierte Themen.	No
└– 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	Eine Inhaltsfilterkategorie, die auf inhalte verweisen kann, die angriffe oder diskriminierende oder diskriminierende Inhalte verwenden Sprache mit Verweis auf eine Person oder Identitätsgruppe basierend auf bestimmten Unterscheidungsattributen dieser Gruppen einschließlich, aber nicht beschränkt auf Rasse, ethnische Zugehörigkeit, Nationalität, Geschlechtsidentität und Ausdruck, sexuelle Orientierung, Religion, Einwanderungsstatus, Fähigkeitsstatus, persönliches Aussehen und Körpergröße.	No
└– indirekter_Angriff	AzureContentFilterDetectionResult	Ein Erkennungsergebnis, das Angriffe auf Systeme beschreibt, die von generativen KI-Modellen unterstützt werden, die jedes Mal auftreten können eine Anwendung verarbeitet Informationen, die nicht direkt vom Entwickler der Anwendung erstellt wurden oder der Benutzer.	No
└– Entsperrung	AzureContentFilterDetectionResult	Ein Erkennungsergebnis, das Benutzereinfügungsangriffe beschreibt, bei denen böswillige Benutzer absichtlich Exploits ausnutzen Systemrisiken, um nicht autorisiertes Verhalten von der LLM zu entlocken. Dies kann zu unangemessenem Inhalt führen Generierung oder Verstöße gegen vom System auferlegte Einschränkungen.	Ja
└– personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Ein Erkennungsergebnis, das Übereinstimmungen mit personenbezogenen Informationen mit konfigurierbaren Unterkategorien beschreibt.	No
└– Profanität	AzureContentFilterDetectionResult	Ein Erkennungsergebnis, das angibt, ob roh, vulgär oder anderweitig Einspruchssprache in der Inhalt.	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, 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 Erkennungsergebnis, das eine Übereinstimmung mit Text beschreibt, der durch das Urheberrecht oder einen anderen Status geschützt ist.	No
└– Selbstverletzung	AzureContentFilterSeverityResult	Eine Inhaltsfilterkategorie, die die Sprache beschreibt, die sich auf physische Handlungen bezieht, die absichtlich verletzen, verletzt werden sollen, schaden sie dem Körper oder töten sich selbst.	No
└─ sexuell	AzureContentFilterSeverityResult	Eine Inhaltsfilterkategorie für Sprache im Zusammenhang mit anatomischen Organen und Genitalien, romantische Beziehungen, Handlungen dargestellt in erotischen oder liebevollen Begriffen, Schwangerschaft, körperliche sexuelle Handlungen, einschließlich derer, die als ein Angriff oder ein erzwungener sexueller Gewaltakt gegen willens, Prostitution, Pornografie und Missbrauch.	No
└– task_adherence	AzureContentFilterDetectionResult	Ein Erkennungsergebnis, das angibt, ob der Ausführungsfluss den Plan noch hält.	Ja
└– ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
└– Gewalt	AzureContentFilterSeverityResult	Eine Inhaltsfilterkategorie für Sprache im Zusammenhang mit körperlichen Handlungen, die verletzt, verletzt, beschädigt oder getötet werden sollen jemand oder etwas; beschreibt Waffen, Waffen und verwandte Entitäten, z. B. Herstellungen, Verbände, Rechtsvorschriften usw.	No
source_type	Schnur	Der Name des Quelltyps der Nachricht.	Ja
tool_call_id	Schnur	Die ID des Toolaufrufs, der mit diesem Inhaltsfilter verbunden ist, falls zutreffend.	No

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

AzureContentFilterResultOffsets

Name	Typ	Required
check_offset	ganze Zahl (int32)	Ja
end_offset	ganze Zahl (int32)	Ja
start_offset	ganze Zahl (int32)	Ja

AzureContentFilterResultsForResponsesAPI

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
indirect_attack	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
Jailbreak	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
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
task_adherence	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
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

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

AzureToolApprovalRequest

Azure Tool Approval Request

Eine Azure-Tool-Genehmigungsanfrage in der Antwortausgabe.

Name	Typ	Description	Required
Argumente	Schnur	Eine JSON-Zeichenfolge mit Argumenten für das Tool.	Ja
call_id	Schnur	Die ID des Tools ruft eine Genehmigung an.	Ja
id	Schnur	Die eindeutige ID der Genehmigungsanforderung.	Ja
label	Schnur	Die Bezeichnung des Werkzeugs (z. B. 'remote_functions').	Ja
Name	Schnur	Der Name der Werkzeugfunktion (z. B. 'output_binding').	Ja
type	enum	Der Typ des Elements. Immer `tool_approval_request`. Mögliche Werte: `tool_approval_request`	Ja

AzureToolApprovalResponse

Azure tool approval response

Eine Azure-Tool-Approval-Antwort in der Anfrageeingabe.

Name	Typ	Description	Required
approval_request_id	Schnur	Die ID der Genehmigungsanforderung, die beantwortet wird.	Ja
Genehmigen	boolean	Gibt an, ob die Anforderung genehmigt wurde.	Ja
type	enum	Der Typ des Elements. Immer `tool_approval_response`. Mögliche Werte: `tool_approval_response`	Ja

OpenAI.Annotation

Eine Anmerkung, die sich auf einen Bereich von Ausgabetext bezieht.

Diskriminator für OpenAI.Annotation

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

Typwert	Schema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

Name	Typ	Description	Required	Vorgabe
type	OpenAI.AnnotationType		Ja

OpenAI.AnnotationType

Property	Wert
Typ	Schnur
Werte	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

Property	Wert
Typ	Schnur
Werte	`completed` `failed`

OpenAI.ApplyPatchCallOutputStatusParam

Patch-Aufruf-Ausgabestatus anwenden

Für apply_patch Toolaufrufe gemeldete Ergebniswerte.

Property	Wert
Typ	Schnur
Werte	`completed` `failed`

OpenAI.ApplyPatchCallStatus

Property	Wert
Typ	Schnur
Werte	`in_progress` `completed`

OpenAI.ApplyPatchCallStatusParam

Patch-Aufruf-Status anwenden

Für apply_patch Toolaufrufe gemeldete Statuswerte.

Property	Wert
Typ	Schnur
Werte	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

Patch-Erstellen-Operation

Anweisung, die beschreibt, wie eine Datei über das apply_patch Tool erstellt wird.

Name	Typ	Description	Required	Vorgabe
Unterschiede	Schnur	Diff, das angewendet werden soll.	Ja
path	Schnur	Pfad der zu erstellenden Datei.	Ja
type	enum	Erstellen Sie eine neue Datei mit dem bereitgestellten Diff. Mögliche Werte: `create_file`	Ja	create_file

OpenAI.ApplyPatchCreateFileOperationParam

Patch-Erstellen-Operation

Anweisung zum Erstellen einer neuen Datei über das tool apply_patch.

Name	Typ	Description	Required	Vorgabe
Unterschiede	Schnur	Einheitliche Diff-Inhalte, die beim Erstellen der Datei angewendet werden sollen. Einschränkungen: maxLength: 10485760	Ja
path	Schnur	Pfad der Datei, die relativ zum Arbeitsbereichstamm erstellt werden soll. Einschränkungen: minLength: 1	Ja
type	enum	Der Vorgangstyp. Immer `create_file`. Mögliche Werte: `create_file`	Ja	create_file

OpenAI.ApplyPatchDeleteFileOperation

Patch-Delete-Datei-Operation anwenden

Anweisung, die beschreibt, wie eine Datei über das apply_patch-Tool gelöscht wird.

Name	Typ	Description	Required	Vorgabe
path	Schnur	Pfad der zu löschenden Datei.	Ja
type	enum	Löschen Sie die angegebene Datei. Mögliche Werte: `delete_file`	Ja	delete_file

OpenAI.ApplyPatchDeleteFileOperationParam

Patch-Delete-Datei-Operation anwenden

Anweisung zum Löschen einer vorhandenen Datei über das tool apply_patch.

Name	Typ	Description	Required	Vorgabe
path	Schnur	Pfad der Datei, die relativ zum Arbeitsbereichstamm gelöscht werden soll. Einschränkungen: minLength: 1	Ja
type	enum	Der Vorgangstyp. Immer `delete_file`. Mögliche Werte: `delete_file`	Ja	delete_file

OpenAI.ApplyPatchFileOperation

Patch-Operation anwenden

Einer der create_file, delete_file oder update_file Vorgänge, die über apply_patch angewendet werden.

Diskriminator für OpenAI.ApplyPatchFileOperation

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

Typwert	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ApplyPatchFileOperationType		Ja

OpenAI.ApplyPatchFileOperationType

Property	Wert
Typ	Schnur
Werte	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchOperationParam

Patch-Operation anwenden

Einer der create_file-, delete_file- oder update_file-Vorgänge, die dem apply_patch Tool bereitgestellt werden.

Diskriminator für OpenAI.ApplyPatchOperationParam

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

Typwert	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperationParam
`delete_file`	OpenAI.ApplyPatchDeleteFileOperationParam
`update_file`	OpenAI.ApplyPatchUpdateFileOperationParam

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ApplyPatchOperationParamType		Ja

OpenAI.ApplyPatchOperationParamType

Property	Wert
Typ	Schnur
Werte	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

Patch-Tool anwenden

Ermöglicht dem Assistenten das Erstellen, Löschen oder Aktualisieren von Dateien mit einheitlichen Diffs.

Name	Typ	Description	Required	Vorgabe
type	enum	Der Typ des Tools. Immer `apply_patch`. Mögliche Werte: `apply_patch`	Ja	apply_patch

OpenAI.ApplyPatchUpdateFileOperation

Patch-Update-Datei-Operation anwenden

Anweisung, die beschreibt, wie eine Datei über das apply_patch Tool aktualisiert wird.

Name	Typ	Description	Required	Vorgabe
Unterschiede	Schnur	Diff, das angewendet werden soll.	Ja
path	Schnur	Pfad der zu aktualisierenden Datei.	Ja
type	enum	Aktualisieren Sie eine vorhandene Datei mit dem bereitgestellten Diff. Mögliche Werte: `update_file`	Ja	update_file

OpenAI.ApplyPatchUpdateFileOperationParam

Patch-Update-Datei-Operation anwenden

Anweisung zum Aktualisieren einer vorhandenen Datei über das apply_patch Tool.

Name	Typ	Description	Required	Vorgabe
Unterschiede	Schnur	Einheitlicher Diff-Inhalt, der auf die vorhandene Datei angewendet werden soll. Einschränkungen: maxLength: 10485760	Ja
path	Schnur	Pfad der Datei, die relativ zum Arbeitsbereichstamm aktualisiert werden soll. Einschränkungen: minLength: 1	Ja
type	enum	Der Vorgangstyp. Immer `update_file`. Mögliche Werte: `update_file`	Ja	update_file

OpenAI.ApproximateLocation

Name	Typ	Description	Required	Vorgabe
Stadt	Zeichenfolge oder null		No
country	Zeichenfolge oder null		No
Region	Zeichenfolge oder null		No
timezone	Zeichenfolge oder null		No
type	enum	Der Typ der Standortannäherung. Immer `approximate`. Mögliche Werte: `approximate`	Ja	Ungefähre

OpenAI.AutoCodeInterpreterToolParam

Parameter des automatischen Code-Interpreter-Tools

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

Name	Typ	Description	Required	Vorgabe
Datei-IDs	Array von Strings	Eine optionale Liste der hochgeladenen Dateien, die Ihrem Code zur Verfügung gestellt werden sollen. Einschränkungen: maxItems: 50	No
Speicherbegrenzung	OpenAI.ContainerMemoryLimit oder NULL		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Netzwerkzugriffsrichtlinie für den Container.	No
type	enum	Immer `auto`. Mögliche Werte: `auto`	Ja	auto

OpenAI.ClickButtonType

Property	Wert
Typ	Schnur
Werte	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Click

Ein Klickvorgang.

Name	Typ	Description	Required	Vorgabe
button	OpenAI.ClickButtonType		Ja
keys	Array von Zeichenfolge oder Null		No
type	enum	Gibt den Ereignistyp an. Für eine Klickaktion ist diese Eigenschaft immer `click`. Mögliche Werte: `click`	Ja	klicken
x	integer	Die x-Koordinate, an der der Klick aufgetreten ist.	Ja
y	integer	Die y-Koordinate, an der der Klick aufgetreten ist.	Ja

OpenAI.CodeInterpreterOutputImage

Code-Interpreter-Ausgabebild

Die Bildausgabe des Codedolmetschers.

Name	Typ	Description	Required	Vorgabe
type	enum	Der Typ der Ausgabe. Immer `image`. Mögliche Werte: `image`	Ja	image
url	Zeichenfolge (URI)	Die URL der Bildausgabe des Codedolmetschers.	Ja

OpenAI.CodeInterpreterOutputLogs

Code-Interpreter-Ausgabelogs

Die Protokolle werden vom Codedolmetscher ausgegeben.

Name	Typ	Description	Required	Vorgabe
logs	Schnur	Die Protokolle werden vom Codedolmetscher ausgegeben.	Ja
type	enum	Der Typ der Ausgabe. Immer `logs`. Mögliche Werte: `logs`	Ja	logs

OpenAI.CodeInterpreterTool

Codedolmetscher

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

Name	Typ	Description	Required	Vorgabe
container	String oder OpenAI.AutoCodeInterpreterToolParam	Der Codedolmetschercontainer. Kann eine Container-ID oder ein Objekt sein, das Gibt hochgeladene Datei-IDs an, die Ihrem Code zur Verfügung gestellt werden sollen, zusammen mit einer optionale `memory_limit` Einstellung.	Ja
type	enum	Der Typ des Codedolmetschertools. Immer `code_interpreter`. Mögliche Werte: `code_interpreter`	Ja

OpenAI.Vergleichsfilter

Vergleichsfilter

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

Name	Typ	Description	Required	Vorgabe
key	Schnur	Der Schlüssel für den Vergleich mit dem Wert	Ja
type	enum	Gibt den Vergleichsoperator an: `eq`, , `negt`, `gte`, , `lt`, `lte`, . `innin` - `eq`: entspricht - `ne`: ungleich - `gt`:größer als - `gte`: größer oder gleich - `lt`:weniger als - `lte`: kleiner oder gleich - `in`:In - `nin`: nicht in Mögliche Werte: `eq`, , `ne`, `gtgte`, `lt`, , `lte`, `innin`	Ja	eq
value	String oder Number oder Boolean oder Array von String oder Number	Der Wert, der mit dem Attributschlüssel verglichen werden soll; unterstützt Zeichenfolgen-, Zahlen- oder boolesche Typen.	Ja

OpenAI.CompoundFilter

Zusammengesetzter Filter

Kombinieren mehrerer Filter mit and oder or.

Name	Typ	Description	Required	Vorgabe
Filter	Array von OpenAI.ComparisonFilter oder Objekt	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.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.DragParam
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.MoveParam
`screenshot`	OpenAI.ScreenshotParam
`scroll`	OpenAI.ScrollParam
`type`	OpenAI.TypeParam
`wait`	OpenAI.WaitParam

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ComputerActionType		Ja

OpenAI.ComputerActionList

Computer-Aktionsliste

Abgeflachte Batch-Aktionen für computer_use. Jede Aktion enthält einen type Diskriminator und aktionsspezifische Felder.

Array von: OpenAI.ComputerAction

OpenAI.ComputerActionType

Property	Wert
Typ	Schnur
Werte	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

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

Name	Typ	Description	Required
Programmcode	Zeichenfolge oder null		No
id	Schnur	Die ID der ausstehenden Sicherheitsprüfung	Ja
message	Zeichenfolge oder null		No

OpenAI.ComputerEnvironment

Property	Wert
Typ	Schnur
Werte	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotContent

Computer-Screenshot

Screenshot eines Computers.

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.ImageDetail		Ja
Datei-ID	Zeichenfolge oder null		Ja
image_url	Zeichenfolge oder null		Ja
type	enum	Gibt den Ereignistyp an. Für einen Computer-Screenshot ist diese Eigenschaft immer auf `computer_screenshot`. Mögliche Werte: `computer_screenshot`	Ja	computer_screenshot

OpenAI.ComputerScreenshotImage

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

Name	Typ	Description	Required	Vorgabe
Datei-ID	Schnur	Der Bezeichner einer hochgeladenen Datei, die den Screenshot enthält.	No
image_url	Zeichenfolge (URI)	Die URL des Screenshotbilds.	No
type	enum	Gibt den Ereignistyp an. Für einen Computerfoto ist diese Eigenschaft immer auf `computer_screenshot` festgelegt. Mögliche Werte: `computer_screenshot`	Ja	computer_screenshot

OpenAI.ComputerTool

Computer

Ein Tool, das einen virtuellen Computer steuert.

Name	Typ	Description	Required	Vorgabe
type	enum	Der Typ des Computerwerkzeugs. Immer `computer`. Mögliche Werte: `computer`	Ja	Computer

OpenAI.ComputerUsePreviewTool

Computer-Nutzungsvorschau

Ein Tool, das einen virtuellen Computer steuert.

Name	Typ	Description	Required	Vorgabe
Anzeigehöhe	integer	Die Höhe der Computeranzeige.	Ja
Bildschirmbreite	integer	Die Breite der Computeranzeige.	Ja
environment	OpenAI.ComputerEnvironment		Ja
type	enum	Der Typ des Tools zur Computernutzung. Immer `computer_use_preview`. Mögliche Werte: `computer_use_preview`	Ja	computer_use_preview

OpenAI.ContainerAutoParam

Name	Typ	Description	Required	Vorgabe
Datei-IDs	Array von Strings	Eine optionale Liste der hochgeladenen Dateien, die Ihrem Code zur Verfügung gestellt werden sollen. Einschränkungen: maxItems: 50	No
Speicherbegrenzung	OpenAI.ContainerMemoryLimit oder NULL		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Netzwerkzugriffsrichtlinie für den Container.	No
Fähigkeiten	Array von OpenAI.ContainerSkill	Eine optionale Liste von Fähigkeiten, die durch ID oder Inline-Daten referenziert werden. Einschränkungen: maxItems: 200	No
type	enum	Erstellt automatisch einen Container für diese Anfrage Mögliche Werte: `container_auto`	Ja	container_auto

OpenAI.ContainerFileCitationBody

Container-Datei-Zitation

Ein Zitat für eine Containerdatei, die zum Generieren einer Modellantwort verwendet wird.

Name	Typ	Description	Required	Vorgabe
container_id	Schnur	Die ID der Containerdatei.	Ja
end_index	integer	Der Index des letzten Zeichens des Zitats der Containerdatei in der Nachricht.	Ja
Datei-ID	Schnur	Die ID der Datei.	Ja
filename	Schnur	Der Dateiname der zitierten Containerdatei.	Ja
start_index	integer	Der Index des ersten Zeichens des Zitats der Containerdatei in der Nachricht.	Ja
type	enum	Der Typ des Containerdateizitats. Immer `container_file_citation`. Mögliche Werte: `container_file_citation`	Ja	container_file_citation

OpenAI.ContainerMemoryLimit

Property	Wert
Typ	Schnur
Werte	`1g` `4g` `16g` `64g`

OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Typ	Description	Required	Vorgabe
allowed_domains	Array von Strings	Eine Liste der erlaubten Domänen, wenn der Typ ist `allowlist`. Einschränkungen: minItems: 1	Ja
type	enum	Erlauben Sie nur ausgehenden Netzwerkzugriff auf bestimmte Domains. Immer `allowlist`. Mögliche Werte: `allowlist`	Ja	allowlist

OpenAI.ContainerNetworkPolicyDisabledParam

Name	Typ	Description	Required	Vorgabe
type	enum	Deaktiviere den ausgehenden Netzwerkzugang. Immer `disabled`. Mögliche Werte: `disabled`	Ja	disabled

OpenAI.ContainerNetworkPolicyParam

Netzwerkzugriffsrichtlinie für den Container.

Discriminator für OpenAI.ContainerNetworkPolicyParam

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

Typwert	Schema
`disabled`	OpenAI.ContainerNetworkPolicyDisabledParam
`allowlist`	OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ContainerNetworkPolicyParamType		Ja

OpenAI.ContainerNetworkPolicyParamType

Property	Wert
Typ	Schnur
Werte	`disabled` `allowlist`

OpenAI.ContainerReferenceResource

Containerreferenz

Repräsentiert einen Container, der mit /v1/containers erstellt wurde.

Name	Typ	Description	Required	Vorgabe
container_id	Schnur		Ja
type	enum	Der Umgebungstyp. Immer `container_reference`. Mögliche Werte: `container_reference`	Ja	container_reference

OpenAI.ContainerSkill

Discriminator für OpenAI.ContainerSkill

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

Typwert	Schema
`skill_reference`	OpenAI.SkillReferenceParam
`inline`	OpenAI.InlineSkillParam

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ContainerSkillType		Ja

OpenAI.ContainerSkillType

Property	Wert
Typ	Schnur
Werte	`skill_reference` `inline`

OpenAI.ContextManagementParam

Name	Typ	Description	Required	Vorgabe
compact_threshold	ganze Zahl oder Null		No
type	Schnur	Der Kontextmanagement-Eintragstyp. Derzeit wird nur 'Verdichtung' unterstützt.	Ja

OpenAI.ConversationParam

Die Unterhaltung, zu der diese Antwort gehört. Elemente aus dieser Unterhaltung werden dieser Antwortanforderung vorangestellt input_items . Eingabeelemente und Ausgabeelemente aus dieser Antwort werden dieser Unterhaltung automatisch hinzugefügt, nachdem diese Antwort abgeschlossen wurde.

Diese Komponente kann eine der folgenden Sein:

String
OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Gesprächsobjekt

Die Unterhaltung, zu der diese Antwort gehört.

Name	Typ	Description	Required	Vorgabe
id	Schnur	Die eindeutige ID der Unterhaltung.	Ja

OpenAI.ConversationReference

Unterhaltung

Die Unterhaltung, zu der diese Antwort gehörte. Eingabeelemente und Ausgabeelemente aus dieser Antwort wurden dieser Unterhaltung automatisch hinzugefügt.

Name	Typ	Description	Required	Vorgabe
id	Schnur	Die eindeutige ID der Unterhaltung, der diese Antwort zugeordnet war.	Ja

OpenAI.CoordParam

Coordinate

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

Name	Typ	Description	Required	Vorgabe
x	integer	Die x-Koordinate.	Ja
y	integer	Die y-Koordinate.	Ja

OpenAI.CreateResponse

Name	Typ	Description	Required
Hintergrund	Boolescher Wert oder Null		No
context_management	array von OpenAI.ContextManagementParam oder null	Kontextmanagement-Konfiguration für diese Anfrage.	No
Gespräch	OpenAI.ConversationParam oder NULL		No
einschließen	Array von OpenAI.IncludeEnum oder NULL		No
input	OpenAI.InputParam	Text-, Bild- oder Dateieingaben für das Modell, die zum Generieren einer Antwort verwendet werden. Erfahren Sie mehr: - Texteingaben und -ausgaben - Bildeingaben - Dateieingaben - Gesprächszustand - Funktionsaufruf	No
instructions	Zeichenfolge oder null		No
max_output_tokens	ganze Zahl oder Null		No
max_tool_calls	ganze Zahl oder Null		No
metadata	OpenAI.Metadata oder NULL		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. Siehe die Modellanleitung um verfügbare Modelle zu durchsuchen und zu vergleichen.	No
Parallele Werkzeugaufrufe	Boolescher Wert oder Null		No
previous_response_id	Zeichenfolge oder null		No
Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	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.	No
prompt_cache_retention	Zeichenfolge oder null		No
reasoning	OpenAI.Reasoning oder NULL		No
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 Zeichenkette sein, die jeden Benutzer eindeutig identifiziert, mit einer maximalen Länge von 64 Zeichen. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Einschränkungen: maxLänge: 64	No
abspeichern	Boolescher Wert oder Null		No
stream	Boolescher Wert oder Null		No
stream_options	OpenAI.ResponseStreamOptions oder NULL		No
Temperatur	Zahl oder Null		No
Text	OpenAI.ResponseTextParam	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann einfach sein Text- oder strukturierte JSON-Daten. Erfahren Sie mehr: - Texteingaben und -ausgaben - Strukturierte Ausgaben	No
tool_choice	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	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. Sie können die beiden folgenden Kategorien von Tools bereitstellen: - Integrierte Tools: Tools, die von OpenAI zur Erweiterung von Funktionen bereitgestellt werden Die Funktionen des Modells, z. B. die Dateisuche. - Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, Ermöglichen, dass das Modell Ihren eigenen Code ausführt.	No
top_logprobs	ganze Zahl oder Null		No
top_p	Zahl oder Null		No
truncation	Zeichenfolge oder null		No
user	Zeichenfolge (veraltet)	Dieses Feld wird durch `safety_identifier` und `prompt_cache_key`. Verwenden Sie `prompt_cache_key` stattdessen die Zwischenspeicherungsoptimierungen. Ein stabiler Bezeichner für Ihre Endbenutzer. Wird verwendet, um Die Trefferraten des Caches zu erhöhen, indem ähnliche Anforderungen besser zusammengefasst werden, und um OpenAI dabei zu helfen, Missbrauch zu erkennen und zu verhindern.	No

OpenAI.CustomGrammarFormatParam

Grammatikformat

Eine vom Benutzer definierte Grammatik.

Name	Typ	Description	Required	Vorgabe
Definition	Schnur	Die Grammatikdefinition.	Ja
Syntax	OpenAI.GrammarSyntax1		Ja
type	enum	Grammatikformat. Immer `grammar`. Mögliche Werte: `grammar`	Ja	Grammatik

OpenAI.CustomTextFormatParam

Textformat

Nicht eingeschränkter Freiformtext.

Name	Typ	Description	Required	Vorgabe
type	enum	Nicht eingeschränktes Textformat. Immer `text`. Mögliche Werte: `text`	Ja	Text

OpenAI.CustomToolParam

Benutzerdefiniertes Werkzeug

Ein benutzerdefiniertes Tool, das Eingaben mithilfe eines angegebenen Formats verarbeitet. Erfahren Sie mehr über benutzerdefinierte Werkzeuge

Name	Typ	Description	Required	Vorgabe
defer_loading	boolean	Ob dieses Tool aufgeschoben und über die Tool-Suche entdeckt werden sollte.	No
description	Schnur	Optionale Beschreibung des benutzerdefinierten Tools, das verwendet wird, um mehr Kontext bereitzustellen.	No
format	OpenAI.CustomToolParamFormat	Das Eingabeformat für das benutzerdefinierte Tool. Der Standardwert ist nicht eingeschränkter Text.	No
└– Typ	OpenAI.CustomToolParamFormatType		Ja
Name	Schnur	Der Name des benutzerdefinierten Tools, das verwendet wird, um es in Toolaufrufen zu identifizieren.	Ja
type	enum	Der Typ des benutzerdefinierten Tools. Immer `custom`. Mögliche Werte: `custom`	Ja	custom

OpenAI.CustomToolParamFormat

Das Eingabeformat für das benutzerdefinierte Tool. Der Standardwert ist nicht eingeschränkter Text.

Diskriminator für OpenAI.CustomToolParamFormat

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

Typwert	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

Name	Typ	Description	Required	Vorgabe
type	OpenAI.CustomToolParamFormatType		Ja

OpenAI.CustomToolParamFormatType

Property	Wert
Typ	Schnur
Werte	`text` `grammar`

OpenAI.DetailEnum

Property	Wert
Typ	Schnur
Werte	`low` `high` `auto` `original`

OpenAI.DoubleClickAction

DoubleClick

Eine Doppelklickaktion

Name	Typ	Description	Required	Vorgabe
keys	Array von Zeichenfolge oder Null		Ja
type	enum	Gibt den Ereignistyp an. Bei einer Doppelklickaktion ist diese Eigenschaft immer auf `double_click` gesetzt. Mögliche Werte: `double_click`	Ja	double_click
x	integer	Die x-Koordinate, an der der Doppelklick aufgetreten ist.	Ja
y	integer	Die y-Koordinate, an der der Doppelklick aufgetreten ist.	Ja

OpenAI.DragParam

Drag

Eine Ziehaktion

Name	Typ	Description	Required	Vorgabe
keys	Array von Zeichenfolge oder Null		No
path	Array von OpenAI.CoordParam	Ein Array von Koordinaten, die den Pfad der Ziehaktion darstellen. Koordinaten werden als Array von Objekten angezeigt, z. B. `<br> [ { x: 100, y: 200 }, { x: 200, y: 300 } ]<br>`	Ja
type	enum	Gibt den Ereignistyp an. Bei einer Ziehaktion ist diese Eigenschaft immer auf `drag` gesetzt. Mögliche Werte: `drag`	Ja	Drag

OpenAI.EasyInputMessage

Eingabenachricht

Meldungseingabe für das Modell mit einer Rolle für die Anweisung, gefolgt von der Hierarchie 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	Description	Required
Inhalt	String oder OpenAI.InputMessageContentList oder OpenAI.InputMessageContentList	Text-, Bild- oder Audioeingabe für das Modell, um eine Antwort zu generieren. Kann auch frühere Assistentenantworten enthalten.	Ja
Phase	OpenAI.MessagePhase oder null		No
Rolle	enum	Die Rolle der Nachrichteneingabe. Einer von `user`, `assistant`, , `system`oder `developer`. Mögliche Werte: `user`, , `assistant`, `systemdeveloper`	Ja
status	enum	Der Status des Elements. Einer von `in_progress`, , `completed`oder `incomplete`. Wird ausgefüllt, wenn Elemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	No
type	enum	Der Typ der Nachrichteneingabe. Immer `message`. Mögliche Werte: `message`	Ja

OpenAI.EmptyModelParam

Typ: Objekt

OpenAI.FileCitationBody

Quellenangabe

Ein Verweis auf eine Datei.

Name	Typ	Description	Required	Vorgabe
Datei-ID	Schnur	Die ID der Datei.	Ja
filename	Schnur	Der Dateiname der zitierten Datei.	Ja
index	integer	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	file_citation

OpenAI.FileInputDetail

Property	Wert
Typ	Schnur
Werte	`low` `high`

OpenAI.FilePath

Dateipfad

Ein Pfad zu einer Datei.

Name	Typ	Description	Required
Datei-ID	Schnur	Die ID der Datei.	Ja
index	integer	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.FileSearchTool

Dateisuche

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

Name	Typ	Description	Required	Vorgabe
Filter	OpenAI.Filters oder NULL		No
max_anzahl_ergebnisse	integer	Die maximale Anzahl der zurückzugebenden Ergebnisse. Diese Zahl sollte zwischen 1 und 50 (einschließlich) liegen.	No
Ranglistenoptionen	OpenAI.RankingOptions		No
└– hybrid_search	OpenAI.HybridSearchOptions	Gewichtungen, die steuern, wie reziproke Rangfusionsabgleiche semantische Einbettungsabgleiche im Vergleich zu sparsamen Schlüsselwort-Übereinstimmungen bei der Hybridsuche ausgleichen.	No
└– Ranker	OpenAI.RankerVersionType	Der Rangfolger, der für die Dateisuche verwendet werden soll.	No
└─ Punktschwelle	Zahl	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	file_search
vector_store_ids	Array von Strings	Die IDs der zu durchsuchenden Vektorspeicher.	Ja

OpenAI.FileSearchToolCallResults

Name	Typ	Required
attributes	OpenAI.VectorStoreFileAttributes oder Null	No
Datei-ID	Schnur	No
filename	Schnur	No
Punktzahl	Zahl (Float)	No
Text	Schnur	No

OpenAI.Filters

Typ: OpenAI.ComparisonFilter oder OpenAI.CompoundFilter

OpenAI.FunctionAndCustomToolCallOutput

Diskriminator für OpenAI.FunctionAndCustomToolCallOutput

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

Typwert	Schema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Name	Typ	Description	Required	Vorgabe
type	OpenAI.FunctionAndCustomToolCallOutputType		Ja

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Eingabedatei

Eine Dateieingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.FileInputDetail		No
file_data	Schnur	Der Inhalt der Datei, die an das Modell gesendet werden soll.	No
Datei-ID	Zeichenfolge oder null		No
file_url	Zeichenfolge (URI)	Die URL der Datei, die an das Modell gesendet werden soll.	No
filename	Schnur	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	input_file

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Eingabebild

Eine Bildeingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.ImageDetail		Ja
Datei-ID	Zeichenfolge oder null		No
image_url	Zeichenfolge oder null		No
type	enum	Der Typ des Eingabeelements. Immer `input_image`. Mögliche Werte: `input_image`	Ja	input_image

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Eingabetext

Eine Texteingabe für das Modell.

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

OpenAI.FunctionAndCustomToolCallOutputType

Property	Wert
Typ	Schnur
Werte	`input_text` `input_image` `input_file`

OpenAI.FunctionCallItemStatus

Property	Wert
Typ	Schnur
Werte	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallOutputStatusEnum

Property	Wert
Typ	Schnur
Werte	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallStatus

Property	Wert
Typ	Schnur
Werte	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellAction

Aktion des Shell-Exekutivs

Führen Sie einen Shellbefehl aus.

Name	Typ	Required
commands	Array von Strings	Ja
max_output_length	ganze Zahl oder Null	Ja
timeout_ms	ganze Zahl oder Null	Ja

OpenAI.FunctionShellActionParam

Granatenmechanik

Befehle und Grenzwerte, die beschreiben, wie der Shelltoolaufruf ausgeführt wird.

Name	Typ	Description	Required
commands	Array von Strings	Geordnete Shellbefehle für die Ausführungsumgebung.	Ja
max_output_length	ganze Zahl oder Null		No
timeout_ms	ganze Zahl oder Null		No

OpenAI.FunctionShellCallEnvironment

Discriminator für OpenAI.FunctionShellCallEnvironment

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

Typwert	Schema
`local`	OpenAI.LocalEnvironmentResource
`container_reference`	OpenAI.ContainerReferenceResource

Name	Typ	Description	Required	Vorgabe
type	OpenAI.FunctionShellCallEnvironmentType		Ja

OpenAI.FunctionShellCallEnvironmentType

Property	Wert
Typ	Schnur
Werte	`local` `container_reference`

OpenAI.FunctionShellCallItemParamEnvironment

Die Umgebung, in der die Shell-Befehle ausgeführt werden.

Discriminator für OpenAI.FunctionShellCallItemParamEnvironment

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

Typwert	Schema
`local`	OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Name	Typ	Description	Required	Vorgabe
type	OpenAI.FunctionShellCallItemParamEnvironmentType		Ja

OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Name	Typ	Description	Required	Vorgabe
container_id	Schnur	Die ID des referenzierten Containers.	Ja
type	enum	Verweist auf einen Container, der mit dem /v1/container-Endpunkt erstellt wurde Mögliche Werte: `container_reference`	Ja	container_reference

OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam

Name	Typ	Description	Required	Vorgabe
Fähigkeiten	Array von OpenAI.LocalSkillParam	Eine optionale Liste von Fähigkeiten. Einschränkungen: maxItems: 200	No
type	enum	Nutze eine lokale Computerumgebung. Mögliche Werte: `local`	Ja	lokal

OpenAI.FunctionShellCallItemParamEnvironmentType

Property	Wert
Typ	Schnur
Werte	`local` `container_reference`

OpenAI.FunctionShellCallItemStatus

Shell-Rufstatus

Für Shelltoolaufrufe gemeldete Statuswerte.

Property	Wert
Typ	Schnur
Werte	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContent

Shell-Aufruf-Ausgabeinhalt

Der Inhalt einer Shelltoolaufrufausgabe, die ausgegeben wurde.

Name	Typ	Description	Required
created_by	Schnur	Der Bezeichner des Akteurs, der das Element erstellt hat.	No
Ergebnis	OpenAI.FunctionShellCallOutputOutcome	Stellt entweder ein Ausgangsergebnis (mit einem Exitcode) oder ein Timeoutergebnis für einen Shell-Aufrufausgabeblock dar.	Ja
└– Typ	OpenAI.FunctionShellCallOutputOutcomeType		Ja
Stderr	Schnur	Die Standardfehlerausgabe, die erfasst wurde.	Ja
Stdout	Schnur	Die Standardausgabe, die erfasst wurde.	Ja

OpenAI.FunctionShellCallOutputContentParam

Shell-Ausgabeinhalt

Erfasste Stdout- und Stderr-Funktion für einen Teil einer Shelltoolaufrufausgabe.

Name	Typ	Description	Required
Ergebnis	OpenAI.FunctionShellCallOutputOutcomeParam	Das Exit- oder Timeout-Ergebnis, das diesem Shellaufruf zugeordnet ist.	Ja
└– Typ	OpenAI.FunctionShellCallOutputOutcomeParamType		Ja
Stderr	Schnur	Erfasste Stderr-Ausgabe für den Shellaufruf. Einschränkungen: maxLength: 10485760	Ja
Stdout	Schnur	Erfasste Stdout-Ausgabe für den Shellaufruf. Einschränkungen: maxLength: 10485760	Ja

OpenAI.FunctionShellCallOutputExitOutcome

Shell Call Austrittsergebnis

Gibt an, dass die Shellbefehle abgeschlossen und einen Beendigungscode zurückgegeben haben.

Name	Typ	Description	Required	Vorgabe
exit_code	integer	Beenden Sie Code aus dem Shellprozess.	Ja
type	enum	Der Ergebnistyp. Immer `exit`. Mögliche Werte: `exit`	Ja	exit

OpenAI.FunctionShellCallOutputExitOutcomeParam

Shell Call Austrittsergebnis

Gibt an, dass die Shellbefehle abgeschlossen und einen Beendigungscode zurückgegeben haben.

Name	Typ	Description	Required	Vorgabe
exit_code	integer	Der vom Shell-Prozess zurückgegebene Ausgangscode.	Ja
type	enum	Der Ergebnistyp. Immer `exit`. Mögliche Werte: `exit`	Ja	exit

OpenAI.FunctionShellCallOutputOutcome

Shell Call Ergebnis

Stellt entweder ein Ausgangsergebnis (mit einem Exitcode) oder ein Timeoutergebnis für einen Shell-Aufrufausgabeblock dar.

Diskriminator für OpenAI.FunctionShellCallOutputOutputOutcome

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

Typwert	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

Name	Typ	Description	Required	Vorgabe
type	OpenAI.FunctionShellCallOutputOutcomeType		Ja

OpenAI.FunctionShellCallOutputOutcomeParam

Shell Call Ergebnis

Das Exit- oder Timeout-Ergebnis, das diesem Shellaufruf zugeordnet ist.

Diskriminator für OpenAI.FunctionShellCallOutputOutcomeParam

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

Typwert	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
`exit`	OpenAI.FunctionShellCallOutputExitOutcomeParam

Name	Typ	Description	Required	Vorgabe
type	OpenAI.FunctionShellCallOutputOutcomeParamType		Ja

OpenAI.FunctionShellCallOutputOutcomeParamType

Property	Wert
Typ	Schnur
Werte	`timeout` `exit`

OpenAI.FunctionShellCallOutputOutcomeType

Property	Wert
Typ	Schnur
Werte	`timeout` `exit`

OpenAI.FunctionShellCallOutputStatusEnum

Property	Wert
Typ	Schnur
Werte	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Shell-Call-Timeout-Ergebnis

Gibt an, dass der Shellaufruf das konfigurierte Zeitlimit überschritten hat.

Name	Typ	Description	Required	Vorgabe
type	enum	Der Ergebnistyp. Immer `timeout`. Mögliche Werte: `timeout`	Ja	timeout

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Shell-Call-Timeout-Ergebnis

Gibt an, dass der Shellaufruf das konfigurierte Zeitlimit überschritten hat.

Name	Typ	Description	Required	Vorgabe
type	enum	Der Ergebnistyp. Immer `timeout`. Mögliche Werte: `timeout`	Ja	timeout

OpenAI.FunctionShellCallStatus

Property	Wert
Typ	Schnur
Werte	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellToolParam

Schalenwerkzeug

Ein Tool, mit dem das Modell Shellbefehle ausführen kann.

Name	Typ	Description	Required	Vorgabe
environment	OpenAI.FunctionShellToolParamEnvironment oder null		No
type	enum	Der Typ des Shelltools. Immer `shell`. Mögliche Werte: `shell`	Ja	Shell

OpenAI.FunctionShellToolParamEnvironment

Discriminator für OpenAI.FunctionShellToolParamEnvironment

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

Typwert	Schema
`local`	OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam
`container_auto`	OpenAI.ContainerAutoParam

Name	Typ	Description	Required	Vorgabe
type	OpenAI.FunctionShellToolParamEnvironmentType		Ja

OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam

Name	Typ	Description	Required	Vorgabe
container_id	Schnur	Die ID des referenzierten Containers.	Ja
type	enum	Verweist auf einen Container, der mit dem /v1/container-Endpunkt erstellt wurde Mögliche Werte: `container_reference`	Ja	container_reference

OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam

Name	Typ	Description	Required	Vorgabe
Fähigkeiten	Array von OpenAI.LocalSkillParam	Eine optionale Liste von Fähigkeiten. Einschränkungen: maxItems: 200	No
type	enum	Nutze eine lokale Computerumgebung. Mögliche Werte: `local`	Ja	lokal

OpenAI.FunctionShellToolParamEnvironmentType

Property	Wert
Typ	Schnur
Werte	`container_auto` `local` `container_reference`

OpenAI.FunctionTool

Funktion

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

Name	Typ	Description	Required	Vorgabe
defer_loading	boolean	Ob diese Funktion aufgeschoben und über die Tool-Suche geladen wird.	No
description	Zeichenfolge oder null		No
Name	Schnur	Der Name der funktion, die aufgerufen werden soll.	Ja
parameters	-Objekt oder Null		Ja
strict	Boolescher Wert oder Null		Ja
type	enum	Der Typ des Funktionstools. Immer `function`. Mögliche Werte: `function`	Ja	Funktion

OpenAI.FunctionToolParam

Name	Typ	Description	Required	Vorgabe
defer_loading	boolean	Ob diese Funktion aufgeschoben und über Tool-Suche entdeckt werden sollte.	No
description	Zeichenfolge oder null		No
Name	Schnur	Einschränkungen: minLänge: 1, maxLänge: 128, Muster: `^[a-zA-Z0-9_-]+$`	Ja
parameters	OpenAI.EmptyModelParam oder null		No
strict	Boolescher Wert oder Null		No
type	enum	Mögliche Werte: `function`	Ja	Funktion

OpenAI.GrammarSyntax1

Property	Wert
Typ	Schnur
Werte	`lark` `regex`

OpenAI.HybridSearchOptions

Name	Typ	Description	Required	Vorgabe
embedding_weight	Zahl	Das Gewicht der Einbettung in die gegenseitigen Rangfolgenfusion.	Ja
text_weight	Zahl	Die Gewichtung des Texts in der gegenseitigen Rangfolgenfusion.	Ja

OpenAI.ImageDetail

Property	Wert
Typ	Schnur
Werte	`low` `high` `auto` `original`

OpenAI.ImageGenActionEnum

Property	Wert
Typ	Schnur
Werte	`generate` `edit` `auto`

OpenAI.ImageGenTool

Bildgenerierungstool

Ein Tool, das Bilder mithilfe der GPT-Bildmodelle generiert.

Gültige Modelle:

gpt-image-1
gpt-image-1-mini
gpt-image-1.5

Name	Typ	Description	Required	Vorgabe
Aktion	OpenAI.ImageGenActionEnum		No
Hintergrund	enum	Hintergrundtyp für das generierte Bild. Einer von `transparent`, `opaque` oder `auto`. Standardwert: `auto`. Mögliche Werte: `transparent`, , `opaqueauto`	No	auto
input_fidelity	OpenAI.InputFidelity oder NULL		No
input_image_mask	OpenAI.ImageGenToolInputImageMask		No
└– file_id	Schnur		No
└– image_url	Zeichenfolge (URI)		No
model	string (siehe gültige Modelle unten)		No
Moderation	enum	Moderationsebene für das generierte Bild. Standardwert: `auto`. Mögliche Werte: `auto`, `low`	No	auto
Ausgabekomprimierung	integer	Komprimierungsebene für das Ausgabebild. Standard: 100. Einschränkungen: min: 0, max: 100	No	100
Ausgabeformat	enum	Das Ausgabeformat des generierten Bilds. Einer von `png`, , `webp`oder `jpeg`. Standardwert: `png`. Mögliche Werte: `png`, , `webpjpeg`	No	png
unvollständige Bilder	integer	Anzahl der Teilbilder, die im Streamingmodus generiert werden sollen, von 0 (Standardwert) bis 3. Einschränkungen: min: 0, max: 3	No
Qualität	enum	Die Qualität des generierten Bilds. Einer von `low`, , `medium`, `high` oder `auto`. Standardwert: `auto`. Mögliche Werte: `low`, , `medium`, `highauto`	No	auto
size	string (siehe gültige Modelle unten)	Die Größe der generierten Bilder. Für `gpt-image-2` und `gpt-image-2-2026-04-21`werden beliebige Resolutionen als `WIDTHxHEIGHT` Strings unterstützt, zum Beispiel `1536x864`. Breite und Höhe müssen beide durch 16 teilbar sein, und das gewünschte Seitenverhältnis muss zwischen 1:3 und 3:1 liegen. Die oben genannten `2560x1440` Auflösungen sind experimentell, und die maximal unterstützte Auflösung ist `3840x2160`. Die gewünschte Größe muss außerdem die aktuellen Pixel- und Kantengrenzen des Modells erfüllen. Die Standardgrößen `1024x1024`, `1536x1024`, und `1024x1536` werden von den GPT-Bildmodellen unterstützt; `auto` wird für Modelle unterstützt, die automatische Größenzuordnung erlauben. Für `dall-e-2`, verwende eines von `256x256`, `512x512`, oder `1024x1024`. Für `dall-e-3`, verwende eines von `1024x1024`, `1792x1024`, oder `1024x1792`.	No
type	enum	Der Typ des Tools zur Bildgenerierung. Immer `image_generation`. Mögliche Werte: `image_generation`	Ja	image_generation

OpenAI.ImageGenToolInputImageMask

Name	Typ	Description	Required	Vorgabe
Datei-ID	Schnur		No
image_url	Zeichenfolge (URI)		No

OpenAI.IncludeEnum

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

web_search_call.results: Fügen Sie die Suchergebnisse des Web-Suchtool-Aufrufs ein.
web_search_call.action.sources: Schließen Sie die Quellen des Aufrufs des Websuchtools ein.
code_interpreter_call.outputs: Enthält die Ausgaben der Python-Codeausführung in Codedolmetscher-Toolaufrufelemente.
computer_call_output.output.image_url: Bild-URLs aus dem Ergebnis einer Computeranfrage einfügen.
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 Argumentationstoken in den Ergebnissen von Argumentationselementen. Dies ermöglicht die Verwendung von logischen Elementen in mehrteiligen Unterhaltungen, wenn die Antworten-API zustandslos verwendet wird (z. B. wenn der store-Parameter auf false festgelegt ist oder wenn eine Organisation am Null-Datenaufbewahrungsprgramm teilnimmt).

Property	Wert
Beschreibung	Geben Sie zusätzliche Ausgabedaten an, die in die Modellantwort eingeschlossen werden sollen. Derzeit unterstützte Werte sind: - `web_search_call.results`: Fügen Sie die Suchergebnisse des Web-Suchtool-Aufrufs ein. - `web_search_call.action.sources`: Fügen Sie die Quellen des Websuchwerkzeug-Aufrufs hinzu. - `code_interpreter_call.outputs`: Enthält die Ausgaben der Python-Codeausführung in den Toolaufrufelementen des Code-Interpreters. - `computer_call_output.output.image_url`: Einschließen der Bild-URLs aus der Ausgabe des Computeraufrufs - `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 Argumentationstoken in den Ergebnissen von Argumentationselementen. Dies ermöglicht die Verwendung von logischen Elementen in mehrteiligen Unterhaltungen, wenn die Antworten-API zustandslos verwendet wird (z. B. wenn der `store`-Parameter auf `false` festgelegt ist oder wenn eine Organisation am Null-Datenaufbewahrungsprgramm teilnimmt).
Typ	Schnur
Werte	`file_search_call.results` `web_search_call.results` `web_search_call.action.sources` `message.input_image.image_url` `computer_call_output.output.image_url` `code_interpreter_call.outputs` `reasoning.encrypted_content` `message.output_text.logprobs`

OpenAI.InlineSkillParam

Name	Typ	Description	Required	Vorgabe
description	Schnur	Die Beschreibung der Fähigkeit.	Ja
Name	Schnur	Der Name der Fähigkeit.	Ja
Quelle	OpenAI.InlineSkillSourceParam	Nutzlast für Inline-Fähigkeiten	Ja
└– Daten	Schnur	Base64-codiertes Skill-Zip-Bundle. Einschränkungen: minLength: 1, maxLength: 70254592	Ja
└─ media_type	enum	Der Medientyp der Inline-Skill-Nutzlast. Muss `application/zip` sein. Mögliche Werte: `application/zip`	Ja	application/zip
└– Typ	enum	Die Art der Inline-Fähigkeitsquelle. Muss `base64` sein. Mögliche Werte: `base64`	Ja	Base64
type	enum	Definiert eine Inline-Fähigkeit für diese Anfrage. Mögliche Werte: `inline`	Ja	inline

OpenAI.InlineSkillSourceParam

Nutzlast für Inline-Fähigkeiten

Name	Typ	Description	Required	Vorgabe
data	Schnur	Base64-codiertes Skill-Zip-Bundle. Einschränkungen: minLength: 1, maxLength: 70254592	Ja
media_type	enum	Der Medientyp der Inline-Skill-Nutzlast. Muss `application/zip` sein. Mögliche Werte: `application/zip`	Ja	application/zip
type	enum	Die Art der Inline-Fähigkeitsquelle. Muss `base64` sein. Mögliche Werte: `base64`	Ja	Base64

OpenAI.InputContent

Diskriminator für OpenAI.InputContent

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

Typwert	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContentContent
`input_file`	OpenAI.InputContentInputFileContent

Name	Typ	Description	Required	Vorgabe
type	OpenAI.InputContentType		Ja

OpenAI.InputContentInputFileContent

Eingabedatei

Eine Dateieingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.FileInputDetail		No
file_data	Schnur	Der Inhalt der Datei, die an das Modell gesendet werden soll.	No
Datei-ID	Zeichenfolge oder null		No
file_url	Zeichenfolge (URI)	Die URL der Datei, die an das Modell gesendet werden soll.	No
filename	Schnur	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	input_file

OpenAI.InputContentInputImageContentContent

Eingabebild

Eine Bildeingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.ImageDetail		Ja
Datei-ID	Zeichenfolge oder null		No
image_url	Zeichenfolge oder null		No
type	enum	Der Typ des Eingabeelements. Immer `input_image`. Mögliche Werte: `input_image`	Ja	input_image

OpenAI.InputContentInputTextContent

Eingabetext

Eine Texteingabe für das Modell.

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

OpenAI.InputContentType

Property	Wert
Typ	Schnur
Werte	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

Steuern Sie, wie viel Aufwand das Modell ausüben wird, um dem Stil und den Features, insbesondere Gesichtsmerkmalen, von Eingabebildern zu entsprechen. Dieser Parameter wird nur für gpt-image-1 und gpt-image-1.5 und spätere Modelle unterstützt, nicht für gpt-image-1-miniunterstützt. Unterstützt high und low. Wird standardmäßig auf low festgelegt.

Property	Wert
Typ	Schnur
Werte	`high` `low`

OpenAI.InputFileContent

Eingabedatei

Eine Dateieingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.FileInputDetail		No
file_data	Schnur	Der Inhalt der Datei, die an das Modell gesendet werden soll.	No
Datei-ID	Zeichenfolge oder null		No
file_url	Zeichenfolge (URI)	Die URL der Datei, die an das Modell gesendet werden soll.	No
filename	Schnur	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	input_file

OpenAI.InputFileContentParam

Eingabedatei

Eine Dateieingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.FileInputDetail		No
file_data	Zeichenfolge oder null		No
Datei-ID	Zeichenfolge oder null		No
file_url	Zeichenfolge oder null		No
filename	Zeichenfolge oder null		No
type	enum	Der Typ des Eingabeelements. Immer `input_file`. Mögliche Werte: `input_file`	Ja	input_file

OpenAI.InputImageContent

Eingabebild

Eine Bildeingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.ImageDetail		Ja
Datei-ID	Zeichenfolge oder null		No
image_url	Zeichenfolge oder null		No
type	enum	Der Typ des Eingabeelements. Immer `input_image`. Mögliche Werte: `input_image`	Ja	input_image

OpenAI.InputImageContentParamAutoParam

Eingabebild

Eine Bildeingabe für das Modell. Erfahren Sie mehr über Bildeingaben

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.DetailEnum oder null		No
Datei-ID	Zeichenfolge oder null		No
image_url	Zeichenfolge oder null		No
type	enum	Der Typ des Eingabeelements. Immer `input_image`. Mögliche Werte: `input_image`	Ja	input_image

OpenAI.InputItem

Ein Element, das einen Teil des Kontexts darstellt, damit die Antwort vom Modell generiert wird. Kann Text-, Bild- und Audioeingaben sowie frühere Antworten des Assistenten und Die Ausgabe von Toolanrufen enthalten.

Diskriminator für OpenAI.InputItem

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

Typwert	Schema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam
`output_message`	OpenAI.InputItemOutputMessage
`file_search_call`	OpenAI.InputItemFileSearchToolCall
`computer_call`	OpenAI.InputItemComputerToolCall
`computer_call_output`	OpenAI.InputItemComputerCallOutputItemParam
`web_search_call`	OpenAI.InputItemWebSearchToolCall
`function_call`	OpenAI.InputItemFunctionToolCall
`function_call_output`	OpenAI.InputItemFunctionCallOutputItemParam
`tool_search_call`	OpenAI.InputItemToolSearchCallItemParam
`tool_search_output`	OpenAI.InputItemToolSearchOutputItemParam
`reasoning`	OpenAI.InputItemReasoningItem
`compaction`	OpenAI.InputItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.InputItemImageGenToolCall
`code_interpreter_call`	OpenAI.InputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.InputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.InputItemLocalShellToolCallOutput
`shell_call`	OpenAI.InputItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.InputItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.InputItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.InputItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.InputItemMcpListTools
`mcp_approval_request`	OpenAI.InputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.InputItemMcpApprovalResponse
`mcp_call`	OpenAI.InputItemMcpToolCall
`custom_tool_call_output`	OpenAI.InputItemCustomToolCallOutput
`custom_tool_call`	OpenAI.InputItemCustomToolCall
`tool_approval_response`	AzureToolApprovalResponse

Name	Typ	Description	Required	Vorgabe
type	OpenAI.InputItemType		Ja

OpenAI.InputItemApplyPatchToolCallItemParam

Apply patch tool-Aufruf

Ein Toolaufruf, der eine Anforderung zum Erstellen, Löschen oder Aktualisieren von Dateien mithilfe von Diff-Patches darstellt.

Name	Typ	Description	Required	Vorgabe
call_id	Schnur	Die eindeutige ID des vom Modell generierten Aufrufs des Anwenden-Patchtools. Einschränkungen: minLength: 1, maxLength: 64	Ja
id	Zeichenfolge oder null		No
operation	OpenAI.ApplyPatchOperationParam	Einer der create_file-, delete_file- oder update_file-Vorgänge, die dem apply_patch Tool bereitgestellt werden.	Ja
└– Typ	OpenAI.ApplyPatchOperationParamType		Ja
status	OpenAI.ApplyPatchCallStatusParam	Für apply_patch Toolaufrufe gemeldete Statuswerte.	Ja
type	enum	Der Typ des Elements. Immer `apply_patch_call`. Mögliche Werte: `apply_patch_call`	Ja	apply_patch_call

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Patch-Tool-Aufrufausgabe anwenden

Die gestreamte Ausgabe, die von einem Anwenden eines Patchtoolaufrufs ausgegeben wird.

Name	Typ	Description	Required	Vorgabe
call_id	Schnur	Die eindeutige ID des vom Modell generierten Aufrufs des Anwenden-Patchtools. Einschränkungen: minLength: 1, maxLength: 64	Ja
id	Zeichenfolge oder null		No
Ausgabe	Zeichenfolge oder null		No
status	OpenAI.ApplyPatchCallOutputStatusParam	Für apply_patch Toolaufrufe gemeldete Ergebniswerte.	Ja
type	enum	Der Typ des Elements. Immer `apply_patch_call_output`. Mögliche Werte: `apply_patch_call_output`	Ja	apply_patch_call_output

OpenAI.InputItemCodeInterpreterToolCall

Code-Interpreter-Tool-Aufruf

Ein Toolaufruf zum Ausführen von Code.

Name	Typ	Description	Required	Vorgabe
Programmcode	Zeichenfolge oder null		Ja
container_id	Schnur	Die ID des Containers, der zum Ausführen des Codes verwendet wird.	Ja
id	Schnur	Die eindeutige ID des Aufrufs des Code-Interpreter-Tools.	Ja
outputs	Array von OpenAI.CodeInterpreterOutputLogs oder OpenAI.CodeInterpreterOutputImage oder null		Ja
status	enum	Der Status des Code-Interpreter-Werkzeugaufrufs. Gültige Werte sind `in_progress`, `completed`, `incomplete`, `interpreting` und `failed`. Mögliche Werte: `in_progress`, , `completedincomplete`, , `interpretingfailed`	Ja
type	enum	Der Typ des Codedolmetscher-Toolaufrufs. Immer `code_interpreter_call`. Mögliche Werte: `code_interpreter_call`	Ja	code_interpreter_call

OpenAI.InputItemCompactionSummaryItemParam

Kompaktionsobjekt

Ein Kompaktionselement, das von der API generiert wird v1/responses/compact .

Name	Typ	Description	Required	Vorgabe
encrypted_content	Schnur	Der verschlüsselte Inhalt der Komprimierungszusammenfassung. Einschränkungen: maxLength: 10485760	Ja
id	Zeichenfolge oder null		No
type	enum	Der Typ des Elements. Immer `compaction`. Mögliche Werte: `compaction`	Ja	Verdichtung

OpenAI.InputItemComputerCallOutputItemParam

Computerwerkzeug-Aufrufausgabe

Die Ausgabe eines Computertoolaufrufs

Name	Typ	Description	Required	Vorgabe
acknowledged_safety_checks	Array von OpenAI.ComputerCallSafetyCheckParam oder null		No
call_id	Schnur	Die ID des Aufrufs des Computer-Tools, der die Ausgabe erzeugt hat. Einschränkungen: minLength: 1, maxLength: 64	Ja
id	Zeichenfolge oder null		No
Ausgabe	OpenAI.ComputerScreenshotImage	Ein Screenshotbild des Computers, das mit dem Computerverwendungstool verwendet wird.	Ja
status	OpenAI.FunctionCallItemStatus oder null		No
type	enum	Der Typ der Ausgabe des Computertoolsaufrufs Immer `computer_call_output`. Mögliche Werte: `computer_call_output`	Ja	computer_call_output

OpenAI.InputItemComputerToolCall

Computerwerkzeug-Ruf

Ein Toolaufruf eines von einem Computer verwendeten Tools

Name	Typ	Description	Required	Vorgabe
Aktion	OpenAI.ComputerAction		No
Aktionen	OpenAI.ComputerActionList	Abgeflachte Batch-Aktionen für `computer_use`. Jede Aktion enthält eine `type` diskriminierende und aktionsspezifische Felder.	No
call_id	Schnur	Ein Bezeichner, der beim Antworten auf den Toolaufruf mit einer Ausgabe verwendet wird	Ja
id	Schnur	Die eindeutige ID des Computeraufrufs.	Ja
pending_safety_checks	Array von OpenAI.ComputerCallSafetyCheckParam	Die ausstehenden Sicherheitsprüfungen für den Computeranruf.	Ja
status	enum	Der Status des Elements. Einer von `in_progress`, , `completed`oder `incomplete`. Wird ausgefüllt, wenn Elemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Der Typ des Computeraufrufs. Immer `computer_call`. Mögliche Werte: `computer_call`	Ja	computer_call

OpenAI.InputItemCustomToolCall

Benutzerdefinierter Werkzeugaufruf

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

Name	Typ	Description	Required
call_id	Schnur	Ein Bezeichner, der verwendet wird, um diesen benutzerdefinierten Toolaufruf einer Toolaufrufausgabe zuzuordnen.	Ja
id	Schnur	Die eindeutige ID des benutzerdefinierten Toolaufrufs in der OpenAI-Plattform.	No
input	Schnur	Die Eingabe für den vom Modell generierten benutzerdefinierten Toolaufruf.	Ja
Name	Schnur	Der Name des benutzerdefinierten Tools, das aufgerufen wird.	Ja
namespace	Schnur	Der Namensraum des benutzerdefinierten Werkzeugs, das aufgerufen wird.	No
type	enum	Der Typ des benutzerdefinierten Toolaufrufs. Immer `custom_tool_call`. Mögliche Werte: `custom_tool_call`	Ja

OpenAI.InputItemCustomToolCallOutput

Ausgabe benutzerdefinierter Werkzeugaufrufe

Die Ausgabe eines benutzerdefinierten Toolaufrufs aus Ihrem Code, der an das Modell zurückgesendet wird.

Name	Typ	Description	Required
call_id	Schnur	Die Anruf-ID, die verwendet wird, um diese benutzerdefinierte Toolaufrufausgabe einem benutzerdefinierten Toolaufruf zuzuordnen.	Ja
id	Schnur	Die eindeutige ID der Ausgabe des benutzerdefinierten Toolaufrufs in der OpenAI-Plattform.	No
Ausgabe	Zeichenfolge oder Array von OpenAI.FunctionAndCustomToolCallOutput	Die Ausgabe des vom Code generierten benutzerdefinierten Toolaufrufs. Dies kann eine Zeichenfolge oder eine Liste von Ausgabeinhalten sein.	Ja
type	enum	Der Typ der Ausgabe des benutzerdefinierten Toolaufrufs. Immer `custom_tool_call_output`. Mögliche Werte: `custom_tool_call_output`	Ja

OpenAI.InputItemFileSearchToolCall

Dateisuch-Tool-Aufruf

Die Ergebnisse eines Dateisuchtoolaufrufs.

Name	Typ	Description	Required
id	Schnur	Die eindeutige ID des Aufrufs des Dateisuchtools.	Ja
Abfragen	Array von Strings	Die Zum Suchen nach Dateien verwendeten Abfragen.	Ja
results	Array von OpenAI.FileSearchToolCallResults oder Null		No
status	enum	Der Status des Aufrufs des Dateisuchwerkzeugs. Einer von `in_progress`, `searching`, `incomplete` oder `failed` Mögliche Werte: `in_progress`, , `searchingcompleted`, , `incompletefailed`	Ja
type	enum	Der Typ des Aufrufs des Dateisuchtools. Immer `file_search_call`. Mögliche Werte: `file_search_call`	Ja

OpenAI.InputItemFunctionCallOutputItemParam

Function Tool Call Output

Die Ausgabe eines Funktionstoolaufrufs

Name	Typ	Description	Required	Vorgabe
call_id	Schnur	Die eindeutige ID des vom Modell generierten Funktionstoolaufrufs. Einschränkungen: minLength: 1, maxLength: 64	Ja
id	Zeichenfolge oder null		No
Ausgabe	Zeichenfolge oder Array von OpenAI.InputTextContentParam oder OpenAI.InputImageContentParamAutoParam oder OpenAI.InputFileContentParam	Text-, Bild- oder Dateiausgabe des Funktionstoolaufrufs.	Ja
status	OpenAI.FunctionCallItemStatus oder null		No
type	enum	Der Typ der Ausgabe des Funktionstoolaufrufs Immer `function_call_output`. Mögliche Werte: `function_call_output`	Ja	function_call_output

OpenAI.InputItemFunctionShellCallItemParam

Shell-Werkzeugruf

Ein Tool, das eine Anforderung zum Ausführen eines oder mehrerer Shellbefehle darstellt.

Name	Typ	Description	Required	Vorgabe
Aktion	OpenAI.FunctionShellActionParam	Befehle und Grenzwerte, die beschreiben, wie der Shelltoolaufruf ausgeführt wird.	Ja
└– Befehle	Array von Strings	Geordnete Shellbefehle für die Ausführungsumgebung.	Ja
└– max_output_length	ganze Zahl oder Null		No
└– timeout_ms	ganze Zahl oder Null		No
call_id	Schnur	Die eindeutige ID des vom Modell generierten Shelltoolaufrufs. Einschränkungen: minLength: 1, maxLength: 64	Ja
environment	OpenAI.FunctionShellCallItemParamEnvironment oder null		No
id	Zeichenfolge oder null		No
status	OpenAI.FunctionShellCallItemStatus oder null		No
type	enum	Der Typ des Elements. Immer `shell_call`. Mögliche Werte: `shell_call`	Ja	shell_call

OpenAI.InputItemFunctionShellCallOutputItemParam

Ausgabe des Shell-Werkzeugaufrufs

Die gestreamten Ausgabeelemente, die von einem Shelltoolaufruf ausgegeben werden.

Name	Typ	Description	Required	Vorgabe
call_id	Schnur	Die eindeutige ID des vom Modell generierten Shelltoolaufrufs. Einschränkungen: minLength: 1, maxLength: 64	Ja
id	Zeichenfolge oder null		No
max_output_length	ganze Zahl oder Null		No
Ausgabe	Array von OpenAI.FunctionShellCallOutputContentParam	Erfasste Blöcke der Stdout- und Stderr-Ausgabe zusammen mit den zugehörigen Ergebnissen.	Ja
status	OpenAI.FunctionShellCallItemStatus oder null		No
type	enum	Der Typ des Elements. Immer `shell_call_output`. Mögliche Werte: `shell_call_output`	Ja	shell_call_output

OpenAI.InputItemFunctionToolCall

Funktionswerkzeugaufruf

Ein Toolaufruf zum Ausführen einer Funktion.

Name	Typ	Description	Required
Argumente	Schnur	Eine JSON-Zeichenfolge der Argumente, die an die Funktion übergeben werden sollen.	Ja
call_id	Schnur	Die eindeutige ID des vom Modell generierten Funktionstoolaufrufs.	Ja
id	Zeichenfolge (schreibgeschützt)	Die eindeutige ID des Aufrufs des Funktionswerkzeugs.	Ja
Name	Schnur	Der Name der auszuführenden Funktion.	Ja
namespace	Schnur	Der Namensraum der zu ausführenden Funktion.	No
status	enum	Der Status des Elements. Einer von `in_progress`, , `completed`oder `incomplete`. Wird ausgefüllt, wenn Elemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	No
type	enum	Der Typ des Funktionswerkzeuganrufs. Immer `function_call`. Mögliche Werte: `function_call`	Ja

OpenAI.InputItemImageGenToolCall

Bilderzeugungsaufruf

Eine Vom Modell vorgenommene Anforderung zur Bildgenerierung.

Name	Typ	Description	Required
id	Schnur	Die eindeutige ID des Aufrufs der Bildgenerierung.	Ja
result	Zeichenfolge oder null		Ja
status	enum	Der Status des Aufrufs der Bildgenerierung. Mögliche Werte: `in_progress`, , `completed`, `generatingfailed`	Ja
type	enum	Der Typ des Aufrufs der Bildgenerierung. Immer `image_generation_call`. Mögliche Werte: `image_generation_call`	Ja

OpenAI.InputItemLocalShellToolCall

Lokaler Muschelruf

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

Name	Typ	Description	Required
Aktion	OpenAI.LocalShellExecAction	Führen Sie einen Shellbefehl auf dem Server aus.	Ja
call_id	Schnur	Die eindeutige ID des vom Modell generierten aufrufs des lokalen Shelltools.	Ja
id	Schnur	Die eindeutige ID des lokalen Shellaufrufs.	Ja
status	enum	Der Status des lokalen Shellaufrufs. Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Der Typ des lokalen Shellaufrufs. Immer `local_shell_call`. Mögliche Werte: `local_shell_call`	Ja

OpenAI.InputItemLocalShellToolCallOutput

Lokaler Shell-Aufrufausgang

Die Ausgabe eines Aufrufs eines lokalen Shell-Tools.

Name	Typ	Description	Required
id	Schnur	Die eindeutige ID des vom Modell generierten aufrufs des lokalen Shelltools.	Ja
Ausgabe	Schnur	Eine JSON-Zeichenfolge der Ausgabe des aufrufs des lokalen Shell-Tools.	Ja
status	Zeichenfolge oder null		No
type	enum	Der Typ der Ausgabe des lokalen Shelltools. Immer `local_shell_call_output`. Mögliche Werte: `local_shell_call_output`	Ja

OpenAI.InputItemMcpApprovalRequest

Antrag auf MCP-Genehmigung

Eine Anforderung für menschliche Genehmigung eines Toolaufrufs.

Name	Typ	Description	Required
Argumente	Schnur	Eine JSON-Zeichenfolge mit Argumenten für das Tool.	Ja
id	Schnur	Die eindeutige ID der Genehmigungsanforderung.	Ja
Name	Schnur	Der Name des auszuführenden Tools.	Ja
Serverbeschriftung	Schnur	Die Bezeichnung des MCP-Servers, der die Anforderung vornimmt.	Ja
type	enum	Der Typ des Elements. Immer `mcp_approval_request`. Mögliche Werte: `mcp_approval_request`	Ja

OpenAI.InputItemMcpApprovalResponse

MCP-Genehmigungsantwort

Eine Antwort auf eine MCP-Genehmigungsanforderung.

Name	Typ	Description	Required
approval_request_id	Schnur	Die ID der Genehmigungsanforderung, die beantwortet wird.	Ja
Genehmigen	boolean	Gibt an, ob die Anforderung genehmigt wurde.	Ja
id	Zeichenfolge oder null		No
Grund	Zeichenfolge oder null		No
type	enum	Der Typ des Elements. Immer `mcp_approval_response`. Mögliche Werte: `mcp_approval_response`	Ja

OpenAI.InputItemMcpListTools

MCP-Listenwerkzeuge

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

Name	Typ	Description	Required
Fehler	OpenAI.RealtimeMCPError		No
id	Schnur	Die eindeutige ID der Liste.	Ja
Serverbeschriftung	Schnur	Die Bezeichnung des MCP-Servers.	Ja
tools	Array von OpenAI.MCPListToolsTool	Die auf dem Server verfügbaren Tools.	Ja
type	enum	Der Typ des Elements. Immer `mcp_list_tools`. Mögliche Werte: `mcp_list_tools`	Ja

OpenAI.InputItemMcpToolCall

MCP-Werkzeugruf

Ein Aufruf eines Tools auf einem MCP-Server.

Name	Typ	Description	Required
approval_request_id	Zeichenfolge oder null		No
Argumente	Schnur	Eine JSON-Zeichenfolge der Argumente, die an das Tool übergeben werden.	Ja
Fehler	OpenAI.RealtimeMCPError		No
id	Schnur	Die eindeutige ID des Toolaufrufs.	Ja
Name	Schnur	Der Name des tools, das ausgeführt wurde.	Ja
Ausgabe	Zeichenfolge oder null		No
Serverbeschriftung	Schnur	Die Bezeichnung des MCP-Servers, auf dem das Tool ausgeführt wird.	Ja
status	OpenAI.MCPToolCallStatus		No
type	enum	Der Typ des Elements. Immer `mcp_call`. Mögliche Werte: `mcp_call`	Ja

OpenAI.InputItemOutputMessage

Ausgabenachricht

Eine Ausgabemeldung aus dem Modell.

Name	Typ	Description	Required
Inhalt	Array von OpenAI.OutputMessageContent	Der Inhalt der Ausgabenachricht.	Ja
id	Schnur	Die eindeutige ID der Ausgabenachricht.	Ja
Phase	OpenAI.MessagePhase oder null		No
Rolle	enum	Die Rolle der Ausgabemeldung. Immer `assistant`. Mögliche Werte: `assistant`	Ja
status	enum	Der Status der Nachrichteneingabe. Einer von `in_progress`, , `completed`oder `incomplete`. Befüllt, wenn Eingabeelemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Der Typ der Ausgabemeldung. Immer `message`. Mögliche Werte: `output_message`	Ja

OpenAI.InputItemReasoningItem

Reasoning

Eine Beschreibung der Gedankenkette, die von einem Begründungsmodell beim Generieren einer Antwort verwendet wird. Achten Sie darauf, diese Elemente in Ihre input an die Antworten-API für die nächsten Gesprächsverläufe einzufügen, wenn Sie den Kontext manuell verwalten.

Name	Typ	Description	Required
Inhalt	Array von OpenAI.ReasoningTextContent	Textinhalt wird mit Gründen versehen.	No
encrypted_content	Zeichenfolge oder null		No
id	Schnur	Der eindeutige Bezeichner des Argumentationsinhalts.	Ja
status	enum	Der Status des Elements. Einer von `in_progress`, , `completed`oder `incomplete`. Wird ausgefüllt, wenn Elemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	No
summary	Array von OpenAI.ZusammenfassungTextInhalt	Zusammenfassungsinhalt der Gründe.	Ja
type	enum	Der Typ des Objekts. Immer `reasoning`. Mögliche Werte: `reasoning`	Ja

OpenAI.InputItemToolSearchCallItemParam

Name	Typ	Description	Required	Vorgabe
Argumente	OpenAI.EmptyModelParam		Ja
call_id	Zeichenfolge oder null		No
Ausführung	OpenAI.ToolSearchExecutionType		No
id	Zeichenfolge oder null		No
status	OpenAI.FunctionCallItemStatus oder null		No
type	enum	Der Elementtyp. Immer `tool_search_call`. Mögliche Werte: `tool_search_call`	Ja	tool_search_call

OpenAI.InputItemToolSearchOutputItemParam

Name	Typ	Description	Required	Vorgabe
call_id	Zeichenfolge oder null		No
Ausführung	OpenAI.ToolSearchExecutionType		No
id	Zeichenfolge oder null		No
status	OpenAI.FunctionCallItemStatus oder null		No
tools	Array von OpenAI.Tool	Die geladenen Werkzeugdefinitionen, die von der Werkzeugsuche zurückgegeben wurden, geben aus.	Ja
type	enum	Der Elementtyp. Immer `tool_search_output`. Mögliche Werte: `tool_search_output`	Ja	tool_search_output

OpenAI.InputItemType

Property Wert

Typ Schnur

Werte message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
tool_search_call
tool_search_output
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call_output
custom_tool_call
item_reference
tool_approval_response

OpenAI.InputItemWebSearchToolCall

Websuchwerkzeug-Aufruf

Die Ergebnisse eines Aufrufs eines Websuchtools.

Name	Typ	Description	Required
Aktion	OpenAI.WebSearchActionSearch oder OpenAI.WebSearchActionOpenPage oder OpenAI.WebSearchActionFind	Ein Objekt, das die spezifische Aktion beschreibt, die in diesem Websuchaufruf ausgeführt wird. Enthält Details darüber, wie das Modell das Web genutzt hat (Suche, open_page, find_in_page).	Ja
id	Schnur	Die eindeutige ID des Aufrufs des Websuchtools.	Ja
status	enum	Der Status des Aufrufs des Websuchtools. Mögliche Werte: `in_progress`, , `searching`, `completedfailed`	Ja
type	enum	Der Typ des Aufrufs des Websuchtools. Immer `web_search_call`. Mögliche Werte: `web_search_call`	Ja

OpenAI.InputMessageContentList

Eingabeobjekt-Inhaltsliste

Eine Liste mit einem oder mehreren Eingabeelementen für das Modell, die unterschiedliche Inhaltstypen enthält.

Array von: OpenAI.InputContent

OpenAI.InputParam

Text-, Bild- oder Dateieingaben für das Modell, die zum Generieren einer Antwort verwendet werden. Erfahren Sie mehr:

Texteingaben und -ausgaben
Bildeingaben
Dateieingaben
Konversationsstatus
Funktionsaufruf

Diese Komponente kann eine der folgenden Sein:

String
array

OpenAI.InputTextContent

Eingabetext

Eine Texteingabe für das Modell.

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

OpenAI.InputTextContentParam

Eingabetext

Eine Texteingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
Text	Schnur	Die Texteingabe für das Modell. Einschränkungen: maxLength: 10485760	Ja
type	enum	Der Typ des Eingabeelements. Immer `input_text`. Mögliche Werte: `input_text`	Ja	input_text

OpenAI.ItemReferenceParam

Elementreferenz

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

Name	Typ	Description	Required	Vorgabe
id	Schnur	Die ID des zu referenzierenden Elements.	Ja
type	enum	Der Typ des zu referenzierenden Elements. Immer `item_reference`. Mögliche Werte: `item_reference`	Ja	item_reference

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
`message`	OpenAI.ItemResourceInputMessage
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutput
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCall
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutput
`tool_search_call`	OpenAI.ItemResourceToolSearchCall
`tool_search_output`	OpenAI.ItemResourceToolSearchOutput
`reasoning`	OpenAI.ItemResourceReasoningItem
`compaction`	OpenAI.ItemResourceCompactionBody
`image_generation_call`	OpenAI.ItemResourceImageGenToolCall
`code_interpreter_call`	OpenAI.ItemResourceCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemResourceLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemResourceLocalShellToolCallOutput
`shell_call`	OpenAI.ItemResourceFunctionShellCall
`shell_call_output`	OpenAI.ItemResourceFunctionShellCallOutput
`apply_patch_call`	OpenAI.ItemResourceApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ItemResourceApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ItemResourceMcpListTools
`mcp_approval_request`	OpenAI.ItemResourceMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemResourceMcpApprovalResponseResource
`mcp_call`	OpenAI.ItemResourceMcpToolCall
`custom_tool_call`	OpenAI.ItemResourceCustomToolCallResource
`custom_tool_call_output`	OpenAI.ItemResourceCustomToolCallOutputResource

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ItemResourceType		Ja

OpenAI.ItemResourceApplyPatchToolCall

Apply patch tool-Aufruf

Ein Toolaufruf, der Datei-Diffs anwendet, indem Dateien erstellt, gelöscht oder aktualisiert werden.

Name	Typ	Description	Required	Vorgabe
call_id	Schnur	Die eindeutige ID des vom Modell generierten Aufrufs des Anwenden-Patchtools.	Ja
created_by	Schnur	Die ID der Entität, die diesen Toolaufruf erstellt hat.	No
id	Schnur	Die eindeutige ID des Aufrufs des Anwenden-Patchtools. Aufgefüllt, wenn dieses Element über die API zurückgegeben wird.	Ja
operation	OpenAI.ApplyPatchFileOperation	Einer der create_file, delete_file oder update_file Vorgänge, die über apply_patch angewendet werden.	Ja
└– Typ	OpenAI.ApplyPatchFileOperationType		Ja
status	OpenAI.ApplyPatchCallStatus		Ja
type	enum	Der Typ des Elements. Immer `apply_patch_call`. Mögliche Werte: `apply_patch_call`	Ja	apply_patch_call

OpenAI.ItemResourceApplyPatchToolCallOutput

Patch-Tool-Aufrufausgabe anwenden

Die Ausgabe, die von einem Aufruf des Apply Patch-Tools ausgegeben wird.

Name	Typ	Description	Required	Vorgabe
call_id	Schnur	Die eindeutige ID des vom Modell generierten Aufrufs des Anwenden-Patchtools.	Ja
created_by	Schnur	Die ID der Entität, die diese Toolaufrufausgabe erstellt hat.	No
id	Schnur	Die eindeutige ID der Ausgabe des Anwenden-Patchtools. Aufgefüllt, wenn dieses Element über die API zurückgegeben wird.	Ja
Ausgabe	Zeichenfolge oder null		No
status	OpenAI.ApplyPatchCallOutputStatus		Ja
type	enum	Der Typ des Elements. Immer `apply_patch_call_output`. Mögliche Werte: `apply_patch_call_output`	Ja	apply_patch_call_output

OpenAI.ItemResourceCodeInterpreterToolCall

Code-Interpreter-Tool-Aufruf

Ein Toolaufruf zum Ausführen von Code.

Name	Typ	Description	Required	Vorgabe
Programmcode	Zeichenfolge oder null		Ja
container_id	Schnur	Die ID des Containers, der zum Ausführen des Codes verwendet wird.	Ja
id	Schnur	Die eindeutige ID des Aufrufs des Code-Interpreter-Tools.	Ja
outputs	Array von OpenAI.CodeInterpreterOutputLogs oder OpenAI.CodeInterpreterOutputImage oder null		Ja
status	enum	Der Status des Code-Interpreter-Werkzeugaufrufs. Gültige Werte sind `in_progress`, `completed`, `incomplete`, `interpreting` und `failed`. Mögliche Werte: `in_progress`, , `completedincomplete`, , `interpretingfailed`	Ja
type	enum	Der Typ des Codedolmetscher-Toolaufrufs. Immer `code_interpreter_call`. Mögliche Werte: `code_interpreter_call`	Ja	code_interpreter_call

OpenAI.ItemResourceCompactionBody

Kompaktionsobjekt

Ein Kompaktionselement, das von der API generiert wird v1/responses/compact .

Name	Typ	Description	Required	Vorgabe
created_by	Schnur	Der Bezeichner des Akteurs, der das Element erstellt hat.	No
encrypted_content	Schnur	Der verschlüsselte Inhalt, der durch Komprimierung erzeugt wurde.	Ja
id	Schnur	Die eindeutige ID des Komprimierungselements.	Ja
type	enum	Der Typ des Elements. Immer `compaction`. Mögliche Werte: `compaction`	Ja	Verdichtung

OpenAI.ItemResourceComputerToolCall

Computerwerkzeug-Ruf

Ein Toolaufruf eines von einem Computer verwendeten Tools

Name	Typ	Description	Required	Vorgabe
Aktion	OpenAI.ComputerAction		No
Aktionen	OpenAI.ComputerActionList	Abgeflachte Batch-Aktionen für `computer_use`. Jede Aktion enthält eine `type` diskriminierende und aktionsspezifische Felder.	No
call_id	Schnur	Ein Bezeichner, der beim Antworten auf den Toolaufruf mit einer Ausgabe verwendet wird	Ja
id	Schnur	Die eindeutige ID des Computeraufrufs.	Ja
pending_safety_checks	Array von OpenAI.ComputerCallSafetyCheckParam	Die ausstehenden Sicherheitsprüfungen für den Computeranruf.	Ja
status	enum	Der Status des Elements. Einer von `in_progress`, , `completed`oder `incomplete`. Wird ausgefüllt, wenn Elemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Der Typ des Computeraufrufs. Immer `computer_call`. Mögliche Werte: `computer_call`	Ja	computer_call

OpenAI.ItemResourceComputerToolCallOutput

Computerwerkzeug-Aufrufausgabe

Die Ausgabe eines Computertoolaufrufs

Name	Typ	Description	Required	Vorgabe
acknowledged_safety_checks	Array von OpenAI.ComputerCallSafetyCheckParam	Die von der API gemeldeten Sicherheitskontrollen, die von der API anerkannt wurden. entwickelnden Person bestätigt wurden	No
call_id	Schnur	Die ID des Aufrufs des Computer-Tools, der die Ausgabe erzeugt hat.	Ja
id	Zeichenfolge (schreibgeschützt)	Die ID der Ausgabe des Computertoolsaufrufs	Ja
Ausgabe	OpenAI.ComputerScreenshotImage	Ein Screenshotbild des Computers, das mit dem Computerverwendungstool verwendet wird.	Ja
status	enum	Der Status der Nachrichteneingabe. Einer von `in_progress`, , `completed`oder `incomplete`. Befüllt, wenn Eingabeelemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	No
type	enum	Der Typ der Ausgabe des Computertoolsaufrufs Immer `computer_call_output`. Mögliche Werte: `computer_call_output`	Ja	computer_call_output

OpenAI.ItemResourceCustomToolCallOutputResource

ResponseCustomToolCallOutputItem

Name	Typ	Description	Required
call_id	Schnur	Die Anruf-ID, die verwendet wird, um diese benutzerdefinierte Toolaufrufausgabe einem benutzerdefinierten Toolaufruf zuzuordnen.	Ja
created_by	Schnur	Der Bezeichner des Akteurs, der das Element erstellt hat.	No
id	Schnur	Die eindeutige ID der Ausgabe des benutzerdefinierten Toolaufrufs in der OpenAI-Plattform.	No
Ausgabe	Zeichenfolge oder Array von OpenAI.FunctionAndCustomToolCallOutput	Die Ausgabe des vom Code generierten benutzerdefinierten Toolaufrufs. Dies kann eine Zeichenfolge oder eine Liste von Ausgabeinhalten sein.	Ja
status	OpenAI.FunctionCallOutputStatusEnum		Ja
type	enum	Der Typ der Ausgabe des benutzerdefinierten Toolaufrufs. Immer `custom_tool_call_output`. Mögliche Werte: `custom_tool_call_output`	Ja

OpenAI.ItemResourceCustomToolCallResource

ResponseCustomToolCallItem

Name	Typ	Description	Required
call_id	Schnur	Ein Bezeichner, der verwendet wird, um diesen benutzerdefinierten Toolaufruf einer Toolaufrufausgabe zuzuordnen.	Ja
created_by	Schnur	Der Bezeichner des Akteurs, der das Element erstellt hat.	No
id	Schnur	Die eindeutige ID des benutzerdefinierten Toolaufrufs in der OpenAI-Plattform.	No
input	Schnur	Die Eingabe für den vom Modell generierten benutzerdefinierten Toolaufruf.	Ja
Name	Schnur	Der Name des benutzerdefinierten Tools, das aufgerufen wird.	Ja
namespace	Schnur	Der Namensraum des benutzerdefinierten Werkzeugs, das aufgerufen wird.	No
status	OpenAI.FunctionCallStatus		Ja
type	enum	Der Typ des benutzerdefinierten Toolaufrufs. Immer `custom_tool_call`. Mögliche Werte: `custom_tool_call`	Ja

OpenAI.ItemResourceFileSearchToolCall

Dateisuch-Tool-Aufruf

Die Ergebnisse eines Dateisuchtoolaufrufs.

Name	Typ	Description	Required
id	Schnur	Die eindeutige ID des Aufrufs des Dateisuchtools.	Ja
Abfragen	Array von Strings	Die Zum Suchen nach Dateien verwendeten Abfragen.	Ja
results	Array von OpenAI.FileSearchToolCallResults oder Null		No
status	enum	Der Status des Aufrufs des Dateisuchwerkzeugs. Einer von `in_progress`, `searching`, `incomplete` oder `failed` Mögliche Werte: `in_progress`, , `searchingcompleted`, , `incompletefailed`	Ja
type	enum	Der Typ des Aufrufs des Dateisuchtools. Immer `file_search_call`. Mögliche Werte: `file_search_call`	Ja

OpenAI.ItemResourceFunctionShellCall

Shell-Werkzeugruf

Ein Toolaufruf, der einen oder mehrere Shellbefehle in einer verwalteten Umgebung ausführt.

Name	Typ	Description	Required	Vorgabe
Aktion	OpenAI.FunctionShellAction	Führen Sie einen Shellbefehl aus.	Ja
└– Befehle	Array von Strings		Ja
└– max_output_length	ganze Zahl oder Null		Ja
└– timeout_ms	ganze Zahl oder Null		Ja
call_id	Schnur	Die eindeutige ID des vom Modell generierten Shelltoolaufrufs.	Ja
created_by	Schnur	Die ID der Entität, die diesen Toolaufruf erstellt hat.	No
environment	OpenAI.FunctionShellCallEnvironment oder null		Ja
id	Schnur	Die eindeutige ID des Shelltoolaufrufs. Aufgefüllt, wenn dieses Element über die API zurückgegeben wird.	Ja
status	OpenAI.FunctionShellCallStatus		Ja
type	enum	Der Typ des Elements. Immer `shell_call`. Mögliche Werte: `shell_call`	Ja	shell_call

OpenAI.ItemResourceFunctionShellCallOutput

Ausgabe von Shell-Aufrufen

Die Ausgabe eines Shelltoolaufrufs, der ausgegeben wurde.

Name	Typ	Description	Required	Vorgabe
call_id	Schnur	Die eindeutige ID des vom Modell generierten Shelltoolaufrufs.	Ja
created_by	Schnur	Der Bezeichner des Akteurs, der das Element erstellt hat.	No
id	Schnur	Die eindeutige ID der Shellaufrufausgabe. Aufgefüllt, wenn dieses Element über die API zurückgegeben wird.	Ja
max_output_length	ganze Zahl oder Null		Ja
Ausgabe	Array von OpenAI.FunctionShellCallOutputContent	Ein Array von Shellaufrufausgabeinhalten	Ja
status	OpenAI.FunctionShellCallOutputStatusEnum		Ja
type	enum	Der Typ der Shellaufrufausgabe. Immer `shell_call_output`. Mögliche Werte: `shell_call_output`	Ja	shell_call_output

OpenAI.ItemResourceFunctionToolCall

Funktionswerkzeugaufruf

Ein Toolaufruf zum Ausführen einer Funktion.

Name	Typ	Description	Required
Argumente	Schnur	Eine JSON-Zeichenfolge der Argumente, die an die Funktion übergeben werden sollen.	Ja
call_id	Schnur	Die eindeutige ID des vom Modell generierten Funktionstoolaufrufs.	Ja
id	Zeichenfolge (schreibgeschützt)	Die eindeutige ID des Aufrufs des Funktionswerkzeugs.	Ja
Name	Schnur	Der Name der auszuführenden Funktion.	Ja
namespace	Schnur	Der Namensraum der zu ausführenden Funktion.	No
status	enum	Der Status des Elements. Einer von `in_progress`, , `completed`oder `incomplete`. Wird ausgefüllt, wenn Elemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	No
type	enum	Der Typ des Funktionswerkzeuganrufs. Immer `function_call`. Mögliche Werte: `function_call`	Ja

OpenAI.ItemResourceFunctionToolCallOutput

Function Tool Call Output

Die Ausgabe eines Funktionstoolaufrufs

Name	Typ	Description	Required
call_id	Schnur	Die eindeutige ID des vom Modell generierten Funktionstoolaufrufs.	Ja
id	Zeichenfolge (schreibgeschützt)	Die eindeutige ID der Ausgabe des Funktionstoolaufrufs Aufgefüllt, wenn dieses Element wird über DIE API zurückgegeben.	Ja
Ausgabe	Zeichenfolge oder Array von OpenAI.FunctionAndCustomToolCallOutput	Die Ausgabe des von Ihrem Code generierten Funktionsaufrufs. Dies kann eine Zeichenfolge oder eine Liste von Ausgabeinhalten sein.	Ja
status	enum	Der Status des Elements. Einer von `in_progress`, , `completed`oder `incomplete`. Wird ausgefüllt, wenn Elemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	No
type	enum	Der Typ der Ausgabe des Funktionstoolaufrufs Immer `function_call_output`. Mögliche Werte: `function_call_output`	Ja

OpenAI.ItemResourceImageGenToolCall

Bilderzeugungsaufruf

Eine Vom Modell vorgenommene Anforderung zur Bildgenerierung.

Name	Typ	Description	Required
id	Schnur	Die eindeutige ID des Aufrufs der Bildgenerierung.	Ja
result	Zeichenfolge oder null		Ja
status	enum	Der Status des Aufrufs der Bildgenerierung. Mögliche Werte: `in_progress`, , `completed`, `generatingfailed`	Ja
type	enum	Der Typ des Aufrufs der Bildgenerierung. Immer `image_generation_call`. Mögliche Werte: `image_generation_call`	Ja

OpenAI.ItemResourceInputMessage

Eingabenachricht

Name	Typ	Description	Required	Vorgabe
Inhalt	OpenAI.InputMessageContentList	Eine Liste mit einem oder mehreren Eingabeelementen für das Modell, die unterschiedliche Inhalte enthält types.	Ja
id	Zeichenfolge (schreibgeschützt)	Die eindeutige ID der Nachrichteneingabe.	Ja
Rolle	enum	Die Rolle der Nachrichteneingabe. Einer der folgenden Werte: `user`, `system` oder `developer`. Mögliche Werte: `user`, , `systemdeveloper`	Ja
status	enum	Der Status des Elements. Einer von `in_progress`, , `completed`oder `incomplete`. Wird ausgefüllt, wenn Elemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	No
type	enum	Der Typ der Nachrichteneingabe. Immer auf `message` festgelegt. Mögliche Werte: `message`	Ja	message

OpenAI.ItemResourceLocalShellToolCall

Lokaler Muschelruf

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

Name	Typ	Description	Required
Aktion	OpenAI.LocalShellExecAction	Führen Sie einen Shellbefehl auf dem Server aus.	Ja
call_id	Schnur	Die eindeutige ID des vom Modell generierten aufrufs des lokalen Shelltools.	Ja
id	Schnur	Die eindeutige ID des lokalen Shellaufrufs.	Ja
status	enum	Der Status des lokalen Shellaufrufs. Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Der Typ des lokalen Shellaufrufs. Immer `local_shell_call`. Mögliche Werte: `local_shell_call`	Ja

OpenAI.ItemResourceLocalShellToolCallOutput

Lokaler Shell-Aufrufausgang

Die Ausgabe eines Aufrufs eines lokalen Shell-Tools.

Name	Typ	Description	Required
id	Schnur	Die eindeutige ID des vom Modell generierten aufrufs des lokalen Shelltools.	Ja
Ausgabe	Schnur	Eine JSON-Zeichenfolge der Ausgabe des aufrufs des lokalen Shell-Tools.	Ja
status	Zeichenfolge oder null		No
type	enum	Der Typ der Ausgabe des lokalen Shelltools. Immer `local_shell_call_output`. Mögliche Werte: `local_shell_call_output`	Ja

OpenAI.ItemResourceMcpApprovalRequest

Antrag auf MCP-Genehmigung

Eine Anforderung für menschliche Genehmigung eines Toolaufrufs.

Name	Typ	Description	Required
Argumente	Schnur	Eine JSON-Zeichenfolge mit Argumenten für das Tool.	Ja
id	Schnur	Die eindeutige ID der Genehmigungsanforderung.	Ja
Name	Schnur	Der Name des auszuführenden Tools.	Ja
Serverbeschriftung	Schnur	Die Bezeichnung des MCP-Servers, der die Anforderung vornimmt.	Ja
type	enum	Der Typ des Elements. Immer `mcp_approval_request`. Mögliche Werte: `mcp_approval_request`	Ja

OpenAI.ItemResourceMcpApprovalResponseResource

MCP-Genehmigungsantwort

Eine Antwort auf eine MCP-Genehmigungsanforderung.

Name	Typ	Description	Required
approval_request_id	Schnur	Die ID der Genehmigungsanforderung, die beantwortet wird.	Ja
Genehmigen	boolean	Gibt an, ob die Anforderung genehmigt wurde.	Ja
id	Schnur	Die eindeutige ID der Genehmigungsantwort	Ja
Grund	Zeichenfolge oder null		No
type	enum	Der Typ des Elements. Immer `mcp_approval_response`. Mögliche Werte: `mcp_approval_response`	Ja

OpenAI.ItemResourceMcpListTools

MCP-Listenwerkzeuge

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

Name	Typ	Description	Required
Fehler	OpenAI.RealtimeMCPError		No
id	Schnur	Die eindeutige ID der Liste.	Ja
Serverbeschriftung	Schnur	Die Bezeichnung des MCP-Servers.	Ja
tools	Array von OpenAI.MCPListToolsTool	Die auf dem Server verfügbaren Tools.	Ja
type	enum	Der Typ des Elements. Immer `mcp_list_tools`. Mögliche Werte: `mcp_list_tools`	Ja

OpenAI.ItemResourceMcpToolCall

MCP-Werkzeugruf

Ein Aufruf eines Tools auf einem MCP-Server.

Name	Typ	Description	Required
approval_request_id	Zeichenfolge oder null		No
Argumente	Schnur	Eine JSON-Zeichenfolge der Argumente, die an das Tool übergeben werden.	Ja
Fehler	OpenAI.RealtimeMCPError		No
id	Schnur	Die eindeutige ID des Toolaufrufs.	Ja
Name	Schnur	Der Name des tools, das ausgeführt wurde.	Ja
Ausgabe	Zeichenfolge oder null		No
Serverbeschriftung	Schnur	Die Bezeichnung des MCP-Servers, auf dem das Tool ausgeführt wird.	Ja
status	OpenAI.MCPToolCallStatus		No
type	enum	Der Typ des Elements. Immer `mcp_call`. Mögliche Werte: `mcp_call`	Ja

OpenAI.ItemResourceOutputMessage

Ausgabenachricht

Eine Ausgabemeldung aus dem Modell.

Name	Typ	Description	Required
Inhalt	Array von OpenAI.OutputMessageContent	Der Inhalt der Ausgabenachricht.	Ja
id	Schnur	Die eindeutige ID der Ausgabenachricht.	Ja
Phase	OpenAI.MessagePhase oder null		No
Rolle	enum	Die Rolle der Ausgabemeldung. Immer `assistant`. Mögliche Werte: `assistant`	Ja
status	enum	Der Status der Nachrichteneingabe. Einer von `in_progress`, , `completed`oder `incomplete`. Befüllt, wenn Eingabeelemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Der Typ der Ausgabemeldung. Immer `message`. Mögliche Werte: `output_message`	Ja

OpenAI.ItemResourceReasoningItem

Reasoning

Name	Typ	Description	Required
Inhalt	Array von OpenAI.ReasoningTextContent	Textinhalt wird mit Gründen versehen.	No
encrypted_content	Zeichenfolge oder null		No
id	Schnur	Der eindeutige Bezeichner des Argumentationsinhalts.	Ja
status	enum	Der Status des Elements. Einer von `in_progress`, , `completed`oder `incomplete`. Wird ausgefüllt, wenn Elemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	No
summary	Array von OpenAI.ZusammenfassungTextInhalt	Zusammenfassungsinhalt der Gründe.	Ja
type	enum	Der Typ des Objekts. Immer `reasoning`. Mögliche Werte: `reasoning`	Ja

OpenAI.ItemResourceToolSearchCall

Name	Typ	Description	Required	Vorgabe
Argumente		Argumente, die für den Tool-Suchaufruf verwendet werden.	Ja
call_id	Zeichenfolge oder null		Ja
created_by	Schnur	Der Bezeichner des Akteurs, der das Element erstellt hat.	No
Ausführung	OpenAI.ToolSearchExecutionType		Ja
id	Schnur	Die eindeutige ID des Tool-Suchaufruf-Elements.	Ja
status	OpenAI.FunctionCallStatus		Ja
type	enum	Der Typ des Elements. Immer `tool_search_call`. Mögliche Werte: `tool_search_call`	Ja	tool_search_call

OpenAI.ItemResourceToolSearchOutput

Name	Typ	Description	Required	Vorgabe
call_id	Zeichenfolge oder null		Ja
created_by	Schnur	Der Bezeichner des Akteurs, der das Element erstellt hat.	No
Ausführung	OpenAI.ToolSearchExecutionType		Ja
id	Schnur	Die eindeutige ID des Tool-Such-Output-Elements.	Ja
status	OpenAI.FunctionCallOutputStatusEnum		Ja
tools	Array von OpenAI.Tool	Die geladenen Werkzeugdefinitionen wurden durch die Werkzeugsuche zurückgegeben.	Ja
type	enum	Der Typ des Elements. Immer `tool_search_output`. Mögliche Werte: `tool_search_output`	Ja	tool_search_output

OpenAI.ItemResourceType

Property Wert

Typ Schnur

OpenAI.ItemResourceWebSearchToolCall

Websuchwerkzeug-Aufruf

Die Ergebnisse eines Aufrufs eines Websuchtools.

Name	Typ	Description	Required
Aktion	OpenAI.WebSearchActionSearch oder OpenAI.WebSearchActionOpenPage oder OpenAI.WebSearchActionFind	Ein Objekt, das die spezifische Aktion beschreibt, die in diesem Websuchaufruf ausgeführt wird. Enthält Details darüber, wie das Modell das Web genutzt hat (Suche, open_page, find_in_page).	Ja
id	Schnur	Die eindeutige ID des Aufrufs des Websuchtools.	Ja
status	enum	Der Status des Aufrufs des Websuchtools. Mögliche Werte: `in_progress`, , `searching`, `completedfailed`	Ja
type	enum	Der Typ des Aufrufs des Websuchtools. Immer `web_search_call`. Mögliche Werte: `web_search_call`	Ja

OpenAI.KeyPressAction

KeyPress

Eine Sammlung von Tastendrücken, die das Modell ausführen möchte.

Name	Typ	Description	Required	Vorgabe
keys	Array von Strings	Die Tastenkombination, die das Modell gedrückt haben möchte. 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` gesetzt. Mögliche Werte: `keypress`	Ja	Tastendruck

OpenAI.LocalEnvironmentResource

Lokale Umgebung

Repräsentiert die Nutzung einer lokalen Umgebung zur Durchführung von Shell-Aktionen.

Name	Typ	Description	Required	Vorgabe
type	enum	Der Umgebungstyp. Immer `local`. Mögliche Werte: `local`	Ja	lokal

OpenAI.LocalShellExecAction

Lokale Aktion des Shell-Exekutivs

Führen Sie einen Shellbefehl auf dem Server aus.

Name	Typ	Description	Required	Vorgabe
Befehl	Array von Strings	Der auszuführende Befehl.	Ja
env	Objekt	Umgebungsvariablen, die für den Befehl festgelegt werden sollen.	Ja
timeout_ms	ganze Zahl oder Null		No
type	enum	Der Typ der lokalen Shellaktion. Immer `exec`. Mögliche Werte: `exec`	Ja	exec
user	Zeichenfolge oder null		No
working_directory	Zeichenfolge oder null		No

OpenAI.LocalShellToolParam

Lokales Schalenwerkzeug

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

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

OpenAI.LocalSkillParam

Name	Typ	Description	Required
description	Schnur	Die Beschreibung der Fähigkeit.	Ja
Name	Schnur	Der Name der Fähigkeit.	Ja
path	Schnur	Der Pfad zum Verzeichnis, das die Skill enthält.	Ja

OpenAI.LogProb

Log-Wahrscheinlichkeit

Die Protokollwahrscheinlichkeit eines Tokens.

Name	Typ	Required
Byte	Array mit ganzzahliger Zahl	Ja
logprob	Zahl	Ja
token	Schnur	Ja
top_logprobs	Array von OpenAI.TopLogProb	Ja

OpenAI.MCPListToolsTool

MCP-Listenwerkzeuge

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

Name	Typ	Description	Required
annotations	OpenAI.MCPListToolsToolAnnotations oder NULL		No
description	Zeichenfolge oder null		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Ja
Name	Schnur	Der Name des Tools.	Ja

OpenAI.MCPListToolsToolAnnotations

Typ: Objekt

OpenAI.MCPListToolsToolInputSchema

Typ: Objekt

OpenAI.MCPTool

MCP-Tool

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

Name	Typ	Description	Required
erlaubte_Werkzeuge	Array von Zeichenfolge oder OpenAI.MCPToolFilter oder NULL		No
authorization	Schnur	Ein OAuth-Zugriffstoken, das mit einem Remote-MCP-Server verwendet werden kann, entweder mit einer benutzerdefinierten MCP-Server-URL oder einem Dienstconnector. Ihre Anwendung muss den OAuth-Autorisierungsfluss verarbeiten und das Token hier bereitstellen.	No
connector_id	enum	Bezeichner für Dienstconnectors, z. B. die in ChatGPT verfügbaren. Einer von `server_url` oder `connector_id` muss bereitgestellt werden. Weitere Informationen zum Dienst Ich bin Verbinder. Derzeit unterstützte `connector_id` Werte sind: -Dropbox: `connector_dropbox` -Google mail: `connector_gmail` - Google-Kalender: `connector_googlecalendar` - Google Drive: `connector_googledrive` - Microsoft Teams:`connector_microsoftteams` - Outlook Kalender: `connector_outlookcalendar` - Outlook-E-Mail: `connector_outlookemail` -Sharepoint: `connector_sharepoint` Mögliche Werte: `connector_dropbox`, , `connector_gmail`, `connector_googlecalendarconnector_googledrive`, `connector_microsoftteams`, , `connector_outlookcalendar`, `connector_outlookemailconnector_sharepoint`	No
defer_loading	boolean	Ob dieses MCP-Tool aufgeschoben und durch die Tool-Suche entdeckt wird.	No
headers	-Objekt oder Null		No
Genehmigung erforderlich	OpenAI.MCPToolRequireApproval oder string oder null		No
server_description	Schnur	Optionale Beschreibung des MCP-Servers, die verwendet wird, um mehr Kontext bereitzustellen.	No
Serverbeschriftung	Schnur	Eine Bezeichnung für diesen MCP-Server, die verwendet wird, um sie in Toolaufrufen zu identifizieren.	Ja
server_url	Zeichenfolge (URI)	Die URL für den MCP-Server. Einer von `server_url` oder `connector_id` muss sein bereitgestellt.	No
type	enum	Der Typ des MCP-Tools. Immer `mcp`. Mögliche Werte: `mcp`	Ja

OpenAI.MCPToolCallStatus

Property	Wert
Typ	Schnur
Werte	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

MCP-Werkzeugfilter

Ein Filterobjekt, das angibt, welche Tools zulässig sind.

Name	Typ	Description	Required	Vorgabe
Read_only	boolean	Gibt an, ob ein Tool Daten ändert oder schreibgeschützt ist. Wenn ein MCP-Server ist mit Anmerkungen versehen mit `readOnlyHint`, dieser Filter entspricht.	No
tool_names	Array von Strings	Liste der zulässigen Toolnamen.	No

OpenAI.MCPToolRequireApproval

Name	Typ	Description	Required	Vorgabe
immer	OpenAI.MCPToolFilter	Ein Filterobjekt, das angibt, welche Tools zulässig sind.	No
Niemals	OpenAI.MCPToolFilter	Ein Filterobjekt, das angibt, welche Tools zulässig sind.	No

OpenAI.MessageContent

Ein Inhaltsteil, aus dem ein Eingabe- oder Ausgabeelement besteht.

Diskriminator für OpenAI.MessageContent

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

Typwert	Schema
`text`	OpenAI.TextContent
`computer_screenshot`	OpenAI.ComputerScreenshotContent
`input_text`	OpenAI.MessageContentInputTextContent
`output_text`	OpenAI.MessageContentOutputTextContent
`reasoning_text`	OpenAI.MessageContentReasoningTextContent
`refusal`	OpenAI.MessageContentRefusalContent
`input_image`	OpenAI.MessageContentInputImageContent
`input_file`	OpenAI.MessageContentInputFileContent
`summary_text`	OpenAI.SummaryTextContent

Name	Typ	Description	Required	Vorgabe
type	OpenAI.MessageContentType		Ja

OpenAI.MessageContentInputFileContent

Eingabedatei

Eine Dateieingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.FileInputDetail		No
file_data	Schnur	Der Inhalt der Datei, die an das Modell gesendet werden soll.	No
Datei-ID	Zeichenfolge oder null		No
file_url	Zeichenfolge (URI)	Die URL der Datei, die an das Modell gesendet werden soll.	No
filename	Schnur	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	input_file

OpenAI.MessageContentInputImageContent

Eingabebild

Eine Bildeingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.ImageDetail		Ja
Datei-ID	Zeichenfolge oder null		No
image_url	Zeichenfolge oder null		No
type	enum	Der Typ des Eingabeelements. Immer `input_image`. Mögliche Werte: `input_image`	Ja	input_image

OpenAI.MessageContentInputTextContent

Eingabetext

Eine Texteingabe für das Modell.

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

OpenAI.MessageContentOutputTextContent

Ausgabetext

Eine Textausgabe aus dem Modell.

Name	Typ	Description	Required	Vorgabe
annotations	Array von OpenAI.Annotation	Die Anmerkungen der Textausgabe	Ja
logprobs	Array von OpenAI.LogProb		Ja
Text	Schnur	Die Textausgabe aus dem Modell.	Ja
type	enum	Der Typ des Ausgabetexts. Immer `output_text`. Mögliche Werte: `output_text`	Ja	output_text

OpenAI.MessageContentReasoningTextContent

Begründungstext

Grundierungstext aus dem Modell.

Name	Typ	Description	Required	Vorgabe
Text	Schnur	Der Begründungstext aus dem Modell.	Ja
type	enum	Der Typ des Begründungstexts. Immer `reasoning_text`. Mögliche Werte: `reasoning_text`	Ja	reasoning_text

OpenAI.MessageContentRefusalContent

Refusal

Eine Ablehnung des Modells

Name	Typ	Description	Required	Vorgabe
Weigerung	Schnur	Die Erklärung der Ablehnung des Modells	Ja
type	enum	Die Art der Ablehnung. Immer `refusal`. Mögliche Werte: `refusal`	Ja	Weigerung

OpenAI.MessageContentType

Property	Wert
Typ	Schnur
Werte	`input_text` `output_text` `text` `summary_text` `reasoning_text` `refusal` `input_image` `computer_screenshot` `input_file`

OpenAI.MessagePhase

Bezeichnet eine assistant Nachricht als Zwischenkommentar (commentary) oder als Endantwort (final_answer). Bei Modellen wie und gpt-5.3-codex darüber hinaus gilt: Beim Versenden von Folgeanfragen sollte man die Phase aller Assistenten-Nachrichten speichern und erneut senden – ein Ausfall kann die Leistung beeinträchtigen. Wird nicht für Benutzernachrichten verwendet.

Property	Wert
Typ	Schnur
Werte	`commentary` `final_answer`

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

Move

Aktion zur Änderung der Mauszeigerposition

Name	Typ	Description	Required	Vorgabe
keys	Array von Zeichenfolge oder Null		No
type	enum	Gibt den Ereignistyp an. Bei einer Verschiebungsaktion ist diese Eigenschaft immer auf `move` gesetzt. Mögliche Werte: `move`	Ja	move
x	integer	Die x-Koordinate, zu der verschoben werden soll.	Ja
y	integer	Die y-Koordinate, zu der verschoben werden soll.	Ja

OpenAI.NamespaceToolParam

Namespace

Gruppenfunktionen/benutzerdefinierte Werkzeuge unter einem gemeinsamen Namensraum.

Name	Typ	Description	Required	Vorgabe
description	Schnur	Eine Beschreibung des Namensraums, der dem Modell gezeigt wird. Einschränkungen: minLength: 1	Ja
Name	Schnur	Der Name des Namensraums, der in Werkzeugaufrufen verwendet wird (zum Beispiel `crm`). Einschränkungen: minLength: 1	Ja
tools	array von OpenAI.FunctionToolParam oder OpenAI.CustomToolParam	Die Funktionen/benutzerdefinierten Werkzeuge, die in diesem Namensraum verfügbar sind. Einschränkungen: minItems: 1	Ja
type	enum	Der Typ des Tools. Immer `namespace`. Mögliche Werte: `namespace`	Ja	namespace

OpenAI.OutputContent

Diskriminator für OpenAI.OutputContent

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

Typwert	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent
`reasoning_text`	OpenAI.OutputContentReasoningTextContent

Name	Typ	Description	Required	Vorgabe
type	OpenAI.OutputContentType		Ja

OpenAI.OutputContentOutputTextContent

Ausgabetext

Eine Textausgabe aus dem Modell.

Name	Typ	Description	Required	Vorgabe
annotations	Array von OpenAI.Annotation	Die Anmerkungen der Textausgabe	Ja
logprobs	Array von OpenAI.LogProb		Ja
Text	Schnur	Die Textausgabe aus dem Modell.	Ja
type	enum	Der Typ des Ausgabetexts. Immer `output_text`. Mögliche Werte: `output_text`	Ja	output_text

OpenAI.OutputContentReasoningTextContent

Begründungstext

Grundierungstext aus dem Modell.

Name	Typ	Description	Required	Vorgabe
Text	Schnur	Der Begründungstext aus dem Modell.	Ja
type	enum	Der Typ des Begründungstexts. Immer `reasoning_text`. Mögliche Werte: `reasoning_text`	Ja	reasoning_text

OpenAI.OutputContentRefusalContent

Refusal

Eine Ablehnung des Modells

Name	Typ	Description	Required	Vorgabe
Weigerung	Schnur	Die Erklärung der Ablehnung des Modells	Ja
type	enum	Die Art der Ablehnung. Immer `refusal`. Mögliche Werte: `refusal`	Ja	Weigerung

OpenAI.OutputContentType

Property	Wert
Typ	Schnur
Werte	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

Diskriminator für OpenAI.OutputItem

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

Typwert	Schema
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`function_call_output`	OpenAI.OutputItemFunctionToolCallOutput
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`computer_call_output`	OpenAI.OutputItemComputerToolCallOutput
`reasoning`	OpenAI.OutputItemReasoningItem
`tool_search_call`	OpenAI.OutputItemToolSearchCall
`tool_search_output`	OpenAI.OutputItemToolSearchOutput
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.OutputItemLocalShellToolCallOutput
`shell_call`	OpenAI.OutputItemFunctionShellCall
`shell_call_output`	OpenAI.OutputItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.OutputItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.OutputItemApplyPatchToolCallOutput
`mcp_call`	OpenAI.OutputItemMcpToolCall
`mcp_list_tools`	OpenAI.OutputItemMcpListTools
`mcp_approval_request`	OpenAI.OutputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.OutputItemMcpApprovalResponseResource
`custom_tool_call`	OpenAI.OutputItemCustomToolCallResource
`custom_tool_call_output`	OpenAI.OutputItemCustomToolCallOutputResource
`tool_approval_request`	AzureToolApprovalRequest

Name	Typ	Description	Required	Vorgabe
type	OpenAI.OutputItemType		Ja

OpenAI.OutputItemApplyPatchToolCall

Apply patch tool-Aufruf

Ein Toolaufruf, der Datei-Diffs anwendet, indem Dateien erstellt, gelöscht oder aktualisiert werden.

Name	Typ	Description	Required	Vorgabe
call_id	Schnur	Die eindeutige ID des vom Modell generierten Aufrufs des Anwenden-Patchtools.	Ja
created_by	Schnur	Die ID der Entität, die diesen Toolaufruf erstellt hat.	No
id	Schnur	Die eindeutige ID des Aufrufs des Anwenden-Patchtools. Aufgefüllt, wenn dieses Element über die API zurückgegeben wird.	Ja
operation	OpenAI.ApplyPatchFileOperation	Einer der create_file, delete_file oder update_file Vorgänge, die über apply_patch angewendet werden.	Ja
└– Typ	OpenAI.ApplyPatchFileOperationType		Ja
status	OpenAI.ApplyPatchCallStatus		Ja
type	enum	Der Typ des Elements. Immer `apply_patch_call`. Mögliche Werte: `apply_patch_call`	Ja	apply_patch_call

OpenAI.OutputItemApplyPatchToolCallOutput

Patch-Tool-Aufrufausgabe anwenden

Die Ausgabe, die von einem Aufruf des Apply Patch-Tools ausgegeben wird.

Name	Typ	Description	Required	Vorgabe
call_id	Schnur	Die eindeutige ID des vom Modell generierten Aufrufs des Anwenden-Patchtools.	Ja
created_by	Schnur	Die ID der Entität, die diese Toolaufrufausgabe erstellt hat.	No
id	Schnur	Die eindeutige ID der Ausgabe des Anwenden-Patchtools. Aufgefüllt, wenn dieses Element über die API zurückgegeben wird.	Ja
Ausgabe	Zeichenfolge oder null		No
status	OpenAI.ApplyPatchCallOutputStatus		Ja
type	enum	Der Typ des Elements. Immer `apply_patch_call_output`. Mögliche Werte: `apply_patch_call_output`	Ja	apply_patch_call_output

OpenAI.OutputItemCodeInterpreterToolCall

Code-Interpreter-Tool-Aufruf

Ein Toolaufruf zum Ausführen von Code.

Name	Typ	Description	Required	Vorgabe
Programmcode	Zeichenfolge oder null		Ja
container_id	Schnur	Die ID des Containers, der zum Ausführen des Codes verwendet wird.	Ja
id	Schnur	Die eindeutige ID des Aufrufs des Code-Interpreter-Tools.	Ja
outputs	Array von OpenAI.CodeInterpreterOutputLogs oder OpenAI.CodeInterpreterOutputImage oder null		Ja
status	enum	Der Status des Code-Interpreter-Werkzeugaufrufs. Gültige Werte sind `in_progress`, `completed`, `incomplete`, `interpreting` und `failed`. Mögliche Werte: `in_progress`, , `completedincomplete`, , `interpretingfailed`	Ja
type	enum	Der Typ des Codedolmetscher-Toolaufrufs. Immer `code_interpreter_call`. Mögliche Werte: `code_interpreter_call`	Ja	code_interpreter_call

OpenAI.OutputItemCompactionBody

Kompaktionsobjekt

Ein Kompaktionselement, das von der API generiert wird v1/responses/compact .

Name	Typ	Description	Required	Vorgabe
created_by	Schnur	Der Bezeichner des Akteurs, der das Element erstellt hat.	No
encrypted_content	Schnur	Der verschlüsselte Inhalt, der durch Komprimierung erzeugt wurde.	Ja
id	Schnur	Die eindeutige ID des Komprimierungselements.	Ja
type	enum	Der Typ des Elements. Immer `compaction`. Mögliche Werte: `compaction`	Ja	Verdichtung

OpenAI.OutputItemComputerToolCall

Computerwerkzeug-Ruf

Ein Toolaufruf eines von einem Computer verwendeten Tools

Name	Typ	Description	Required	Vorgabe
Aktion	OpenAI.ComputerAction		No
Aktionen	OpenAI.ComputerActionList	Abgeflachte Batch-Aktionen für `computer_use`. Jede Aktion enthält eine `type` diskriminierende und aktionsspezifische Felder.	No
call_id	Schnur	Ein Bezeichner, der beim Antworten auf den Toolaufruf mit einer Ausgabe verwendet wird	Ja
id	Schnur	Die eindeutige ID des Computeraufrufs.	Ja
pending_safety_checks	Array von OpenAI.ComputerCallSafetyCheckParam	Die ausstehenden Sicherheitsprüfungen für den Computeranruf.	Ja
status	enum	Der Status des Elements. Einer von `in_progress`, , `completed`oder `incomplete`. Wird ausgefüllt, wenn Elemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Der Typ des Computeraufrufs. Immer `computer_call`. Mögliche Werte: `computer_call`	Ja	computer_call

OpenAI.OutputItemComputerToolCallOutput

Computerwerkzeug-Aufrufausgabe

Die Ausgabe eines Computertoolaufrufs

Name	Typ	Description	Required	Vorgabe
acknowledged_safety_checks	Array von OpenAI.ComputerCallSafetyCheckParam	Die von der API gemeldeten Sicherheitskontrollen, die von der API anerkannt wurden. entwickelnden Person bestätigt wurden	No
call_id	Schnur	Die ID des Aufrufs des Computer-Tools, der die Ausgabe erzeugt hat.	Ja
id	Zeichenfolge (schreibgeschützt)	Die ID der Ausgabe des Computertoolsaufrufs	Ja
Ausgabe	OpenAI.ComputerScreenshotImage	Ein Screenshotbild des Computers, das mit dem Computerverwendungstool verwendet wird.	Ja
status	enum	Der Status der Nachrichteneingabe. Einer von `in_progress`, , `completed`oder `incomplete`. Befüllt, wenn Eingabeelemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	No
type	enum	Der Typ der Ausgabe des Computertoolsaufrufs Immer `computer_call_output`. Mögliche Werte: `computer_call_output`	Ja	computer_call_output

OpenAI.OutputItemCustomToolCallOutputResource

ResponseCustomToolCallOutputItem

Name	Typ	Description	Required
call_id	Schnur	Die Anruf-ID, die verwendet wird, um diese benutzerdefinierte Toolaufrufausgabe einem benutzerdefinierten Toolaufruf zuzuordnen.	Ja
created_by	Schnur	Der Bezeichner des Akteurs, der das Element erstellt hat.	No
id	Schnur	Die eindeutige ID der Ausgabe des benutzerdefinierten Toolaufrufs in der OpenAI-Plattform.	No
Ausgabe	Zeichenfolge oder Array von OpenAI.FunctionAndCustomToolCallOutput	Die Ausgabe des vom Code generierten benutzerdefinierten Toolaufrufs. Dies kann eine Zeichenfolge oder eine Liste von Ausgabeinhalten sein.	Ja
status	OpenAI.FunctionCallOutputStatusEnum		Ja
type	enum	Der Typ der Ausgabe des benutzerdefinierten Toolaufrufs. Immer `custom_tool_call_output`. Mögliche Werte: `custom_tool_call_output`	Ja

OpenAI.OutputItemCustomToolCallResource

ResponseCustomToolCallItem

Name	Typ	Description	Required
call_id	Schnur	Ein Bezeichner, der verwendet wird, um diesen benutzerdefinierten Toolaufruf einer Toolaufrufausgabe zuzuordnen.	Ja
created_by	Schnur	Der Bezeichner des Akteurs, der das Element erstellt hat.	No
id	Schnur	Die eindeutige ID des benutzerdefinierten Toolaufrufs in der OpenAI-Plattform.	No
input	Schnur	Die Eingabe für den vom Modell generierten benutzerdefinierten Toolaufruf.	Ja
Name	Schnur	Der Name des benutzerdefinierten Tools, das aufgerufen wird.	Ja
namespace	Schnur	Der Namensraum des benutzerdefinierten Werkzeugs, das aufgerufen wird.	No
status	OpenAI.FunctionCallStatus		Ja
type	enum	Der Typ des benutzerdefinierten Toolaufrufs. Immer `custom_tool_call`. Mögliche Werte: `custom_tool_call`	Ja

OpenAI.OutputItemFileSearchToolCall

Dateisuch-Tool-Aufruf

Die Ergebnisse eines Dateisuchtoolaufrufs.

Name	Typ	Description	Required
id	Schnur	Die eindeutige ID des Aufrufs des Dateisuchtools.	Ja
Abfragen	Array von Strings	Die Zum Suchen nach Dateien verwendeten Abfragen.	Ja
results	Array von OpenAI.FileSearchToolCallResults oder Null		No
status	enum	Der Status des Aufrufs des Dateisuchwerkzeugs. Einer von `in_progress`, `searching`, `incomplete` oder `failed` Mögliche Werte: `in_progress`, , `searchingcompleted`, , `incompletefailed`	Ja
type	enum	Der Typ des Aufrufs des Dateisuchtools. Immer `file_search_call`. Mögliche Werte: `file_search_call`	Ja

OpenAI.OutputItemFunctionShellCall

Shell-Werkzeugruf

Ein Toolaufruf, der einen oder mehrere Shellbefehle in einer verwalteten Umgebung ausführt.

Name	Typ	Description	Required	Vorgabe
Aktion	OpenAI.FunctionShellAction	Führen Sie einen Shellbefehl aus.	Ja
└– Befehle	Array von Strings		Ja
└– max_output_length	ganze Zahl oder Null		Ja
└– timeout_ms	ganze Zahl oder Null		Ja
call_id	Schnur	Die eindeutige ID des vom Modell generierten Shelltoolaufrufs.	Ja
created_by	Schnur	Die ID der Entität, die diesen Toolaufruf erstellt hat.	No
environment	OpenAI.FunctionShellCallEnvironment oder null		Ja
id	Schnur	Die eindeutige ID des Shelltoolaufrufs. Aufgefüllt, wenn dieses Element über die API zurückgegeben wird.	Ja
status	OpenAI.FunctionShellCallStatus		Ja
type	enum	Der Typ des Elements. Immer `shell_call`. Mögliche Werte: `shell_call`	Ja	shell_call

OpenAI.OutputItemFunctionShellCallOutput

Ausgabe von Shell-Aufrufen

Die Ausgabe eines Shelltoolaufrufs, der ausgegeben wurde.

Name	Typ	Description	Required	Vorgabe
call_id	Schnur	Die eindeutige ID des vom Modell generierten Shelltoolaufrufs.	Ja
created_by	Schnur	Der Bezeichner des Akteurs, der das Element erstellt hat.	No
id	Schnur	Die eindeutige ID der Shellaufrufausgabe. Aufgefüllt, wenn dieses Element über die API zurückgegeben wird.	Ja
max_output_length	ganze Zahl oder Null		Ja
Ausgabe	Array von OpenAI.FunctionShellCallOutputContent	Ein Array von Shellaufrufausgabeinhalten	Ja
status	OpenAI.FunctionShellCallOutputStatusEnum		Ja
type	enum	Der Typ der Shellaufrufausgabe. Immer `shell_call_output`. Mögliche Werte: `shell_call_output`	Ja	shell_call_output

OpenAI.OutputItemFunctionToolCall

Funktionswerkzeugaufruf

Ein Toolaufruf zum Ausführen einer Funktion.

Name	Typ	Description	Required
Argumente	Schnur	Eine JSON-Zeichenfolge der Argumente, die an die Funktion übergeben werden sollen.	Ja
call_id	Schnur	Die eindeutige ID des vom Modell generierten Funktionstoolaufrufs.	Ja
id	Zeichenfolge (schreibgeschützt)	Die eindeutige ID des Aufrufs des Funktionswerkzeugs.	Ja
Name	Schnur	Der Name der auszuführenden Funktion.	Ja
namespace	Schnur	Der Namensraum der zu ausführenden Funktion.	No
status	enum	Der Status des Elements. Einer von `in_progress`, , `completed`oder `incomplete`. Wird ausgefüllt, wenn Elemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	No
type	enum	Der Typ des Funktionswerkzeuganrufs. Immer `function_call`. Mögliche Werte: `function_call`	Ja

OpenAI.OutputItemFunctionToolCallOutput

Function Tool Call Output

Die Ausgabe eines Funktionstoolaufrufs

Name	Typ	Description	Required
call_id	Schnur	Die eindeutige ID des vom Modell generierten Funktionstoolaufrufs.	Ja
id	Zeichenfolge (schreibgeschützt)	Die eindeutige ID der Ausgabe des Funktionstoolaufrufs Aufgefüllt, wenn dieses Element wird über DIE API zurückgegeben.	Ja
Ausgabe	Zeichenfolge oder Array von OpenAI.FunctionAndCustomToolCallOutput	Die Ausgabe des von Ihrem Code generierten Funktionsaufrufs. Dies kann eine Zeichenfolge oder eine Liste von Ausgabeinhalten sein.	Ja
status	enum	Der Status des Elements. Einer von `in_progress`, , `completed`oder `incomplete`. Wird ausgefüllt, wenn Elemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	No
type	enum	Der Typ der Ausgabe des Funktionstoolaufrufs Immer `function_call_output`. Mögliche Werte: `function_call_output`	Ja

OpenAI.OutputItemImageGenToolCall

Bilderzeugungsaufruf

Eine Vom Modell vorgenommene Anforderung zur Bildgenerierung.

Name	Typ	Description	Required
id	Schnur	Die eindeutige ID des Aufrufs der Bildgenerierung.	Ja
result	Zeichenfolge oder null		Ja
status	enum	Der Status des Aufrufs der Bildgenerierung. Mögliche Werte: `in_progress`, , `completed`, `generatingfailed`	Ja
type	enum	Der Typ des Aufrufs der Bildgenerierung. Immer `image_generation_call`. Mögliche Werte: `image_generation_call`	Ja

OpenAI.OutputItemLocalShellToolCall

Lokaler Muschelruf

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

Name	Typ	Description	Required
Aktion	OpenAI.LocalShellExecAction	Führen Sie einen Shellbefehl auf dem Server aus.	Ja
call_id	Schnur	Die eindeutige ID des vom Modell generierten aufrufs des lokalen Shelltools.	Ja
id	Schnur	Die eindeutige ID des lokalen Shellaufrufs.	Ja
status	enum	Der Status des lokalen Shellaufrufs. Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Der Typ des lokalen Shellaufrufs. Immer `local_shell_call`. Mögliche Werte: `local_shell_call`	Ja

OpenAI.OutputItemLocalShellToolCallOutput

Lokaler Shell-Aufrufausgang

Die Ausgabe eines Aufrufs eines lokalen Shell-Tools.

Name	Typ	Description	Required
id	Schnur	Die eindeutige ID des vom Modell generierten aufrufs des lokalen Shelltools.	Ja
Ausgabe	Schnur	Eine JSON-Zeichenfolge der Ausgabe des aufrufs des lokalen Shell-Tools.	Ja
status	Zeichenfolge oder null		No
type	enum	Der Typ der Ausgabe des lokalen Shelltools. Immer `local_shell_call_output`. Mögliche Werte: `local_shell_call_output`	Ja

OpenAI.OutputItemMcpApprovalRequest

Antrag auf MCP-Genehmigung

Eine Anforderung für menschliche Genehmigung eines Toolaufrufs.

Name	Typ	Description	Required
Argumente	Schnur	Eine JSON-Zeichenfolge mit Argumenten für das Tool.	Ja
id	Schnur	Die eindeutige ID der Genehmigungsanforderung.	Ja
Name	Schnur	Der Name des auszuführenden Tools.	Ja
Serverbeschriftung	Schnur	Die Bezeichnung des MCP-Servers, der die Anforderung vornimmt.	Ja
type	enum	Der Typ des Elements. Immer `mcp_approval_request`. Mögliche Werte: `mcp_approval_request`	Ja

OpenAI.OutputItemMcpApprovalResponseResource

MCP-Genehmigungsantwort

Eine Antwort auf eine MCP-Genehmigungsanforderung.

Name	Typ	Description	Required
approval_request_id	Schnur	Die ID der Genehmigungsanforderung, die beantwortet wird.	Ja
Genehmigen	boolean	Gibt an, ob die Anforderung genehmigt wurde.	Ja
id	Schnur	Die eindeutige ID der Genehmigungsantwort	Ja
Grund	Zeichenfolge oder null		No
type	enum	Der Typ des Elements. Immer `mcp_approval_response`. Mögliche Werte: `mcp_approval_response`	Ja

OpenAI.OutputItemMcpListTools

MCP-Listenwerkzeuge

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

Name	Typ	Description	Required
Fehler	OpenAI.RealtimeMCPError		No
id	Schnur	Die eindeutige ID der Liste.	Ja
Serverbeschriftung	Schnur	Die Bezeichnung des MCP-Servers.	Ja
tools	Array von OpenAI.MCPListToolsTool	Die auf dem Server verfügbaren Tools.	Ja
type	enum	Der Typ des Elements. Immer `mcp_list_tools`. Mögliche Werte: `mcp_list_tools`	Ja

OpenAI.OutputItemMcpToolCall

MCP-Werkzeugruf

Ein Aufruf eines Tools auf einem MCP-Server.

Name	Typ	Description	Required
approval_request_id	Zeichenfolge oder null		No
Argumente	Schnur	Eine JSON-Zeichenfolge der Argumente, die an das Tool übergeben werden.	Ja
Fehler	OpenAI.RealtimeMCPError		No
id	Schnur	Die eindeutige ID des Toolaufrufs.	Ja
Name	Schnur	Der Name des tools, das ausgeführt wurde.	Ja
Ausgabe	Zeichenfolge oder null		No
Serverbeschriftung	Schnur	Die Bezeichnung des MCP-Servers, auf dem das Tool ausgeführt wird.	Ja
status	OpenAI.MCPToolCallStatus		No
type	enum	Der Typ des Elements. Immer `mcp_call`. Mögliche Werte: `mcp_call`	Ja

OpenAI.OutputItemOutputMessage

Ausgabenachricht

Eine Ausgabemeldung aus dem Modell.

Name	Typ	Description	Required
Inhalt	Array von OpenAI.OutputMessageContent	Der Inhalt der Ausgabenachricht.	Ja
id	Schnur	Die eindeutige ID der Ausgabenachricht.	Ja
Phase	OpenAI.MessagePhase oder null		No
Rolle	enum	Die Rolle der Ausgabemeldung. Immer `assistant`. Mögliche Werte: `assistant`	Ja
status	enum	Der Status der Nachrichteneingabe. Einer von `in_progress`, , `completed`oder `incomplete`. Befüllt, wenn Eingabeelemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	Ja
type	enum	Der Typ der Ausgabemeldung. Immer `message`. Mögliche Werte: `output_message`	Ja

OpenAI.OutputItemReasoningItem

Reasoning

Name	Typ	Description	Required
Inhalt	Array von OpenAI.ReasoningTextContent	Textinhalt wird mit Gründen versehen.	No
encrypted_content	Zeichenfolge oder null		No
id	Schnur	Der eindeutige Bezeichner des Argumentationsinhalts.	Ja
status	enum	Der Status des Elements. Einer von `in_progress`, , `completed`oder `incomplete`. Wird ausgefüllt, wenn Elemente über die API zurückgegeben werden. Mögliche Werte: `in_progress`, , `completedincomplete`	No
summary	Array von OpenAI.ZusammenfassungTextInhalt	Zusammenfassungsinhalt der Gründe.	Ja
type	enum	Der Typ des Objekts. Immer `reasoning`. Mögliche Werte: `reasoning`	Ja

OpenAI.OutputItemToolSearchCall

Name	Typ	Description	Required	Vorgabe
Argumente		Argumente, die für den Tool-Suchaufruf verwendet werden.	Ja
call_id	Zeichenfolge oder null		Ja
created_by	Schnur	Der Bezeichner des Akteurs, der das Element erstellt hat.	No
Ausführung	OpenAI.ToolSearchExecutionType		Ja
id	Schnur	Die eindeutige ID des Tool-Suchaufruf-Elements.	Ja
status	OpenAI.FunctionCallStatus		Ja
type	enum	Der Typ des Elements. Immer `tool_search_call`. Mögliche Werte: `tool_search_call`	Ja	tool_search_call

OpenAI.OutputItemToolSearchOutput

Name	Typ	Description	Required	Vorgabe
call_id	Zeichenfolge oder null		Ja
created_by	Schnur	Der Bezeichner des Akteurs, der das Element erstellt hat.	No
Ausführung	OpenAI.ToolSearchExecutionType		Ja
id	Schnur	Die eindeutige ID des Tool-Such-Output-Elements.	Ja
status	OpenAI.FunctionCallOutputStatusEnum		Ja
tools	Array von OpenAI.Tool	Die geladenen Werkzeugdefinitionen wurden durch die Werkzeugsuche zurückgegeben.	Ja
type	enum	Der Typ des Elements. Immer `tool_search_output`. Mögliche Werte: `tool_search_output`	Ja	tool_search_output

OpenAI.OutputItemType

Property Wert

Typ Schnur

Werte output_message
file_search_call
function_call
function_call_output
web_search_call
computer_call
computer_call_output
reasoning
tool_search_call
tool_search_output
compaction
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_call
mcp_list_tools
mcp_approval_request
mcp_approval_response
custom_tool_call
custom_tool_call_output
tool_approval_request

OpenAI.OutputItemWebSearchToolCall

Websuchwerkzeug-Aufruf

Die Ergebnisse eines Aufrufs eines Websuchtools.

Name	Typ	Description	Required
Aktion	OpenAI.WebSearchActionSearch oder OpenAI.WebSearchActionOpenPage oder OpenAI.WebSearchActionFind	Ein Objekt, das die spezifische Aktion beschreibt, die in diesem Websuchaufruf ausgeführt wird. Enthält Details darüber, wie das Modell das Web genutzt hat (Suche, open_page, find_in_page).	Ja
id	Schnur	Die eindeutige ID des Aufrufs des Websuchtools.	Ja
status	enum	Der Status des Aufrufs des Websuchtools. Mögliche Werte: `in_progress`, , `searching`, `completedfailed`	Ja
type	enum	Der Typ des Aufrufs des Websuchtools. Immer `web_search_call`. Mögliche Werte: `web_search_call`	Ja

OpenAI.OutputMessageContent

Diskriminator für OpenAI.OutputMessageContent

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

Typwert	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

Name	Typ	Description	Required	Vorgabe
type	OpenAI.OutputMessageContentType		Ja

OpenAI.OutputMessageContentOutputTextContent

Ausgabetext

Eine Textausgabe aus dem Modell.

Name	Typ	Description	Required	Vorgabe
annotations	Array von OpenAI.Annotation	Die Anmerkungen der Textausgabe	Ja
logprobs	Array von OpenAI.LogProb		Ja
Text	Schnur	Die Textausgabe aus dem Modell.	Ja
type	enum	Der Typ des Ausgabetexts. Immer `output_text`. Mögliche Werte: `output_text`	Ja	output_text

OpenAI.OutputMessageContentRefusalContent

Refusal

Eine Ablehnung des Modells

Name	Typ	Description	Required	Vorgabe
Weigerung	Schnur	Die Erklärung der Ablehnung des Modells	Ja
type	enum	Die Art der Ablehnung. Immer `refusal`. Mögliche Werte: `refusal`	Ja	Weigerung

OpenAI.OutputMessageContentType

Property	Wert
Typ	Schnur
Werte	`output_text` `refusal`

OpenAI.Prompt

Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.

Name	Typ	Description	Required
id	Schnur	Der eindeutige Bezeichner der zu verwendenden Eingabeaufforderungsvorlage.	Ja
variables	OpenAI.ResponsePromptVariables oder NULL		No
version	Zeichenfolge oder null		No

OpenAI.RankerVersionType

Property	Wert
Typ	Schnur
Werte	`auto` `default-2024-11-15`

OpenAI.RankingOptions

Name	Typ	Description	Required
hybrid_search	OpenAI.HybridSearchOptions		No
└– embedding_weight	Zahl	Das Gewicht der Einbettung in die gegenseitigen Rangfolgenfusion.	Ja
└– text_weight	Zahl	Die Gewichtung des Texts in der gegenseitigen Rangfolgenfusion.	Ja
Bewerter	OpenAI.RankerVersionType		No
score-threshold	Zahl	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.RealtimeMCPError

Discriminator für OpenAI.RealtimeMCPError

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

Typwert	Schema
`protocol_error`	OpenAI.RealtimeMCPProtocolError
`tool_execution_error`	OpenAI.RealtimeMCPToolExecutionError
`http_error`	OpenAI.RealtimeMCPHTTPError

Name	Typ	Description	Required	Vorgabe
type	OpenAI.RealtimeMcpErrorType		Ja

OpenAI.RealtimeMCPHTTPError

Echtzeit-MCP-HTTP-Fehler

Name	Typ	Description	Required
Programmcode	integer		Ja
message	Schnur		Ja
type	enum	Mögliche Werte: `http_error`	Ja

OpenAI.RealtimeMCPProtocolError

Echtzeit-MCP-Protokollfehler

Name	Typ	Description	Required
Programmcode	integer		Ja
message	Schnur		Ja
type	enum	Mögliche Werte: `protocol_error`	Ja

OpenAI.RealtimeMCPToolExecutionError

Echtzeit-Fehler bei der Ausführung des MCP-Tools

Name	Typ	Description	Required	Vorgabe
message	Schnur		Ja
type	enum	Mögliche Werte: `tool_execution_error`	Ja

OpenAI.RealtimeMcpErrorType

Property	Wert
Typ	Schnur
Werte	`protocol_error` `tool_execution_error` `http_error`

OpenAI.Reasoning

Reasoning

nur gpt-5- und o-Series-Modelle Konfigurationsoptionen für Begründungsmodelle.

Name	Typ	Description	Required
effort	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
generate_summary	Zeichenfolge oder null		No
summary	Zeichenfolge oder null		No

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	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`.
Typ	Schnur
Werte	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

Begründungstext

Grundierungstext aus dem Modell.

Name	Typ	Description	Required	Vorgabe
Text	Schnur	Der Begründungstext aus dem Modell.	Ja
type	enum	Der Typ des Begründungstexts. Immer `reasoning_text`. Mögliche Werte: `reasoning_text`	Ja	reasoning_text

OpenAI.Response

Das Antwortobjekt

Name	Typ	Description	Required	Vorgabe
Hintergrund	Boolescher Wert oder Null		No
abgeschlossen_am	Zeichenfolge oder null		No
content_filters	Array von AzureContentFilterForResponsesAPI	Der Inhaltsfilter ergibt sich aus RAI.	No
Gespräch	OpenAI.ConversationReference oder NULL		No
erstellt_am	Ganzzahl (Unixtime)	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
Fehler	OpenAI.ResponseError oder NULL		Ja
id	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
incomplete_details	OpenAI.ResponseIncompleteDetails oder NULL		Ja
instructions	Zeichenfolge oder Array von OpenAI.InputItem oder NULL		Ja
max_output_tokens	ganze Zahl oder Null		No
max_tool_calls	ganze Zahl oder Null		No
metadata	OpenAI.Metadata oder NULL		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. Siehe die Modellanleitung um verfügbare Modelle zu durchsuchen und zu vergleichen.	No
Objekt	enum	Der Objekttyp dieser Ressource, immer auf `response` festgelegt. Mögliche Werte: `response`	Ja
Ausgabe	Array von OpenAI.OutputItem	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array ist abhängig von der Antwort des Modells. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant`-Nachricht mit dem Inhalt handelt, der vom Modell generiert wurde, können Sie ggf. die Eigenschaft `output_text` verwenden, sofern dies in SDKs unterstützt wird.	Ja
output_text	Zeichenfolge oder null		No
Parallele Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
previous_response_id	Zeichenfolge oder null		No
Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	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.	No
prompt_cache_retention	Zeichenfolge oder null		No
reasoning	OpenAI.Reasoning oder NULL		No
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 Zeichenkette sein, die jeden Benutzer eindeutig identifiziert, mit einer maximalen Länge von 64 Zeichen. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Einschränkungen: maxLänge: 64	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	Zahl oder Null		No
Text	OpenAI.ResponseTextParam	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann einfach sein Text- oder strukturierte JSON-Daten. Erfahren Sie mehr: - Texteingaben und -ausgaben - Strukturierte Ausgaben	No
tool_choice	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	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. Wir unterstützen die folgenden Kategorien von Tools: - Integrierte Tools: Tools, die von OpenAI zur Erweiterung von Funktionen bereitgestellt werden Die Fähigkeiten des Modells, wie die Websuche, Oder Dateisuche. Weitere Informationen zu eingebaute Werkzeuge. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Werkzeuge. - Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, Aktivieren des Modells zum Aufrufen ihres eigenen Codes mit stark typierten Argumenten und Ausgaben. Weitere Informationen zu Funktionsaufruf. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
top_logprobs	ganze Zahl oder Null		No
top_p	Zahl oder Null		No
truncation	Zeichenfolge oder null		No
usage	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails dar, einschließlich Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken.	No
user	Zeichenfolge (veraltet)	Dieses Feld wird durch `safety_identifier` und `prompt_cache_key`. Verwenden Sie `prompt_cache_key` stattdessen die Zwischenspeicherungsoptimierungen. Ein stabiler Bezeichner für Ihre Endbenutzer. Wird verwendet, um Die Trefferraten des Caches zu erhöhen, indem ähnliche Anforderungen besser zusammengefasst werden, und um OpenAI dabei zu helfen, Missbrauch zu erkennen und zu verhindern.	No

OpenAI.ResponseAudioDeltaEvent

Wird ausgegeben, wenn eine partielle Audioantwort vorhanden ist.

Name	Typ	Description	Required
delta	Schnur	Ein Block der Base64-codierten Antwortaudiobytes Einschränkungen: Codierung: base64	Ja
sequence_number	integer	Eine Sequenznummer für diesen Datenblock der Datenstromantwort.	Ja
type	enum	Typ des Ereignisses Immer `response.audio.delta`. Mögliche Werte: `response.audio.delta`	Ja

OpenAI.ResponseAudioDoneEvent

Wird ausgegeben, wenn die Audioantwort abgeschlossen ist.

Name	Typ	Description	Required	Vorgabe
sequence_number	integer	Die Sequenznummer des Deltas.	Ja
type	enum	Typ des Ereignisses Immer `response.audio.done`. Mögliche Werte: `response.audio.done`	Ja

OpenAI.ResponseAudioTranscriptDeltaEvent

Wird ausgegeben, wenn eine partielle Transkription von Audio vorhanden ist.

Name	Typ	Description	Required
delta	Schnur	Die partielle Transkription der Audioantwort.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer `response.audio.transcript.delta`. Mögliche Werte: `response.audio.transcript.delta`	Ja

OpenAI.ResponseAudioTranscriptDoneEvent

Wird ausgegeben, wenn die vollständige Audiotranskription abgeschlossen ist.

Name	Typ	Description	Required	Vorgabe
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer `response.audio.transcript.done`. Mögliche Werte: `response.audio.transcript.done`	Ja

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

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

Name	Typ	Description	Required
delta	Schnur	Der partielle Codeausschnitt, der vom Codedolmetscher gestreamt wird.	Ja
item_id	Schnur	Der eindeutige Bezeichner des Codedolmetscher-Toolaufrufelements.	Ja
output_index	integer	Der Index des Ausgabeelements in der Antwort, für die der Code gestreamt wird.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses, die zum Sortieren von Streamingereignissen verwendet wird.	Ja
type	enum	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	Description	Required
Programmcode	Schnur	Die endgültige Ausgabe des Codeausschnitts durch den Code-Interpreter.	Ja
item_id	Schnur	Der eindeutige Bezeichner des Codedolmetscher-Toolaufrufelements.	Ja
output_index	integer	Der Index des Ausgabeelements in der Antwort, für die der Code abgeschlossen ist.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses, die zum Sortieren von Streamingereignissen verwendet wird.	Ja
type	enum	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	Description	Required
item_id	Schnur	Der eindeutige Bezeichner des Codedolmetscher-Toolaufrufelements.	Ja
output_index	integer	Der Index des Ausgabeelements in der Antwort, für die der Codedolmetscheraufruf abgeschlossen ist.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses, die zum Sortieren von Streamingereignissen verwendet wird.	Ja
type	enum	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	Description	Required
item_id	Schnur	Der eindeutige Bezeichner des Codedolmetscher-Toolaufrufelements.	Ja
output_index	integer	Der Index des Ausgabeelements in der Antwort, für die der Codedolmetscheraufruf ausgeführt wird.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses, die zum Sortieren von Streamingereignissen verwendet wird.	Ja
type	enum	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	Description	Required
item_id	Schnur	Der eindeutige Bezeichner des Codedolmetscher-Toolaufrufelements.	Ja
output_index	integer	Der Index des Ausgabeelements in der Antwort, für die der Codedolmetscher Code interpretiert.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses, die zum Sortieren von Streamingereignissen verwendet wird.	Ja
type	enum	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	Description	Required	Vorgabe
response	OpenAI.Response		Ja
└– Hintergrund	Boolescher Wert oder Null		No
└– completed_at	String oder Null (unixTimestamp)		No
└- content_filters	Array von AzureContentFilterForResponsesAPI	Der Inhaltsfilter ergibt sich aus RAI.	No
└– Unterhaltung	OpenAI.ConversationReference oder NULL		No
└– created_at	Ganzzahl (Unixtime)	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
└– Fehler	OpenAI.ResponseError oder NULL		Ja
└– ID	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
└─ unvollständige_Details	OpenAI.ResponseIncompleteDetails oder NULL		Ja
└– Anweisungen	Zeichenfolge oder Array von OpenAI.InputItem oder NULL		Ja
└– max_output_tokens	ganze Zahl oder Null		No
└– max_tool_calls	ganze Zahl oder Null		No
└- Metadaten	OpenAI.Metadata oder NULL		No
└─ Modell	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. Siehe die Modellanleitung um verfügbare Modelle zu durchsuchen und zu vergleichen.	No
└- Objekt	enum	Der Objekttyp dieser Ressource, immer auf `response` festgelegt. Mögliche Werte: `response`	Ja
└─ Ausgabe	Array von OpenAI.OutputItem	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array ist abhängig von der Antwort des Modells. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant`-Nachricht mit dem Inhalt handelt, der vom Modell generiert wurde, können Sie ggf. die Eigenschaft `output_text` verwenden, sofern dies in SDKs unterstützt wird.	Ja
└─ Ausgabentext	Zeichenfolge oder null		No
└─ parallele_Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
└– vorherige_Antwort_ID	Zeichenfolge oder null		No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	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.	No
└– prompt_cache_retention	Zeichenfolge oder null		No
└– Begründung	OpenAI.Reasoning oder NULL		No
└– 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 Zeichenkette sein, die jeden Benutzer eindeutig identifiziert, mit einer maximalen Länge von 64 Zeichen. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Einschränkungen: maxLänge: 64	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	Zahl oder Null		No	1
└– Text	OpenAI.ResponseTextParam	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann einfach sein Text- oder strukturierte JSON-Daten. Erfahren Sie mehr: - Texteingaben und -ausgaben - Strukturierte Ausgaben	No
└─ Werkzeugwahl	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceParam		No
└- Werkzeuge	OpenAI.ToolsArray	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. Wir unterstützen die folgenden Kategorien von Tools: - Integrierte Tools: Tools, die von OpenAI zur Erweiterung von Funktionen bereitgestellt werden Die Fähigkeiten des Modells, wie die Websuche, Oder Dateisuche. Weitere Informationen zu eingebaute Werkzeuge. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Werkzeuge. - Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, Aktivieren des Modells zum Aufrufen ihres eigenen Codes mit stark typierten Argumenten und Ausgaben. Weitere Informationen zu Funktionsaufruf. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
└– top_logprobs	ganze Zahl oder Null		No
└– top_p	Zahl oder Null		No	1
└– Abschneiden	Zeichenfolge oder null		No	disabled
└– Nutzung	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails dar, einschließlich Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken.	No
└– Benutzer	Zeichenfolge (veraltet)	Dieses Feld wird durch `safety_identifier` und `prompt_cache_key`. Verwenden Sie `prompt_cache_key` stattdessen die Zwischenspeicherungsoptimierungen. Ein stabiler Bezeichner für Ihre Endbenutzer. Wird verwendet, um Die Trefferraten des Caches zu erhöhen, indem ähnliche Anforderungen besser zusammengefasst werden, und um OpenAI dabei zu helfen, Missbrauch zu erkennen und zu verhindern.	No
sequence_number	integer	Die Sequenznummer für dieses Ereignis.	Ja
type	enum	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	Description	Required
content_index	integer	Der Index des hinzugefügten Inhaltsteils.	Ja
item_id	Schnur	Die ID des Ausgabeelements, dem der Inhaltsteil hinzugefügt wurde.	Ja
output_index	integer	Der Index des Ausgabeelements, dem der Inhaltsteil hinzugefügt wurde.	Ja
part	OpenAI.OutputContent		Ja
└– Typ	OpenAI.OutputContentType		Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	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	Description	Required
content_index	integer	Der Index des Inhaltsteils, der abgeschlossen ist.	Ja
item_id	Schnur	Die ID des Ausgabeelements, dem der Inhaltsteil hinzugefügt wurde.	Ja
output_index	integer	Der Index des Ausgabeelements, dem der Inhaltsteil hinzugefügt wurde.	Ja
part	OpenAI.OutputContent		Ja
└– Typ	OpenAI.OutputContentType		Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	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	Description	Required	Vorgabe
response	OpenAI.Response		Ja
└– Hintergrund	Boolescher Wert oder Null		No
└– completed_at	String oder Null (unixTimestamp)		No
└- content_filters	Array von AzureContentFilterForResponsesAPI	Der Inhaltsfilter ergibt sich aus RAI.	No
└– Unterhaltung	OpenAI.ConversationReference oder NULL		No
└– created_at	Ganzzahl (Unixtime)	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
└– Fehler	OpenAI.ResponseError oder NULL		Ja
└– ID	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
└─ unvollständige_Details	OpenAI.ResponseIncompleteDetails oder NULL		Ja
└– Anweisungen	Zeichenfolge oder Array von OpenAI.InputItem oder NULL		Ja
└– max_output_tokens	ganze Zahl oder Null		No
└– max_tool_calls	ganze Zahl oder Null		No
└- Metadaten	OpenAI.Metadata oder NULL		No
└─ Modell	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. Siehe die Modellanleitung um verfügbare Modelle zu durchsuchen und zu vergleichen.	No
└- Objekt	enum	Der Objekttyp dieser Ressource, immer auf `response` festgelegt. Mögliche Werte: `response`	Ja
└─ Ausgabe	Array von OpenAI.OutputItem	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array ist abhängig von der Antwort des Modells. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant`-Nachricht mit dem Inhalt handelt, der vom Modell generiert wurde, können Sie ggf. die Eigenschaft `output_text` verwenden, sofern dies in SDKs unterstützt wird.	Ja
└─ Ausgabentext	Zeichenfolge oder null		No
└─ parallele_Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
└– vorherige_Antwort_ID	Zeichenfolge oder null		No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	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.	No
└– prompt_cache_retention	Zeichenfolge oder null		No
└– Begründung	OpenAI.Reasoning oder NULL		No
└– 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 Zeichenkette sein, die jeden Benutzer eindeutig identifiziert, mit einer maximalen Länge von 64 Zeichen. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Einschränkungen: maxLänge: 64	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	Zahl oder Null		No	1
└– Text	OpenAI.ResponseTextParam	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann einfach sein Text- oder strukturierte JSON-Daten. Erfahren Sie mehr: - Texteingaben und -ausgaben - Strukturierte Ausgaben	No
└─ Werkzeugwahl	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceParam		No
└- Werkzeuge	OpenAI.ToolsArray	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. Wir unterstützen die folgenden Kategorien von Tools: - Integrierte Tools: Tools, die von OpenAI zur Erweiterung von Funktionen bereitgestellt werden Die Fähigkeiten des Modells, wie die Websuche, Oder Dateisuche. Weitere Informationen zu eingebaute Werkzeuge. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Werkzeuge. - Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, Aktivieren des Modells zum Aufrufen ihres eigenen Codes mit stark typierten Argumenten und Ausgaben. Weitere Informationen zu Funktionsaufruf. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
└– top_logprobs	ganze Zahl oder Null		No
└– top_p	Zahl oder Null		No	1
└– Abschneiden	Zeichenfolge oder null		No	disabled
└– Nutzung	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails dar, einschließlich Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken.	No
└– Benutzer	Zeichenfolge (veraltet)	Dieses Feld wird durch `safety_identifier` und `prompt_cache_key`. Verwenden Sie `prompt_cache_key` stattdessen die Zwischenspeicherungsoptimierungen. Ein stabiler Bezeichner für Ihre Endbenutzer. Wird verwendet, um Die Trefferraten des Caches zu erhöhen, indem ähnliche Anforderungen besser zusammengefasst werden, und um OpenAI dabei zu helfen, Missbrauch zu erkennen und zu verhindern.	No
sequence_number	integer	Die Sequenznummer für dieses Ereignis.	Ja
type	enum	Typ des Ereignisses Immer `response.created`. Mögliche Werte: `response.created`	Ja

OpenAI.ResponseCustomToolCallInputDeltaEvent

ResponseCustomToolCallInputDelta

Ereignis, das ein Delta (partielle Aktualisierung) für die Eingabe eines benutzerdefinierten Toolaufrufs darstellt.

Name	Typ	Description	Required
delta	Schnur	Die inkrementellen Eingabedaten (Delta) für den benutzerdefinierten Toolaufruf.	Ja
item_id	Schnur	Eindeutiger Bezeichner für das API-Element, das diesem Ereignis zugeordnet ist.	Ja
output_index	integer	Der Index der Ausgabe, auf die dieses Delta angewendet wird.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Der Ereignistypbezeichner. Mögliche Werte: `response.custom_tool_call_input.delta`	Ja

OpenAI.ResponseCustomToolCallInputDoneEvent

ResponseCustomToolCallInputDone

Ereignis, das angibt, dass die Eingabe für einen benutzerdefinierten Toolaufruf abgeschlossen ist.

Name	Typ	Description	Required
input	Schnur	Die vollständigen Eingabedaten für den benutzerdefinierten Toolaufruf.	Ja
item_id	Schnur	Eindeutiger Bezeichner für das API-Element, das diesem Ereignis zugeordnet ist.	Ja
output_index	integer	Der Index der Ausgabe, auf die dieses Ereignis gilt.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Der Ereignistypbezeichner. Mögliche Werte: `response.custom_tool_call_input.done`	Ja

OpenAI.ResponseError

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

Name	Typ	Description	Required	Vorgabe
Programmcode	OpenAI.ResponseErrorCode	Der Fehlercode für die Antwort.	Ja
message	Schnur	Eine lesbare Beschreibung des Fehlers.	Ja

OpenAI.ResponseErrorCode

Der Fehlercode für die Antwort.

Property	Wert
Typ	Schnur
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	Description	Required
Programmcode	Zeichenfolge oder null		Ja
message	Schnur	Die Fehlermeldung.	Ja
param	Zeichenfolge oder null		Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer `error`. Mögliche Werte: `error`	Ja

OpenAI.ResponseFailedEvent

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

Name	Typ	Description	Required	Vorgabe
response	OpenAI.Response		Ja
└– Hintergrund	Boolescher Wert oder Null		No
└– completed_at	String oder Null (unixTimestamp)		No
└- content_filters	Array von AzureContentFilterForResponsesAPI	Der Inhaltsfilter ergibt sich aus RAI.	No
└– Unterhaltung	OpenAI.ConversationReference oder NULL		No
└– created_at	Ganzzahl (Unixtime)	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
└– Fehler	OpenAI.ResponseError oder NULL		Ja
└– ID	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
└─ unvollständige_Details	OpenAI.ResponseIncompleteDetails oder NULL		Ja
└– Anweisungen	Zeichenfolge oder Array von OpenAI.InputItem oder NULL		Ja
└– max_output_tokens	ganze Zahl oder Null		No
└– max_tool_calls	ganze Zahl oder Null		No
└- Metadaten	OpenAI.Metadata oder NULL		No
└─ Modell	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. Siehe die Modellanleitung um verfügbare Modelle zu durchsuchen und zu vergleichen.	No
└- Objekt	enum	Der Objekttyp dieser Ressource, immer auf `response` festgelegt. Mögliche Werte: `response`	Ja
└─ Ausgabe	Array von OpenAI.OutputItem	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array ist abhängig von der Antwort des Modells. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant`-Nachricht mit dem Inhalt handelt, der vom Modell generiert wurde, können Sie ggf. die Eigenschaft `output_text` verwenden, sofern dies in SDKs unterstützt wird.	Ja
└─ Ausgabentext	Zeichenfolge oder null		No
└─ parallele_Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
└– vorherige_Antwort_ID	Zeichenfolge oder null		No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	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.	No
└– prompt_cache_retention	Zeichenfolge oder null		No
└– Begründung	OpenAI.Reasoning oder NULL		No
└– 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 Zeichenkette sein, die jeden Benutzer eindeutig identifiziert, mit einer maximalen Länge von 64 Zeichen. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Einschränkungen: maxLänge: 64	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	Zahl oder Null		No	1
└– Text	OpenAI.ResponseTextParam	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann einfach sein Text- oder strukturierte JSON-Daten. Erfahren Sie mehr: - Texteingaben und -ausgaben - Strukturierte Ausgaben	No
└─ Werkzeugwahl	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceParam		No
└- Werkzeuge	OpenAI.ToolsArray	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. Wir unterstützen die folgenden Kategorien von Tools: - Integrierte Tools: Tools, die von OpenAI zur Erweiterung von Funktionen bereitgestellt werden Die Fähigkeiten des Modells, wie die Websuche, Oder Dateisuche. Weitere Informationen zu eingebaute Werkzeuge. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Werkzeuge. - Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, Aktivieren des Modells zum Aufrufen ihres eigenen Codes mit stark typierten Argumenten und Ausgaben. Weitere Informationen zu Funktionsaufruf. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
└– top_logprobs	ganze Zahl oder Null		No
└– top_p	Zahl oder Null		No	1
└– Abschneiden	Zeichenfolge oder null		No	disabled
└– Nutzung	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails dar, einschließlich Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken.	No
└– Benutzer	Zeichenfolge (veraltet)	Dieses Feld wird durch `safety_identifier` und `prompt_cache_key`. Verwenden Sie `prompt_cache_key` stattdessen die Zwischenspeicherungsoptimierungen. Ein stabiler Bezeichner für Ihre Endbenutzer. Wird verwendet, um Die Trefferraten des Caches zu erhöhen, indem ähnliche Anforderungen besser zusammengefasst werden, und um OpenAI dabei zu helfen, Missbrauch zu erkennen und zu verhindern.	No
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	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	Description	Required
item_id	Schnur	Die ID des Ausgabeelements, mit der der Dateisuchaufruf initiiert wird.	Ja
output_index	integer	Der Index des Ausgabeelements, dass der Dateisuchaufruf initiiert wurde	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	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	Description	Required
item_id	Schnur	Die ID des Ausgabeelements, mit der der Dateisuchaufruf initiiert wird.	Ja
output_index	integer	Der Index des Ausgabeelements, dass der Dateisuchaufruf initiiert wurde	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	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 aktuell ausgeführt wird.

Name	Typ	Description	Required
item_id	Schnur	Die ID des Ausgabeelements, mit der der Dateisuchaufruf initiiert wird.	Ja
output_index	integer	Der Index des Ausgabeelements, das der Dateisuchaufruf sucht.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer `response.file_search_call.searching`. Mögliche Werte: `response.file_search_call.searching`	Ja

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

Wird ausgegeben, wenn ein partielles Argumentdelta eines Funktionsaufrufs vorhanden ist.

Name	Typ	Description	Required
delta	Schnur	Das hinzugefügte Argumentdelta des Funktionsaufrufs	Ja
item_id	Schnur	Die ID des Ausgabeelements, dem die Funktionsaufrufargumente delta hinzugefügt werden.	Ja
output_index	integer	Der Index des Ausgabeelements, dem das Argumentdelta des Funktionsaufrufs hinzugefügt wird	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer `response.function_call_arguments.delta`. Mögliche Werte: `response.function_call_arguments.delta`	Ja

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Wird ausgegeben, wenn Funktionsaufrufargumente finalisiert werden.

Name	Typ	Description	Required
Argumente	Schnur	Die Funktionsaufrufargumente.	Ja
item_id	Schnur	Die ID des Elements.	Ja
Name	Schnur	Der Name der Veranstaltung, die genannt wurde.	Ja
output_index	integer	Der Index des Ausgabeelements.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Mögliche Werte: `response.function_call_arguments.done`	Ja

OpenAI.ResponseImageGenCallCompletedEvent

ResponseImageGenCallCompletedEvent

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

Name	Typ	Description	Required
item_id	Schnur	Der eindeutige Bezeichner des verarbeiteten Bildgenerierungselements.	Ja
output_index	integer	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer „response.image_generation_call.completed”. Mögliche Werte: `response.image_generation_call.completed`	Ja

OpenAI.ResponseImageGenCallGeneratingEvent

ResponseImageGenCallGenerratingEvent

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

Name	Typ	Description	Required
item_id	Schnur	Der eindeutige Bezeichner des verarbeiteten Bildgenerierungselements.	Ja
output_index	integer	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
sequence_number	integer	Die Sequenznummer des verarbeiteten Bildgenerierungselements.	Ja
type	enum	Typ des Ereignisses Immer „response.image_generation_call.generating. Mögliche Werte: `response.image_generation_call.generating`	Ja

OpenAI.ResponseImageGenCallInProgressEvent

ResponseImageGenCallInProgressEvent

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

Name	Typ	Description	Required
item_id	Schnur	Der eindeutige Bezeichner des verarbeiteten Bildgenerierungselements.	Ja
output_index	integer	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
sequence_number	integer	Die Sequenznummer des verarbeiteten Bildgenerierungselements.	Ja
type	enum	Typ des Ereignisses Immer „response.image_generation_call.in_progress”. Mögliche Werte: `response.image_generation_call.in_progress`	Ja

OpenAI.ResponseImageGenCallPartialImageEvent

ResponseImageGenCallPartialImageEvent

Wird ausgegeben, wenn ein Teilbild während des Bildgenerierungsstreamings verfügbar ist.

Name	Typ	Description	Required
item_id	Schnur	Der eindeutige Bezeichner des verarbeiteten Bildgenerierungselements.	Ja
output_index	integer	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
partial_image_b64	Schnur	Base64-codierte Teilbilddaten, die für das Rendern als Bild geeignet sind.	Ja
partial_image_index	integer	0-basierter Index für das Teilbild (Back-End ist 1-basiert, dies ist jedoch 0-basiert für den Benutzer).	Ja
sequence_number	integer	Die Sequenznummer des verarbeiteten Bildgenerierungselements.	Ja
type	enum	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 derzeit verarbeitet wird.

Name	Typ	Description	Required	Vorgabe
response	OpenAI.Response		Ja
└– Hintergrund	Boolescher Wert oder Null		No
└– completed_at	String oder Null (unixTimestamp)		No
└- content_filters	Array von AzureContentFilterForResponsesAPI	Der Inhaltsfilter ergibt sich aus RAI.	No
└– Unterhaltung	OpenAI.ConversationReference oder NULL		No
└– created_at	Ganzzahl (Unixtime)	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
└– Fehler	OpenAI.ResponseError oder NULL		Ja
└– ID	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
└─ unvollständige_Details	OpenAI.ResponseIncompleteDetails oder NULL		Ja
└– Anweisungen	Zeichenfolge oder Array von OpenAI.InputItem oder NULL		Ja
└– max_output_tokens	ganze Zahl oder Null		No
└– max_tool_calls	ganze Zahl oder Null		No
└- Metadaten	OpenAI.Metadata oder NULL		No
└─ Modell	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. Siehe die Modellanleitung um verfügbare Modelle zu durchsuchen und zu vergleichen.	No
└- Objekt	enum	Der Objekttyp dieser Ressource, immer auf `response` festgelegt. Mögliche Werte: `response`	Ja
└─ Ausgabe	Array von OpenAI.OutputItem	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array ist abhängig von der Antwort des Modells. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant`-Nachricht mit dem Inhalt handelt, der vom Modell generiert wurde, können Sie ggf. die Eigenschaft `output_text` verwenden, sofern dies in SDKs unterstützt wird.	Ja
└─ Ausgabentext	Zeichenfolge oder null		No
└─ parallele_Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
└– vorherige_Antwort_ID	Zeichenfolge oder null		No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	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.	No
└– prompt_cache_retention	Zeichenfolge oder null		No
└– Begründung	OpenAI.Reasoning oder NULL		No
└– 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 Zeichenkette sein, die jeden Benutzer eindeutig identifiziert, mit einer maximalen Länge von 64 Zeichen. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Einschränkungen: maxLänge: 64	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	Zahl oder Null		No	1
└– Text	OpenAI.ResponseTextParam	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann einfach sein Text- oder strukturierte JSON-Daten. Erfahren Sie mehr: - Texteingaben und -ausgaben - Strukturierte Ausgaben	No
└─ Werkzeugwahl	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceParam		No
└- Werkzeuge	OpenAI.ToolsArray	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. Wir unterstützen die folgenden Kategorien von Tools: - Integrierte Tools: Tools, die von OpenAI zur Erweiterung von Funktionen bereitgestellt werden Die Fähigkeiten des Modells, wie die Websuche, Oder Dateisuche. Weitere Informationen zu eingebaute Werkzeuge. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Werkzeuge. - Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, Aktivieren des Modells zum Aufrufen ihres eigenen Codes mit stark typierten Argumenten und Ausgaben. Weitere Informationen zu Funktionsaufruf. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
└– top_logprobs	ganze Zahl oder Null		No
└– top_p	Zahl oder Null		No	1
└– Abschneiden	Zeichenfolge oder null		No	disabled
└– Nutzung	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails dar, einschließlich Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken.	No
└– Benutzer	Zeichenfolge (veraltet)	Dieses Feld wird durch `safety_identifier` und `prompt_cache_key`. Verwenden Sie `prompt_cache_key` stattdessen die Zwischenspeicherungsoptimierungen. Ein stabiler Bezeichner für Ihre Endbenutzer. Wird verwendet, um Die Trefferraten des Caches zu erhöhen, indem ähnliche Anforderungen besser zusammengefasst werden, und um OpenAI dabei zu helfen, Missbrauch zu erkennen und zu verhindern.	No
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer `response.in_progress`. Mögliche Werte: `response.in_progress`	Ja

OpenAI.ResponseIncompleteDetails

Name	Typ	Description	Required	Vorgabe
Grund	enum	Mögliche Werte: `max_output_tokens`, `content_filter`	No

OpenAI.ResponseIncompleteEvent

Ein Ereignis, das ausgelöst wird, wenn eine Antwort als unvollständig beendet wird.

Name	Typ	Description	Required	Vorgabe
response	OpenAI.Response		Ja
└– Hintergrund	Boolescher Wert oder Null		No
└– completed_at	String oder Null (unixTimestamp)		No
└- content_filters	Array von AzureContentFilterForResponsesAPI	Der Inhaltsfilter ergibt sich aus RAI.	No
└– Unterhaltung	OpenAI.ConversationReference oder NULL		No
└– created_at	Ganzzahl (Unixtime)	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
└– Fehler	OpenAI.ResponseError oder NULL		Ja
└– ID	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
└─ unvollständige_Details	OpenAI.ResponseIncompleteDetails oder NULL		Ja
└– Anweisungen	Zeichenfolge oder Array von OpenAI.InputItem oder NULL		Ja
└– max_output_tokens	ganze Zahl oder Null		No
└– max_tool_calls	ganze Zahl oder Null		No
└- Metadaten	OpenAI.Metadata oder NULL		No
└─ Modell	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. Siehe die Modellanleitung um verfügbare Modelle zu durchsuchen und zu vergleichen.	No
└- Objekt	enum	Der Objekttyp dieser Ressource, immer auf `response` festgelegt. Mögliche Werte: `response`	Ja
└─ Ausgabe	Array von OpenAI.OutputItem	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array ist abhängig von der Antwort des Modells. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant`-Nachricht mit dem Inhalt handelt, der vom Modell generiert wurde, können Sie ggf. die Eigenschaft `output_text` verwenden, sofern dies in SDKs unterstützt wird.	Ja
└─ Ausgabentext	Zeichenfolge oder null		No
└─ parallele_Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
└– vorherige_Antwort_ID	Zeichenfolge oder null		No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	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.	No
└– prompt_cache_retention	Zeichenfolge oder null		No
└– Begründung	OpenAI.Reasoning oder NULL		No
└– 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 Zeichenkette sein, die jeden Benutzer eindeutig identifiziert, mit einer maximalen Länge von 64 Zeichen. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Einschränkungen: maxLänge: 64	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	Zahl oder Null		No	1
└– Text	OpenAI.ResponseTextParam	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann einfach sein Text- oder strukturierte JSON-Daten. Erfahren Sie mehr: - Texteingaben und -ausgaben - Strukturierte Ausgaben	No
└─ Werkzeugwahl	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceParam		No
└- Werkzeuge	OpenAI.ToolsArray	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. Wir unterstützen die folgenden Kategorien von Tools: - Integrierte Tools: Tools, die von OpenAI zur Erweiterung von Funktionen bereitgestellt werden Die Fähigkeiten des Modells, wie die Websuche, Oder Dateisuche. Weitere Informationen zu eingebaute Werkzeuge. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Werkzeuge. - Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, Aktivieren des Modells zum Aufrufen ihres eigenen Codes mit stark typierten Argumenten und Ausgaben. Weitere Informationen zu Funktionsaufruf. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
└– top_logprobs	ganze Zahl oder Null		No
└– top_p	Zahl oder Null		No	1
└– Abschneiden	Zeichenfolge oder null		No	disabled
└– Nutzung	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails dar, einschließlich Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken.	No
└– Benutzer	Zeichenfolge (veraltet)	Dieses Feld wird durch `safety_identifier` und `prompt_cache_key`. Verwenden Sie `prompt_cache_key` stattdessen die Zwischenspeicherungsoptimierungen. Ein stabiler Bezeichner für Ihre Endbenutzer. Wird verwendet, um Die Trefferraten des Caches zu erhöhen, indem ähnliche Anforderungen besser zusammengefasst werden, und um OpenAI dabei zu helfen, Missbrauch zu erkennen und zu verhindern.	No
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer `response.incomplete`. Mögliche Werte: `response.incomplete`	Ja

OpenAI.ResponseItemList

Eine Liste der Antwortelemente.

Name	Typ	Description	Required
data	Array von OpenAI.ItemResource	Eine Liste der Elemente, die zum Generieren dieser Antwort verwendet werden.	Ja
first_id	Schnur	Die ID des ersten Elements in der Liste.	Ja
has_more	boolean	Gibt an, ob weitere Elemente verfügbar sind.	Ja
last_id	Schnur	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.ResponseLogProb

Ein Logprob ist die logarithmische Wahrscheinlichkeit, die das Modell der Erstellung eines bestimmten Tokens an einer bestimmten Position in der Sequenz zuweist. Weniger negative (höhere) Logprobwerte deuten auf eine höhere Modellvertrauensstufe in diese Tokenauswahl hin.

Name	Typ	Description	Required
logprob	Zahl	Die Protokollwahrscheinlichkeit dieses Tokens.	Ja
token	Schnur	Ein mögliches Texttoken.	Ja
top_logprobs	Array von OpenAI.ResponseLogProbTopLogprobs	Die Log-Wahrscheinlichkeiten von bis zu 20 der wahrscheinlichsten Token.	No

OpenAI.ResponseLogProbTopLogprobs

Name	Typ	Description	Required	Vorgabe
logprob	Zahl		No
token	Schnur		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

AntwortMCPCallArgumenteDeltaEvent

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

Name	Typ	Description	Required
delta	Schnur	Eine JSON-Zeichenfolge, die die teilweise Aktualisierung der Argumente für den MCP-Toolaufruf enthält.	Ja
item_id	Schnur	Der eindeutige Bezeichner des verarbeiteten MCP-Toolaufrufelements.	Ja
output_index	integer	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer "response.mcp_call_arguments.delta". Mögliche Werte: `response.mcp_call_arguments.delta`	Ja

OpenAI.ResponseMCPCallArgumentsDoneEvent

ResponseMCPCallArgumentsDoneEvent

Wird ausgelöst, wenn die Argumente für einen MCP-Toolaufruf endgültig festgelegt sind.

Name	Typ	Description	Required
Argumente	Schnur	Eine JSON-Zeichenfolge mit den abgeschlossenen Argumenten für den MCP-Toolaufruf.	Ja
item_id	Schnur	Der eindeutige Bezeichner des verarbeiteten MCP-Toolaufrufelements.	Ja
output_index	integer	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer "response.mcp_call_arguments.done". Mögliche Werte: `response.mcp_call_arguments.done`	Ja

OpenAI.ResponseMCPCallCompletedEvent

ResponseMCPCallCompletedEvent

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

Name	Typ	Description	Required
item_id	Schnur	Die ID des MCP-Toolaufrufelements, das abgeschlossen wurde.	Ja
output_index	integer	Der Index des abgeschlossenen Ausgabeelements.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer „response.mcp_call.completed“. Mögliche Werte: `response.mcp_call.completed`	Ja

OpenAI.ResponseMCPCallFailedEvent

AntwortMCPCallFailedEvent

Wird ausgegeben, wenn ein MCP-Toolaufruf fehlgeschlagen ist.

Name	Typ	Description	Required
item_id	Schnur	Die ID des MCP-Toolaufrufelements, das fehlgeschlagen ist.	Ja
output_index	integer	Der Index des Ausgabeelements, das fehlgeschlagen ist.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer „response.mcp_call.failed“. Mögliche Werte: `response.mcp_call.failed`	Ja

OpenAI.ResponseMCPCallInProgressEvent

ResponseMCPCallInProgressEvent

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

Name	Typ	Description	Required
item_id	Schnur	Der eindeutige Bezeichner des verarbeiteten MCP-Toolaufrufelements.	Ja
output_index	integer	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer „response.mcp_call.in_progress”. Mögliche Werte: `response.mcp_call.in_progress`	Ja

OpenAI.ResponseMCPListToolsCompletedEvent

ResponseMCPListToolsCompletedEvent

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

Name	Typ	Description	Required
item_id	Schnur	Die ID des MCP-Toolaufrufelements, das diese Ausgabe erzeugt hat.	Ja
output_index	integer	Der Index des verarbeiteten Ausgangselements.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer „response.mcp_list_tools.completed”. Mögliche Werte: `response.mcp_list_tools.completed`	Ja

OpenAI.ResponseMCPListToolsFailedEvent

ResponseMCPListToolsFailedEvent

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

Name	Typ	Description	Required
item_id	Schnur	Die ID des MCP-Toolaufrufelements, das fehlgeschlagen ist.	Ja
output_index	integer	Der Index des Ausgabeelements, das fehlgeschlagen ist.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer „response.mcp_list_tools.failed”. Mögliche Werte: `response.mcp_list_tools.failed`	Ja

OpenAI.ResponseMCPListToolsInProgressEvent

ResponseMCPListToolsInProgressEvent

Wird ausgegeben, wenn sich das System im Prozess des Abrufens der Liste der verfügbaren MCP-Tools befindet.

Name	Typ	Description	Required
item_id	Schnur	Die ID des MCP-Toolaufrufelements, das verarbeitet wird.	Ja
output_index	integer	Der Index des Ausgabeelements, das verarbeitet wird.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	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	Description	Required
item	OpenAI.OutputItem		Ja
└– Typ	OpenAI.OutputItemType		Ja
output_index	integer	Der Index des Ausgabeelements, das hinzugefügt wurde.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	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	Description	Required
item	OpenAI.OutputItem		Ja
└– Typ	OpenAI.OutputItemType		Ja
output_index	integer	Der Index des Ausgabeelements, das als erledigt markiert wurde.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer `response.output_item.done`. Mögliche Werte: `response.output_item.done`	Ja

OpenAI.ResponseOutputTextAnnotationAddedEvent

ResponseOutputTextAnnotationAddedEvent

Wird ausgegeben, wenn eine Anmerkung zum Ausgabetextinhalt hinzugefügt wird.

Name	Typ	Description	Required
Anmerkung	OpenAI.Annotation	Eine Anmerkung, die sich auf einen Bereich von Ausgabetext bezieht.	Ja
└– Typ	OpenAI.AnnotationType		Ja
annotation_index	integer	Der Index der Anmerkung innerhalb des Inhaltsteils.	Ja
content_index	integer	Der Index des Inhaltsteils innerhalb des Ausgabeelements.	Ja
item_id	Schnur	Der eindeutige Bezeichner des Elements, dem die Anmerkung hinzugefügt wird.	Ja
output_index	integer	Der Index des Ausgabeelements im Ausgabearray der Antwort.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer "response.output_text.annotation.added". Mögliche Werte: `response.output_text.annotation.added`	Ja

OpenAI.ResponsePromptVariables

Prompt-Variablen

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

ResponseQueuedEvent

Wird ausgegeben, wenn eine Antwort in die Warteschlange gestellt wird und darauf wartet, verarbeitet zu werden.

Name	Typ	Description	Required	Vorgabe
response	OpenAI.Response		Ja
└– Hintergrund	Boolescher Wert oder Null		No
└– completed_at	String oder Null (unixTimestamp)		No
└- content_filters	Array von AzureContentFilterForResponsesAPI	Der Inhaltsfilter ergibt sich aus RAI.	No
└– Unterhaltung	OpenAI.ConversationReference oder NULL		No
└– created_at	Ganzzahl (Unixtime)	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
└– Fehler	OpenAI.ResponseError oder NULL		Ja
└– ID	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
└─ unvollständige_Details	OpenAI.ResponseIncompleteDetails oder NULL		Ja
└– Anweisungen	Zeichenfolge oder Array von OpenAI.InputItem oder NULL		Ja
└– max_output_tokens	ganze Zahl oder Null		No
└– max_tool_calls	ganze Zahl oder Null		No
└- Metadaten	OpenAI.Metadata oder NULL		No
└─ Modell	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. Siehe die Modellanleitung um verfügbare Modelle zu durchsuchen und zu vergleichen.	No
└- Objekt	enum	Der Objekttyp dieser Ressource, immer auf `response` festgelegt. Mögliche Werte: `response`	Ja
└─ Ausgabe	Array von OpenAI.OutputItem	Ein Array von Inhaltselementen, die vom Modell generiert werden. - Die Länge und Reihenfolge der Elemente im `output` Array ist abhängig von der Antwort des Modells. – Anstatt auf das erste Element im `output` Array zuzugreifen und davon auszugehen, dass es sich um eine `assistant`-Nachricht mit dem Inhalt handelt, der vom Modell generiert wurde, können Sie ggf. die Eigenschaft `output_text` verwenden, sofern dies in SDKs unterstützt wird.	Ja
└─ Ausgabentext	Zeichenfolge oder null		No
└─ parallele_Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
└– vorherige_Antwort_ID	Zeichenfolge oder null		No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen.	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.	No
└– prompt_cache_retention	Zeichenfolge oder null		No
└– Begründung	OpenAI.Reasoning oder NULL		No
└– 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 Zeichenkette sein, die jeden Benutzer eindeutig identifiziert, mit einer maximalen Länge von 64 Zeichen. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Einschränkungen: maxLänge: 64	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	Zahl oder Null		No	1
└– Text	OpenAI.ResponseTextParam	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann einfach sein Text- oder strukturierte JSON-Daten. Erfahren Sie mehr: - Texteingaben und -ausgaben - Strukturierte Ausgaben	No
└─ Werkzeugwahl	OpenAI.ToolChoiceOptions oder OpenAI.ToolChoiceParam		No
└- Werkzeuge	OpenAI.ToolsArray	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. Wir unterstützen die folgenden Kategorien von Tools: - Integrierte Tools: Tools, die von OpenAI zur Erweiterung von Funktionen bereitgestellt werden Die Fähigkeiten des Modells, wie die Websuche, Oder Dateisuche. Weitere Informationen zu eingebaute Werkzeuge. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Werkzeuge. - Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, Aktivieren des Modells zum Aufrufen ihres eigenen Codes mit stark typierten Argumenten und Ausgaben. Weitere Informationen zu Funktionsaufruf. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
└– top_logprobs	ganze Zahl oder Null		No
└– top_p	Zahl oder Null		No	1
└– Abschneiden	Zeichenfolge oder null		No	disabled
└– Nutzung	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails dar, einschließlich Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken.	No
└– Benutzer	Zeichenfolge (veraltet)	Dieses Feld wird durch `safety_identifier` und `prompt_cache_key`. Verwenden Sie `prompt_cache_key` stattdessen die Zwischenspeicherungsoptimierungen. Ein stabiler Bezeichner für Ihre Endbenutzer. Wird verwendet, um Die Trefferraten des Caches zu erhöhen, indem ähnliche Anforderungen besser zusammengefasst werden, und um OpenAI dabei zu helfen, Missbrauch zu erkennen und zu verhindern.	No
sequence_number	integer	Die Sequenznummer für dieses Ereignis.	Ja
type	enum	Typ des Ereignisses Immer „response.queued”. Mögliche Werte: `response.queued`	Ja

OpenAI.ResponseReasoningSummaryPartAddedEvent

Wird ausgegeben, wenn ein neuer Zusammenfassungsteil für die Begründung hinzugefügt wird.

Name	Typ	Description	Required
item_id	Schnur	Die ID des Elements, dem dieser Zusammenfassungsteil zugeordnet ist.	Ja
output_index	integer	Der Index des Ausgabeelements, dem dieser Zusammenfassungsteil zugeordnet ist.	Ja
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Ja
└– Text	Schnur		Ja
└– Typ	enum	Mögliche Werte: `summary_text`	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
summary_index	integer	Der Index des zusammenfassenden Teils innerhalb der Begründungszusammenfassung.	Ja
type	enum	Typ des Ereignisses Immer `response.reasoning_summary_part.added`. Mögliche Werte: `response.reasoning_summary_part.added`	Ja

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Name	Typ	Description	Required	Vorgabe
Text	Schnur		Ja
type	enum	Mögliche Werte: `summary_text`	Ja

OpenAI.ResponseReasoningSummaryPartDoneEvent

Wird ausgelöst, wenn ein Teil der Argumentationszusammenfassung abgeschlossen ist.

Name	Typ	Description	Required
item_id	Schnur	Die ID des Elements, dem dieser Zusammenfassungsteil zugeordnet ist.	Ja
output_index	integer	Der Index des Ausgabeelements, dem dieser Zusammenfassungsteil zugeordnet ist.	Ja
part	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Ja
└– Text	Schnur		Ja
└– Typ	enum	Mögliche Werte: `summary_text`	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
summary_index	integer	Der Index des zusammenfassenden Teils innerhalb der Begründungszusammenfassung.	Ja
type	enum	Typ des Ereignisses Immer `response.reasoning_summary_part.done`. Mögliche Werte: `response.reasoning_summary_part.done`	Ja

OpenAI.ResponseReasoningSummaryPartDoneEventPart

Name	Typ	Description	Required	Vorgabe
Text	Schnur		Ja
type	enum	Mögliche Werte: `summary_text`	Ja

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Wird ausgegeben, wenn ein Delta zu einem Begründungszusammenfassungstext hinzugefügt wird.

Name	Typ	Description	Required
delta	Schnur	Das Textdelta, das der Zusammenfassung hinzugefügt wurde.	Ja
item_id	Schnur	Die ID des Elements, dem dieses Zusammenfassungstextdelta zugeordnet ist.	Ja
output_index	integer	Der Index des Ausgabeelements, dem dieses Zusammenfassungstextdelta zugeordnet ist.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
summary_index	integer	Der Index des zusammenfassenden Teils innerhalb der Begründungszusammenfassung.	Ja
type	enum	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	Description	Required
item_id	Schnur	Die ID des Elements, dem dieser Zusammenfassungstext zugeordnet ist.	Ja
output_index	integer	Der Index des Ausgabeelements, dem dieser Zusammenfassungstext zugeordnet ist.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
summary_index	integer	Der Index des zusammenfassenden Teils innerhalb der Begründungszusammenfassung.	Ja
Text	Schnur	Der vollständige Text der vollständigen Zusammenfassung der Begründung.	Ja
type	enum	Typ des Ereignisses Immer `response.reasoning_summary_text.done`. Mögliche Werte: `response.reasoning_summary_text.done`	Ja

OpenAI.ResponseReasoningTextDeltaEvent

Wird ausgegeben, wenn ein Delta einem Grundsatztext hinzugefügt wird.

Name	Typ	Description	Required
content_index	integer	Der Index des Grundinhaltsteils, dem dieses Delta zugeordnet ist.	Ja
delta	Schnur	Das Textdelta, das dem Grundinhalt hinzugefügt wurde.	Ja
item_id	Schnur	Die ID des Elements, dem dieses Grundtextdelta zugeordnet ist.	Ja
output_index	integer	Der Index des Ausgabeelements, dem dieses Grundtextdelta zugeordnet ist.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	Typ des Ereignisses Immer `response.reasoning_text.delta`. Mögliche Werte: `response.reasoning_text.delta`	Ja

OpenAI.ResponseReasoningTextDoneEvent

Wird ausgegeben, wenn ein Grundsatztext abgeschlossen ist.

Name	Typ	Description	Required
content_index	integer	Der Index des Argumentations-Inhalts.	Ja
item_id	Schnur	Die ID des Elements, dem dieser Grundtext zugeordnet ist.	Ja
output_index	integer	Der Index des Ausgabeelements, mit dem dieser Schlussfolgertext verknüpft ist.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
Text	Schnur	Der vollständige Text des vollständigen Begründungsinhalts.	Ja
type	enum	Typ des Ereignisses Immer `response.reasoning_text.done`. Mögliche Werte: `response.reasoning_text.done`	Ja

OpenAI.ResponseRefusalDeltaEvent

Wird ausgegeben, wenn ein Teilverweigerungstext vorhanden ist.

Name	Typ	Description	Required
content_index	integer	Der Index des Inhaltsteils, dem der Ablehnungstext hinzugefügt wird.	Ja
delta	Schnur	Der Verweigerungstext, der hinzugefügt wird.	Ja
item_id	Schnur	Die ID des Ausgabeelements, dem der Ablehnungstext hinzugefügt wird.	Ja
output_index	integer	Der Index des Ausgabeelements, dem der Ablehnungstext hinzugefügt wird.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	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	Description	Required
content_index	integer	Der Index des Inhaltsteils, dass der Ablehnungstext abgeschlossen wird	Ja
item_id	Schnur	Die ID des Ausgabeelements, bei dem der Ablehnungstext finalisiert wurde.	Ja
output_index	integer	Der Index des Ausgabeelements, dass der Ablehnungstext abgeschlossen wird	Ja
Weigerung	Schnur	Der endgültige Ablehnungstext.	Ja
sequence_number	integer	Die Sequenznummer dieses Ereignisses.	Ja
type	enum	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.audio.done`	OpenAI.ResponseAudioDoneEvent
`response.audio.transcript.delta`	OpenAI.ResponseAudioTranscriptDeltaEvent
`response.audio.transcript.done`	OpenAI.ResponseAudioTranscriptDoneEvent
`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
`response.completed`	OpenAI.ResponseCompletedEvent
`response.content_part.added`	OpenAI.ResponseContentPartAddedEvent
`response.content_part.done`	OpenAI.ResponseContentPartDoneEvent
`response.created`	OpenAI.ResponseCreatedEvent
`response.custom_tool_call_input.delta`	OpenAI.ResponseCustomToolCallInputDeltaEvent
`response.custom_tool_call_input.done`	OpenAI.ResponseCustomToolCallInputDoneEvent
`error`	OpenAI.ResponseErrorEvent
`response.failed`	OpenAI.ResponseFailedEvent
`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.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.in_progress`	OpenAI.ResponseInProgressEvent
`response.incomplete`	OpenAI.ResponseIncompleteEvent
`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.output_item.added`	OpenAI.ResponseOutputItemAddedEvent
`response.output_item.done`	OpenAI.ResponseOutputItemDoneEvent
`response.output_text.annotation.added`	OpenAI.ResponseOutputTextAnnotationAddedEvent
`response.queued`	OpenAI.ResponseQueuedEvent
`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.reasoning_text.delta`	OpenAI.ResponseReasoningTextDeltaEvent
`response.reasoning_text.done`	OpenAI.ResponseReasoningTextDoneEvent
`response.refusal.delta`	OpenAI.ResponseRefusalDeltaEvent
`response.refusal.done`	OpenAI.ResponseRefusalDoneEvent
`response.output_text.delta`	OpenAI.ResponseTextDeltaEvent
`response.output_text.done`	OpenAI.ResponseTextDoneEvent
`response.web_search_call.completed`	OpenAI.ResponseWebSearchCallCompletedEvent
`response.web_search_call.in_progress`	OpenAI.ResponseWebSearchCallInProgressEvent
`response.web_search_call.searching`	OpenAI.ResponseWebSearchCallSearchingEvent
`response.audio.delta`	OpenAI.ResponseAudioDeltaEvent

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ResponseStreamEventType		Ja

OpenAI.ResponseStreamEventType

Property Wert

Typ Schnur

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.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.reasoning_text.delta
response.reasoning_text.done
response.refusal.delta
response.refusal.done
response.output_text.delta
response.output_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.output_text.annotation.added
response.queued
response.custom_tool_call_input.delta
response.custom_tool_call_input.done

OpenAI.ResponseStreamOptions

Optionen für Antworten im Streaming-Bereich. 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

OpenAI.ResponseTextDeltaEvent

Wird ausgegeben, wenn ein zusätzliches Textdelta vorhanden ist.

Name	Typ	Description	Required
content_index	integer	Der Index des Inhaltsteils, dem das Textdelta hinzugefügt wurde	Ja
delta	Schnur	Das Textdelta, das hinzugefügt wurde	Ja
item_id	Schnur	Die ID des Ausgabeelements, dem das Textdelta hinzugefügt wurde.	Ja
logprobs	Array von OpenAI.ResponseLogProb	Die Protokollwahrscheinlichkeiten der Token im Delta.	Ja
output_index	integer	Der Index des Ausgabeelements, dem das Textdelta hinzugefügt wurde	Ja
sequence_number	integer	Die Sequenznummer für dieses Ereignis.	Ja
type	enum	Typ des Ereignisses Immer `response.output_text.delta`. Mögliche Werte: `response.output_text.delta`	Ja

OpenAI.ResponseTextDoneEvent

Wird gesendet, wenn der Textinhalt finalisiert ist.

Name	Typ	Description	Required
content_index	integer	Der Index des Inhaltsteils, dass der Textinhalt abgeschlossen wird	Ja
item_id	Schnur	Die ID des Ausgabeelements, dessen Textinhalt abgeschlossen ist.	Ja
logprobs	Array von OpenAI.ResponseLogProb	Die Protokollwahrscheinlichkeiten der Token im Delta.	Ja
output_index	integer	Der Index des Ausgabeelements, dass der Textinhalt abgeschlossen wird	Ja
sequence_number	integer	Die Sequenznummer für dieses Ereignis.	Ja
Text	Schnur	Der textinhalt, der abgeschlossen ist.	Ja
type	enum	Typ des Ereignisses Immer `response.output_text.done`. Mögliche Werte: `response.output_text.done`	Ja

OpenAI.ResponseTextParam

Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann Nur-Text- oder strukturierte JSON-Daten sein. Erfahren Sie mehr:

Texteingaben und -ausgaben
Strukturierte Ausgaben

Name	Typ	Description	Required	Vorgabe
format	OpenAI.TextResponseFormatConfiguration	Ein Objekt, das das Format angibt, das das Modell ausgeben muss. Konfigurieren `{ "type": "json_schema" }` von strukturierten Ausgaben, dadurch wird sichergestellt, dass das Modell mit Ihrem bereitgestellten JSON-Schema übereinstimmt. Weitere Informationen finden Sie im Das Standardformat ist `{ "type": "text" }` ohne zusätzliche Optionen verfügbar. Nicht empfohlen für gpt-4o und neuere Modelle: 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
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

OpenAI.ResponseUsage

Stellt Tokenverwendungsdetails wie Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken dar.

Name	Typ	Description	Required
input_tokens	integer	Die Anzahl der Eingabetoken.	Ja
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Ja
└– zwischengespeicherte_Token	integer		Ja
output_tokens	integer	Die Anzahl der Ausgabetoken.	Ja
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Ja
└– reasoning_tokens	integer		Ja
Gesamtanzahl Tokens	integer	Die Gesamtzahl der verwendeten Token.	Ja

OpenAI.ResponseUsageInputTokensDetails

Name	Typ	Description	Required	Vorgabe
cached_tokens	integer		Ja

OpenAI.ResponseUsageOutputTokensDetails

Name	Typ	Description	Required	Vorgabe
Begründungs_Token	integer		Ja

OpenAI.ResponseWebSearchCallCompletedEvent

Hinweis: web_search ist noch nicht über Azure OpenAI verfügbar.

Name	Typ	Description	Required
item_id	Schnur	Eindeutige ID für das Ausgabeelement, das dem Websuchaufruf zugeordnet ist.	Ja
output_index	integer	Der Index des Ausgabeelements, dem der Websuchaufruf zugeordnet ist.	Ja
sequence_number	integer	Die Sequenznummer des verarbeiteten Websuchaufrufs.	Ja
type	enum	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	Description	Required
item_id	Schnur	Eindeutige ID für das Ausgabeelement, das dem Websuchaufruf zugeordnet ist.	Ja
output_index	integer	Der Index des Ausgabeelements, dem der Websuchaufruf zugeordnet ist.	Ja
sequence_number	integer	Die Sequenznummer des verarbeiteten Websuchaufrufs.	Ja
type	enum	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	Description	Required
item_id	Schnur	Eindeutige ID für das Ausgabeelement, das dem Websuchaufruf zugeordnet ist.	Ja
output_index	integer	Der Index des Ausgabeelements, dem der Websuchaufruf zugeordnet ist.	Ja
sequence_number	integer	Die Sequenznummer des verarbeiteten Websuchaufrufs.	Ja
type	enum	Typ des Ereignisses Immer `response.web_search_call.searching`. Mögliche Werte: `response.web_search_call.searching`	Ja

OpenAI.ScreenshotParam

Screenshot

Screenshotaktion

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

OpenAI.ScrollParam

Scroll

Eine Scrollaktion

Name	Typ	Description	Required	Vorgabe
keys	Array von Zeichenfolge oder Null		No
scroll_x	integer	Der horizontale Scrollabstand	Ja
scroll_y	integer	Der vertikale Scrollabstand	Ja
type	enum	Gibt den Ereignistyp an. Beim Scrollen wird diese Eigenschaft immer auf `scroll` gesetzt. Mögliche Werte: `scroll`	Ja	Blättern
x	integer	Die X-Koordinate, an der das Scrollen erfolgt ist	Ja
y	integer	Die y-Koordinate, bei der das Scrollen stattfindet.	Ja

OpenAI.SearchContentType

Property	Wert
Typ	Schnur
Werte	`text` `image`

OpenAI.SearchContextSize

Property	Wert
Typ	Schnur
Werte	`low` `medium` `high`

OpenAI.SkillReferenceParam

Name	Typ	Description	Required	Vorgabe
skill_id	Schnur	Die ID der referenzierten Fähigkeit. Einschränkungen: minLength: 1, maxLength: 64	Ja
type	enum	Bezieht sich auf eine Fähigkeit, die mit dem /v1/skills-Endpunkt erstellt wurde. Mögliche Werte: `skill_reference`	Ja	skill_reference
version	Schnur	Optionale Fertigkeitsversion. Verwenden Sie eine positive ganze Zahl oder 'neueste'. Standardmäßig weglassen.	No

OpenAI.SpecificApplyPatchParam

Spezifische Anwendung des Patch-Werkzeugs

Erzwingt das Modell, das apply_patch Tool aufzurufen, wenn ein Toolaufruf ausgeführt wird.

Name	Typ	Description	Required	Vorgabe
type	enum	Das tool, das aufgerufen werden soll. Immer `apply_patch`. Mögliche Werte: `apply_patch`	Ja	apply_patch

OpenAI.SpecificFunctionShellParam

Spezifische Wahl des Schalenwerkzeugs

Erzwingt das Modell, das Shelltool aufzurufen, wenn ein Toolaufruf erforderlich ist.

Name	Typ	Description	Required	Vorgabe
type	enum	Das tool, das aufgerufen werden soll. Immer `shell`. Mögliche Werte: `shell`	Ja	Shell

OpenAI.SummaryTextContent

Zusammenfassungstext

Ein Zusammenfassungstext aus dem Modell.

Name	Typ	Description	Required	Vorgabe
Text	Schnur	Eine Zusammenfassung der bisher vom Modell ausgegebenen Gründe.	Ja
type	enum	Der Typ des Objekts. Immer `summary_text`. Mögliche Werte: `summary_text`	Ja	summary_text

OpenAI.TextContent

Textinhalt

Ein Textinhalt.

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

OpenAI.TextResponseFormatConfiguration

Ein Objekt, das das Format angibt, das das Modell ausgeben muss. Das Konfigurieren von { "type": "json_schema" } stellt strukturierte Ausgaben, die garantieren, dass das Modell Ihrem bereitgestellten JSON-Schema entspricht, sicher. Weitere Informationen finden Sie im

Das Standardformat ist { "type": "text" } ohne zusätzliche Optionen verfügbar. Nicht empfohlen für GPT-4o und neuere Modelle: Einstellung aktiviert den { "type": "json_object" } älteren JSON-Modus, der sicherstellt, dass die vom Modell generierte Nachricht gültiges JSON ist. Die Verwendung json_schema wird für Modelle bevorzugt, die sie unterstützen.

Diskriminator für OpenAI.TextResponseFormatConfiguration

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

Typwert	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Typ	Description	Required	Vorgabe
type	OpenAI.TextResponseFormatConfigurationType		Ja

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

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

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

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

OpenAI.TextResponseFormatJsonSchema

JSON-Schema

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

Name	Typ	Description	Required
description	Schnur	Eine Beschreibung des Zwecks des Antwortformats, mit dem vom Modell bestimmt wird, wie im Format geantwortet werden soll.	No
Name	Schnur	Der Name des Antwortformats. Muss a–z, A–Z, 0–9 sein oder Unterstriche und Gedankenstriche enthalten (maximale Länge: 64 Zeichen).	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 oder Null		No
type	enum	Der Typ des zu definierenden Antwortformats. Immer `json_schema`. Mögliche Werte: `json_schema`	Ja

OpenAI.Tool

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

Diskriminator für OpenAI.Tool

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

Typwert	Schema
`code_interpreter`	OpenAI.CodeInterpreterTool
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search`	OpenAI.WebSearchTool
`mcp`	OpenAI.MCPTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellToolParam
`shell`	OpenAI.FunctionShellToolParam
`custom`	OpenAI.CustomToolParam
`web_search_preview`	OpenAI.WebSearchPreviewTool
`apply_patch`	OpenAI.ApplyPatchToolParam
`computer`	OpenAI.ComputerTool
`namespace`	OpenAI.NamespaceToolParam
`tool_search`	OpenAI.ToolSearchToolParam

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ToolType		Ja

OpenAI.ToolChoiceAllowed

Zulässige Tools

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

Name	Typ	Description	Required
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 Antwort-API könnte die Liste der Tooldefinitionen wie folgt aussehen: `json<br> [ { "type": "function", "name": "get_weather" }, { "type": "mcp", "server_label": "deepwiki" }, { "type": "image_generation" } ]<br>`	Ja
type	enum	Zulässiger Toolkonfigurationstyp. Immer `allowed_tools`. Mögliche Werte: `allowed_tools`	Ja

OpenAI.ToolChoiceCodeInterpreter

Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll. Erfahren Sie mehr über integrierte Tools.

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

OpenAI.ToolChoiceComputer

Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll. Erfahren Sie mehr über integrierte Tools.

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

OpenAI.ToolChoiceComputerUse

Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll. Erfahren Sie mehr über integrierte Tools.

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

OpenAI.ToolChoiceComputerUsePreview

Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll. Erfahren Sie mehr über integrierte Tools.

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

OpenAI.ToolChoiceCustom

Benutzerdefiniertes Werkzeug

Verwenden Sie diese Option, um zu erzwingen, dass das Modell ein bestimmtes benutzerdefiniertes Tool aufruft.

Name	Typ	Description	Required	Vorgabe
Name	Schnur	Der Name des benutzerdefinierten Tools, das aufgerufen werden soll.	Ja
type	enum	Für benutzerdefinierte Toolaufrufe ist der Typ immer `custom`. Mögliche Werte: `custom`	Ja

OpenAI.ToolChoiceFileSearch

Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll. Erfahren Sie mehr über integrierte Tools.

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

OpenAI.ToolChoiceFunction

Funktionswerkzeug

Verwenden Sie diese Option, um zu erzwingen, dass das Modell eine bestimmte Funktion aufruft.

Name	Typ	Description	Required	Vorgabe
Name	Schnur	Der Name der funktion, die aufgerufen werden soll.	Ja
type	enum	Bei Funktionsaufrufen ist der Typ immer `function`. Mögliche Werte: `function`	Ja

OpenAI.ToolChoiceImageGeneration

Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll. Erfahren Sie mehr über integrierte Tools.

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

OpenAI.ToolChoiceMCP

MCP-Tool

Verwenden Sie diese Option, um zu erzwingen, dass das Modell ein bestimmtes Tool auf einem Remote-MCP-Server aufruft.

Name	Typ	Description	Required
Name	Zeichenfolge oder null		No
Serverbeschriftung	Schnur	Die Bezeichnung des zu verwendenden MCP-Servers.	Ja
type	enum	Bei MCP-Tools ist der Typ immer `mcp`. Mögliche Werte: `mcp`	Ja

OpenAI.ToolChoiceOptions

Werkzeugauswahlmodus

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.

Property	Wert
Typ	Schnur
Werte	`none` `auto` `required`

OpenAI.ToolChoiceParam

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.

Diskriminator für OpenAI.ToolChoiceParam

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

Typwert	Schema
`allowed_tools`	OpenAI.ToolChoiceAllowed
`mcp`	OpenAI.ToolChoiceMCP
`custom`	OpenAI.ToolChoiceCustom
`apply_patch`	OpenAI.SpecificApplyPatchParam
`shell`	OpenAI.SpecificFunctionShellParam
`file_search`	OpenAI.ToolChoiceFileSearch
`web_search_preview`	OpenAI.ToolChoiceWebSearchPreview
`computer_use_preview`	OpenAI.ToolChoiceComputerUsePreview
`web_search_preview_2025_03_11`	OpenAI.ToolChoiceWebSearchPreview20250311
`image_generation`	OpenAI.ToolChoiceImageGeneration
`code_interpreter`	OpenAI.ToolChoiceCodeInterpreter
`computer`	OpenAI.ToolChoiceComputer
`computer_use`	OpenAI.ToolChoiceComputerUse
`function`	OpenAI.ToolChoiceFunction

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ToolChoiceParamType		Ja

OpenAI.ToolChoiceParamType

Property	Wert
Typ	Schnur
Werte	`allowed_tools` `function` `mcp` `custom` `apply_patch` `shell` `file_search` `web_search_preview` `computer_use_preview` `web_search_preview_2025_03_11` `image_generation` `code_interpreter` `computer` `computer_use`

OpenAI.ToolChoiceWebSearchPreview

Hinweis: web_search ist noch nicht über Azure OpenAI verfügbar.

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

OpenAI.ToolChoiceWebSearchPreview20250311

Gibt an, dass das Modell ein integriertes Tool zum Generieren einer Antwort verwenden soll. Erfahren Sie mehr über integrierte Tools.

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

OpenAI.ToolSearchExecutionType

Property	Wert
Typ	Schnur
Werte	`server` `client`

OpenAI.ToolSearchToolParam

Werkzeugsuchwerkzeug

Gehostete oder BYOT-Tool-Suchkonfiguration für aufgeschobene Tools.

Name	Typ	Description	Required	Vorgabe
description	Zeichenfolge oder null		No
Ausführung	OpenAI.ToolSearchExecutionType		No
parameters	OpenAI.EmptyModelParam oder null		No
type	enum	Der Typ des Tools. Immer `tool_search`. Mögliche Werte: `tool_search`	Ja	tool_search

OpenAI.ToolType

Property	Wert
Typ	Schnur
Werte	`function` `file_search` `computer` `computer_use_preview` `web_search` `mcp` `code_interpreter` `image_generation` `local_shell` `shell` `custom` `namespace` `tool_search` `web_search_preview` `apply_patch`

OpenAI.ToolsArray

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. Wir unterstützen die folgenden Kategorien von Tools:

Eingebaute Werkzeuge: Werkzeuge, die von OpenAI bereitgestellt werden und die Funktionen des Modells erweitern, wie Websuche oder Dateisuche. Erfahren Sie mehr über integrierte Werkzeuge.
MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Erfahren Sie mehr über MCP Tools.
Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, wodurch das Modell Ihren eigenen Code mit stark typierten Argumenten und Ausgaben aufrufen kann. Erfahren Sie mehr über den Funktionsaufruf. Sie können auch benutzerdefinierte Tools verwenden, um Ihren eigenen Code aufzurufen.

Array von: OpenAI.Tool

OpenAI.TopLogProb

Top-Log-Wahrscheinlichkeit

Die oberste Protokollwahrscheinlichkeit eines Tokens.

Name	Typ	Required
Byte	Array mit ganzzahliger Zahl	Ja
logprob	Zahl	Ja
token	Schnur	Ja

OpenAI.TypeParam

Typ

Eine Aktion zum Eingeben von Text.

Name	Typ	Description	Required	Vorgabe
Text	Schnur	Der einzugebende Text.	Ja
type	enum	Gibt den Ereignistyp an. Bei einer Typaktion wird diese Eigenschaft immer auf `type` gesetzt. Mögliche Werte: `type`	Ja	type

OpenAI.UrlCitationBody

URL-Zitation

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

Name	Typ	Description	Required	Vorgabe
end_index	integer	Der Index des letzten Zeichens des URL-Zitats in der Nachricht.	Ja
start_index	integer	Der Index des ersten Zeichens des URL-Zitats in der Nachricht.	Ja
title	Schnur	Der Titel der Webressource.	Ja
type	enum	Der Typ des URL-Zitats. Immer `url_citation`. Mögliche Werte: `url_citation`	Ja	url_citation
url	Zeichenfolge (URI)	Die URL der Webressource.	Ja

OpenAI.VectorStoreFileAttributes

Typ: Objekt

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äzisere Antworten, während höhere Werte zu ausführlicheren Antworten führen. Derzeit unterstützte Werte sind `low`, `medium`und `high`.
Typ	Schnur
Werte	`low` `medium` `high`

OpenAI.WaitParam

Warten

Eine Warteaktion.

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

OpenAI.WebSearchActionFind

Aktion finden

Aktionstyp "find_in_page": Sucht nach einem Muster innerhalb einer geladenen Seite.

Name	Typ	Description	Required
pattern	Schnur	Das Muster oder der Text, nach dem innerhalb der Seite gesucht werden soll.	Ja
type	enum	Der Aktionstyp. Mögliche Werte: `find_in_page`	Ja
url	Zeichenfolge (URI)	Die URL der Seite, die nach dem Muster gesucht wurde.	Ja

OpenAI.WebSearchActionOpenPage

Open-Page-Aktion

Aktionstyp "open_page" – Öffnet eine bestimmte URL aus Suchergebnissen.

Name	Typ	Description	Required	Vorgabe
type	enum	Der Aktionstyp. Mögliche Werte: `open_page`	Ja
url	Zeichenfolge oder null	Die URL, die vom Modell geöffnet wurde.	No

OpenAI.WebSearchActionSearch

Suchaktion

Aktionstyp "suche" – Führt eine Websuchabfrage aus.

Name	Typ	Description	Required
Abfragen	Array von Strings	Die Suchabfragen.	No
query	Zeichenfolge (veraltet)	[VERALTET] Die Suchabfrage.	Ja
Quellen	Array von OpenAI.WebSearchActionSearchSources	Die in der Suche verwendeten Quellen.	No
type	enum	Der Aktionstyp. Mögliche Werte: `search`	Ja

OpenAI.WebSearchActionSearchSources

Name	Typ	Description	Required	Vorgabe
type	enum	Mögliche Werte: `url`	Ja
url	Zeichenfolge (URI)		Ja

OpenAI.WebSearchApproximateLocation

Ungefährer Standort der Websuche

Die ungefähre Position des Benutzers.

Name	Typ	Description	Required	Vorgabe
Stadt	Zeichenfolge oder null		No
country	Zeichenfolge oder null		No
Region	Zeichenfolge oder null		No
timezone	Zeichenfolge oder null		No
type	enum	Der Typ der Standortannäherung. Immer `approximate`. Mögliche Werte: `approximate`	Ja	Ungefähre

OpenAI.WebSearchPreviewTool

Websuchvorschau

Hinweis: web_search ist noch nicht über Azure OpenAI verfügbar.

Name	Typ	Description	Required	Vorgabe
search_content_types	Array von OpenAI.SearchContentType		No
Suchkontextgröße	OpenAI.SearchContextSize		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	web_search_preview
Benutzerstandort	OpenAI.ApproximateLocation oder NULL		No

OpenAI.WebSearchTool

Websuche

Hinweis: web_search ist noch nicht über Azure OpenAI verfügbar.

Name	Typ	Description	Required	Vorgabe
Filter	OpenAI.WebSearchToolFilters oder NULL		No
Suchkontextgröße	enum	Allgemeine Richtlinie für die Menge des Kontextfensterbereichs, der für die Suche verwendet werden soll. Einer der folgenden Werte: `low`, `medium` oder `high`. `medium` ist der Standardwert. Mögliche Werte: `low`, , `mediumhigh`	No	medium
type	enum	Der Typ des Websuchtools. Einer von `web_search` oder `web_search_2025_08_26`. Mögliche Werte: `web_search`	Ja	Websuche
Benutzerstandort	OpenAI.WebSearchApproximateLocation oder null		No

OpenAI.WebSearchToolFilters

Name	Typ	Description	Required	Vorgabe
allowed_domains	Array von Zeichenfolge oder Null		No

Last updated on 2026-07-10