Microsoft Foundry

API-Version: v1

Authentifizierung

Fluss: implizit

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

Bereiche:

• https://ai.azure.com/.default

Agenten

Agents – Agent erstellen

POST {endpoint}/agents?api-version=v1

Erstellt den Agent.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Falsch	Schnur Mögliche Werte: ContainerAgents=V1Preview, , HostedAgents=V1PreviewWorkflowAgents=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
Definition	AgentDefinition		Ja
└– Art	AgentKind		Ja
└- rai_config	RaiConfig	Konfiguration für die Inhaltsfilterung und Sicherheitsfunktionen von Responsible AI (RAI).	No
description	Schnur	Eine lesbare Beschreibung des Agents. Einschränkungen: maxLength: 512	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
Name	Schnur	Der eindeutige Name, der den Agent identifiziert. Name kann zum Abrufen/Aktualisieren/Löschen des Agenten verwendet werden. - Muss mit alphanumerischen Zeichen beginnen und enden, - Kann Bindestriche in der Mitte enthalten - Darf 63 Zeichen nicht überschreiten. Einschränkungen: maxLength: 63	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AgentObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agents – Agents auflisten

GET {endpoint}/agents?api-version=v1

Gibt die Liste aller Agenten zurück.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
kind	query	No	Schnur Mögliche Werte: prompt, , hosted, container_appworkflow	Filtert Agents nach Art. Wenn nicht angegeben, werden alle Agents zurückgegeben.
Limit	query	No	integer	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen. Der Standardwert ist 20.
order	query	No	Schnur Mögliche Werte: asc, desc	Sortierreihenfolge nach dem created_at Zeitstempel der Objekte. asc für aufsteigende Reihenfolge unddesc für absteigende Reihenfolge.
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.
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.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt	Die Antwortdaten für eine angeforderte Liste von Elementen.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agents – Agent abrufen

GET {endpoint}/agents/{agent_name}?api-version=v1

Ruft den Agenten ab.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des abzurufenden Agents.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AgentObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agents – Update-Agent

POST {endpoint}/agents/{agent_name}?api-version=v1

Aktualisiert den Agent, indem eine neue Version hinzugefügt wird, wenn Änderungen an der Agentendefinition vorgenommen werden. Wenn keine Änderungen vorgenommen werden, wird die vorhandene Agent-Version zurückgegeben.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des abzurufenden Agents.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Falsch	Schnur Mögliche Werte: ContainerAgents=V1Preview, , HostedAgents=V1PreviewWorkflowAgents=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
Definition	AgentDefinition		Ja
└– Art	AgentKind		Ja
└- rai_config	RaiConfig	Konfiguration für die Inhaltsfilterung und Sicherheitsfunktionen von Responsible AI (RAI).	No
description	Schnur	Eine lesbare Beschreibung des Agents. Einschränkungen: maxLength: 512	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AgentObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agents – Agent löschen

DELETE {endpoint}/agents/{agent_name}?api-version=v1

Löscht einen Agent.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des zu löschenden Agents.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	DeleteAgentResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agents – Agent aus dem Manifest aktualisieren

POST {endpoint}/agents/{agent_name}/import?api-version=v1

Aktualisiert den Agent aus einem Manifest, indem eine neue Version hinzugefügt wird, wenn Änderungen an der Agentdefinition vorhanden sind. Wenn keine Änderungen vorgenommen werden, wird die vorhandene Agent-Version zurückgegeben.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des zu aktualisierenden Agents.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
description	Schnur	Eine lesbare Beschreibung des Agents. Einschränkungen: maxLength: 512	No
manifest_id	Schnur	Die Manifest-ID, aus der die Agentversion importiert werden soll.	Ja
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
parameter_values	Objekt	Die Eingaben in das Manifest, die zu einem vollständig materialisierten Agent führen.	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AgentObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agents – Agent-Version erstellen

POST {endpoint}/agents/{agent_name}/versions?api-version=v1

Erstellen Sie eine neue Agentversion.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der eindeutige Name, der den Agent identifiziert. Name kann zum Abrufen/Aktualisieren/Löschen des Agenten verwendet werden. - Muss mit alphanumerischen Zeichen beginnen und enden, - Kann Bindestriche in der Mitte enthalten - Darf 63 Zeichen nicht überschreiten.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Falsch	Schnur Mögliche Werte: ContainerAgents=V1Preview, , HostedAgents=V1PreviewWorkflowAgents=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
Definition	AgentDefinition		Ja
└– Art	AgentKind		Ja
└- rai_config	RaiConfig	Konfiguration für die Inhaltsfilterung und Sicherheitsfunktionen von Responsible AI (RAI).	No
description	Schnur	Eine lesbare Beschreibung des Agents. Einschränkungen: maxLength: 512	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AgentVersionObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agents – Agentversionen auflisten

GET {endpoint}/agents/{agent_name}/versions?api-version=v1

Gibt die Liste der Versionen eines Agenten zurück.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des Agents, für den Versionen abgerufen werden sollen.
Limit	query	No	integer	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen. Der Standardwert ist 20.
order	query	No	Schnur Mögliche Werte: asc, desc	Sortierreihenfolge nach dem created_at Zeitstempel der Objekte. asc für aufsteigende Reihenfolge unddesc für absteigende Reihenfolge.
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.
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.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt	Die Antwortdaten für eine angeforderte Liste von Elementen.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agents – Agentversion abrufen

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Ruft eine bestimmte Version eines Agenten ab.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des abzurufenden Agents.
agent_version	path	Ja	Schnur	Die Version des abzurufenden Agents.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AgentVersionObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agents – Agent-Version löschen

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Löscht eine bestimmte Version eines Agenten.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des zu löschenden Agents.
agent_version	path	Ja	Schnur	Die zu löschende Version des Agents
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	DeleteAgentVersionResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agents – Agent-Version aus dem Manifest erstellen

POST {endpoint}/agents/{agent_name}/versions:import?api-version=v1

Erstellen Sie eine neue Agent-Version aus einem Manifest.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der eindeutige Name, der den Agent identifiziert. Name kann zum Abrufen/Aktualisieren/Löschen des Agenten verwendet werden. - Muss mit alphanumerischen Zeichen beginnen und enden, - Kann Bindestriche in der Mitte enthalten - Darf 63 Zeichen nicht überschreiten.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
description	Schnur	Eine lesbare Beschreibung des Agents. Einschränkungen: maxLength: 512	No
manifest_id	Schnur	Die Manifest-ID, aus der die Agentversion importiert werden soll.	Ja
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
parameter_values	Objekt	Die Eingaben in das Manifest, die zu einem vollständig materialisierten Agent führen.	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AgentVersionObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agents – Agent aus dem Manifest erstellen

POST {endpoint}/agents:import?api-version=v1

Erstellt einen Agent aus einem Manifest.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
description	Schnur	Eine lesbare Beschreibung des Agents. Einschränkungen: maxLength: 512	No
manifest_id	Schnur	Die Manifest-ID, aus der die Agentversion importiert werden soll.	Ja
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
Name	Schnur	Der eindeutige Name, der den Agent identifiziert. Name kann zum Abrufen/Aktualisieren/Löschen des Agenten verwendet werden. - Muss mit alphanumerischen Zeichen beginnen und enden, - Kann Bindestriche in der Mitte enthalten - Darf 63 Zeichen nicht überschreiten. Einschränkungen: maxLength: 63	Ja
parameter_values	Objekt	Die Eingaben in das Manifest, die zu einem vollständig materialisierten Agent führen.	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AgentObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agentcontainer

Agentcontainer – Listen-Agent-Containervorgänge

GET {endpoint}/agents/{agent_name}/operations?api-version=v1

Listen von Containervorgängen für einen Agent.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des Agents.
Limit	query	No	integer	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen. Der Standardwert ist 20.
order	query	No	Schnur Mögliche Werte: asc, desc	Sortierreihenfolge nach dem created_at Zeitstempel der Objekte. asc für aufsteigende Reihenfolge unddesc für absteigende Reihenfolge.
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.
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.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Falsch	Schnur Mögliche Werte: ContainerAgents=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt	Die Antwortdaten für eine angeforderte Liste von Elementen.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agentcontainer – Agentcontainer-Vorgang abrufen

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=v1

Rufen Sie den Status eines Containervorgangs für einen Agent ab.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des Agents.
operation_id	path	Ja	Schnur	Die Vorgangs-ID.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Falsch	Schnur Mögliche Werte: ContainerAgents=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AgentContainerOperationObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agentcontainer – Agentcontainer abrufen

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=v1

Abrufen eines Containers für eine bestimmte Version eines Agents.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des Agents.
agent_version	path	Ja	Schnur	Die Version des Agents.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Falsch	Schnur Mögliche Werte: ContainerAgents=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AgentContainerObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agentcontainer – Listen-Agent-Versionscontainervorgänge

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=v1

Auflisten von Containervorgängen für eine bestimmte Version eines Agents.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des Agents.
agent_version	path	Ja	Schnur	Die Version des Agents.
Limit	query	No	integer	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen. Der Standardwert ist 20.
order	query	No	Schnur Mögliche Werte: asc, desc	Sortierreihenfolge nach dem created_at Zeitstempel der Objekte. asc für aufsteigende Reihenfolge unddesc für absteigende Reihenfolge.
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.
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.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Falsch	Schnur Mögliche Werte: ContainerAgents=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt	Die Antwortdaten für eine angeforderte Liste von Elementen.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agentcontainer – Agentcontainer löschen

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=v1

Löschen eines Containers für eine bestimmte Version eines Agents. Wenn der Container nicht vorhanden ist, wird der Vorgang no-op. Der Vorgang ist ein lang ausgeführter Vorgang. Befolgen sie die Entwurfsrichtlinien für lange ausgeführte Vorgänge in Azure REST-APIs. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des Agents.
agent_version	path	Ja	Schnur	Die Version des Agents.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Falsch	Schnur Mögliche Werte: ContainerAgents=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 202

Beschreibung: Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AgentContainerOperationObject

Antwortheader:

Header	Typ	Description
Betriebsstandort	Schnur

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agentcontainer – Stream-Agent-Containerprotokolle

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:logstream?api-version=v1

Containerprotokolleintrag, der aus dem Container als Textblöcke gestreamt wurde. Jeder Block ist eine UTF-8-Zeichenfolge, die abhängig vom Typ des gestreamten Containerprotokolls entweder eine Nur-Text-Protokollzeile oder einen JSON-formatierten Protokolleintrag sein kann. Clients sollten jeden Block als undurchsichtigen Text behandeln und bei Bedarf versuchen, ihn basierend auf ihren Protokollierungsanforderungen als JSON zu analysieren.

Für Systemprotokolle: das Format ist JSON mit der folgenden Struktur: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Connecting to the events collector...","Reason":"StartingGettingEvents ","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":"null,"Msg":"Erfolgreich mit Ereignissen verbunden server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

Bei Konsolenprotokollen ist das Format nur Text, der vom Stdout/stderr des Containers ausgegeben wird. 2025-12-15T08:43:48.72656 Herstellen einer Verbindung mit dem Container "agent-container" ... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des Agents.
agent_version	path	Ja	Schnur	Die Version des Agents.
kind	query	No	Schnur Mögliche Werte: console, system	Die Konsole gibt den Container STDOUT/STDERR zurück, das System gibt den Container-App-Ereignisstrom zurück. Standardeinstellungen für Konsole
replica_name	query	No	Schnur	Wenn sie weggelassen wird, wählt der Server das erste Replikat für Konsolenprotokolle aus. Erforderlich, um ein bestimmtes Replikat als Ziel festzulegen.
Schwanz	query	No	integer	Anzahl der zurückgegebenen abschließenden Zeilen. Wird auf 1-300 erzwungen. Standardwert ist 20.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Falsch	Schnur Mögliche Werte: ContainerAgents=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agentcontainer – Agent-Container starten

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=v1

Starten Sie einen Container für eine bestimmte Version eines Agents. Wenn der Container bereits ausgeführt wird, wird der Vorgang no-op. Der Vorgang ist ein lang ausgeführter Vorgang. Befolgen sie die Entwurfsrichtlinien für lange ausgeführte Vorgänge in Azure REST-APIs. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des Agents.
agent_version	path	Ja	Schnur	Die Version des Agents.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Falsch	Schnur Mögliche Werte: ContainerAgents=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
max_replicas	integer	Die maximale Anzahl von Replikaten. Der Standardwert ist 1.	No	1
min_replicas	integer	Die Mindestanzahl der Replikate. Der Standardwert ist 1.	No	1

Responses

Statuscode: 202

Beschreibung: Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AgentContainerOperationObject

Antwortheader:

Header	Typ	Description
Betriebsstandort	Schnur

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agentcontainer – Agent-Container beenden

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=v1

Beenden Sie einen Container für eine bestimmte Version eines Agents. Wenn der Container nicht ausgeführt wird oder bereits beendet wird, wird der Vorgang no-op. Der Vorgang ist ein lang ausgeführter Vorgang. Befolgen sie die Entwurfsrichtlinien für lange ausgeführte Vorgänge in Azure REST-APIs. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des Agents.
agent_version	path	Ja	Schnur	Die Version des Agents.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Falsch	Schnur Mögliche Werte: ContainerAgents=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 202

Beschreibung: Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AgentContainerOperationObject

Antwortheader:

Header	Typ	Description
Betriebsstandort	Schnur

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Agentcontainer – Agent-Container aktualisieren

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=v1

Aktualisieren eines Containers für eine bestimmte Version eines Agents. Wenn der Container nicht ausgeführt wird, wird der Vorgang no-op. Der Vorgang ist ein lang ausgeführter Vorgang. Befolgen sie die Entwurfsrichtlinien für lange ausgeführte Vorgänge in Azure REST-APIs. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	Schnur	Der Name des Agents.
agent_version	path	Ja	Schnur	Die Version des Agents.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Falsch	Schnur Mögliche Werte: ContainerAgents=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
max_replicas	integer	Die maximale Anzahl von Replikaten.	No
min_replicas	integer	Die Mindestanzahl der Replikate.	No

Responses

Statuscode: 202

Beschreibung: Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AgentContainerOperationObject

Antwortheader:

Header	Typ	Description
Betriebsstandort	Schnur

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Connections

Verbindungen – Liste

GET {endpoint}/connections?api-version=v1

Auflisten aller Verbindungen im Projekt, ohne Verbindungsanmeldeinformationen aufzufüllen

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Verbindungstyp	query	No	Schnur Mögliche Werte: AzureOpenAI, , AzureBlob, AzureStorageAccount, CognitiveSearchCosmosDB, ApiKey, AppConfig, AppInsights, CustomKeysRemoteTool_Preview	Auflisten von Verbindungen dieses bestimmten Typs
defaultConnection	query	No	boolean	Auflisten von Verbindungen, die Standardverbindungen sind

Anfrage-Kopf

Name	Required	Typ	Description
x-ms-client-request-id	Falsch	Schnur	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PagedConnection

Antwortheader:

Header	Typ	Description
x-ms-client-request-id		Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Verbindungen – get

GET {endpoint}/connections/{name}?api-version=v1

Abrufen einer Verbindung anhand des Namens, ohne Verbindungsanmeldeinformationen aufzufüllen

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Anzeigename der Verbindung, die vom Benutzer bereitgestellt wird.

Anfrage-Kopf

Name	Required	Typ	Description
x-ms-client-request-id	Falsch	Schnur	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Connection

Antwortheader:

Header	Typ	Description
x-ms-client-request-id		Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Verbindungen – Abrufen mit Anmeldeinformationen

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=v1

Abrufen einer Verbindung anhand des Namens mit den Verbindungsanmeldeinformationen

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Anzeigename der Verbindung, die vom Benutzer bereitgestellt wird.

Anfrage-Kopf

Name	Required	Typ	Description
x-ms-client-request-id	Falsch	Schnur	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Connection

Antwortheader:

Header	Typ	Description
x-ms-client-request-id		Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Datasets

Datasets – neueste Liste

GET {endpoint}/datasets?api-version=v1

Auflisten der neuesten Version jeder DatasetVersion

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PagedDatasetVersion

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Datasets – Listenversionen

GET {endpoint}/datasets/{name}/versions?api-version=v1

Auflisten aller Versionen der angegebenen DatasetVersion

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PagedDatasetVersion

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Datasets – Version abrufen

GET {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Rufen Sie die spezifische Version der DatasetVersion ab. Der Dienst gibt den Fehler 404 Nicht gefunden zurück, wenn die DatasetVersion nicht vorhanden ist.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource
version	path	Ja	Schnur	Die spezifische Versions-ID der abzurufenden DatasetVersion.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	DatasetVersion

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Datasets – Version löschen

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Löschen Sie die spezifische Version von DatasetVersion. Der Dienst gibt 204 Keinen Inhalt zurück, wenn die DatasetVersion erfolgreich gelöscht wurde oder wenn die DatasetVersion nicht vorhanden ist.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource
version	path	Ja	Schnur	Die zu löschende Version der DatasetVersion.

Responses

Statuscode: 204

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

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Datasets – Erstellen oder Aktualisieren der Version

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Erstellen einer neuen oder Aktualisieren einer vorhandenen DatasetVersion mit der angegebenen Versions-ID

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource
version	path	Ja	Schnur	Die spezifische Versions-ID der DatasetVersion, die erstellt oder aktualisiert werden soll.

Anforderungstext

Inhaltstyp: application/merge-patch+json

Name	Typ	Description	Required	Vorgabe
description	Schnur	Der Text der Objektbeschreibung.	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No
type	DatasetType	Aufzählung, um den Datentyp zu bestimmen.	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	DatasetVersion

Statuscode: 201

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

Inhaltstyp	Typ	Beschreibung
Anwendung/json	DatasetVersion

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Datasets – Abrufen von Anmeldeinformationen

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=v1

Rufen Sie die SAS-Anmeldeinformationen ab, um auf das Speicherkonto zuzugreifen, das einer Datasetversion zugeordnet ist.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource
version	path	Ja	Schnur	Die spezifische Versions-ID der DatasetVersion, die ausgeführt werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	AssetCredentialResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Datasets – Ausstehende Uploadversion starten

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=v1

Starten Sie ein neues Element, oder rufen Sie einen vorhandenen ausstehenden Upload eines Datasets für eine bestimmte Version ab.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource
version	path	Ja	Schnur	Die spezifische Versions-ID der DatasetVersion, die ausgeführt werden soll.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
Connectionname	Schnur	Verbindungsname des Azure Storage-Kontos, der zum Generieren eines temporären SAS-Tokens verwendet werden soll	No
pendingUploadId	Schnur	Wenn PendingUploadId nicht angegeben wird, wird eine zufällige GUID verwendet.	No
pendingUploadType	enum	BlobReference ist der einzige unterstützte Typ. Mögliche Werte: BlobReference	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PendingUploadResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Bereitstellungen

Bereitstellungen – Liste

GET {endpoint}/deployments?api-version=v1

Auflisten aller bereitgestellten Modelle im Projekt

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
modelPublisher	query	No	Schnur	Modellherausgeber zum Filtern von Modellen nach
modelName	query	No	Schnur	Modellname (der herausgeberspezifische Name) zum Filtern von Modellen nach
deploymentType	query	No	Schnur Mögliche Werte: ModelDeployment	Typ der Bereitstellung zum Filtern der Liste nach

Anfrage-Kopf

Name	Required	Typ	Description
x-ms-client-request-id	Falsch	Schnur	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PagedDeployment

Antwortheader:

Header	Typ	Description
x-ms-client-request-id		Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Bereitstellungen – abrufen

GET {endpoint}/deployments/{name}?api-version=v1

Rufen Sie ein bereitgestelltes Modell ab.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Name der Bereitstellung

Anfrage-Kopf

Name	Required	Typ	Description
x-ms-client-request-id	Falsch	Schnur	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Deployment

Antwortheader:

Header	Typ	Description
x-ms-client-request-id		Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Bewertungstaxonomie

Bewertungstaxonomien – Liste

GET {endpoint}/evaluationtaxonomies?api-version=v1

Listenauswertungstaxonomien

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
inputName	query	No	Schnur	Filtern Sie nach dem Eingabenamen der Auswertung.
Inputtype	query	No	Schnur	Filtern nach Taxonomieeingabetyp.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Evaluations=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PagedEvaluationTaxonomy

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Bewertungstaxonomien – get

GET {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Rufen Sie eine Auswertung anhand des Namens ab.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Evaluations=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	EvaluationTaxonomy

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Bewertungstaxonomien - löschen

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Löschen Sie eine Auswertungstaxonomie anhand des Namens.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Evaluations=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 204

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

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Bewertungstaxonomien – erstellen

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Erstellen Sie eine Auswertungstaxonomie.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Auswertungstaxonomie.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Evaluations=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
description	Schnur	Der Text der Objektbeschreibung.	No
properties	Objekt	Zusätzliche Eigenschaften für die Auswertungstaxonomie.	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No
taxonomyCategories	Array von TaxonomyCategory	Liste der Taxonomiekategorien.	No
taxonomyInput	EvaluationTaxonomyInput	Eingabekonfiguration für die Auswertungstaxonomie.	Ja
└– Typ	EvaluationTaxonomyInputType	Eingabetyp der Auswertungstaxonomie.	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	EvaluationTaxonomy

Statuscode: 201

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

Inhaltstyp	Typ	Beschreibung
Anwendung/json	EvaluationTaxonomy

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Bewertungstaxonomien – Aktualisieren

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Aktualisieren sie eine Auswertungstaxonomie.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Auswertungstaxonomie.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Evaluations=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
description	Schnur	Der Text der Objektbeschreibung.	No
properties	Objekt	Zusätzliche Eigenschaften für die Auswertungstaxonomie.	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No
taxonomyCategories	Array von TaxonomyCategory	Liste der Taxonomiekategorien.	No
taxonomyInput	EvaluationTaxonomyInputUpdate	Eingabekonfiguration für die Auswertungstaxonomie.	No
└– Typ	EvaluationTaxonomyInputType	Eingabetyp der Auswertungstaxonomie.	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	EvaluationTaxonomy

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Auswertungsregeln

Auswertungsregeln – Liste

GET {endpoint}/evaluationrules?api-version=v1

Listet alle Auswertungsregeln auf.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
actionType	query	No	Schnur Mögliche Werte: continuousEvaluation, humanEvaluationPreview	Filtert nach dem Typ der Auswertungsregel.
Name des Agenten.	query	No	Schnur	Filtern Sie nach dem Agent-Namen.
enabled	query	No	boolean	Filtern Sie nach dem aktivierten Status.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PagedEvaluationRule

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Auswertungsregeln – get

GET {endpoint}/evaluationrules/{id}?api-version=v1

Dient zum Abrufen einer Auswertungsregel.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
id	path	Ja	Schnur	Eindeutiger Bezeichner für die Auswertungsregel.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	EvaluationRule

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Auswertungsregeln – Löschen

DELETE {endpoint}/evaluationrules/{id}?api-version=v1

Löschen sie eine Auswertungsregel.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
id	path	Ja	Schnur	Eindeutiger Bezeichner für die Auswertungsregel.

Responses

Statuscode: 204

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

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Auswertungsregeln – Erstellen oder Aktualisieren

PUT {endpoint}/evaluationrules/{id}?api-version=v1

Erstellen oder Aktualisieren einer Auswertungsregel.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
id	path	Ja	Schnur	Eindeutiger Bezeichner für die Auswertungsregel.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Falsch	Schnur Mögliche Werte: Evaluations=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
Aktion	EvaluationRuleAction	Evaluierungs-Aktionsmodell.	Ja
└– Typ	EvaluationRuleActionType	Art der Evaluierungsmaßnahme.	Ja
description	Schnur	Beschreibung für die Auswertungsregel.	No
displayName	Schnur	Anzeigename für die Auswertungsregel.	No
enabled	boolean	Gibt an, ob die Auswertungsregel aktiviert ist. Der Standardwert ist "true".	Ja
eventType	EvaluationRuleEventType	Typ des Auswertungsregelereignisses.	Ja
filter	EvaluationRuleFilter	Modell des Auswertungsfilters.	No
└– agentName	Schnur	Filtert nach Agentname.	Ja
id	Zeichenfolge (schreibgeschützt)	Eindeutiger Bezeichner für die Auswertungsregel.	Ja
Systemdaten	-Objekt (schreibgeschützt)	Systemmetadaten für die Auswertungsregel.	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	EvaluationRule

Statuscode: 201

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

Inhaltstyp	Typ	Beschreibung
Anwendung/json	EvaluationRule

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Bewerter

Bewertungen – neueste Versionen auflisten

GET {endpoint}/evaluators?api-version=v1

Auflisten der neuesten Version jedes Evaluators

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
type	query	No	Schnur Mögliche Werte: builtin, , customall	Filterevaluatoren nach Typ. Mögliche Werte: 'all', 'custom', 'builtin'.
Limit	query	No	integer	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen, und der Standardwert ist 20.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Evaluations=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PagedEvaluatorVersion

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Auswertungen – Listenversionen

GET {endpoint}/evaluators/{name}/versions?api-version=v1

Listet alle Versionen des angegebenen Evaluators auf

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource
type	query	No	Schnur Mögliche Werte: builtin, , customall	Filterevaluatoren nach Typ. Mögliche Werte: 'all', 'custom', 'builtin'.
Limit	query	No	integer	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen, und der Standardwert ist 20.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Evaluations=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PagedEvaluatorVersion

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Auswertungen – Version erstellen

POST {endpoint}/evaluators/{name}/versions?api-version=v1

Erstellen einer neuen EvaluatorVersion mit automatisch inkrementierter Versions-ID

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Evaluations=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
categories	Array von EvaluatorCategory	Die Kategorien des Bewerters	Ja
Definition	EvaluatorDefinition	Konfiguration des Basisauswerters mit Diskriminator	Ja
└– data_schema	Objekt	Das JSON-Schema (Entwurf 2020-12) für die Eingabedaten des Evaluators. Dazu gehören Parameter wie Typ, Eigenschaften, erforderlich.	No
└– init_parameters	Objekt	Das JSON-Schema (Entwurf 2020-12) für die Eingabeparameter des Evaluators. Dazu gehören Parameter wie Typ, Eigenschaften, erforderlich.	No
└– Metriken	Objekt	Liste der von diesem Evaluator erzeugten Ausgabemetriken	No
└– Typ	EvaluatorDefinitionType	Der Typ der Definition des Evaluators	Ja
description	Schnur	Der Text der Objektbeschreibung.	No
display_name	Schnur	Anzeigename für den Evaluator. Es hilft, den Evaluator in AI Foundry leicht zu finden. Es muss nicht eindeutig sein.	No
evaluator_type	EvaluatorType	Der Typ des Evaluators	Ja
metadata	Objekt	Metadaten über den Evaluator	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No

Responses

Statuscode: 201

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

Inhaltstyp	Typ	Beschreibung
Anwendung/json	EvaluatorVersion

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Auswertungen – Version abrufen

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Rufen Sie die spezifische Version der EvaluatorVersion ab. Der Dienst gibt den Fehler 404 Not Found zurück, wenn die EvaluatorVersion nicht vorhanden ist.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource
version	path	Ja	Schnur	Die spezifische Versions-ID der abzurufenden EvaluatorVersion.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Evaluations=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	EvaluatorVersion

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Auswertungen – Version löschen

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Löschen Sie die spezifische Version der EvaluatorVersion. Der Dienst gibt 204 No Content zurück, wenn die EvaluatorVersion erfolgreich gelöscht wurde oder wenn die EvaluatorVersion nicht vorhanden ist.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource
version	path	Ja	Schnur	Die Zu löschende Version der EvaluatorVersion.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Evaluations=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 204

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

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Auswertungen – Updateversion

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Aktualisieren einer vorhandenen EvaluatorVersion mit der angegebenen Versions-ID

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource
version	path	Ja	Schnur	Die Version der zu aktualisierenden EvaluatorVersion.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Evaluations=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
categories	Array von EvaluatorCategory	Die Kategorien des Bewerters	No
description	Schnur	Der Text der Objektbeschreibung.	No
display_name	Schnur	Anzeigename für den Evaluator. Es hilft, den Evaluator in AI Foundry leicht zu finden. Es muss nicht eindeutig sein.	No
metadata	Objekt	Metadaten über den Evaluator	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	EvaluatorVersion

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Indizes

Indizes – neueste Liste

GET {endpoint}/indexes?api-version=v1

Auflisten der neuesten Version jedes Indexes

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PagedIndex

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Indizes – Listenversionen

GET {endpoint}/indexes/{name}/versions?api-version=v1

Auflisten aller Versionen des angegebenen Indexes

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PagedIndex

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Indizes – Version abrufen

GET {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Rufen Sie die spezifische Version des Index ab. Der Dienst gibt den Fehler "404 Nicht gefunden" zurück, wenn der Index nicht vorhanden ist.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource
version	path	Ja	Schnur	Die spezifische Versions-ID des abzurufenden Indexes.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Index

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Indizes – Version löschen

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Löschen Sie die spezifische Version des Indexes. Der Dienst gibt 204 No Content zurück, wenn der Index erfolgreich gelöscht wurde oder wenn der Index nicht vorhanden ist.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource
version	path	Ja	Schnur	Die Version des zu löschenden Indexes.

Responses

Statuscode: 204

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

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Indizes – Erstellen oder Aktualisieren der Version

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Erstellen eines neuen oder Aktualisieren eines vorhandenen Indexes mit der angegebenen Versions-ID

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Der Name der Ressource
version	path	Ja	Schnur	Die spezifische Versions-ID des zu erstellenden oder aktualisierenden Indexes.

Anforderungstext

Inhaltstyp: application/merge-patch+json

Name	Typ	Description	Required	Vorgabe
description	Schnur	Der Text der Objektbeschreibung.	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No
type	IndexType		Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Index

Statuscode: 201

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

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Index

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Insights

Insights – Generieren

POST {endpoint}/insights?api-version=v1

Insights generieren

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Insights=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.
Wiederholbarkeit–Request-ID	Falsch	Schnur	Eindeutiger, vom Client generierter Identifikator zur Sicherstellung der Request-Idempotenz. Verwenden Sie dieselbe ID für Wiederholungen, um doppelte Auswertungen zu vermeiden.
Wiederholbarkeit–First-Sent	Falsch	Schnur	Zeitstempel, der angibt, wann diese Anforderung zum ersten Mal initiiert wurde. Wird in Verbindung mit repeatability-request-id zur Idempotenzkontrolle verwendet.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
displayName	Schnur	Benutzerfreundlicher Anzeigename für den Einblick.	Ja
id	Zeichenfolge (schreibgeschützt)	Der eindeutige Bezeichner für den Insights-Bericht.	Ja
metadata	InsightsMetadata (schreibgeschützt)	Metadaten zu den Erkenntnissen.	Ja
└– completedAt	Schnur	Der Zeitstempel, zu dem die Einblicke abgeschlossen wurden.	No
└– createdAt	Schnur	Der Zeitstempel, zu dem die Einblicke erstellt wurden.	Ja
request	InsightRequest	Die Anforderung des Insights-Berichts.	Ja
└– Typ	InsightType	Der Anforderungstyp.	Ja
result	InsightResult (schreibgeschützt)	Das Ergebnis der Erkenntnisse.	No
└– Typ	InsightType	Der Typ des Insights-Ergebnisses.	Ja
state	Azure. Core.Foundation.OperationState (schreibgeschützt)	Enumeration, die zulässige Betriebszustände beschreibt.	Ja

Responses

Statuscode: 201

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

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Erkenntnis

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Insights – Liste

GET {endpoint}/insights?api-version=v1

Alle Erkenntnisse in umgekehrter chronologischer Reihenfolge auflisten (neustes zuerst).

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
type	query	No	Schnur Mögliche Werte: EvaluationRunClusterInsight, , AgentClusterInsightEvaluationComparison	Filtern Sie nach der Art der Analyse.
evalId	query	No	Schnur	Filtern Sie nach der Auswertungs-ID.
runId	query	No	Schnur	Filtern Sie nach der ID des Auswertungslaufs.
Name des Agenten.	query	No	Schnur	Filtern Sie nach dem Agent-Namen.
includeCoordinates	query	No	boolean	Gibt an, ob Koordinaten für die Visualisierung in die Antwort aufgenommen werden sollen. Der Standardwert ist „false“.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Insights=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PagedInsight

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Insights – get

GET {endpoint}/insights/{id}?api-version=v1

Erhalten Sie einen bestimmten Einblick anhand der ID.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
id	path	Ja	Schnur	Der eindeutige Bezeichner für den Insights-Bericht.
includeCoordinates	query	No	boolean	Gibt an, ob Koordinaten für die Visualisierung in die Antwort aufgenommen werden sollen. Der Standardwert ist „false“.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Insights=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Erkenntnis

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Speicher

Speicher erstellen

POST {endpoint}/memory_stores?api-version=v1

Erstellen Sie einen Speicher.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: MemoryStores=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
Definition	MemoryStoreDefinition	Basisdefinition für Speicherspeicherkonfigurationen.	Ja
└– Art	MemoryStoreKind	Die Art des Speichers.	Ja
description	Schnur	Eine lesbare Beschreibung des Speichers. Einschränkungen: maxLength: 512	No
metadata	Objekt	Beliebige Schlüsselwertmetadaten, die dem Speicher zugeordnet werden sollen.	No
Name	Schnur	Der Name des Speichers. Einschränkungen: maxLength: 256	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	MemoryStoreObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Liste von Speicherplätzen

GET {endpoint}/memory_stores?api-version=v1

Listet alle Speicherspeicher auf.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Limit	query	No	integer	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen. Der Standardwert ist 20.
order	query	No	Schnur Mögliche Werte: asc, desc	Sortierreihenfolge nach dem created_at Zeitstempel der Objekte. asc für aufsteigende Reihenfolge unddesc für absteigende Reihenfolge.
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.
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.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: MemoryStores=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt	Die Antwortdaten für eine angeforderte Liste von Elementen.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Aktualisieren des Speicherspeichers

POST {endpoint}/memory_stores/{name}?api-version=v1

Aktualisieren Sie einen Speicherspeicher.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Name	path	Ja	Schnur	Der Name des zu aktualisierenden Speichers.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: MemoryStores=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
description	Schnur	Eine lesbare Beschreibung des Speichers. Einschränkungen: maxLength: 512	No
metadata	Objekt	Beliebige Schlüsselwertmetadaten, die dem Speicher zugeordnet werden sollen.	No

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	MemoryStoreObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Speicher abrufen

GET {endpoint}/memory_stores/{name}?api-version=v1

Rufen Sie einen Speicherspeicher ab.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Name	path	Ja	Schnur	Der Name des abzurufenden Speichers.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: MemoryStores=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	MemoryStoreObject

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Speicher löschen

DELETE {endpoint}/memory_stores/{name}?api-version=v1

Löschen Sie einen Speicherspeicher.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Name	path	Ja	Schnur	Der Name des zu löschenden Speichers.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: MemoryStores=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	DeleteMemoryStoreResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Updateergebnis abrufen

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=v1

Abrufen des Aktualisierungsergebnisses des Speicherspeichers.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Name	path	Ja	Schnur	Der Name des Speichers.
update_id	path	Ja	Schnur	Die ID des Speicheraktualisierungsvorgangs.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: MemoryStores=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	MemoryStoreUpdateResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Löschen von Bereichsspeichern

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=v1

Löschen Sie alle Speicher, die einem bestimmten Bereich zugeordnet sind, aus einem Speicherspeicher.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Name	path	Ja	Schnur	Der Name des Speichers.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: MemoryStores=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
scope	Schnur	Der Namespace, der Speicher logisch gruppiert und isoliert, die gelöscht werden sollen, z. B. eine Benutzer-ID.	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	MemoryStoreDeleteScopeResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Erinnerungen durchsuchen

POST {endpoint}/memory_stores/{name}:search_memories?api-version=v1

Suchen Sie nach relevanten Erinnerungen aus einem Speicher, basierend auf dem Unterhaltungskontext.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Name	path	Ja	Schnur	Der Name des zu durchsuchenden Speichers.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: MemoryStores=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
items	Array von OpenAI.InputItem	Elemente, nach denen nach relevanten Erinnerungen gesucht werden soll.	No
options	MemorySearchOptions	Optionen für die Speichersuche.	No
└– max_memories	integer	Maximale Anzahl der zurückzugebenden Speicherelemente.	No
previous_search_id	Schnur	Die eindeutige ID der vorherigen Suchanforderung, wodurch die inkrementelle Speichersuche aktiviert wird, von der der letzte Vorgang unterbrochen wurde.	No
scope	Schnur	Der Namespace, der Speicher logisch gruppiert und isoliert, z. B. eine Benutzer-ID.	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	MemoryStoreSearchResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Aktualisieren von Erinnerungen

POST {endpoint}/memory_stores/{name}:update_memories?api-version=v1

Aktualisieren des Speichers mit Unterhaltungserinnerungen.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Name	path	Ja	Schnur	Der Name des zu aktualisierenden Speichers.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: MemoryStores=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
items	Array von OpenAI.InputItem	Unterhaltungselemente, aus denen Erinnerungen extrahiert werden sollen.	No
previous_update_id	Schnur	Die eindeutige ID der vorherigen Updateanforderung, wodurch inkrementelle Speicherupdates aktiviert werden, von denen der letzte Vorgang unterbrochen wurde.	No
scope	Schnur	Der Namespace, der Speicher logisch gruppiert und isoliert, z. B. eine Benutzer-ID.	Ja
update_delay	integer	Timeoutperiode vor der Verarbeitung der Speicheraktualisierung in Sekunden. Wenn während dieses Zeitraums eine neue Updateanforderung empfangen wird, wird die aktuelle Anforderung abgebrochen und das Timeout zurückgesetzt. Legen Sie "0" fest, um das Update unverzüglich auszulösen. Der Standardwert ist 300 (5 Minuten).	No	300

Responses

Statuscode: 202

Beschreibung: Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	MemoryStoreUpdateResponse

Antwortheader:

Header	Typ	Description
Betriebsstandort	Schnur	Der Ort für die Überwachung des Vorgangszustands.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Gespräche

Unterhaltung erstellen

POST {endpoint}/openai/v1/conversations

Erstellen sie eine Unterhaltung.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
items	Array von OpenAI.InputItem		No
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.ConversationResource

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Unterhaltungen auflisten

GET {endpoint}/openai/v1/conversations

Gibt die Liste aller Unterhaltungen zurück.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Limit	query	No	integer	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen. Der Standardwert ist 20.
order	query	No	Schnur Mögliche Werte: asc, desc	Sortierreihenfolge nach dem created_at Zeitstempel der Objekte. asc für aufsteigende Reihenfolge unddesc für absteigende Reihenfolge.
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.
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.
agent_name	query	No	Schnur	Filtert nach Agentname. Wenn angegeben, werden nur Elemente zurückgegeben, die dem angegebenen Agent zugeordnet sind.
agent_id	query	No	Schnur	Filtern nach Agent-ID im Format name:version. Wenn angegeben, werden nur Elemente zurückgegeben, die der angegebenen Agent-ID zugeordnet sind.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt	Die Antwortdaten für eine angeforderte Liste von Elementen.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Unterhaltung aktualisieren

POST {endpoint}/openai/v1/conversations/{conversation_id}

Aktualisieren einer Unterhaltung.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Ja	Schnur	Die ID der zu aktualisierenden Unterhaltung.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.ConversationResource

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Unterhaltung abrufen

GET {endpoint}/openai/v1/conversations/{conversation_id}

Ruft eine Unterhaltung ab.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Ja	Schnur	Die ID der abzurufenden Unterhaltung.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.ConversationResource

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Unterhaltung löschen

DELETE {endpoint}/openai/v1/conversations/{conversation_id}

Löscht eine Unterhaltung.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Ja	Schnur	Die ID der zu löschenden Unterhaltung.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.DeletedConversationResource

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Erstellen von Unterhaltungselementen

POST {endpoint}/openai/v1/conversations/{conversation_id}/items

Erstellen Sie Elemente in einer Unterhaltung mit der angegebenen ID.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Ja	Schnur	Die ID der Unterhaltung, auf der das Element erstellt werden muss.
einschließen	query	No	array	Zusätzliche Felder, die in die Antwort eingeschlossen werden sollen. Weitere Informationen finden Sie im include Parameter zum Auflisten von Unterhaltungselementen.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
items	Array von OpenAI.Item	Die Elemente, die der Unterhaltung hinzugefügt werden sollen. Sie können jeweils bis zu 20 Elemente hinzufügen.	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.ConversationItemList

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Auflisten von Unterhaltungselementen

GET {endpoint}/openai/v1/conversations/{conversation_id}/items

Listet alle Elemente für eine Unterhaltung mit der angegebenen ID auf.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Ja	Schnur	Die ID der Unterhaltung, in der die Elemente aufgelistet werden müssen.
Limit	query	No	integer	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen. Der Standardwert ist 20.
order	query	No	Schnur Mögliche Werte: asc, desc	Sortierreihenfolge nach dem created_at Zeitstempel der Objekte. asc für aufsteigende Reihenfolge unddesc für absteigende Reihenfolge.
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.
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.
item_type	query	No	Schnur Mögliche Werte: message, , output_message, file_search_call, computer_callcomputer_call_output, , web_search_call, function_call, function_call_outputreasoningcompactionimage_generation_callcode_interpreter_call, , local_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callcustom_tool_call_outputcustom_tool_callstructured_outputsoauth_consent_requestmemory_search_callworkflow_action	Nach Elementtyp filtern. Wenn angegeben, werden nur Elemente des angegebenen Typs zurückgegeben.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt	Die Antwortdaten für eine angeforderte Liste von Elementen.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Unterhaltungselement abrufen

GET {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Ruft ein einzelnes Element aus einer Unterhaltung mit den angegebenen IDs ab.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Ja	Schnur	Die ID der Unterhaltung, die das Element enthält.
item_id	path	Ja	Schnur	Die ID des abzurufenden Unterhaltungselements.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.OutputItem

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Unterhaltungselement löschen

DELETE {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Löschen eines Elements aus einer Unterhaltung mit den angegebenen IDs.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Ja	Schnur	Die ID der Unterhaltung, aus der das Element gelöscht werden muss.
item_id	path	Ja	Schnur	Die ID des zu löschenden Unterhaltungselements.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.ConversationResource

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Evals

Evals - Listen-Evals

GET {endpoint}/openai/v1/evals

Auflisten aller Auswertungen Listenauswertungen für ein Projekt.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Nach	query	No	Schnur	Kennung für den letzten Ausführungslauf aus der vorherigen Paginierungsanforderung.
Limit	query	No	integer	Anzahl der abzurufenden Ausführungen
order	query	No	Schnur Mögliche Werte: asc, desc	Sortierreihenfolge der Ausführungen nach Zeitstempel Verwenden Sie asc für aufsteigende Reihenfolge oder desc für absteigende Reihenfolge. Wird standardmäßig auf asc festgelegt.
order_by	query	No	Schnur Mögliche Werte: created_at, updated_at	Evals können nach Erstellungszeit oder zuletzt aktualisierter Zeit sortiert werden. Verwenden Sie created_at für die Erstellungszeit oder updated_at für die Zeit der letzten Aktualisierung.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt	Die Antwortdaten für eine angeforderte Liste von Elementen.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Evals - eval erstellen

POST {endpoint}/openai/v1/evals

Erstellen Sie die Auswertung Erstellen Sie die Struktur einer Auswertung, die zum Testen der Leistung eines Modells verwendet werden kann. Eine Auswertung ist eine Reihe von Testkriterien und die Konfiguration für eine Datenquelle, die das Schema der in der Auswertung verwendeten Daten bestimmt. Nachdem Sie eine Auswertung erstellt haben, können Sie sie auf verschiedenen Modellen und Modellparametern ausführen. Wir unterstützen verschiedene Arten von Benotern und Datenquellen. Weitere Informationen finden Sie unter

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
Datenquellenkonfiguration	OpenAI.CreateEvalCustomDataSourceConfig oder OpenAI.CreateEvalLogsDataSourceConfig oder OpenAI.CreateEvalStoredCompletionsDataSourceConfig oder AzureAIDataSourceConfig	Die Konfiguration für die Datenquelle, die für die Auswertung verwendet wird, wird ausgeführt. Bestimmt das Schema der daten, die in der Auswertung verwendet werden.	Ja
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
Name	Schnur	Der Name der Auswertung.	No
properties	Objekt	Satz unveränderlicher 16 Schlüsselwertpaare, die an ein Objekt angefügt werden können, um zusätzliche Informationen zu speichern. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
Testkriterien	Array von OpenAI.EvalGraderLabelModel oder OpenAI.EvalGraderStringCheck oder OpenAI.EvalGraderTextSimilarity oder OpenAI.EvalGraderPython oder OpenAI.EvalGraderScoreModel oder EvalGraderAzureAIEvaluator	Liste der Bewerter (Grader) für alle Auswertungsausführungen in dieser Gruppe Grader können mithilfe von doppelt geschweiften Klammern auf Variablen in der Datenquelle verweisen, z {{item.variable_name}}. B. . Um auf die Ausgabe des Modells zu verweisen, verwenden Sie den sample Namespace (ie, {{sample.output_text}}).	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Eval

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Evals - eval löschen

DELETE {endpoint}/openai/v1/evals/{eval_id}

Löschen einer Auswertung Löschen einer Auswertung

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	Schnur	Die ID der zu löschenden Auswertung.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	DeleteEvalResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Bewertungen – eine Bewertung erhalten

GET {endpoint}/openai/v1/evals/{eval_id}

Abrufen einer Auswertung Abrufen einer Auswertung nach ID.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	Schnur	Die ID der abzurufenden Auswertung.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Eval

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Evals - Update eval

POST {endpoint}/openai/v1/evals/{eval_id}

Aktualisieren einer Auswertung Aktualisieren bestimmter Eigenschaften einer Auswertung.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	Schnur	Die ID der zu aktualisierenden Auswertung.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
Name	Schnur		No
properties	Objekt	Satz unveränderlicher 16 Schlüsselwertpaare, die an ein Objekt angefügt werden können, um zusätzliche Informationen zu speichern. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Eval

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Evals - Listenläufe

GET {endpoint}/openai/v1/evals/{eval_id}/runs

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

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	Schnur	ID der Auswertung, zu der Ausführungen abgerufen werden sollen
Nach	query	No	Schnur	Kennung für den letzten Ausführungslauf aus der vorherigen Paginierungsanforderung.
Limit	query	No	integer	Anzahl der abzurufenden Ausführungen
order	query	No	Schnur Mögliche Werte: asc, desc	Sortierreihenfolge der Ausführungen nach Zeitstempel Verwenden Sie asc für aufsteigende Reihenfolge oder desc für absteigende Reihenfolge. Wird standardmäßig auf asc festgelegt.
status	query	No	Schnur Mögliche Werte: queued, in_progress, completed, canceled, . failed Filtern der Ausführungen nach Status Einer von queued, in_progress, failed, completed, . canceled

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt	Die Antwortdaten für eine angeforderte Liste von Elementen.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Evals - eval run erstellen

POST {endpoint}/openai/v1/evals/{eval_id}/runs

Auswertungsausführung erstellen

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	Schnur	ID der Auswertung, für die eine Ausführung erstellt werden soll.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
Datenquelle	OpenAI.CreateEvalJsonlRunDataSource oder OpenAI.CreateEvalCompletionsRunDataSource oder OpenAI.CreateEvalResponsesRunDataSource oder EvalRunDataSource	Details zur Datenquelle der Ausführung.	Ja
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
Name	Schnur	Name der Ausführung	No
properties	Objekt	Satz unveränderlicher 16 Schlüsselwertpaare, die an ein Objekt angefügt werden können, um zusätzliche Informationen zu speichern. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	EvalRun

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Evals - eval run löschen

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Auswertungsausführung löschen Löschen einer Eval-Ausführung.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	Schnur	Die ID der Auswertung, aus der der Lauf gelöscht werden soll.
run_id	path	Ja	Schnur	ID der zu löschenden Ausführung

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	DeleteEvalRunResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Evaluierungen – Eval-Durchlauf

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Abrufen einer Auswertungsausführung Abrufen einer Auswertung, die nach ID ausgeführt wird.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	Schnur	ID der Auswertung, zu der Ausführungen abgerufen werden sollen
run_id	path	Ja	Schnur	ID der abzurufenden Ausführung

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	EvalRun

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Evals - Abbrechen der Ausführung der Auswertung

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Abbrechen der Auswertungsausführung Abbrechen einer laufenden Auswertungsausführung.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	Schnur	Die ID der Auswertung, deren Ausführung Sie abbrechen möchten.
run_id	path	Ja	Schnur	ID der Ausführung, die abgebrochen werden soll

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	EvalRun

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Evals - Ausgabeelemente abrufen

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items

Abrufen von Ausgabeelementen für die Auswertungsausführung Abrufen einer Liste der Ausgabeelemente für einen Auswertungslauf.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	Schnur
run_id	path	Ja	Schnur	ID der Ausführung, für die Ausgabeelemente abgerufen werden sollen
Nach	query	No	Schnur	Kennung für den letzten Ausführungslauf aus der vorherigen Paginierungsanforderung.
Limit	query	No	integer	Anzahl der abzurufenden Ausführungen
order	query	No	Schnur Mögliche Werte: asc, desc	Sortierreihenfolge der Ausführungen nach Zeitstempel Verwenden Sie asc für aufsteigende Reihenfolge oder desc für absteigende Reihenfolge. Wird standardmäßig auf asc festgelegt.
status	query	No	Schnur Mögliche Werte: fail, pass	Filtert Ausgabeelemente nach Status. Verwendung failed zum Filtern nach fehlgeschlagener Ausgabe Elemente oder pass zum Filtern nach übergebenen Ausgabeelementen.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt	Die Antwortdaten für eine angeforderte Liste von Elementen.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Evals – Ausgabeelement "eval run" abrufen

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}

Abrufen eines Ausgabeelements einer Auswertungsausführung Abrufen eines Ausgabeelements für die Auswertungsausführung nach ID.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	Schnur	ID der Auswertung, zu der Ausführungen abgerufen werden sollen
run_id	path	Ja	Schnur	ID der abzurufenden Ausführung
output_item_id	path	Ja	Schnur	Die ID des abzurufenden Ausgabeelements.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	EvalRunOutputItem

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Fine-Tuning

Erstellen eines Feinabstimmungsauftrags

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

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

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

Erfahren Sie mehr über Feinabstimmung

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
Hyperparameter	OpenAI.CreateFineTuningJobRequestHyperparameters		No
└- batch_size	String oder OpenAI.integer		No	auto
└– Lernraten-Multiplikator	Zeichenfolge oder OpenAI.numeric		No
└– n_epochs	String oder OpenAI.integer		No	auto
Integrationen	Array von OpenAI.CreateFineTuningJobRequestIntegrations	Eine Liste der Integrationen, die Für Ihren Feinabstimmungsauftrag aktiviert werden sollen.	No
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
method	OpenAI.FineTuneMethod	Die Methode, die für die Feinabstimmung verwendet wird.	No
model	string (siehe gültige Modelle unten)	Der Name des Modells, das optimiert werden soll. Sie können eine der Folgenden auswählen: unterstützte Modelle.	Ja
seed	OpenAI.integer (nullable)		No
Suffix	String (nullierbar)	Eine Zeichenfolge von bis zu 64 Zeichen, die ihrem fein abgestimmten Modellnamen hinzugefügt werden. Beispielsweise würde ein suffix "custom-model-name" einen Modellnamen wie ft:gpt-4o-mini:openai:custom-model-name:7p4lURel. Einschränkungen: minLength: 1, maxLength: 64	No
Trainingsdatei	Schnur	Die ID einer hochgeladenen Datei, die Schulungsdaten enthält. Informationen zum Hochladen einer Datei finden Sie unter "Hochladen einer Datei". Ihr Dataset muss als JSONL-Datei formatiert werden. Darüber hinaus müssen Sie Ihre Datei mit dem Zweck fine-tunehochladen. Der Inhalt der Datei sollte je nachdem, ob das Modell das Chat-, Abschlussformat verwendet oder wenn die Feinabstimmungsmethode das Einstellungsformat verwendet. Weitere Details finden Sie im Fine-Tuning-Leitfaden.	Ja
Validierungsdatei	String (nullierbar)	Die ID einer hochgeladenen Datei, die Überprüfungsdaten enthält. Wenn Sie diese Datei angeben, werden die Daten verwendet, um die Validierung zu generieren. Metriken werden während der Feinabstimmung regelmäßig überprüft. Diese Metriken können in die Feinabstimmungsergebnisdatei. Die gleichen Daten sollten nicht sowohl in Train- als auch in Validierungsdateien vorhanden sein. Ihr Dataset muss als JSONL-Datei formatiert werden. Sie müssen Ihre Datei mit dem Zweck fine-tunehochladen. Weitere Details finden Sie im Fine-Tuning-Leitfaden.	No

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.FineTuningJob

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Auflisten von paginierten Feinabstimmungsaufträgen

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

Auflisten der Feinabstimmungsaufträge Ihrer Organisation

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Nach	query	No	Schnur	Bezeichner für den letzten Auftrag aus der vorherigen Paginierungsanforderung.
Limit	query	No	integer	Anzahl der abzurufenden Feinabstimmungsaufträge.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.ListPaginatedFineTuningJobsResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Feinabstimmungsauftrag abrufen

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

Erhalten Sie Informationen zu einem Feinabstimmungsauftrag.

Erfahren Sie mehr über Feinabstimmung

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Ja	Schnur	Die ID des Feinabstimmungsauftrags.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.FineTuningJob

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Abbrechen des Feinabstimmungsauftrags

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

Sofortiges Abbrechen eines Feinabstimmungsauftrags.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Ja	Schnur	Die ID des abzubrechenden Feinabstimmungsauftrags.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.FineTuningJob

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Auflisten von Feinabstimmungsauftragsprüfpunkten

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

Auflisten von Prüfpunkten für einen Feinabstimmungsauftrag.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Ja	Schnur	Die ID des Feinabstimmungsauftrags, für den Prüfpunkte abgerufen werden sollen.
Nach	query	No	Schnur	Bezeichner für die letzte Prüfpunkt-ID aus der vorherigen Paginierungsanforderung.
Limit	query	No	integer	Anzahl der abzurufenden Prüfpunkte.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.ListFineTuningJobCheckpointsResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Auflisten von Feinabstimmungsauftragsereignissen

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

Erhalten Sie fein abgestimmte Statusupdates für einen Feinabstimmungsauftrag.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Ja	Schnur	Die ID des Feinabstimmungsauftrags, für den Ereignisse abgerufen werden sollen.
Nach	query	No	Schnur	Bezeichner für das letzte Ereignis aus der vorherigen Paginierungsanforderung.
Limit	query	No	integer	Anzahl der abzurufenden Ereignisse.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.ListFineTuningJobEventsResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Feinabstimmungsauftrag anhalten

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

Anhalten eines ausgeführten Feinabstimmungsauftrags.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Ja	Schnur	Die ID des zu unterbrechenden Feinabstimmungsauftrags.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.FineTuningJob

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Feinabstimmungsauftrag fortsetzen

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

Fortsetzen eines angehaltenen Feinabstimmungsauftrags.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Ja	Schnur	Die ID des Feinabstimmungsauftrags, der fortgesetzt werden soll.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.FineTuningJob

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Responses

Antwort erstellen – Antwortdatenstrom erstellen

POST {endpoint}/openai/v1/responses

Erstellt eine Modellantwort. Erstellt eine Modellantwort (Streamingantwort).

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
Hintergrund	boolescher Wert (nullable)		No
Gespräch	OpenAI.ConversationParam (nullierbar)	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.	No
einschließen	Array von OpenAI.IncludeEnum		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 - Unterhaltungsstatus - Funktionsaufrufe	No
instructions	String (nullierbar)		No
max_output_tokens	OpenAI.integer (nullable)		No
max_tool_calls	OpenAI.integer (nullable)		No
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
model	Schnur	Das Modell, das für die Erstellung dieser Antwort eingesetzt werden soll.	No
Parallele Werkzeugaufrufe	boolescher Wert (nullable)		No	Richtig
previous_response_id	String (nullierbar)		No
Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen. Erfahren Sie mehr.	No
prompt_cache_key	Schnur	Wird von OpenAI verwendet, um Antworten für ähnliche Anforderungen zwischenzuspeichern, um ihre Cachetreffraten zu optimieren. Ersetzt das user Feld. Erfahren Sie mehr.	No
prompt_cache_retention	enum	Mögliche Werte: in-memory, 24h	No
reasoning	OpenAI.Reasoning (nullierbar)	nur gpt-5- und o-Series-Modelle Konfigurationsoptionen für Begründungsmodelle.	No
└– Aufwand	OpenAI.ReasoningEffort	Schränkt den Aufwand für die Begründung ein Begründungsmodelle. Derzeit unterstützte Werte sind none, , minimal, low, medium, highund 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, mediumund 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	enum	Mögliche Werte: auto, , concisedetailed	No
└– Zusammenfassung	enum	Mögliche Werte: auto, , concisedetailed	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 Zeichenfolge sein, die jeden Benutzer eindeutig identifiziert. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Erfahren Sie mehr.	No
Dienststufe	OpenAI.ServiceTier	Gibt den Verarbeitungstyp an, der für die Bereitstellung der Anforderung verwendet wird. – Bei Festlegung auf "Auto" wird die Anforderung mit der in den Project Einstellungen konfigurierten Dienstebene verarbeitet. Sofern nicht anders konfiguriert, verwendet die Project "default". - Bei Festlegung auf "Standard" wird die Anforderung mit den Standardpreisen und der Leistung für das ausgewählte Modell verarbeitet. - Wenn sie auf "Flex" oder "Priorität" festgelegt ist, wird die Anforderung mit der entsprechenden Dienstebene verarbeitet. - Wenn sie nicht festgelegt ist, lautet das Standardverhalten "auto". Wenn der service_tier Parameter festgelegt ist, enthält der Antworttext den service_tier Wert basierend auf dem Verarbeitungsmodus, der tatsächlich für die Anforderung verwendet wird. Dieser Antwortwert kann sich von dem wert unterscheiden, der im Parameter festgelegt wurde.	No
abspeichern	boolescher Wert (nullable)		No	Richtig
stream	boolescher Wert (nullable)		No
stream_options	OpenAI.ResponseStreamOptions (nullable)	Optionen für Antworten im Streaming-Bereich. Legen Sie dies nur fest, wenn Sie festlegen stream: true.	No
└– 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
structured_inputs	Objekt	Die strukturierten Eingaben für die Antwort, die an der Eingabeaufforderungsvorlagenersetzung oder Toolargumentbindungen teilnehmen können.	No
Temperatur	OpenAI.numeric (nullierbar)		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
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 Funktionen des Modells, z. B. die Websuche oder Dateisuche. Weitere Informationen zu integrierte Tools. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Tools. - 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 Funktionsaufrufe. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
top_logprobs	OpenAI.integer (nullable)		No
top_p	OpenAI.numeric (nullierbar)		No	1
truncation	enum	Mögliche Werte: auto, disabled	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. Erfahren Sie mehr.	No

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Antworten auflisten

GET {endpoint}/openai/v1/responses

Gibt die Liste aller Antworten zurück.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Limit	query	No	integer	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen. Der Standardwert ist 20.
order	query	No	Schnur Mögliche Werte: asc, desc	Sortierreihenfolge nach dem created_at Zeitstempel der Objekte. asc für aufsteigende Reihenfolge unddesc für absteigende Reihenfolge.
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.
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.
agent_name	query	No	Schnur	Filtert nach Agentname. Wenn angegeben, werden nur Elemente zurückgegeben, die dem angegebenen Agent zugeordnet sind.
agent_id	query	No	Schnur	Filtern nach Agent-ID im Format name:version. Wenn angegeben, werden nur Elemente zurückgegeben, die der angegebenen Agent-ID zugeordnet sind.
conversation_id	query	No	Schnur	Filtern nach Unterhaltungs-ID. Wenn angegeben, werden nur Antworten zurückgegeben, die der angegebenen Unterhaltung zugeordnet sind.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt	Die Antwortdaten für eine angeforderte Liste von Elementen.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Kompakte Antwortunterhaltung

POST {endpoint}/openai/v1/responses/compact

Erzeugt eine Komprimierung einer Antwortunterhaltung.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
input	Zeichenfolge oder Array von OpenAI.InputItem		No
instructions	String (nullierbar)		No
model	OpenAI.ModelIdsCompaction	Modell-ID, die zum Generieren der Antwort verwendet wird, z gpt-5 . B. oder o3. OpenAI bietet eine breite Palette von Modellen mit unterschiedlichen Funktionen, Leistungsmerkmalen und Preispunkten. In der Modellanleitung finden Sie Informationen zum Durchsuchen und Vergleichen der verfügbaren Modelle.	Ja
previous_response_id	String (nullierbar)		No

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.CompactResource

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Antwort abrufen – Antwortdatenstrom abrufen

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

Ruft eine Modellantwort mit der angegebenen ID ab. Ruft eine Modellantwort mit der angegebenen ID (Streamingantwort) ab.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Ja	Schnur
include[]	query	No	array
stream	query	No	boolean
starting_after	query	No	integer

Anfrage-Kopf

Name	Required	Typ	Description
Akzeptieren	Falsch	Schnur Mögliche Werte: text/event-stream

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Antwort löschen

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

Löscht eine Modellantwort.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Ja	Schnur	Die ID der zu löschenden Antwort.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	DeleteResponseResult

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Antwort abbrechen

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

Bricht eine Modellantwort ab.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Ja	Schnur	Die ID der Antwort, die abgebrochen werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	OpenAI.Response

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

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	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Ja	Schnur
Limit	query	No	integer	Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen. Der Standardwert ist 20.
order	query	No	Schnur Mögliche Werte: asc, desc	Sortierreihenfolge nach dem created_at Zeitstempel der Objekte. asc für aufsteigende Reihenfolge unddesc für absteigende Reihenfolge.
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.
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.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Objekt	Die Antwortdaten für eine angeforderte Liste von Elementen.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Redteams

Redteams - Liste

GET {endpoint}/redTeams/runs?api-version=v1

Auflisten eines Roten Teams nach Namen.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: RedTeams=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PagedRedTeam

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Redteams – holen Sie sich

GET {endpoint}/redTeams/runs/{name}?api-version=v1

Rufen Sie ein Redteam anhand des Namens ab.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
Name	path	Ja	Schnur	Bezeichner der roten Teamausführung.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: RedTeams=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	RedTeam

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Redteams – erstellen

POST {endpoint}/redTeams/runs:run?api-version=v1

Erstellt eine Redteam-Ausführung.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: RedTeams=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
applicationScenario	Schnur	Anwendungsszenario für den roten Teamvorgang, um szenariospezifische Angriffe zu generieren.	No
attackStrategies	Array von AttackStrategy	Liste der Angriffsstrategien oder geschachtelten Listen von Angriffsstrategien.	No
displayName	Schnur	Name der Rot-Team-Ausführung.	No
id	Zeichenfolge (schreibgeschützt)	Bezeichner der roten Teamausführung.	Ja
numTurns	integer	Anzahl der Simulationsrunden.	No
properties	Objekt	Eigenschaften des roten Teams. Im Gegensatz zu Tags sind Eigenschaften nur add-only. Nachdem eine Eigenschaft hinzugefügt wurde, kann keine Eigenschaft entfernt werden.	No
riskCategories	Array von RiskCategory	Liste der Risikokategorien, für die Angriffsziele generiert werden sollen.	No
simulationOnly	boolean	Nur Simulation oder Simulation + Auswertung. Standardwert "false", wenn "true" die Ausgabe des Unterhaltungsergebnisses ohne Auswertung ausgibt.	No	Falsch
status	Zeichenfolge (schreibgeschützt)	Status des roten Teams. Sie wird nach Dienst festgelegt und ist schreibgeschützt.	No
tags	Objekt	Die Tags des roten Teams. Im Gegensatz zu Eigenschaften sind Tags vollständig änderbar.	No
target	TargetConfig	Abstrakte Klasse für die Zielkonfiguration.	Ja
└– Typ	Schnur	Typ der Modellkonfiguration.	Ja

Responses

Statuscode: 201

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

Inhaltstyp	Typ	Beschreibung
Anwendung/json	RedTeam

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Schedules

Zeitpläne – Liste

GET {endpoint}/schedules?api-version=v1

Listet alle Zeitpläne auf.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
type	query	No	Schnur Mögliche Werte: Evaluation, Insight	Filtern Sie nach dem Typ des Zeitplans.
enabled	query	No	boolean	Filtern Sie nach dem aktivierten Status.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Schedules=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PagedSchedule

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Zeitpläne – Löschen

DELETE {endpoint}/schedules/{id}?api-version=v1

Löschen eines Zeitplans.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
id	path	Ja	Schnur	Bezeichner des Zeitplans.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Schedules=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 204

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

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Zeitpläne – abrufen

GET {endpoint}/schedules/{id}?api-version=v1

Abrufen eines Zeitplans nach ID.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
id	path	Ja	Schnur	Bezeichner des Zeitplans.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Schedules=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Schedule

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Zeitpläne – Erstellen oder Aktualisieren

PUT {endpoint}/schedules/{id}?api-version=v1

Erstellen oder Aktualisieren der Vorgangsvorlage.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
id	path	Ja	Schnur	Bezeichner des Zeitplans.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Schedules=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Anforderungstext

Content-Type: application/json

Name	Typ	Description	Required	Vorgabe
description	Schnur	Beschreibung des Zeitplans.	No
displayName	Schnur	Name des Zeitplans.	No
enabled	boolean	Aktivierter Status des Zeitplans.	Ja
id	Zeichenfolge (schreibgeschützt)	Bezeichner des Zeitplans.	Ja
properties	Objekt	Eigenschaften des Zeitplans. Im Gegensatz zu Tags sind Eigenschaften nur add-only. Nachdem eine Eigenschaft hinzugefügt wurde, kann keine Eigenschaft entfernt werden.	No
Stand der Bereitstellung	ScheduleProvisioningStatus (schreibgeschützt)	Planen Sie den Bereitstellungsstatus.	No
Systemdaten	-Objekt (schreibgeschützt)	Systemmetadaten für die Ressource.	Ja
tags	Objekt	Tags des Zeitplans. Im Gegensatz zu Eigenschaften sind Tags vollständig änderbar.	No
Aufgabe	ScheduleTask	Aufgabenmodell planen.	Ja
└– Konfiguration	Objekt	Konfiguration für die Aufgabe.	No
└– Typ	ScheduleTaskType	Typ des Vorgangs.	Ja
trigger	Auslösen	Basismodell für Trigger des Zeitplans.	Ja
└– Typ	Trigger-Typ	Typ des Auslösers.	Ja

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Schedule

Statuscode: 201

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

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Schedule

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Zeitpläne – Listenausführungen

GET {endpoint}/schedules/{id}/runs?api-version=v1

Listet alle Zeitplanausführungen auf.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.
id	path	Ja	Schnur	Bezeichner des Zeitplans.
type	query	No	Schnur Mögliche Werte: Evaluation, Insight	Filtern Sie nach dem Typ des Zeitplans.
enabled	query	No	boolean	Filtern Sie nach dem aktivierten Status.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Schedules=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	PagedScheduleRun

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	Azure. Core.Foundation.ErrorResponse

Antwortheader:

Header	Typ	Description
x-ms-error-code	Schnur	Zeichenfolgenfehlercode, der angibt, was schief gelaufen ist.

Zeitpläne – get run

GET {endpoint}/schedules/{schedule_id}/runs/{run_id}?api-version=v1

Rufen Sie einen Zeitplan nach ID ab.

URI-Parameter

Name	In	Required	Typ	Description
endpoint	path	Ja	Schnur	Foundry Project Endpunkt im Formular "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Wenn Sie nur einen Project im Foundry Hub haben oder die Standard-Project verwenden Sie das Formular in Ihrem Hub. "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
schedule_id	path	Ja	Schnur	Der eindeutige Bezeichner des Zeitplans.
run_id	path	Ja	Schnur	Der eindeutige Bezeichner der Zeitplanausführung.
API-Version	query	Ja	Schnur	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anfrage-Kopf

Name	Required	Typ	Description
Foundry-Features	Richtig	Schnur Mögliche Werte: Schedules=V1Preview	Ein Featurekennzeichnungs-Opt-In erforderlich, wenn Sie Vorschauvorgänge verwenden oder beibehaltene Vorschauressourcen ändern.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ScheduleRun

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp	Typ	Beschreibung
Anwendung/json	ApiErrorResponse

Components

A2APreviewTool

Ein Agent, der das A2A-Protokoll implementiert.

Name	Typ	Description	Required	Vorgabe
agent_card_path	Schnur	Der Pfad zur Agentenkarte relativ zu .base_url Wenn nicht angegeben, wird standardmäßig /.well-known/agent-card.json	No
base_url	Schnur	Basis-URL des Agenten.	No
project_connection_id	Schnur	Die Verbindungs-ID im project für den A2A-Server. In der Verbindung werden die Authentifizierung und andere Verbindungsdetails gespeichert, die für die Verbindung mit dem A2A-Server erforderlich sind.	No
type	enum	Der Typ des Tools. Immer "a2a_preview. Mögliche Werte: a2a_preview	Ja

AISearchIndexResource

Eine AI Search Index-Ressource.

Name	Typ	Description	Required	Vorgabe
filter	Schnur	Filterzeichenfolge für die Suchressource. Weitere Informationen finden Sie hier.	No
index_asset_id	Schnur	Index-Objekt-ID für die Suchressource.	No
index_name	Schnur	Der Name eines Indexes in einer indexResource, die diesem Agent zugeordnet ist.	No
project_connection_id	Schnur	Eine Indexverbindungs-ID in einer IndexResource, die an diesen Agent angefügt ist.	No
Abfrage_typ	AzureAISearchQueryType	Verfügbare Abfragetypen für das Azure KI-Suche-Tool.	No
top_k	integer	Die Anzahl der Dokumente, die aus der Suche abgerufen und dem Modell präsentiert werden sollen.	No

AgentClusterInsightRequest

Einblicke in die Ergebnisse der Agentenbewertung

Name	Typ	Description	Required	Vorgabe
Name des Agenten.	Schnur	Bezeichner für den Agent.	Ja
modelKonfiguration	InsightModelConfiguration	Konfiguration des Modells, das bei der Generierung von Erkenntnissen verwendet wird.	No
└– modelDeploymentName	Schnur	Die modellbasierte Bereitstellung, die ausgewertet werden soll. Akzeptiert entweder den Bereitstellungsnamen allein oder mit dem Verbindungsnamen als {connectionName}/<modelDeploymentName>.	Ja
type	enum	Der Anforderungstyp. Mögliche Werte: AgentClusterInsight	Ja

AgentClusterInsightResult

Erkenntnisse aus der Agent-Cluster-Analyse.

Name	Typ	Description	Required	Vorgabe
clusterInsight	ClusterInsightResult	Erkenntnisse aus der Clusteranalyse.	Ja
type	enum	Der Typ des Insights-Ergebnisses. Mögliche Werte: AgentClusterInsight	Ja

AgentContainerObject

Die Details des Containers einer bestimmten Version eines Agents.

Name	Typ	Description	Required	Vorgabe
container	ContainerDetails (schreibgeschützt)	Detaillierte Informationen zum Container.	No
└– health_state	Schnur	Der Integritätszustand des Containers.	Ja
└– provisioning_error	Schnur	Der Bereitstellungsfehler des Containers, falls vorhanden.	No
└– provisioning_state	Schnur	Der Bereitstellungsstatus des Containers.	Ja
└- Replikate	Array von ContainerReplica	Die Liste der Replikate im Container.	Ja
└– Zustand	Schnur	Der Status des Containers.	Ja
└– updated_on	Schnur	Der Zeitpunkt der letzten Aktualisierung des Containers.	Ja
erstellt_am	Schnur	Die Erstellungszeit des Containers.	Ja
Error_message	Zeichenfolge (schreibgeschützt)	Die Fehlermeldung, wenn der Container nicht ausgeführt werden konnte, falls vorhanden.	No
id	Zeichenfolge (schreibgeschützt)	Der Bezeichner des Containers.	No
max_replicas	integer	Die maximale Anzahl von Replikaten für den Container. Der Standardwert ist 1.	No
min_replicas	integer	Die Mindestanzahl der Replikate für den Container. Der Standardwert ist 1.	No
Objekt	enum	Der Objekttyp, der immer "agent.container" ist. Mögliche Werte: agent.container	Ja
status	AgentContainerStatus (schreibgeschützt)	Status des Containers einer bestimmten Version eines Agents.	Ja
updated_at	Schnur	Der Zeitpunkt der letzten Aktualisierung des Containers.	Ja

AgentContainerOperationError

Die Fehlerdetails des Containervorgangs, falls vorhanden.

Name	Typ	Description	Required	Vorgabe
Programmcode	Schnur	Der Fehlercode des Containervorgangs( falls vorhanden).	Ja
message	Schnur	Die Fehlermeldung des Containervorgangs, falls vorhanden.	Ja
type	Schnur	Der Fehlertyp des Containervorgangs, falls vorhanden.	Ja

AgentContainerOperationObject

Der Containervorgang für eine bestimmte Version eines Agents.

Name	Typ	Description	Required	Vorgabe
agent_id	Schnur	Die ID des Agenten.	Ja
agent_version_id	Schnur	Die ID der Agentversion.	Ja
container	AgentContainerObject	Die Details des Containers einer bestimmten Version eines Agents.	No
└– Container	ContainerDetails (schreibgeschützt)	Die detaillierten Containerinformationen.	No
└– created_at	Zeichenfolge (schreibgeschützt)	Die Erstellungszeit des Containers.	Ja
└– error_message	Zeichenfolge (schreibgeschützt)	Die Fehlermeldung, wenn der Container nicht ausgeführt werden konnte, falls vorhanden.	No
└– ID	Zeichenfolge (schreibgeschützt)	Der Bezeichner des Containers.	No
└– max_replicas	integer	Die maximale Anzahl von Replikaten für den Container. Der Standardwert ist 1.	No
└– min_replicas	integer	Die Mindestanzahl der Replikate für den Container. Der Standardwert ist 1.	No
└- Objekt	enum	Der Objekttyp, der immer "agent.container" ist. Mögliche Werte: agent.container	Ja
└─ Status	AgentContainerStatus (schreibgeschützt)	Der Status des Containers einer bestimmten Version eines Agents.	Ja
└– updated_at	Zeichenfolge (schreibgeschützt)	Der Zeitpunkt der letzten Aktualisierung des Containers.	Ja
Fehler	AgentContainerOperationError	Die Fehlerdetails des Containervorgangs, falls vorhanden.	No
└– Code	Schnur	Der Fehlercode des Containervorgangs( falls vorhanden).	Ja
└– Nachricht	Schnur	Die Fehlermeldung des Containervorgangs, falls vorhanden.	Ja
└– Typ	Schnur	Der Fehlertyp des Containervorgangs, falls vorhanden.	Ja
id	Schnur	Die ID des Containervorgangs. Diese ID ist eindeutiger Bezeichner im gesamten System.	Ja
status	AgentContainerOperationStatus	Status des Containervorgangs für eine bestimmte Version eines Agents.	Ja

AgentContainerOperationStatus

Status des Containervorgangs für eine bestimmte Version eines Agents.

Property	Wert
Typ	Schnur
Werte	NotStarted InProgress Succeeded Failed

AgentContainerStatus

Status des Containers einer bestimmten Version eines Agents.

Property	Wert
Typ	Schnur
Werte	Starting Running Stopping Stopped Failed Deleting Deleted Updating

AgentDefinition

Diskriminator für AgentDefinition

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

Typwert	Schema
prompt	PromptAgentDefinition
workflow	WorkflowAgentDefinition
hosted	HostedAgentDefinition
container_app	ContainerAppAgentDefinition

Name	Typ	Description	Required	Vorgabe
kind	AgentKind		Ja
rai_config	RaiConfig	Konfiguration für die Inhaltsfilterung und Sicherheitsfunktionen von Responsible AI (RAI).	No
└– rai_policy_name	Schnur	Der Name der zu übernehmenden RAI-Richtlinie.	Ja

AgentKind

Property	Wert
Typ	Schnur
Werte	prompt hosted container_app workflow

AgentObject

Name	Typ	Description	Required	Vorgabe
id	Schnur	Der eindeutige Bezeichner des Agents.	Ja
Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 63	Ja
Objekt	enum	Der Objekttyp, der immer "Agent" ist. Mögliche Werte: agent	Ja
versions	Objekt	Die neueste Version des Agents.	Ja
└– neueste	AgentVersionObject		Ja

AgentProtocol

Property	Wert
Typ	Schnur
Werte	activity_protocol responses

AgentReference

Name	Typ	Description	Required	Vorgabe
Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
type	enum	Mögliche Werte: agent_reference	Ja
version	Schnur	Der Versionsbezeichner des Agents.	No

AgentTaxonomyInput

Eingabekonfiguration für die Auswertungstaxonomie, wenn der Eingabetyp Agent ist.

Name	Typ	Description	Required	Vorgabe
riskCategories	Array von RiskCategory	Liste der Risikokategorien, die ausgewertet werden sollen.	Ja
target	Ziel	Basisklasse für Ziele mit Diskriminatorunterstützung.	Ja
└– Typ	Schnur	Der Zieltyp.	Ja
type	enum	Eingabetyp der Auswertungstaxonomie. Mögliche Werte: agent	Ja

AgentTaxonomyInputUpdate

Eingabekonfiguration für die Auswertungstaxonomie, wenn der Eingabetyp Agent ist.

Name	Typ	Description	Required	Vorgabe
riskCategories	Array von RiskCategory	Liste der Risikokategorien, die ausgewertet werden sollen.	No
target	TargetUpdate	Basisklasse für Ziele mit Diskriminatorunterstützung.	No
└– Typ	Schnur	Der Zieltyp.	Ja
type	enum	Eingabetyp der Auswertungstaxonomie. Mögliche Werte: agent	Ja

AgentVersionObject

Name	Typ	Description	Required	Vorgabe
erstellt_am	integer	Der Unix-Zeitstempel (Sekunden), zu dem der Agent erstellt wurde.	Ja
Definition	AgentDefinition		Ja
description	Schnur	Eine lesbare Beschreibung des Agents. Einschränkungen: maxLength: 512	No
id	Schnur	Die eindeutige Kennung der Agent-Version.	Ja
metadata	Objekt (null)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	Ja
Name	Schnur	Der Name des Agents. Name kann zum Abrufen/Aktualisieren/Löschen des Agenten verwendet werden. Einschränkungen: maxLength: 256	Ja
Objekt	enum	Der Objekttyp, der immer 'agent.version' ist. Mögliche Werte: agent.version	Ja
version	Schnur	Der Versionsbezeichner des Agents. Agenten sind unveränderlich und jedes Update erstellt eine neue Version, wobei der Name unverändert bleibt.	Ja

AgenticIdentityPreviewCredentials

Definition der Anmeldeinformationen für die Agentenidentität

Name	Typ	Description	Required	Vorgabe
type	enum	Der Anmeldeinformationstyp Mögliche Werte: AgenticIdentityToken_Preview	Ja

ApiErrorResponse

Fehlerantwort bei API-Fehlern.

Name	Typ	Description	Required	Vorgabe
Fehler	OpenAI.Error		Ja

ApiKeyCredentials

Definition der API-Schlüsselanmeldeinformationen

Name	Typ	Description	Required	Vorgabe
key	Zeichenfolge (schreibgeschützt)	API-Schlüssel	No
type	enum	Der Anmeldeinformationstyp Mögliche Werte: ApiKey	Ja

AssetCredentialResponse

Stellt einen Verweis auf ein Blob für die Nutzung dar

Name	Typ	Description	Required	Vorgabe
blobReference	BlobReference	Details zum Blobverweis.	Ja
└– blobUri	Schnur	Blob-URI-Pfad für den Client zum Hochladen von Daten. Beispiel: https://blob.windows.core.net/Container/Path	Ja
└– Anmeldeinformationen	SasCredential	Anmeldeinformationen für den Zugriff auf das Speicherkonto.	Ja
└– storageAccountArmId	Schnur	ARM-ID des zu verwendenden Speicherkontos.	Ja

AssetId

Bezeichner einer gespeicherten Ressource.

Typ: Zeichenfolge

AttackStrategy

Strategien für Angriffe.

Property	Wert
Beschreibung	Strategien für Angriffe.
Typ	Schnur
Werte	easy moderate difficult ascii_art ascii_smuggler atbash base64 binary caesar character_space jailbreak ansi_attack character_swap suffix_append string_join unicode_confusable unicode_substitution diacritic flip leetspeak rot13 morse url baseline indirect_jailbreak tense multi_turn crescendo

Azure. Core.Foundation.Error

Das Fehlerobjekt.

Name	Typ	Description	Required	Vorgabe
Programmcode	Schnur	Eine serverdefinierte Gruppe von Fehlercodes.	Ja
details	Array von Azure. Core.Foundation.Error	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.	No
innererror	Azure. Core.Foundation.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Laut Azure REST API-Richtlinien – https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└– Code	Schnur	Eine serverdefinierte Gruppe von Fehlercodes.	No
└– innerer Fehler	Azure. Core.Foundation.InnerError	Innerer Fehler.	No
message	Schnur	Eine lesbare Darstellung des Fehlers.	Ja
target	Schnur	Das Ziel des Fehlers.	No

Azure. Core.Foundation.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Description	Required	Vorgabe
Fehler	Azure. Core.Foundation.Error	Das Fehlerobjekt.	Ja
└– Code	Schnur	Eine serverdefinierte Gruppe von Fehlercodes.	Ja
└– Einzelheiten	Array von Azure. Core.Foundation.Error	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.	No
└– innerer Fehler	Azure. Core.Foundation.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.	No
└– Nachricht	Schnur	Eine lesbare Darstellung des Fehlers.	Ja
└- Ziel	Schnur	Das Ziel des Fehlers.	No

Azure. Core.Foundation.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Laut Azure REST API-Richtlinien – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description	Required	Vorgabe
Programmcode	Schnur	Eine serverdefinierte Gruppe von Fehlercodes.	No
innererror	Azure. Core.Foundation.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Laut Azure REST API-Richtlinien – https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└– Code	Schnur	Eine serverdefinierte Gruppe von Fehlercodes.	No
└– innerer Fehler	Azure. Core.Foundation.InnerError	Innerer Fehler.	No

Azure. Core.Foundation.OperationState

Enumeration, die zulässige Betriebszustände beschreibt.

Property	Wert
Beschreibung	Enumeration, die zulässige Betriebszustände beschreibt.
Typ	Schnur
Werte	NotStarted Running Succeeded Failed Canceled

Azure. Core.uuid

Universell eindeutige Kennung

Typ: Zeichenfolge

Format: uuid

AzureAIAgentTarget

Repräsentiert ein Ziel, das einen Azure-KI-Agenten spezifiziert.

Name	Typ	Description	Required	Vorgabe
Name	Schnur	Der eindeutige Bezeichner des Azure KI-Agents.	Ja
tool_descriptions	Array von ToolDescription	Die Parameter, mit denen das Sampling-Verhalten des Agenten während der Textgenerierung gesteuert wird.	No
type	enum	Der Typ des Ziels, immer azure_ai_agent. Mögliche Werte: azure_ai_agent	Ja
version	Schnur	Die Version des Azure KI-Agents.	No

AzureAIAgentTargetUpdate

Repräsentiert ein Ziel, das einen Azure-KI-Agenten spezifiziert.

Name	Typ	Description	Required	Vorgabe
Name	Schnur	Der eindeutige Bezeichner des Azure KI-Agents.	No
tool_descriptions	Array von ToolDescription	Die Parameter, mit denen das Sampling-Verhalten des Agenten während der Textgenerierung gesteuert wird.	No
type	enum	Der Typ des Ziels, immer azure_ai_agent. Mögliche Werte: azure_ai_agent	Ja
version	Schnur	Die Version des Azure KI-Agents.	No

AzureAIDataSourceConfig

Name	Typ	Description	Required	Vorgabe
Szenario	enum	Datenschemaszenario. Mögliche Werte: red_team, , responses, traces_previewsynthetic_data_gen_preview	Ja
schema	Objekt	Das json-Allgemeine Objektschema für die ausgeführten Datenquellenelemente.	Ja
type	enum	Der Objekttyp, der immer azure_ai_sourceist. Mögliche Werte: azure_ai_source	Ja

AzureAIModelTarget

Repräsentiert ein Ziel, das ein Azure-KI-Modell für Operationen spezifiziert, die Modellauswahl erfordern.

Name	Typ	Description	Required	Vorgabe
model	Schnur	Der eindeutige Bezeichner des Azure KI-Modells.	No
Parameter für Stichprobennahme	ModelSamplingParams	Stellt eine Reihe von Parametern dar, die zum Steuern des Samplingverhaltens eines Sprachmodells während der Textgenerierung verwendet werden.	No
└– max_completion_tokens	integer	Die maximale Anzahl von Token, die im Abschluss zulässig sind.	Ja
└- Samen	integer	Der zufällige Samen zur Reproduzierbarkeit.	Ja
└– Temperatur	Zahl	Der Temperaturparameter für die Probenahme.	Ja
└– top_p	Zahl	Der Top-p-Parameter für die Kernsampling.	Ja
type	enum	Der Typ des Ziels, immer azure_ai_model. Mögliche Werte: azure_ai_model	Ja

AzureAIModelTargetUpdate

Repräsentiert ein Ziel, das ein Azure-KI-Modell für Operationen spezifiziert, die Modellauswahl erfordern.

Name	Typ	Description	Required	Vorgabe
model	Schnur	Der eindeutige Bezeichner des Azure KI-Modells.	No
Parameter für Stichprobennahme	ModelSamplingParamsUpdate	Stellt eine Reihe von Parametern dar, die zum Steuern des Samplingverhaltens eines Sprachmodells während der Textgenerierung verwendet werden.	No
└– max_completion_tokens	integer	Die maximale Anzahl von Token, die im Abschluss zulässig sind.	No
└- Samen	integer	Der zufällige Samen zur Reproduzierbarkeit.	No
└– Temperatur	Zahl	Der Temperaturparameter für die Probenahme.	No
└– top_p	Zahl	Der Top-p-Parameter für die Kernsampling.	No
type	enum	Der Typ des Ziels, immer azure_ai_model. Mögliche Werte: azure_ai_model	Ja

AzureAIResponsesEvalRunDataSource

Stellt eine Datenquelle für Auswertungsläufe dar, die für Fortlaufende Auswertungsszenarien spezifisch sind.

Name	Typ	Description	Required	Vorgabe
event_configuration_id	Schnur	Der Ereigniskonfigurationsname, der dieser Auswertungsausführung zugeordnet ist.	Ja
item_generation_params	ResponseRetrievalItemGenerationParams	Stellt die Parameter für die Generierung von Antwortabrufelementen dar.	Ja
└– data_mapping	Objekt	Zuordnung von Quellfeldern zu response_id Feld, erforderlich zum Abrufen des Chatverlaufs.	Ja
└– max_num_turns	integer	Die maximale Anzahl der zu bewertenden Chatverlaufszahlen.	Ja
└- Quelle	OpenAI.EvalJsonlFileContentSource oder OpenAI.EvalJsonlFileIdSource	Die Quelle, aus der JSONL-Inhalte gelesen werden.	Ja
└– Typ	enum	Der Typ der Elementgenerierungsparameter, immer response_retrieval. Mögliche Werte: response_retrieval	Ja
max_runs_hourly	integer	Maximale Anzahl von Auswertungsläufen pro Stunde zulässig.	Ja
type	enum	Der Typ der Datenquelle, immer azure_ai_responses. Mögliche Werte: azure_ai_responses	Ja

Azure-AI-Suchindex

Azure KI-Suche Indexdefinition

Name	Typ	Description	Required	Vorgabe
id	Zeichenfolge (schreibgeschützt)	Asset ID, eine eindeutige Kennung für das Asset	No
Name	Zeichenfolge (schreibgeschützt)	Der Name der Ressource	Ja
type	enum	Indextyp Mögliche Werte: AzureSearch	Ja
version	Zeichenfolge (schreibgeschützt)	Die Version der Ressource	Ja

AzureAISearchIndexUpdate

Azure KI-Suche Indexdefinition

Name	Typ	Description	Required	Vorgabe
description	Schnur	Der Text der Objektbeschreibung.	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No
type	enum	Indextyp Mögliche Werte: AzureSearch	Ja

AzureAISearchQueryType

Verfügbare Abfragetypen für das Azure KI-Suche-Tool.

Property	Wert
Beschreibung	Verfügbare Abfragetypen für das Azure KI-Suche-Tool.
Typ	Schnur
Werte	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchTool

Die Eingabedefinitionsinformationen für ein Azure-KI-Suchwerkzeug, wie sie zur Konfiguration eines Agenten verwendet werden.

Name	Typ	Description	Required	Vorgabe
azure_ai_search	AzureAISearchToolResource	Eine Reihe von Indexressourcen, die vom tool azure_ai_search verwendet werden.	Ja
└- Indizes	Array von AISearchIndexResource	Die an diesen Agent angefügten Indizes. Es kann maximal 1 Index geben. an den Agent angefügte Ressource. Einschränkungen: maxItems: 1	Ja
type	enum	Der Objekttyp, der immer 'azure_ai_search' ist. Mögliche Werte: azure_ai_search	Ja

AzureAISearchToolResource

Eine Reihe von Indexressourcen, die vom tool azure_ai_search verwendet werden.

Name	Typ	Description	Required	Vorgabe
Indizes	Array von AISearchIndexResource	Die an diesen Agent angefügten Indizes. Es kann maximal 1 Index geben. an den Agent angefügte Ressource.	Ja

AzureFunctionBinding

Die Struktur zum Beibehalten storage Warteschlangennamens und URI.

Name	Typ	Description	Required	Vorgabe
storage_queue	AzureFunctionStorageQueue	Die Struktur zum Beibehalten storage Warteschlangennamens und URI.	Ja
└– queue_name	Schnur	Der Name einer Azure Funktionsspeicherwarteschlange.	Ja
└– queue_service_endpoint	Schnur	URI für den Azure Storage Warteschlangendienst, mit dem Sie eine Warteschlange bearbeiten können.	Ja
type	enum	Der Bindungstyp, der immer "storage_queue" ist. Mögliche Werte: storage_queue	Ja

AzureFunctionDefinition

Die Definition der Azure-Funktion.

Name	Typ	Description	Required	Vorgabe
Funktion	Objekt	Die Definition der Azure-Funktion und deren Parameter.	Ja
└– Beschreibung	Schnur	Eine Beschreibung der Funktion, die vom Modell verwendet wird, um auszuwählen, wann und wie die Funktion aufgerufen wird.	No
└– Name	Schnur	Der Name der funktion, die aufgerufen werden soll.	Ja
└- Parameter	Objekt	Die Parameter, die die Funktionen akzeptieren, die als JSON-Schemaobjekt beschrieben werden.	Ja
input_binding	AzureFunctionBinding	Die Struktur zum Beibehalten storage Warteschlangennamens und URI.	Ja
└– storage_queue	AzureFunctionStorageQueue	Speicherwarteschlange.	Ja
└– Typ	enum	Der Bindungstyp, der immer "storage_queue" ist. Mögliche Werte: storage_queue	Ja
output_binding	AzureFunctionBinding	Die Struktur zum Beibehalten storage Warteschlangennamens und URI.	Ja
└– storage_queue	AzureFunctionStorageQueue	Speicherwarteschlange.	Ja
└– Typ	enum	Der Bindungstyp, der immer "storage_queue" ist. Mögliche Werte: storage_queue	Ja

AzureFunctionStorageQueue

Die Struktur zum Beibehalten storage Warteschlangennamens und URI.

Name	Typ	Description	Required	Vorgabe
queue_name	Schnur	Der Name einer Azure Funktionsspeicherwarteschlange.	Ja
queue_service_endpoint	Schnur	URI für den Azure Storage Warteschlangendienst, mit dem Sie eine Warteschlange bearbeiten können.	Ja

AzureFunctionTool

Die Eingabedefinitionsinformationen für ein Azure Function Tool, wie sie zur Konfiguration eines Agenten verwendet werden.

Name	Typ	Description	Required	Vorgabe
azure_function	AzureFunctionDefinition	Die Definition der Azure-Funktion.	Ja
└- Funktion	Objekt	Die Definition der Azure-Funktion und deren Parameter.	Ja
└– Beschreibung	Schnur	Eine Beschreibung der Funktion, die vom Modell verwendet wird, um auszuwählen, wann und wie die Funktion aufgerufen wird.	No
└– Name	Schnur	Der Name der funktion, die aufgerufen werden soll.	Ja
└- Parameter	Objekt	Die Parameter, die die Funktionen akzeptieren, die als JSON-Schemaobjekt beschrieben werden.	Ja
└– input_binding	AzureFunctionBinding	Eingabespeicherwarteschlange. Der Warteschlangenspeichertrigger führt eine Funktion aus, wenn Meldungen hinzugefügt werden.	Ja
└– output_binding	AzureFunctionBinding	Ausgabespeicherwarteschlange. Die Funktion schreibt die Ausgabe in diese Warteschlange, wenn die Eingabeelemente verarbeitet werden.	Ja
type	enum	Der Objekttyp, der immer 'browser_automation' ist. Mögliche Werte: azure_function	Ja

AzureOpenAIModelConfiguration

Azure OpenAI-Modellkonfiguration. Die API-Version wird vom Dienst für die Abfrage des Modells ausgewählt.

Name	Typ	Description	Required	Vorgabe
modelDeploymentName	Schnur	Bereitstellungsname für das AOAI-Modell. Beispiel: gpt-4o, wenn in AIServices oder verbindungsbasiert connection_name/deployment_name (z. B. my-aoai-connection/gpt-4o).	Ja
type	enum	Mögliche Werte: AzureOpenAIModel	Ja

BaseCredentials

Eine Basisklasse für Verbindungsanmeldeinformationen

Diskriminator für BaseCredentials

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

Typwert	Schema
ApiKey	ApiKeyCredentials
AAD	EntraIDCredentials
CustomKeys	CustomCredential
SAS	SASCredentials
None	NoAuthenticationCredentials
AgenticIdentityToken_Preview	AgenticIdentityPreviewCredentials

Name	Typ	Description	Required	Vorgabe
type	CredentialType (schreibgeschützt)	Der von der Verbindung verwendete Anmeldeinformationstyp	Ja

BingCustomSearchConfiguration

Eine bing benutzerdefinierte Suchkonfiguration.

Name	Typ	Description	Required	Vorgabe
count	integer	Die Anzahl der Suchergebnisse, die in der Bing-API-Antwort zurückgegeben werden sollen	No
freshness	Schnur	Filtern von Suchergebnissen nach einem bestimmten Zeitraum. Hier finden Sie akzeptierte Werte.	No
instance_name	Schnur	Name der benutzerdefinierten Konfigurationsinstanz, die für die Konfiguration angegeben wird.	Ja
Markt	Schnur	Der Markt, aus dem die Ergebnisse stammen.	No
project_connection_id	Schnur	Project Verbindungs-ID für die Grundlage für die Bing-Suche	Ja
set_lang	Schnur	Die Sprache, die beim Aufrufen der Bing-API für Benutzeroberflächenzeichenfolgen verwendet werden soll.	No

BingCustomSearchPreviewTool

Die Eingabedefinitionsinformationen für ein Bing benutzerdefiniertes Suchtool zur Konfiguration eines Agents.

Name	Typ	Description	Required	Vorgabe
bing_custom_search_preview	BingCustomSearchToolParameters	Die parameter bing benutzerdefinierten Suchtools.	Ja
└– search_configurations	Array von BingCustomSearchConfiguration	Die an dieses Tool angefügten project Verbindungen. Es kann maximal 1 Verbindung bestehen. an das Tool angefügte Ressource. Einschränkungen: maxItems: 1	Ja
type	enum	Der Objekttyp, der immer 'bing_custom_search_preview' ist. Mögliche Werte: bing_custom_search_preview	Ja

BingCustomSearchToolParameters

Die parameter bing benutzerdefinierten Suchtools.

Name	Typ	Description	Required	Vorgabe
search_configurations	Array von BingCustomSearchConfiguration	Die an dieses Tool angefügten project Verbindungen. Es kann maximal 1 Verbindung bestehen. an das Tool angefügte Ressource.	Ja

BingGroundingSearchConfiguration

Suchkonfiguration für Bing-Erdung

Name	Typ	Description	Required	Vorgabe
count	integer	Die Anzahl der Suchergebnisse, die in der Bing-API-Antwort zurückgegeben werden sollen	No
freshness	Schnur	Filtern von Suchergebnissen nach einem bestimmten Zeitraum. Hier finden Sie akzeptierte Werte.	No
Markt	Schnur	Der Markt, aus dem die Ergebnisse stammen.	No
project_connection_id	Schnur	Project Verbindungs-ID für die Grundlage für die Bing-Suche	Ja
set_lang	Schnur	Die Sprache, die beim Aufrufen der Bing-API für Benutzeroberflächenzeichenfolgen verwendet werden soll.	No

BingGroundingSearchToolParameters

Die Parameter für das bing-Suchtool.

Name	Typ	Description	Required	Vorgabe
search_configurations	Array von BingGroundingSearchConfiguration	Die an dieses Tool angefügten Suchkonfigurationen. Es kann maximal 1 sein. Die mit dem Tool verknüpfte Suchkonfigurationsressource.	Ja

BingGroundingTool

Die Eingabedefinitionsinformationen für ein bing Grounding-Suchtool, das zum Konfigurieren eines Agents verwendet wird.

Name	Typ	Description	Required	Vorgabe
bing_grounding	BingGroundingSearchToolParameters	Die Parameter für das bing-Suchtool.	Ja
└– search_configurations	Array von BingGroundingSearchConfiguration	Die an dieses Tool angefügten Suchkonfigurationen. Es kann maximal 1 sein. Die mit dem Tool verknüpfte Suchkonfigurationsressource. Einschränkungen: maxItems: 1	Ja
type	enum	Der Objekttyp, der immer "bing_grounding" ist. Mögliche Werte: bing_grounding	Ja

BlobReference

Details zum Blobverweis.

Name	Typ	Description	Required	Vorgabe
blobUri	Schnur	Blob-URI-Pfad für den Client zum Hochladen von Daten. Beispiel: https://blob.windows.core.net/Container/Path	Ja
credential	SasCredential	Definition der SAS-Anmeldeinformationen	Ja
└– sasUri	Zeichenfolge (schreibgeschützt)	SAS-URI	Ja
└– Typ	enum	Typ der Anmeldeinformationen Mögliche Werte: SAS	Ja
storageAccountArmId	Schnur	ARM-ID des zu verwendenden Speicherkontos.	Ja

BrowserAutomationPreviewTool

Die Eingabedefinitionsinformationen für ein Browser-Automatisierungstool, wie sie zum Konfigurieren eines Agenten verwendet werden.

Name	Typ	Description	Required	Vorgabe
browser_automation_preview	BrowserAutomationToolParameters	Definition von Eingabeparametern für das Browser Automation Tool.	Ja
└- Verbindung	BrowserAutomationToolConnectionParameters	Die Projektverbindungsparameter, die dem Browserautomatisierungstool zugeordnet sind.	Ja
type	enum	Der Objekttyp, der immer 'browser_automation_preview' ist. Mögliche Werte: browser_automation_preview	Ja

BrowserAutomationToolConnectionParameters

Definition der Eingabeparameter für die Verbindung, die vom Browser Automation Tool verwendet wird.

Name	Typ	Description	Required	Vorgabe
project_connection_id	Schnur	Die ID der Projektverbindung mit Ihrer Azure Playwright-Ressource.	Ja

BrowserAutomationToolParameters

Definition von Eingabeparametern für das Browser Automation Tool.

Name	Typ	Description	Required	Vorgabe
Verbindung	BrowserAutomationToolConnectionParameters	Definition der Eingabeparameter für die Verbindung, die vom Browser Automation Tool verwendet wird.	Ja
└– project_connection_id	Schnur	Die ID der Projektverbindung mit Ihrer Azure Playwright-Ressource.	Ja

CaptureStructuredOutputsTool

Ein Tool zum Erfassen strukturierter Ausgaben

Name	Typ	Description	Required	Vorgabe
outputs	StructuredOutputDefinition	Eine strukturierte Ausgabe, die vom Agenten erzeugt werden kann.	Ja
└– Beschreibung	Schnur	Eine Beschreibung der Ausgabe, die ausgegeben werden soll. Wird vom Modell verwendet, um zu bestimmen, wann die Ausgabe ausgegeben werden soll.	Ja
└– Name	Schnur	Der Name der strukturierten Ausgabe.	Ja
└- Schema	Objekt	Das JSON-Schema für die strukturierte Ausgabe.	Ja
└– streng	boolescher Wert (nullable)	Gibt an, ob eine strenge Überprüfung erzwungen werden soll. Standard-true.	Ja
type	enum	Der Typ des Tools. Immer capture_structured_outputs. Mögliche Werte: capture_structured_outputs	Ja

ChartCoordinate

Koordinaten für das Analysediagramm.

Name	Typ	Description	Required	Vorgabe
size	integer	Größe des Diagrammelements.	Ja
x	integer	X-Achsenkoordinate.	Ja
y	integer	Y-Achsenkoordinate.	Ja

ChatSummaryMemoryItem

Ein Speicherelement, das eine Zusammenfassung enthält, die aus Unterhaltungen extrahiert wurde.

Name	Typ	Description	Required	Vorgabe
Inhalt	Schnur	Der Inhalt des Speichers.	Ja
kind	enum	Die Art des Speicherelements. Mögliche Werte: chat_summary	Ja
memory_id	Schnur	Die eindeutige ID des Speicherelements.	Ja
scope	Schnur	Der Namespace, der Speicher logisch gruppiert und isoliert, z. B. eine Benutzer-ID.	Ja
updated_at	integer	Der Zeitpunkt der letzten Aktualisierung des Speicherelements.	Ja

ClusterInsightResult

Erkenntnisse aus der Clusteranalyse.

Name	Typ	Description	Required	Vorgabe
clusters	Array von InsightCluster	Liste der in den Erkenntnissen identifizierten Cluster.	Ja
Koordinaten	Objekt	Optionale Zuordnung von IDs zu 2D-Koordinaten, die von der UX für die Visualisierung verwendet werden. Bei den Zuordnungsschlüsseln handelt es sich um Zeichenfolgenbezeichner (z. B. eine Cluster-ID oder eine Beispiel-ID) und die Werte sind die Koordinaten und die visuelle Größe für das Rendern in einem 2D-Diagramm. Diese Eigenschaft wird nicht angegeben, es sei denn, die Clientanforderungen koordinieren (z. B. durch Übergeben includeCoordinates=true als Abfrageparameter). Beispiel: <br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br> Koordinaten sind nur für die clientseitige Visualisierung vorgesehen und nicht ändern Sie die kanonischen Insights-Ergebnisse.	No
summary	InsightSummary	Zusammenfassung der Fehlerclusteranalyse.	Ja
└- Methode	Schnur	Methode, die für das Clustering verwendet wird.	Ja
└– sampleCount	integer	Gesamtzahl der analysierten Stichproben.	Ja
└– uniqueClusterCount	integer	Gesamtanzahl eindeutiger Cluster.	Ja
└– uniqueSubclusterCount	integer	Gesamtanzahl eindeutiger Unterclusterbeschriftungen.	Ja
└– Nutzung	ClusterTokenUsage	Tokenverwendung beim Durchführen von Clusteringanalysen	Ja

ClusterTokenUsage

Token-Nutzung für die Cluster-Analyse

Name	Typ	Description	Required	Vorgabe
inputTokenUsage	integer	Verwendung von Eingabetoken	Ja
outputTokenUsage	integer	Ausgabetokenverwendung	Ja
totalTokenUsage	integer	Gesamtanzahl der Tokenverwendung	Ja

CodeBasedEvaluatorDefinition

Codebasierte Evaluatordefinition mit Python-Code

Name	Typ	Description	Required	Vorgabe
code_text	Schnur	Inlinecodetext für den Evaluator	Ja
data_schema	Objekt	Das JSON-Schema (Entwurf 2020-12) für die Eingabedaten des Evaluators. Dazu gehören Parameter wie Typ, Eigenschaften, erforderlich.	No
init_parameters	Objekt	Das JSON-Schema (Entwurf 2020-12) für die Eingabeparameter des Evaluators. Dazu gehören Parameter wie Typ, Eigenschaften, erforderlich.	No
metrics	Objekt	Liste der von diesem Evaluator erzeugten Ausgabemetriken	No
type	enum	Mögliche Werte: code	Ja

CompletionMessageToolCallChunk

Toolanrufdetails in einer Nachricht.

Name	Typ	Description	Required	Vorgabe
Funktion	FunctionToolCall	Details eines Funktionstoolaufrufs.	No
└- Argumente	Schnur	Die Argumente, mit denen die Funktion aufgerufen werden können, wie sie vom Modell im JSON-Format erzeugt werden.	Ja
└– Name	Schnur	Der Name der funktion, die aufgerufen werden soll.	Ja
id	Schnur	Die ID für den Toolaufruf.	Ja
type	enum	Der Typ des Toolaufrufs, der immer "Funktion" ist. Mögliche Werte: function	Ja

Verbindung

Antwort aus der Liste und Vorgänge zum Abrufen von Verbindungen

Name	Typ	Description	Required	Vorgabe
credentials	BaseCredentials (schreibgeschützt)	Eine Basisklasse für Verbindungsanmeldeinformationen	Ja
└– Typ	CredentialType (schreibgeschützt)	Der Typ der von der Verbindung verwendeten Anmeldeinformationen	Ja
id	Zeichenfolge (schreibgeschützt)	Ein eindeutiger Bezeichner für die Verbindung, die vom Dienst generiert wird	Ja
isDefault	boolescher Wert (schreibgeschützt)	Gibt an, ob die Verbindung als Standardverbindung des Typs markiert ist.	Ja
metadata	-Objekt (schreibgeschützt)	Metadaten der Verbindung	Ja
Name	Zeichenfolge (schreibgeschützt)	Der Anzeigename der Verbindung, die vom Benutzer bereitgestellt wird.	Ja
target	Zeichenfolge (schreibgeschützt)	Die für diesen Dienst zu verwendende Verbindungs-URL	Ja
type	ConnectionType (schreibgeschützt)	Der Typ (oder die Kategorie) der Verbindung	Ja

ConnectionType

Der Typ (oder die Kategorie) der Verbindung

Property	Wert
Beschreibung	Der Typ (oder die Kategorie) der Verbindung
Typ	Schnur
Werte	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool_Preview

ContainerAppAgentDefinition

Die Definition des Container-App-Agents.

Name	Typ	Description	Required	Vorgabe
container_app_resource_id	Schnur	Die Ressourcen-ID der Azure Container-App, die diesen Agent hosten soll. In allen Versionen nicht änderbar.	Ja
container_protocol_versions	Array von ProtocolVersionRecord	Die Protokolle, die der Agent für die Eingehende Kommunikation der Container unterstützt.	Ja
ingress_subdomain_suffix	Schnur	Das Suffix, das beim Senden des Eingangs an den Agent auf die App-Unterdomäne angewendet werden soll. Dabei kann es sich um eine Bezeichnung (z. B. "---aktuell"), eine bestimmte Überarbeitung (z. B. "--0000001") handeln oder leer sein, um den Standardendpunkt für die Container-App zu verwenden.	Ja
kind	enum	Mögliche Werte: container_app	Ja
rai_config	RaiConfig	Konfiguration für die Inhaltsfilterung und Sicherheitsfunktionen von Responsible AI (RAI).	No
└– rai_policy_name	Schnur	Der Name der zu übernehmenden RAI-Richtlinie.	Ja

ContainerDetails

Detaillierte Informationen zum Container.

Name	Typ	Description	Required	Vorgabe
health_state	Schnur	Der Integritätszustand des Containers.	Ja
provisioning_error	Schnur	Der Bereitstellungsfehler des Containers, falls vorhanden.	No
provisioning_state	Schnur	Der Bereitstellungsstatus des Containers.	Ja
replicas	Array von ContainerReplica	Die Liste der Replikate im Container.	Ja
state	Schnur	Der Status des Containers.	Ja
updated_on	Schnur	Der Zeitpunkt der letzten Aktualisierung des Containers.	Ja

ContainerLogKind

Der Typ der Protokolle, die von einem Container gestreamt werden sollen.

Property	Wert
Typ	Schnur
Werte	console system

ContainerReplica

Informationen zu einem Containerreplikat.

Name	Typ	Description	Required	Vorgabe
container_state	Schnur	Der Containerstatus des Replikats.	Ja
Name	Schnur	Der Name des Replikats.	Ja
state	Schnur	Der Status des Replikats.	Ja

ContinuousEvaluationRuleAction

Auswertungsregelaktion für die kontinuierliche Auswertung.

Name	Typ	Description	Required	Vorgabe
evalId	Schnur	Eval ID, um fortlaufende Auswertungsläufe hinzuzufügen.	Ja
maxHourlyRuns	integer	Maximale Anzahl von Auswertungsläufen pro Stunde zulässig.	No
type	enum	Mögliche Werte: continuousEvaluation	Ja

CosmosDBIndex

Definition des CosmosDB-Vektorspeicher-Index

Name	Typ	Description	Required	Vorgabe
id	Zeichenfolge (schreibgeschützt)	Asset ID, eine eindeutige Kennung für das Asset	No
Name	Zeichenfolge (schreibgeschützt)	Der Name der Ressource	Ja
type	enum	Indextyp Mögliche Werte: CosmosDBNoSqlVectorStore	Ja
version	Zeichenfolge (schreibgeschützt)	Die Version der Ressource	Ja

CosmosDBIndexUpdate

Definition des CosmosDB-Vektorspeicher-Index

Name	Typ	Description	Required	Vorgabe
description	Schnur	Der Text der Objektbeschreibung.	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No
type	enum	Indextyp Mögliche Werte: CosmosDBNoSqlVectorStore	Ja

CreateAgentFromManifestRequest

Name	Typ	Description	Required	Vorgabe
description	Schnur	Eine lesbare Beschreibung des Agents. Einschränkungen: maxLength: 512	No
manifest_id	Schnur	Die Manifest-ID, aus der die Agentversion importiert werden soll.	Ja
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
Name	Schnur	Der eindeutige Name, der den Agent identifiziert. Name kann zum Abrufen/Aktualisieren/Löschen des Agenten verwendet werden. - Muss mit alphanumerischen Zeichen beginnen und enden, - Kann Bindestriche in der Mitte enthalten - Darf 63 Zeichen nicht überschreiten. Einschränkungen: maxLength: 63	Ja
parameter_values	Objekt	Die Eingaben in das Manifest, die zu einem vollständig materialisierten Agent führen.	Ja

CreateAgentRequest

Name	Typ	Description	Required	Vorgabe
Definition	AgentDefinition		Ja
└– Art	AgentKind		Ja
└- rai_config	RaiConfig	Konfiguration für die Inhaltsfilterung und Sicherheitsfunktionen von Responsible AI (RAI).	No
description	Schnur	Eine lesbare Beschreibung des Agents. Einschränkungen: maxLength: 512	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
Name	Schnur	Der eindeutige Name, der den Agent identifiziert. Name kann zum Abrufen/Aktualisieren/Löschen des Agenten verwendet werden. - Muss mit alphanumerischen Zeichen beginnen und enden, - Kann Bindestriche in der Mitte enthalten - Darf 63 Zeichen nicht überschreiten. Einschränkungen: maxLength: 63	Ja

CreateAgentVersionFromManifestRequest

Name	Typ	Description	Required	Vorgabe
description	Schnur	Eine lesbare Beschreibung des Agents. Einschränkungen: maxLength: 512	No
manifest_id	Schnur	Die Manifest-ID, aus der die Agentversion importiert werden soll.	Ja
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
parameter_values	Objekt	Die Eingaben in das Manifest, die zu einem vollständig materialisierten Agent führen.	Ja

CreateAgentVersionRequest

Name	Typ	Description	Required	Vorgabe
Definition	AgentDefinition		Ja
└– Art	AgentKind		Ja
└- rai_config	RaiConfig	Konfiguration für die Inhaltsfilterung und Sicherheitsfunktionen von Responsible AI (RAI).	No
description	Schnur	Eine lesbare Beschreibung des Agents. Einschränkungen: maxLength: 512	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No

ErstelleBewertungsAnfrage

Name	Typ	Description	Required	Vorgabe
Datenquellenkonfiguration	OpenAI.CreateEvalCustomDataSourceConfig oder OpenAI.CreateEvalLogsDataSourceConfig oder OpenAI.CreateEvalStoredCompletionsDataSourceConfig oder AzureAIDataSourceConfig	Die Konfiguration für die Datenquelle, die für die Auswertung verwendet wird, wird ausgeführt. Bestimmt das Schema der daten, die in der Auswertung verwendet werden.	Ja
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
Name	Schnur	Der Name der Auswertung.	No
properties	Objekt	Satz unveränderlicher 16 Schlüsselwertpaare, die an ein Objekt angefügt werden können, um zusätzliche Informationen zu speichern. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
Testkriterien	Array von OpenAI.EvalGraderLabelModel oder OpenAI.EvalGraderStringCheck oder OpenAI.EvalGraderTextSimilarity oder OpenAI.EvalGraderPython oder OpenAI.EvalGraderScoreModel oder EvalGraderAzureAIEvaluator	Liste der Bewerter (Grader) für alle Auswertungsausführungen in dieser Gruppe Grader können mithilfe von doppelt geschweiften Klammern auf Variablen in der Datenquelle verweisen, z {{item.variable_name}}. B. . Um auf die Ausgabe des Modells zu verweisen, verwenden Sie den sample Namespace (ie, {{sample.output_text}}).	Ja

CreateEvalRunRequest

Name	Typ	Description	Required	Vorgabe
Datenquelle	OpenAI.CreateEvalJsonlRunDataSource oder OpenAI.CreateEvalCompletionsRunDataSource oder OpenAI.CreateEvalResponsesRunDataSource oder EvalRunDataSource	Details zur Datenquelle der Ausführung.	Ja
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
Name	Schnur	Name der Ausführung	No
properties	Objekt	Satz unveränderlicher 16 Schlüsselwertpaare, die an ein Objekt angefügt werden können, um zusätzliche Informationen zu speichern. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No

CredentialType

Der von der Verbindung verwendete Anmeldeinformationstyp

Property	Wert
Beschreibung	Der von der Verbindung verwendete Anmeldeinformationstyp
Typ	Schnur
Werte	ApiKey AAD SAS CustomKeys None AgenticIdentityToken_Preview

CronTrigger

Cron-basierter Trigger.

Name	Typ	Description	Required	Vorgabe
endTime	Schnur	Endzeit für den Cron-Zeitplan im ISO 8601-Format.	No
expression	Schnur	Cron-Ausdruck, der die Häufigkeit des Zeitplans definiert.	Ja
startTime	Schnur	Startzeit für den Cron-Zeitplan im ISO 8601-Format.	No
timeZone	Schnur	Zeitzone für den Cron-Zeitplan.	No	UTC
type	enum	Mögliche Werte: Cron	Ja

CustomCredential

Definition von benutzerdefinierten Anmeldeinformationen

Name	Typ	Description	Required	Vorgabe
type	enum	Der Anmeldeinformationstyp Mögliche Werte: CustomKeys	Ja

Dieses Objekt akzeptiert auch zusätzliche Eigenschaften vom Typ: string

DailyRecurrenceSchedule

Täglicher Wiederholungsplan.

Name	Typ	Description	Required	Vorgabe
hours	Array mit ganzzahliger Zahl	Stunden für den Terminplan der Serie.	Ja
type	enum	Täglicher Serientyp. Mögliche Werte: Daily	Ja

DataSourceConfig

Basisklasse zum Ausführen von Datenquellen mit Diskriminatorunterstützung.

Diskriminator für DataSourceConfig

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

Typwert	Schema

Name	Typ	Description	Required	Vorgabe
schema	Objekt	Das json-Allgemeine Objektschema für die ausgeführten Datenquellenelemente.	Ja
type	Schnur	Der Diskriminator des Datenquellentyps.	Ja

DatasetType

Aufzählung, um den Datentyp zu bestimmen.

Property	Wert
Beschreibung	Aufzählung, um den Datentyp zu bestimmen.
Typ	Schnur
Werte	uri_file uri_folder

DatasetVersion

DatasetVersion-Definition

Diskriminator für DatasetVersion

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

Typwert	Schema
uri_file	FileDatasetVersion
uri_folder	FolderDatasetVersion

Name	Typ	Description	Required	Vorgabe
Connectionname	Schnur	Der Azure Storage Kontoverbindungsname. Erforderlich, wenn startPendingUploadVersion vor dem Erstellen des Datasets nicht aufgerufen wurde	No
dataUri	Schnur	URI der Daten (Beispiel) Einschränkungen: minLength: 1, Muster: [a-zA-Z0-9_]	Ja
id	Zeichenfolge (schreibgeschützt)	Asset ID, eine eindeutige Kennung für das Asset	No
Isreference	boolescher Wert (schreibgeschützt)	Gibt an, ob das Dataset einen Verweis auf den Speicher enthält, oder das Dataset verwaltet den Speicher selbst. Wenn true, werden die zugrunde liegenden Daten nicht gelöscht, wenn die Datasetversion gelöscht wird.	No
Name	Zeichenfolge (schreibgeschützt)	Der Name der Ressource	Ja
type	DatasetType	Aufzählung, um den Datentyp zu bestimmen.	Ja
version	Zeichenfolge (schreibgeschützt)	Die Version der Ressource	Ja

DatasetVersionUpdate

DatasetVersion-Definition

Diskriminator für DatasetVersionUpdate

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

Typwert	Schema
uri_file	FileDatasetVersionUpdate
uri_folder	FolderDatasetVersionUpdate

Name	Typ	Description	Required	Vorgabe
description	Schnur	Der Text der Objektbeschreibung.	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No
type	DatasetType	Aufzählung, um den Datentyp zu bestimmen.	Ja

Dayofweek

Wochentage für den Wiederholungsplan.

Property	Wert
Beschreibung	Wochentage für den Wiederholungsplan.
Typ	Schnur
Werte	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

DeleteAgentResponse

Ein gelöschtes Agent-Objekt

Name	Typ	Description	Required	Vorgabe
gelöscht	boolean	Gibt an, ob der Agent erfolgreich gelöscht wurde.	Ja
Name	Schnur	Der Name des Agents.	Ja
Objekt	enum	Der Objekttyp. Immer "agent.deleted". Mögliche Werte: agent.deleted	Ja

DeleteAgentVersionResponse

Ein gelöschter Agent Version Objekt

Name	Typ	Description	Required	Vorgabe
gelöscht	boolean	Gibt an, ob der Agent erfolgreich gelöscht wurde.	Ja
Name	Schnur	Der Name des Agents.	Ja
Objekt	enum	Der Objekttyp. Immer "agent.version.deleted". Mögliche Werte: agent.version.deleted	Ja
version	Schnur	Der Versionsbezeichner des Agents.	Ja

DeleteEvalResponse

Ein gelöschtes Auswertungsobjekt

Name	Typ	Description	Required	Vorgabe
gelöscht	boolean	Gibt an, ob die Auswertung erfolgreich gelöscht wurde.	Ja
eval_id	Schnur	id des eval.	Ja
Objekt	enum	Der Objekttyp. Immer 'eval.deleted'. Mögliche Werte: eval.deleted	Ja

DeleteEvalRunResponse

Ein gelöschtes Auswertungsausführungsobjekt.

Name	Typ	Description	Required	Vorgabe
gelöscht	boolean	Gibt an, ob die Auswertung erfolgreich gelöscht wurde.	No
Objekt	enum	Der Objekttyp. Immer 'eval.deleted'. Mögliche Werte: eval.deleted	No
run_id	Schnur	id des eval.	No

DeleteMemoryStoreResponse

Name	Typ	Description	Required	Vorgabe
gelöscht	boolean	Gibt an, ob der Speicher erfolgreich gelöscht wurde.	Ja
Name	Schnur	Der Name des Speichers.	Ja
Objekt	enum	Der Objekttyp. Immer "memory_store.deleted". Mögliche Werte: memory_store.deleted	Ja

DeleteResponseResult

Das Ergebnis eines Löschantwortvorgangs.

Name	Typ	Description	Required	Vorgabe
gelöscht	enum	True immer zurückgeben Mögliche Werte: True	Ja
id	Schnur	Die Vorgangs-ID.	Ja
Objekt	enum	Gibt immer "antwort" zurück. Mögliche Werte: response	Ja

Einsatz

Definition der Modellbereitstellung

Diskriminator für die Bereitstellung

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

Typwert	Schema
ModelDeployment	ModelDeployment

Name	Typ	Description	Required	Vorgabe
Name	Zeichenfolge (schreibgeschützt)	Name der Bereitstellung	Ja
type	DeploymentType		Ja

DeploymentType

Property	Wert
Typ	Schnur
Werte	ModelDeployment

EntraIDCredentials

Definition der Entra ID-Zugangsdaten

Name	Typ	Description	Required	Vorgabe
type	enum	Der Anmeldeinformationstyp Mögliche Werte: AAD	Ja

Eval

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

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

Name	Typ	Description	Required	Vorgabe
erstellt_am	integer	Der Unix-Zeitstempel (in Sekunden) für den Zeitpunkt der Erstellung des Evals.	Ja
created_by	Schnur	der Name der Person, die die Ausführung erstellt hat.	No
Datenquellenkonfiguration	OpenAI.CreateEvalCustomDataSourceConfig oder OpenAI.CreateEvalLogsDataSourceConfig oder OpenAI.CreateEvalStoredCompletionsDataSourceConfig oder AzureAIDataSourceConfig	Konfiguration von Datenquellen, die bei Ausführung der Auswertung verwendet werden.	Ja
id	Schnur	Eindeutiger Bezeichner für die Auswertung.	Ja
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	Ja
modified_at	Ganzzahl		No
Name	Schnur	Der Name der Auswertung.	Ja
Objekt	enum	Der Objekttyp. Mögliche Werte: eval	Ja
properties	Objekt	Satz unveränderlicher 16 Schlüsselwertpaare, die an ein Objekt angefügt werden können, um zusätzliche Informationen zu speichern. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
Testkriterien	Array von OpenAI.EvalGraderLabelModel oder OpenAI.EvalGraderStringCheck oder OpenAI.EvalGraderTextSimilarity oder OpenAI.EvalGraderPython oder OpenAI.EvalGraderScoreModel oder EvalGraderAzureAIEvaluator	Eine Liste der Testkriterien.	Ja

EvalCsvFileIdSource

Stellt einen Verweis auf eine hochgeladene CSV-Datei dar, die als Quelle für Auswertungsdaten verwendet wird.

Name	Typ	Description	Required	Vorgabe
id	Schnur	Der Bezeichner der hochgeladenen CSV-Datei.	Ja
type	enum	Der Quelltyp, immer file_id. Mögliche Werte: file_id	Ja

EvalCsvRunDataSource

Stellt eine CSV-Datenquelle für Auswertungsläufe dar.

Name	Typ	Description	Required	Vorgabe
source	EvalCsvFileIdSource	Stellt einen Verweis auf eine hochgeladene CSV-Datei dar, die als Quelle für Auswertungsdaten verwendet wird.	Ja
└– ID	Schnur	Der Bezeichner der hochgeladenen CSV-Datei.	Ja
└– Typ	enum	Der Quelltyp, immer file_id. Mögliche Werte: file_id	Ja
type	enum	Der Typ der Datenquelle, immer csv. Mögliche Werte: csv	Ja

EvalGraderAzureAIEvaluator

Name	Typ	Description	Required	Vorgabe
Datenzuordnung	Objekt	Das Modell, das für die Auswertung verwendet werden soll. Muss strukturierte Ausgaben unterstützen	No
evaluator_name	Schnur	Der Name des Evaluators.	Ja
evaluator_version	Schnur	Die Version des Evaluators. Neueste Version, falls nicht angegeben.	No
initialization_parameters	Objekt	Die Initialisierungsparameter für die Auswertung. Muss strukturierte Ausgaben unterstützen	No
Name	Schnur	Name des Bewerters (Graders)	Ja
type	enum	Der Objekttyp, der immer azure_ai_evaluatorist. Mögliche Werte: azure_ai_evaluator	Ja

EvalResult

Ergebnis der Bewertung.

Name	Typ	Description	Required	Vorgabe
Name	Schnur	Name der Prüfung	Ja
Übergeben	boolean	gibt an, ob die Überprüfung erfolgreich war oder fehlgeschlagen ist.	Ja
Punktzahl	Zahl	Punktzahl	Ja
type	Schnur	Typ der Prüfung	Ja

EvalRun

Ein Schema, das eine Auswertungsausführung darstellt.

Name	Typ	Description	Required	Vorgabe
erstellt_am	integer	Unix-Zeitstempel (in Sekunden) beim Erstellen des Auswertungslaufs.	Ja
created_by	Schnur	der Name der Person, die die Ausführung erstellt hat.	No
Datenquelle	OpenAI.CreateEvalJsonlRunDataSource oder OpenAI.CreateEvalCompletionsRunDataSource oder OpenAI.CreateEvalResponsesRunDataSource oder EvalRunDataSource	Informationen zur Datenquelle der Ausführung.	Ja
Fehler	OpenAI.EvalApiError	Ein Objekt, das eine Fehlerantwort der Eval-API darstellt.	Ja
eval_id	Schnur	Bezeichner der zugeordneten Auswertung	Ja
id	Schnur	Eindeutiger Bezeichner für die Auswertungsausführung	Ja
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	Ja
model	Schnur	Das Modell, das ausgewertet wird, falls zutreffend.	Ja
modified_at	Ganzzahl		No
Name	Schnur	Name der Auswertungsausführung	Ja
Objekt	enum	Der Typ des Objekts. Immer „eval.run“ Mögliche Werte: eval.run	Ja
pro_Modell_Nutzung	Array von OpenAI.EvalRunPerModelUsage	Nutzungsstatistiken für jedes Modell während der Auswertungsausführung.	Ja
Ergebnisse_pro_Testkriterien	Array von OpenAI.EvalRunPerTestingCriteriaResults	Ergebnisse pro Testkriterien, die während der Auswertungsausführung angewendet werden.	Ja
properties	Objekt	Satz unveränderlicher 16 Schlüsselwertpaare, die an ein Objekt angefügt werden können, um zusätzliche Informationen zu speichern. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No
report_url	Schnur	URL zum gerenderten Bericht der Auswertungsausführung im Dashboard auf der Benutzeroberfläche	Ja
Ergebnisanzahl	OpenAI.EvalRunResultCounts		Ja
└– fehler	OpenAI.integer		Ja
└– fehlgeschlagen	OpenAI.integer		Ja
└– bestanden	OpenAI.integer		Ja
└– Gesamtsumme	OpenAI.integer		Ja
status	Schnur	Status der Auswertungsausführung	Ja

EvalRunDataSource

Basisklasse zum Ausführen von Datenquellen mit Diskriminatorunterstützung.

Diskriminator für EvalRunDataSource

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

Typwert	Schema
azure_ai_traces_preview	TracesPreviewEvalRunDataSource
azure_ai_synthetic_data_gen_preview	SyntheticDataGenerationPreviewEvalRunDataSource
azure_ai_responses	AzureAIResponsesEvalRunDataSource
azure_ai_target_completions	TargetCompletionEvalRunDataSource
csv	EvalCsvRunDataSource
azure_ai_red_team	RedTeamEvalRunDataSource

Name	Typ	Description	Required	Vorgabe
type	Schnur	Der Diskriminator des Datenquellentyps.	Ja

EvalRunOutputItem

Ein Schema, das ein Ausgabeelement einer Auswertungsausführung darstellt.

Name	Typ	Description	Required	Vorgabe
erstellt_am	integer	Unix-Zeitstempel (in Sekunden) beim Erstellen des Auswertungslaufs.	Ja
Datenquellenobjekt	Objekt	Details zum Datenquellelement der Eingabe	Ja
datasource_item_id	OpenAI.integer		Ja
eval_id	Schnur	Der Bezeichner der Auswertungsgruppe.	Ja
id	Schnur	Eindeutiger Bezeichner für das Ausgabeelement der Auswertungsausführung	Ja
Objekt	enum	Der Typ des Objekts. Immer „eval.run.output_item“ Mögliche Werte: eval.run.output_item	Ja
results	Array von EvalRunOutputItemResult	Eine Liste der Bewertungsergebnisse für dieses Ausgabeelement.	Ja
run_id	Schnur	Der Bezeichner der Auswertungsausführung, die diesem Ausgabeelement zugeordnet ist.	Ja
Beispiel	OpenAI.EvalRunOutputItemSample		Ja
└– Fehler	OpenAI.EvalApiError	Ein Objekt, das eine Fehlerantwort der Eval-API darstellt.	Ja
└- finish_reason	Schnur		Ja
└– Eingabe	Array von EvalRunOutputItemSampleInput		Ja
└– max_completion_tokens	OpenAI.integer		Ja
└─ Modell	Schnur		Ja
└─ Ausgabe	Array von EvalRunOutputItemSampleOutput		Ja
└- Samen	OpenAI.integer		Ja
└– Temperatur	OpenAI.numeric		Ja
└– top_p	OpenAI.numeric		Ja
└– Nutzung	OpenAI.EvalRunOutputItemSampleUsage		Ja
status	Schnur	Status der Auswertungsausführung	Ja

EvalRunOutputItemResult

Ein einzelnes Graderergebnis für ein Auswertungsausführungsausgabeelement.

Name	Typ	Description	Required	Vorgabe
label	Schnur	Die Bezeichnung, die der Metrik "Testkriterien" zugeordnet ist (z. B. "bestanden", "fail", "good", "bad").	No
metric	Schnur	Der Name der Metrik (z. B. "Fluency", "f1_score").	No
Name	Schnur	Name des Bewerters (Graders)	Ja
Übergeben	boolean	Gibt an, ob der Grader die Ausgabe als Pass betrachtet hat.	Ja
properties	Objekt	Weitere Details zur Metrik "Testkriterien".	No
Grund	Schnur	Der Grund für die Testkriterienmetrik.	No
Beispiel	Objekt (null)	Optionale Beispiel- oder Zwischendaten, die vom Grader erzeugt werden.	No
Punktzahl	OpenAI.numeric		Ja
threshold	Zahl	Der Schwellenwert, der zum Ermitteln von Bestanden/Fehlschlagen für diese Testkriterien verwendet wird, wenn er numerisch ist.	No
type	Schnur	Der Gradertyp (z. B. "string-check-grader").	No

Dieses Objekt akzeptiert auch zusätzliche Eigenschaften.

EvalRunOutputItemSampleInput

Eine Meldung im Auswertungslauf.

Name	Typ	Description	Required	Vorgabe
Inhalt	Schnur		Ja
Rolle	Schnur		Ja
tool_calls	Array von CompletionMessageToolCallChunk	Toolaufrufe innerhalb der Nachricht, falls vorhanden.	Ja

EvalRunOutputItemSampleOutput

Eine Meldung im Auswertungslauf.

Name	Typ	Description	Required	Vorgabe
Inhalt	Schnur		No
Rolle	Schnur		No
tool_calls	Array von CompletionMessageToolCallChunk	Toolaufrufe innerhalb der Nachricht, falls vorhanden.	Ja

EvalRunResultCompareItem

Metrikvergleich für eine Behandlung mit dem Ausgangswert.

Name	Typ	Description	Required	Vorgabe
deltaEstimate	Zahl	Geschätzte Differenz zwischen Behandlung und Basisplan.	Ja
Pvalue	Zahl	P-Wert für den Behandlungseffekt.	Ja
treatmentEffect	TreatmentEffectType	Art der Behandlungswirkung.	Ja
treatmentRunId	Schnur	Die Ausführungs-ID der Behandlung.	Ja
behandlungRunSummary	EvalRunResultSummary	Zusammenfassende Statistik einer Metrik in einem Auswertungslauf.	Ja
└- Mittelwert	Zahl	Mittelwert der Metrik im Auswertungslauf.	Ja
└– runId	Schnur	Die Auswertungsausführungs-ID.	Ja
└– sampleCount	integer	Anzahl der Beispiele im Auswertungslauf.	Ja
└– standardDeviation	Zahl	Standardabweichung der Metrik im Auswertungslauf.	Ja

EvalRunResultComparison

Die Vergleichsergebnisse für die Behandlung werden mit dem Ausgangswert verglichen.

Name	Typ	Description	Required	Vorgabe
baselineRunSummary	EvalRunResultSummary	Zusammenfassende Statistik einer Metrik in einem Auswertungslauf.	Ja
└- Mittelwert	Zahl	Mittelwert der Metrik im Auswertungslauf.	Ja
└– runId	Schnur	Die Auswertungsausführungs-ID.	Ja
└– sampleCount	integer	Anzahl der Beispiele im Auswertungslauf.	Ja
└– standardDeviation	Zahl	Standardabweichung der Metrik im Auswertungslauf.	Ja
compareItems	Array von EvalRunResultCompareItem	Liste der Vergleichsergebnisse für jeden Behandlungslauf.	Ja
Evaluator	Schnur	Name des Evaluators für diese Testkriterien.	Ja
metric	Schnur	Metrik, die ausgewertet wird.	Ja
testingCriteria	Schnur	Name der Testkriterien.	Ja

EvalRunResultSummary

Zusammenfassende Statistik einer Metrik in einem Auswertungslauf.

Name	Typ	Description	Required	Vorgabe
Durchschnittliche	Zahl	Mittelwert der Metrik im Auswertungslauf.	Ja
runId	Schnur	Die Auswertungsausführungs-ID.	Ja
sampleCount	integer	Anzahl der Beispiele im Auswertungslauf.	Ja
standardDeviation	Zahl	Standardabweichung der Metrik im Auswertungslauf.	Ja

EvaluationComparisonInsightRequest

Anfrage zum Evaluierungsvergleich

Name	Typ	Description	Required	Vorgabe
baselineRunId	Schnur	Die Basislauf-ID für den Vergleich.	Ja
evalId	Schnur	Bezeichner für die Auswertung.	Ja
treatmentRunIds	Array von Strings	Liste der Behandlungsausführungs-IDs für den Vergleich.	Ja
type	enum	Der Anforderungstyp. Mögliche Werte: EvaluationComparison	Ja

EvaluationComparisonInsightResult

Erkenntnisse aus dem Bewertungsvergleich.

Name	Typ	Description	Required	Vorgabe
Vergleiche	Array von EvalRunResultComparison	Vergleichsergebnisse für jede Behandlung werden gegen den Basisplan ausgeführt.	Ja
method	Schnur	Die zum Vergleich verwendete statistische Methode.	Ja
type	enum	Der Typ des Insights-Ergebnisses. Mögliche Werte: EvaluationComparison	Ja

EvaluationResultSample

Ein Auszug aus dem Auswertungsergebnis.

Name	Typ	Description	Required	Vorgabe
CorrelationInfo	Objekt	Informationen zur Korrelation für das Analysebeispiel.	Ja
evaluationResult	EvalResult	Ergebnis der Bewertung.	Ja
└– Name	Schnur	Name der Prüfung	Ja
└– bestanden	boolean	gibt an, ob die Überprüfung erfolgreich war oder fehlgeschlagen ist.	Ja
└- Score	Zahl	Punktzahl	Ja
└– Typ	Schnur	Typ der Prüfung	Ja
features	Objekt	Features zur Unterstützung der zusätzlichen Filterung von Daten in der UX.	Ja
id	Schnur	Der eindeutige Bezeichner für das Analysebeispiel.	Ja
type	enum	Auswertungsergebnisbeispieltyp Mögliche Werte: EvaluationResultSample	Ja

EvaluationRule (Auswertungsregel)

Modell für Auswertungsregeln.

Name	Typ	Description	Required	Vorgabe
Aktion	EvaluationRuleAction	Evaluierungs-Aktionsmodell.	Ja
└– Typ	EvaluationRuleActionType	Art der Evaluierungsmaßnahme.	Ja
description	Schnur	Beschreibung für die Auswertungsregel.	No
displayName	Schnur	Anzeigename für die Auswertungsregel.	No
enabled	boolean	Gibt an, ob die Auswertungsregel aktiviert ist. Der Standardwert ist "true".	Ja
eventType	EvaluationRuleEventType	Typ des Auswertungsregelereignisses.	Ja
filter	EvaluationRuleFilter	Modell des Auswertungsfilters.	No
└– agentName	Schnur	Filtert nach Agentname.	Ja
id	Zeichenfolge (schreibgeschützt)	Eindeutiger Bezeichner für die Auswertungsregel.	Ja
Systemdaten	-Objekt (schreibgeschützt)	Systemmetadaten für die Auswertungsregel.	Ja

EvaluationRuleAction

Evaluierungs-Aktionsmodell.

Diskriminator für EvaluationRuleAction

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

Typwert	Schema
continuousEvaluation	ContinuousEvaluationRuleAction
humanEvaluationPreview	HumanEvaluationPreviewRuleAction

Name	Typ	Description	Required	Vorgabe
type	EvaluationRuleActionType	Art der Evaluierungsmaßnahme.	Ja

EvaluationRuleActionType

Art der Evaluierungsmaßnahme.

Property	Wert
Beschreibung	Art der Evaluierungsmaßnahme.
Typ	Schnur
Werte	continuousEvaluation humanEvaluationPreview

EvaluationRuleEventType

Typ des Auswertungsregelereignisses.

Property	Wert
Beschreibung	Typ des Auswertungsregelereignisses.
Typ	Schnur
Werte	responseCompleted manual

EvaluationRuleFilter

Modell des Auswertungsfilters.

Name	Typ	Description	Required	Vorgabe
Name des Agenten.	Schnur	Filtert nach Agentname.	Ja

EvaluationRunClusterInsightRequest

Einblicke in die Evaluierungsergebnisse

Name	Typ	Description	Required	Vorgabe
evalId	Schnur	Auswertungs-ID für die Einblicke.	Ja
modelKonfiguration	InsightModelConfiguration	Konfiguration des Modells, das bei der Generierung von Erkenntnissen verwendet wird.	No
└– modelDeploymentName	Schnur	Die modellbasierte Bereitstellung, die ausgewertet werden soll. Akzeptiert entweder den Bereitstellungsnamen allein oder mit dem Verbindungsnamen als {connectionName}/<modelDeploymentName>.	Ja
runIds	Array von Strings	Liste der Auswertungsausführungs-IDs für die Einblicke.	Ja
type	enum	Die Art der Insights-Anforderung. Mögliche Werte: EvaluationRunClusterInsight	Ja

EvaluationRunClusterInsightResult

Erkenntnisse aus der Cluster-Analyse des Evaluierungslaufs.

Name	Typ	Description	Required	Vorgabe
clusterInsight	ClusterInsightResult	Erkenntnisse aus der Clusteranalyse.	Ja
type	enum	Der Typ des Insights-Ergebnisses. Mögliche Werte: EvaluationRunClusterInsight	Ja

EvaluationScheduleTask

Auswertungsaufgabe für den Zeitplan.

Name	Typ	Description	Required	Vorgabe
configuration	Objekt	Konfiguration für die Aufgabe.	No
evalId	Schnur	Bezeichner der Auswertungsgruppe.	Ja
evalRun	Objekt	Die Auswertungsnutzlast wird ausgeführt.	Ja
type	enum	Mögliche Werte: Evaluation	Ja

EvaluationTaxonomy

Definition der Evaluierungstaxonomie

Name	Typ	Description	Required	Vorgabe
id	Zeichenfolge (schreibgeschützt)	Asset ID, eine eindeutige Kennung für das Asset	No
Name	Zeichenfolge (schreibgeschützt)	Der Name der Ressource	Ja
properties	Objekt	Zusätzliche Eigenschaften für die Auswertungstaxonomie.	No
taxonomyCategories	Array von TaxonomyCategory	Liste der Taxonomiekategorien.	No
taxonomyInput	EvaluationTaxonomyInput	Eingabekonfiguration für die Auswertungstaxonomie.	Ja
└– Typ	EvaluationTaxonomyInputType	Eingabetyp der Auswertungstaxonomie.	Ja
version	Zeichenfolge (schreibgeschützt)	Die Version der Ressource	Ja

EvaluationTaxonomyCreateOrUpdate

Definition der Evaluierungstaxonomie

Name	Typ	Description	Required	Vorgabe
description	Schnur	Der Text der Objektbeschreibung.	No
properties	Objekt	Zusätzliche Eigenschaften für die Auswertungstaxonomie.	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No
taxonomyCategories	Array von TaxonomyCategory	Liste der Taxonomiekategorien.	No
taxonomyInput	EvaluationTaxonomyInput	Eingabekonfiguration für die Auswertungstaxonomie.	Ja
└– Typ	EvaluationTaxonomyInputType	Eingabetyp der Auswertungstaxonomie.	Ja

EvaluationTaxonomyInput

Eingabekonfiguration für die Auswertungstaxonomie.

Diskriminator für EvaluationTaxonomyInput

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

Typwert	Schema
agent	AgentTaxonomyInput

Name	Typ	Description	Required	Vorgabe
type	EvaluationTaxonomyInputType	Typ der Eingabe der Auswertungstaxonomie.	Ja

EvaluationTaxonomyInputType

Typ der Eingabe der Auswertungstaxonomie.

Property	Wert
Beschreibung	Typ der Eingabe der Auswertungstaxonomie.
Typ	Schnur
Werte	agent policy

EvaluationTaxonomyInputUpdate

Eingabekonfiguration für die Auswertungstaxonomie.

Diskriminator für EvaluationTaxonomyInputUpdate

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

Typwert	Schema
agent	AgentTaxonomyInputUpdate

Name	Typ	Description	Required	Vorgabe
type	EvaluationTaxonomyInputType	Typ der Eingabe der Auswertungstaxonomie.	Ja

EvaluationTaxonomyUpdate

Definition der Evaluierungstaxonomie

Name	Typ	Description	Required	Vorgabe
description	Schnur	Der Text der Objektbeschreibung.	No
properties	Objekt	Zusätzliche Eigenschaften für die Auswertungstaxonomie.	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No
taxonomyCategories	Array von TaxonomyCategory	Liste der Taxonomiekategorien.	No
taxonomyInput	EvaluationTaxonomyInputUpdate	Eingabekonfiguration für die Auswertungstaxonomie.	No
└– Typ	EvaluationTaxonomyInputType	Eingabetyp der Auswertungstaxonomie.	Ja

EvaluatorCategory

Die Kategorie des Bewerters

Property	Wert
Beschreibung	Die Kategorie des Bewerters
Typ	Schnur
Werte	quality safety agents

EvaluatorDefinition

Konfiguration des Basisauswerters mit Diskriminator

Diskriminator für EvaluatorDefinition

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

Typwert	Schema
code	CodeBasedEvaluatorDefinition
prompt	PromptBasedEvaluatorDefinition

Name	Typ	Description	Required	Vorgabe
data_schema	Objekt	Das JSON-Schema (Entwurf 2020-12) für die Eingabedaten des Evaluators. Dazu gehören Parameter wie Typ, Eigenschaften, erforderlich.	No
init_parameters	Objekt	Das JSON-Schema (Entwurf 2020-12) für die Eingabeparameter des Evaluators. Dazu gehören Parameter wie Typ, Eigenschaften, erforderlich.	No
metrics	Objekt	Liste der von diesem Evaluator erzeugten Ausgabemetriken	No
type	EvaluatorDefinitionType	Der Typ der Definition des Evaluators	Ja

EvaluatorDefinitionType

Der Typ der Definition des Evaluators

Property	Wert
Beschreibung	Der Typ der Definition des Evaluators
Typ	Schnur
Werte	prompt code prompt_and_code service openai_graders

EvaluatorMetric

Evaluator-Metrik

Name	Typ	Description	Required	Vorgabe
desirable_direction	EvaluatorMetricDirection	Die Richtung der Metrik, die angibt, ob ein höherer Wert besser, ein niedrigerer Wert besser oder neutral ist	No
is_primary	boolean	Gibt an, ob diese Metrik primär ist, wenn mehrere Metriken vorhanden sind.	No
max_value	Zahl	Maximalwert für die Metrik. Wenn nicht angegeben, wird davon ausgegangen, dass sie ungebunden ist.	No
min_value	Zahl	Minimalwert für die Metrik	No
type	EvaluatorMetricType	Der Typ des Evaluators	No

EvaluatorMetricDirection

Die Richtung der Metrik, die angibt, ob ein höherer Wert besser, ein niedrigerer Wert besser oder neutral ist

Property	Wert
Beschreibung	Die Richtung der Metrik, die angibt, ob ein höherer Wert besser, ein niedrigerer Wert besser oder neutral ist
Typ	Schnur
Werte	increase decrease neutral

EvaluatorMetricType

Der Typ des Evaluators

Property	Wert
Beschreibung	Der Typ des Evaluators
Typ	Schnur
Werte	ordinal continuous boolean

EvaluatorType

Der Typ des Evaluators

Property	Wert
Beschreibung	Der Typ des Evaluators
Typ	Schnur
Werte	builtin custom

EvaluatorVersion

Definition des Evaluators

Name	Typ	Description	Required	Vorgabe
categories	Array von EvaluatorCategory	Die Kategorien des Bewerters	Ja
erstellt_am	Zeichenfolge (schreibgeschützt)	Erstellungsdatum/-zeit des Evaluators	Ja
created_by	Zeichenfolge (schreibgeschützt)	Ersteller des Evaluators	Ja
Definition	EvaluatorDefinition	Konfiguration des Basisauswerters mit Diskriminator	Ja
└– data_schema	Objekt	Das JSON-Schema (Entwurf 2020-12) für die Eingabedaten des Evaluators. Dazu gehören Parameter wie Typ, Eigenschaften, erforderlich.	No
└– init_parameters	Objekt	Das JSON-Schema (Entwurf 2020-12) für die Eingabeparameter des Evaluators. Dazu gehören Parameter wie Typ, Eigenschaften, erforderlich.	No
└– Metriken	Objekt	Liste der von diesem Evaluator erzeugten Ausgabemetriken	No
└– Typ	EvaluatorDefinitionType	Der Typ der Definition des Evaluators	Ja
display_name	Schnur	Anzeigename für den Evaluator. Es hilft, den Evaluator in AI Foundry leicht zu finden. Es muss nicht eindeutig sein.	No
evaluator_type	EvaluatorType	Der Typ des Evaluators	Ja
id	Zeichenfolge (schreibgeschützt)	Asset ID, eine eindeutige Kennung für das Asset	No
metadata	Objekt	Metadaten über den Evaluator	No
modified_at	Zeichenfolge (schreibgeschützt)	Datum/Uhrzeit der letzten Änderung des Evaluators	Ja
Name	Zeichenfolge (schreibgeschützt)	Der Name der Ressource	Ja
version	Zeichenfolge (schreibgeschützt)	Die Version der Ressource	Ja

EvaluatorVersionCreate

Definition des Evaluators

Name	Typ	Description	Required	Vorgabe
categories	Array von EvaluatorCategory	Die Kategorien des Bewerters	Ja
Definition	EvaluatorDefinition	Konfiguration des Basisauswerters mit Diskriminator	Ja
└– data_schema	Objekt	Das JSON-Schema (Entwurf 2020-12) für die Eingabedaten des Evaluators. Dazu gehören Parameter wie Typ, Eigenschaften, erforderlich.	No
└– init_parameters	Objekt	Das JSON-Schema (Entwurf 2020-12) für die Eingabeparameter des Evaluators. Dazu gehören Parameter wie Typ, Eigenschaften, erforderlich.	No
└– Metriken	Objekt	Liste der von diesem Evaluator erzeugten Ausgabemetriken	No
└– Typ	EvaluatorDefinitionType	Der Typ der Definition des Evaluators	Ja
description	Schnur	Der Text der Objektbeschreibung.	No
display_name	Schnur	Anzeigename für den Evaluator. Es hilft, den Evaluator in AI Foundry leicht zu finden. Es muss nicht eindeutig sein.	No
evaluator_type	EvaluatorType	Der Typ des Evaluators	Ja
metadata	Objekt	Metadaten über den Evaluator	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No

EvaluatorVersionUpdate

Definition des Evaluators

Name	Typ	Description	Required	Vorgabe
categories	Array von EvaluatorCategory	Die Kategorien des Bewerters	No
description	Schnur	Der Text der Objektbeschreibung.	No
display_name	Schnur	Anzeigename für den Evaluator. Es hilft, den Evaluator in AI Foundry leicht zu finden. Es muss nicht eindeutig sein.	No
metadata	Objekt	Metadaten über den Evaluator	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No

FabricDataAgentToolParameters

Die Parameter des Werkzeugs für den Fabric-Datenagenten.

Name	Typ	Description	Required	Vorgabe
project_connections	Array von ToolProjectConnection	Die an dieses Tool angefügten project Verbindungen. Es kann maximal 1 Verbindung bestehen. an das Tool angefügte Ressource.	No

FileDatasetVersion

FileDatasetVersion-Definition

Name	Typ	Description	Required	Vorgabe
Connectionname	Schnur	Der Azure Storage Kontoverbindungsname. Erforderlich, wenn startPendingUploadVersion vor dem Erstellen des Datasets nicht aufgerufen wurde	No
dataUri	Schnur	URI der Daten (Beispiel) Einschränkungen: minLength: 1, Muster: [a-zA-Z0-9_]	Ja
id	Zeichenfolge (schreibgeschützt)	Asset ID, eine eindeutige Kennung für das Asset	No
Isreference	boolescher Wert (schreibgeschützt)	Gibt an, ob das Dataset einen Verweis auf den Speicher enthält, oder das Dataset verwaltet den Speicher selbst. Wenn true, werden die zugrunde liegenden Daten nicht gelöscht, wenn die Datasetversion gelöscht wird.	No
Name	Zeichenfolge (schreibgeschützt)	Der Name der Ressource	Ja
type	enum	Datasettyp Mögliche Werte: uri_file	Ja
version	Zeichenfolge (schreibgeschützt)	Die Version der Ressource	Ja

FileDatasetVersionUpdate

FileDatasetVersion-Definition

Name	Typ	Description	Required	Vorgabe
description	Schnur	Der Text der Objektbeschreibung.	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No
type	enum	Datasettyp Mögliche Werte: uri_file	Ja

FolderDatasetVersion

FileDatasetVersion-Definition

Name	Typ	Description	Required	Vorgabe
Connectionname	Schnur	Der Azure Storage Kontoverbindungsname. Erforderlich, wenn startPendingUploadVersion vor dem Erstellen des Datasets nicht aufgerufen wurde	No
dataUri	Schnur	URI der Daten (Beispiel) Einschränkungen: minLength: 1, Muster: [a-zA-Z0-9_]	Ja
id	Zeichenfolge (schreibgeschützt)	Asset ID, eine eindeutige Kennung für das Asset	No
Isreference	boolescher Wert (schreibgeschützt)	Gibt an, ob das Dataset einen Verweis auf den Speicher enthält, oder das Dataset verwaltet den Speicher selbst. Wenn true, werden die zugrunde liegenden Daten nicht gelöscht, wenn die Datasetversion gelöscht wird.	No
Name	Zeichenfolge (schreibgeschützt)	Der Name der Ressource	Ja
type	enum	Datasettyp Mögliche Werte: uri_folder	Ja
version	Zeichenfolge (schreibgeschützt)	Die Version der Ressource	Ja

FolderDatasetVersionUpdate

FileDatasetVersion-Definition

Name	Typ	Description	Required	Vorgabe
description	Schnur	Der Text der Objektbeschreibung.	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No
type	enum	Datasettyp Mögliche Werte: uri_folder	Ja

FunctionToolCall

Details eines Funktionstoolaufrufs.

Name	Typ	Description	Required	Vorgabe
Argumente	Schnur	Die Argumente, mit denen die Funktion aufgerufen werden können, wie sie vom Modell im JSON-Format erzeugt werden.	Ja
Name	Schnur	Der Name der funktion, die aufgerufen werden soll.	Ja

HostedAgentDefinition

Die Definition des gehosteten Agents.

Name	Typ	Description	Required	Vorgabe
container_protocol_versions	Array von ProtocolVersionRecord	Die Protokolle, die der Agent für die Eingehende Kommunikation der Container unterstützt.	Ja
cpu	Schnur	Die CPU-Konfiguration für den gehosteten Agenten.	Ja
environment_variables	Objekt	Umgebungsvariablen, die im Container des gehosteten Agents festgelegt werden sollen.	No
image	Schnur	Die Bild-ID für den Agent, die für bildbasierte gehostete Agents gilt.	No
kind	enum	Mögliche Werte: hosted	Ja
memory	Schnur	Die Arbeitsspeicherkonfiguration für den gehosteten Agent.	Ja
rai_config	RaiConfig	Konfiguration für die Inhaltsfilterung und Sicherheitsfunktionen von Responsible AI (RAI).	No
└– rai_policy_name	Schnur	Der Name der zu übernehmenden RAI-Richtlinie.	Ja
tools	Array von OpenAI.Tool	Ein Array von Tools, die das Modell des gehosteten Agents beim Generieren einer Antwort aufrufen kann. Sie kann angeben, welches Tool verwendet werden soll, indem der tool_choice Parameter festgelegt wird.	No

HourlyRecurrenceSchedule

Stündlicher Wiederholungsplan.

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

HumanEvaluationPreviewRuleAction

Auswertungsregelaktion für die menschliche Auswertung.

Name	Typ	Description	Required	Vorgabe
templateId	AssetId	Bezeichner einer gespeicherten Ressource.	Ja
type	enum	Mögliche Werte: humanEvaluationPreview	Ja

Index

Indexressourcendefinition

Diskriminator für Index

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

Typwert	Schema
AzureSearch	AzureAISearchIndex
ManagedAzureSearch	ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore	CosmosDBIndex

Name	Typ	Description	Required	Vorgabe
id	Zeichenfolge (schreibgeschützt)	Asset ID, eine eindeutige Kennung für das Asset	No
Name	Zeichenfolge (schreibgeschützt)	Der Name der Ressource	Ja
type	IndexType		Ja
version	Zeichenfolge (schreibgeschützt)	Die Version der Ressource	Ja

IndexType

Property	Wert
Typ	Schnur
Werte	AzureSearch CosmosDBNoSqlVectorStore ManagedAzureSearch

IndexUpdate

Indexressourcendefinition

Diskriminator für IndexUpdate

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

Typwert	Schema
AzureSearch	AzureAISearchIndexUpdate
ManagedAzureSearch	ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore	CosmosDBIndexUpdate

Name	Typ	Description	Required	Vorgabe
description	Schnur	Der Text der Objektbeschreibung.	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No
type	IndexType		Ja

Einblick

Der Antworttext für Cluster Insights.

Name	Typ	Description	Required	Vorgabe
displayName	Schnur	Benutzerfreundlicher Anzeigename für den Einblick.	Ja
id	Zeichenfolge (schreibgeschützt)	Der eindeutige Bezeichner für den Insights-Bericht.	Ja
metadata	InsightsMetadata (schreibgeschützt)	Metadaten zu den Erkenntnissen.	Ja
└– completedAt	Schnur	Der Zeitstempel, zu dem die Einblicke abgeschlossen wurden.	No
└– createdAt	Schnur	Der Zeitstempel, zu dem die Einblicke erstellt wurden.	Ja
request	InsightRequest	Die Anforderung des Insights-Berichts.	Ja
└– Typ	InsightType	Der Anforderungstyp.	Ja
result	InsightResult (schreibgeschützt)	Das Ergebnis der Erkenntnisse.	No
└– Typ	InsightType	Der Typ des Insights-Ergebnisses.	Ja
state	Azure. Core.Foundation.OperationState (schreibgeschützt)	Enumeration, die zulässige Betriebszustände beschreibt.	Ja

InsightCluster

Ein Cluster von Analyseproben.

Name	Typ	Description	Required	Vorgabe
description	Schnur	Beschreibung des Analyseclusters.	Ja
id	Schnur	Die ID des Analyseclusters.	Ja
label	Schnur	Bezeichnung für den Cluster	Ja
Proben	Array von InsightSample	Liste der Beispiele, die zu diesem Cluster gehören. Leer, wenn Beispiele Teil von Unterclustern sind.	No
subClusters	Array von InsightCluster	Liste der Untercluster in diesem Cluster. Leer, wenn keine Untercluster vorhanden sind.	No
Vorschlag	Schnur	Vorschlag für den Cluster	Ja
suggestionTitle	Schnur	Der Titel des Vorschlags für den Cluster	Ja
weight	integer	Die Gewichtung des Analyseclusters. Dies gibt die Anzahl der Beispiele im Cluster an.	Ja

InsightModelConfiguration

Konfiguration des Modells, das bei der Generierung von Erkenntnissen verwendet wird.

Name	Typ	Description	Required	Vorgabe
modelDeploymentName	Schnur	Die modellbasierte Bereitstellung, die ausgewertet werden soll. Akzeptiert entweder den Bereitstellungsnamen allein oder mit dem Verbindungsnamen als {connectionName}/<modelDeploymentName>.	Ja

InsightRequest

Die Anforderung des Insights-Berichts.

Diskriminator für InsightRequest

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

Typwert	Schema
EvaluationRunClusterInsight	EvaluationRunClusterInsightRequest
AgentClusterInsight	AgentClusterInsightRequest
EvaluationComparison	EvaluationComparisonInsightRequest

Name	Typ	Description	Required	Vorgabe
type	InsightType	Die Anforderung der Einblicke.	Ja

InsightResult

Das Ergebnis der Erkenntnisse.

Diskriminator für InsightResult

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

Typwert	Schema
EvaluationComparison	EvaluationComparisonInsightResult
EvaluationRunClusterInsight	EvaluationRunClusterInsightResult
AgentClusterInsight	AgentClusterInsightResult

Name	Typ	Description	Required	Vorgabe
type	InsightType	Die Anforderung der Einblicke.	Ja

InsightSample

Eine Probe aus der Analyse.

Diskriminator für InsightSample

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

Typwert	Schema
EvaluationResultSample	EvaluationResultSample

Name	Typ	Description	Required	Vorgabe
CorrelationInfo	Objekt	Informationen zur Korrelation für das Analysebeispiel.	Ja
features	Objekt	Features zur Unterstützung der zusätzlichen Filterung von Daten in der UX.	Ja
id	Schnur	Der eindeutige Bezeichner für das Analysebeispiel.	Ja
type	Sampletype	Die Art der Probe, die für die Analyse verwendet wird.	Ja

InsightScheduleTask

Insight-Aufgabe für den Zeitplan.

Name	Typ	Description	Required	Vorgabe
configuration	Objekt	Konfiguration für die Aufgabe.	No
Erkenntnis	Erkenntnis	Der Antworttext für Cluster Insights.	Ja
└- displayName	Schnur	Benutzerfreundlicher Anzeigename für den Einblick.	Ja
└– ID	Zeichenfolge (schreibgeschützt)	Der eindeutige Bezeichner für den Insights-Bericht.	Ja
└- Metadaten	InsightsMetadata (schreibgeschützt)	Metadaten zum Insights-Bericht.	Ja
└– Anfrage	InsightRequest	Anfordern der Insights-Analyse.	Ja
└- Ergebnis	InsightResult (schreibgeschützt)	Das Ergebnis des Insights-Berichts.	No
└– Zustand	Azure. Core.Foundation.OperationState (schreibgeschützt)	Der aktuelle Zustand der Erkenntnisse.	Ja
type	enum	Mögliche Werte: Insight	Ja

InsightSummary

Zusammenfassung der Fehlerclusteranalyse.

Name	Typ	Description	Required	Vorgabe
method	Schnur	Methode, die für das Clustering verwendet wird.	Ja
sampleCount	integer	Gesamtzahl der analysierten Stichproben.	Ja
uniqueClusterCount	integer	Gesamtanzahl eindeutiger Cluster.	Ja
uniqueSubclusterCount	integer	Gesamtanzahl eindeutiger Unterclusterbeschriftungen.	Ja
usage	ClusterTokenUsage	Token-Nutzung für die Cluster-Analyse	Ja
└– inputTokenUsage	integer	Verwendung von Eingabetoken	Ja
└– outputTokenUsage	integer	Ausgabetokenverwendung	Ja
└- totalTokenUsage	integer	Gesamtanzahl der Tokenverwendung	Ja

InsightType

Die Anforderung der Einblicke.

Property	Wert
Beschreibung	Die Anforderung der Einblicke.
Typ	Schnur
Werte	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

InsightsMetadata

Metadaten zu den Erkenntnissen.

Name	Typ	Description	Required	Vorgabe
completedAt	Schnur	Der Zeitstempel, zu dem die Einblicke abgeschlossen wurden.	No
createdAt	Schnur	Der Zeitstempel, zu dem die Einblicke erstellt wurden.	Ja

ItemGenerationParams

Stellt den Satz von Parametern dar, die zum Steuern von Elementgenerierungsvorgängen verwendet werden.

Diskriminator für ItemGenerationParams

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

Typwert	Schema
red_team	RedTeamItemGenerationParams
red_team_seed_prompts	RedTeamSeedPromptsItemGenerationParams
red_team_taxonomy	RedTeamTaxonomyItemGenerationParams
response_retrieval	ResponseRetrievalItemGenerationParams

Name	Typ	Description	Required	Vorgabe
type	ItemGenerationParamsType	Die Typen von Parametern für die Generierung roter Teamelemente.	Ja

ItemGenerationParamsType

Die Typen von Parametern für die Generierung roter Teamelemente.

Property	Wert
Beschreibung	Die Typen von Parametern für die Generierung roter Teamelemente.
Typ	Schnur
Werte	red_team response_retrieval red_team_seed_prompts red_team_taxonomy synthetic_data_gen_preview

ManagedAzureAISearchIndex

Verwaltete Azure KI-Suche Indexdefinition

Name	Typ	Description	Required	Vorgabe
id	Zeichenfolge (schreibgeschützt)	Asset ID, eine eindeutige Kennung für das Asset	No
Name	Zeichenfolge (schreibgeschützt)	Der Name der Ressource	Ja
type	enum	Indextyp Mögliche Werte: ManagedAzureSearch	Ja
version	Zeichenfolge (schreibgeschützt)	Die Version der Ressource	Ja

ManagedAzureAISearchIndexUpdate

Verwaltete Azure KI-Suche Indexdefinition

Name	Typ	Description	Required	Vorgabe
description	Schnur	Der Text der Objektbeschreibung.	No
tags	Objekt	Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.	No
type	enum	Indextyp Mögliche Werte: ManagedAzureSearch	Ja

MemoryItem

Ein einzelnes Speicherelement, das im Speicherspeicher gespeichert ist und Inhalte und Metadaten enthält.

Diskriminator für MemoryItem

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

Typwert	Schema
user_profile	UserProfileMemoryItem
chat_summary	ChatSummaryMemoryItem

Name	Typ	Description	Required	Vorgabe
Inhalt	Schnur	Der Inhalt des Speichers.	Ja
kind	MemoryItemKind	Art des Speicherelements.	Ja
memory_id	Schnur	Die eindeutige ID des Speicherelements.	Ja
scope	Schnur	Der Namespace, der Speicher logisch gruppiert und isoliert, z. B. eine Benutzer-ID.	Ja
updated_at	integer	Der Zeitpunkt der letzten Aktualisierung des Speicherelements.	Ja

MemoryItemKind

Art des Speicherelements.

Property	Wert
Beschreibung	Art des Speicherelements.
Typ	Schnur
Werte	user_profile chat_summary

MemoryOperation

Stellt einen einzelnen Speichervorgang (Erstellen, Aktualisieren oder Löschen) dar, der für ein Speicherelement ausgeführt wird.

Name	Typ	Description	Required	Vorgabe
kind	MemoryOperationKind	Art der Speicheroperation.	Ja
memory_item	MemoryItem	Ein einzelnes Speicherelement, das im Speicherspeicher gespeichert ist und Inhalte und Metadaten enthält.	Ja
└– Inhalt	Schnur	Der Inhalt des Speichers.	Ja
└– Art	MemoryItemKind	Die Art des Speicherelements.	Ja
└– memory_id	Schnur	Die eindeutige ID des Speicherelements.	Ja
└– Bereich	Schnur	Der Namespace, der Speicher logisch gruppiert und isoliert, z. B. eine Benutzer-ID.	Ja
└– updated_at	integer	Der Zeitpunkt der letzten Aktualisierung des Speicherelements.	Ja

MemoryOperationKind

Art der Speicheroperation.

Property	Wert
Beschreibung	Art der Speicheroperation.
Typ	Schnur
Werte	create update delete

MemorySearchItem

Ein aus der Speichersuche abgerufenes Speicherelement.

Name	Typ	Description	Required	Vorgabe
memory_item	MemoryItem	Ein einzelnes Speicherelement, das im Speicherspeicher gespeichert ist und Inhalte und Metadaten enthält.	Ja
└– Inhalt	Schnur	Der Inhalt des Speichers.	Ja
└– Art	MemoryItemKind	Die Art des Speicherelements.	Ja
└– memory_id	Schnur	Die eindeutige ID des Speicherelements.	Ja
└– Bereich	Schnur	Der Namespace, der Speicher logisch gruppiert und isoliert, z. B. eine Benutzer-ID.	Ja
└– updated_at	integer	Der Zeitpunkt der letzten Aktualisierung des Speicherelements.	Ja

MemorySearchOptions

Optionen für die Speichersuche.

Name	Typ	Description	Required	Vorgabe
max_memories	integer	Maximale Anzahl der zurückzugebenden Speicherelemente.	No

MemorySearchPreviewTool

Ein Werkzeug zur Integration von Erinnerungen in den Agenten.

Name	Typ	Description	Required	Vorgabe
memory_store_name	Schnur	Der Name des zu verwendenden Speichers.	Ja
scope	Schnur	Der Namespace, der zum Gruppieren und Isolieren von Speichern verwendet wird, z. B. eine Benutzer-ID. Begrenzt die Speicher, die abgerufen oder aktualisiert werden können. Verwenden Sie eine spezielle Variable, {{$userId}} um Speicher auf den aktuell angemeldeten Benutzer zu beschränken.	Ja
search_options	MemorySearchOptions	Optionen für die Speichersuche.	No
└– max_memories	integer	Maximale Anzahl der zurückzugebenden Speicherelemente.	No
type	enum	Der Typ des Tools. Immer memory_search_preview. Mögliche Werte: memory_search_preview	Ja
update_delay	integer	Zeit zum Warten, bevor Erinnerungen nach Inaktivität aktualisiert werden (Sekunden). Standardwert 300.	No	300

MemorySearchToolCallItemParam

Name	Typ	Description	Required	Vorgabe
results	Array von MemorySearchItem	Die ergebnisse, die aus der Speichersuche zurückgegeben wurden.	No
type	enum	Mögliche Werte: memory_search_call	Ja

MemorySearchToolCallItemResource

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
results	Array von MemorySearchItem	Die ergebnisse, die aus der Speichersuche zurückgegeben wurden.	No
status	enum	Der Status des Speichersuchtoolaufrufs. Einer von in_progress, searching, oder completed,incompletefailed Mögliche Werte: in_progress, , searchingcompleted, , incompletefailed	Ja
type	enum	Mögliche Werte: memory_search_call	Ja

MemoryStoreDefaultDefinition

Standardimplementierung des Arbeitsspeichers.

Name	Typ	Description	Required	Vorgabe
chat_model	Schnur	Der Name oder der Bezeichner der Bereitstellung des Chatabschlussmodells, die für die Speicherverarbeitung verwendet wird.	Ja
embedding_model	Schnur	Der Name oder der Bezeichner der Einbettungsmodellbereitstellung, die für die Speicherverarbeitung verwendet wird.	Ja
kind	enum	Die Art des Speichers. Mögliche Werte: default	Ja
options	MemoryStoreDefaultOptions	Standardkonfigurationen für Speicherspeicher.	No
└– chat_summary_enabled	boolean	Gibt an, ob die Zusammenfassungsextraktion für Chats und storage aktiviert werden soll. Der Standardwert ist "true".	Ja	Richtig
└– user_profile_details	Schnur	Bestimmte Kategorien oder Typen von Benutzerprofilinformationen, die extrahiert und gespeichert werden sollen.	No
└– user_profile_enabled	boolean	Gibt an, ob die Benutzerprofilextraktion und storage aktiviert werden soll. Der Standardwert ist "true".	Ja	Richtig

MemoryStoreDefaultOptions

Standardkonfigurationen für Speicherspeicher.

Name	Typ	Description	Required	Vorgabe
chat_summary_enabled	boolean	Gibt an, ob die Zusammenfassungsextraktion für Chats und storage aktiviert werden soll. Der Standardwert ist "true".	Ja	Richtig
user_profile_details	Schnur	Bestimmte Kategorien oder Typen von Benutzerprofilinformationen, die extrahiert und gespeichert werden sollen.	No
user_profile_enabled	boolean	Gibt an, ob die Benutzerprofilextraktion und storage aktiviert werden soll. Der Standardwert ist "true".	Ja	Richtig

MemoryStoreDefinition

Basisdefinition für Speicherspeicherkonfigurationen.

Diskriminator für MemoryStoreDefinition

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

Typwert	Schema
default	MemoryStoreDefaultDefinition

Name	Typ	Description	Required	Vorgabe
kind	MemoryStoreKind	Der Typ der zu verwendenden Speicherimplementierung.	Ja

MemoryStoreDeleteScopeResponse

Antwort für das Löschen von Erinnerungen aus einem Bereich.

Name	Typ	Description	Required	Vorgabe
gelöscht	boolean	Ob der Löschvorgang erfolgreich war.	Ja
Name	Schnur	Der Name des Speichers.	Ja
Objekt	enum	Der Objekttyp. Immer "memory_store.scope.deleted". Mögliche Werte: memory_store.scope.deleted	Ja
scope	Schnur	Der Bereich, aus dem Erinnerungen gelöscht wurden.	Ja

MemoryStoreKind

Der Typ der zu verwendenden Speicherimplementierung.

Property	Wert
Beschreibung	Der Typ der zu verwendenden Speicherimplementierung.
Typ	Schnur
Werte	default

MemoryStoreObject

Ein Speicher, der Benutzerspeicher speichern und abrufen kann.

Name	Typ	Description	Required	Vorgabe
erstellt_am	integer	Der Unix-Zeitstempel (Sekunden), als der Speicher erstellt wurde.	Ja
Definition	MemoryStoreDefinition	Basisdefinition für Speicherspeicherkonfigurationen.	Ja
└– Art	MemoryStoreKind	Die Art des Speichers.	Ja
description	Schnur	Eine lesbare Beschreibung des Speichers. Einschränkungen: maxLength: 512	No
id	Schnur	Der eindeutige Bezeichner des Speichers.	Ja
metadata	Objekt	Beliebige Schlüsselwertmetadaten, die dem Speicher zugeordnet werden sollen.	No
Name	Schnur	Der Name des Speichers. Einschränkungen: maxLength: 256	Ja
Objekt	enum	Der Objekttyp, der immer "memory_store" ist. Mögliche Werte: memory_store	Ja
updated_at	integer	Der Unix-Zeitstempel (Sekunden), als der Speicher zuletzt aktualisiert wurde.	Ja

MemoryStoreOperationUsage

Verwendungsstatistiken eines Speichervorgangs.

Name	Typ	Description	Required	Vorgabe
embedding_tokens	integer	Die Anzahl der Einbettungstoken.	Ja
input_tokens	OpenAI.integer		Ja
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Ja
└– zwischengespeicherte_Token	OpenAI.integer		Ja
output_tokens	OpenAI.integer		Ja
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Ja
└– reasoning_tokens	OpenAI.integer		Ja
Gesamtanzahl Tokens	OpenAI.integer		Ja

MemoryStoreSearchResponse

Antwort auf die Speichersuche.

Name	Typ	Description	Required	Vorgabe
Erinnerungen	Array von MemorySearchItem	Verwandte Speicherelemente, die während des Suchvorgangs gefunden wurden.	Ja
search_id	Schnur	Die eindeutige ID dieser Suchanforderung. Verwenden Sie diesen Wert als previous_search_id in nachfolgenden Anforderungen, um inkrementelle Suchvorgänge auszuführen.	Ja
usage	MemoryStoreOperationUsage	Verwendungsstatistiken eines Speichervorgangs.	Ja
└– embedding_tokens	integer	Die Anzahl der Einbettungstoken.	Ja
└─ Eingabe-Tokens	OpenAI.integer	Die Anzahl der Eingabetoken.	Ja
└– input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Eine detaillierte Aufschlüsselung der Eingabetoken.	Ja
└– Ausgabe-Tokens	OpenAI.integer	Die Anzahl der Ausgabetoken.	Ja
└– output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Eine detaillierte Aufschlüsselung der Ausgabetoken.	Ja
└– total_tokens	OpenAI.integer	Die Gesamtzahl der verwendeten Token.	Ja

MemoryStoreUpdateCompletedResult

Ergebnis der Speicheraktualisierung.

Name	Typ	Description	Required	Vorgabe
memory_operations	Array von MemoryOperation	Eine Liste der einzelnen Speichervorgänge, die während des Updates ausgeführt wurden.	Ja
usage	MemoryStoreOperationUsage	Verwendungsstatistiken eines Speichervorgangs.	Ja
└– embedding_tokens	integer	Die Anzahl der Einbettungstoken.	Ja
└─ Eingabe-Tokens	OpenAI.integer	Die Anzahl der Eingabetoken.	Ja
└– input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Eine detaillierte Aufschlüsselung der Eingabetoken.	Ja
└– Ausgabe-Tokens	OpenAI.integer	Die Anzahl der Ausgabetoken.	Ja
└– output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Eine detaillierte Aufschlüsselung der Ausgabetoken.	Ja
└– total_tokens	OpenAI.integer	Die Gesamtzahl der verwendeten Token.	Ja

MemoryStoreUpdateResponse

Stellt den Status eines Aktualisierungsvorgangs für den Arbeitsspeicher bereit.

Name	Typ	Description	Required	Vorgabe
Fehler	OpenAI.Error		No
└– additionalInfo	Objekt		No
└– Code	String (nullierbar)		Ja
└– debugInfo	Objekt		No
└– Einzelheiten	Array von OpenAI.Error		No
└– Nachricht	Schnur		Ja
└─ param	String (nullierbar)		No
└– Typ	Schnur		No
result	MemoryStoreUpdateCompletedResult	Ergebnis der Speicheraktualisierung.	No
└– memory_operations	Array von MemoryOperation	Eine Liste der einzelnen Speichervorgänge, die während des Updates ausgeführt wurden.	Ja
└– Nutzung	MemoryStoreOperationUsage	Verwendungsstatistiken, die dem Speicheraktualisierungsvorgang zugeordnet sind.	Ja
status	MemoryStoreUpdateStatus	Status eines Aktualisierungsvorgangs für den Arbeitsspeicher.	Ja
superseded_by	Schnur	Die update_id der Vorgang wurde durch den Status "abgelöst" ersetzt.	No
update_id	Schnur	Die eindeutige ID dieser Updateanforderung. Verwenden Sie diesen Wert als previous_update_id in nachfolgenden Anforderungen, um inkrementelle Updates auszuführen.	Ja

MemoryStoreUpdateStatus

Status eines Aktualisierungsvorgangs für den Arbeitsspeicher.

Property	Wert
Typ	Schnur
Werte	queued in_progress completed failed superseded

MicrosoftFabricPreviewTool

Die Eingabedefinitionsinformationen für ein Microsoft Fabric-Tool, wie sie zur Konfiguration eines Agenten verwendet werden.

Name	Typ	Description	Required	Vorgabe
fabric_dataagent_preview	FabricDataAgentToolParameters	Die Parameter des Werkzeugs für den Fabric-Datenagenten.	Ja
└– project_connections	Array von ToolProjectConnection	Die an dieses Tool angefügten project Verbindungen. Es kann maximal 1 Verbindung bestehen. an das Tool angefügte Ressource. Einschränkungen: maxItems: 1	No
type	enum	Der Objekttyp, der immer 'fabric_dataagent_preview' ist. Mögliche Werte: fabric_dataagent_preview	Ja

Modellbereitstellung

Definition der Modellbereitstellung

Name	Typ	Description	Required	Vorgabe
capabilities	-Objekt (schreibgeschützt)	Funktionen des bereitgestellten Modells	Ja
Connectionname	Zeichenfolge (schreibgeschützt)	Name der Verbindung, von der die Bereitstellung stammt	No
modelName	Zeichenfolge (schreibgeschützt)	Publisher spezifischer Name des bereitgestellten Modells	Ja
modelPublisher	Zeichenfolge (schreibgeschützt)	Name des Herausgebers des bereitgestellten Modells	Ja
modelVersion	Zeichenfolge (schreibgeschützt)	Publisher spezifische Version des bereitgestellten Modells	Ja
Name	Zeichenfolge (schreibgeschützt)	Name der Bereitstellung	Ja
sku	Sku (schreibgeschützt)	Sku-Informationen	Ja
└– Kapazität	integer	Sku-Kapazität	Ja
└- Familie	Schnur	Sku-Familie	Ja
└– Name	Schnur	Sku-Name	Ja
└– Größe	Schnur	Sku-Größe	Ja
└– Stufe	Schnur	Sku-Ebene	Ja
type	enum	Der Typ der Bereitstellung Mögliche Werte: ModelDeployment	Ja

ModelSamplingParams

Stellt eine Reihe von Parametern dar, die zum Steuern des Samplingverhaltens eines Sprachmodells während der Textgenerierung verwendet werden.

Name	Typ	Description	Required	Vorgabe
max_completion_tokens	integer	Die maximale Anzahl von Token, die im Abschluss zulässig sind.	Ja
seed	integer	Der zufällige Samen zur Reproduzierbarkeit.	Ja
Temperatur	Zahl	Der Temperaturparameter für die Probenahme.	Ja
top_p	Zahl	Der Top-p-Parameter für die Kernsampling.	Ja

ModelSamplingParamsUpdate

Stellt eine Reihe von Parametern dar, die zum Steuern des Samplingverhaltens eines Sprachmodells während der Textgenerierung verwendet werden.

Name	Typ	Description	Required	Vorgabe
max_completion_tokens	integer	Die maximale Anzahl von Token, die im Abschluss zulässig sind.	No
seed	integer	Der zufällige Samen zur Reproduzierbarkeit.	No
Temperatur	Zahl	Der Temperaturparameter für die Probenahme.	No
top_p	Zahl	Der Top-p-Parameter für die Kernsampling.	No

MonthlyRecurrenceSchedule

Monatlicher Wiederholungsplan.

Name	Typ	Description	Required	Vorgabe
daysOfMonth	Array mit ganzzahliger Zahl	Tage des Monats für den Serienzeitplan.	Ja
type	enum	Monatlicher Serientyp. Mögliche Werte: Monthly	Ja

NoAuthenticationCredentials

Anmeldeinformationen, für die keine Authentifizierung erforderlich ist

Name	Typ	Description	Required	Vorgabe
type	enum	Der Anmeldeinformationstyp Mögliche Werte: None	Ja

OAuthConsentRequestOutputItem

Fordern Sie vom Dienst an, dass der Benutzer die OAuth-Zustimmung durchführt.

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
consent_link	Schnur	Der Link, den der Benutzer zum Ausführen der OAuth-Zustimmung verwenden kann.	Ja
id	Schnur		Ja
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
Serverbeschriftung	Schnur	Die Serverbezeichnung für die OAuth-Zustimmungsanforderung.	Ja
type	enum	Mögliche Werte: oauth_consent_request	Ja

OneTimeTrigger

Einmaliger Auslöser.

Name	Typ	Description	Required	Vorgabe
timeZone	Schnur	Zeitzone für den einmaligen Auslöser.	No	UTC
triggerAt	Schnur	Datum und Uhrzeit für den einmaligen Auslöser im ISO 8601-Format.	Ja
type	enum	Mögliche Werte: OneTime	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

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

Für apply_patch Toolaufrufe gemeldete Statuswerte.

Property	Wert
Typ	Schnur
Werte	in_progress completed

OpenAI.ApplyPatchCreateFileOperation

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

OpenAI.ApplyPatchCreateFileOperationParam

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

OpenAI.ApplyPatchDeleteFileOperation

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

OpenAI.ApplyPatchDeleteFileOperationParam

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

OpenAI.ApplyPatchFileOperation

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

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

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

OpenAI.ApplyPatchUpdateFileOperation

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

OpenAI.ApplyPatchUpdateFileOperationParam

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

OpenAI.ApproximateLocation

Name	Typ	Description	Required	Vorgabe
Stadt	String (nullierbar)		No
country	String (nullierbar)		No
Region	String (nullierbar)		No
timezone	String (nullierbar)		No
type	enum	Der Typ der Standortannäherung. Immer approximate. Mögliche Werte: approximate	Ja

OpenAI.ChatCompletionTool

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

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

OpenAI.ChatModel

Property	Wert
Typ	Schnur
Werte	gpt-5.2 gpt-5.2-2025-12-11 gpt-5.2-chat-latest gpt-5.2-pro gpt-5.2-pro-2025-12-11 gpt-5.1 gpt-5.1-2025-11-13 gpt-5.1-codex gpt-5.1-mini gpt-5.1-chat-latest gpt-5 gpt-5-mini gpt-5-nano gpt-5-2025-08-07 gpt-5-mini-2025-08-07 gpt-5-nano-2025-08-07 gpt-5-chat-latest gpt-4.1 gpt-4.1-mini gpt-4.1-nano gpt-4.1-2025-04-14 gpt-4.1-mini-2025-04-14 gpt-4.1-nano-2025-04-14 o4-mini o4-mini-2025-04-16 o3 o3-2025-04-16 o3-mini o3-mini-2025-01-31 o1 o1-2024-12-17 o1-preview o1-preview-2024-09-12 o1-mini o1-mini-2024-09-12 gpt-4o gpt-4o-2024-11-20 gpt-4o-2024-08-06 gpt-4o-2024-05-13 gpt-4o-audio-preview gpt-4o-audio-preview-2024-10-01 gpt-4o-audio-preview-2024-12-17 gpt-4o-audio-preview-2025-06-03 gpt-4o-mini-audio-preview gpt-4o-mini-audio-preview-2024-12-17 gpt-4o-search-preview gpt-4o-mini-search-preview gpt-4o-search-preview-2025-03-11 gpt-4o-mini-search-preview-2025-03-11 chatgpt-4o-latest codex-mini-latest gpt-4o-mini gpt-4o-mini-2024-07-18 gpt-4-turbo gpt-4-turbo-2024-04-09 gpt-4-0125-preview gpt-4-turbo-preview gpt-4-1106-preview gpt-4-vision-preview gpt-4 gpt-4-0314 gpt-4-0613 gpt-4-32k gpt-4-32k-0314 gpt-4-32k-0613 gpt-3.5-turbo gpt-3.5-turbo-16k gpt-3.5-turbo-0301 gpt-3.5-turbo-0613 gpt-3.5-turbo-1106 gpt-3.5-turbo-0125 gpt-3.5-turbo-16k-0613

OpenAI.ClickButtonType

Property	Wert
Typ	Schnur
Werte	left right wheel back forward

OpenAI.ClickParam

Ein Klickvorgang.

Name	Typ	Description	Required	Vorgabe
button	OpenAI.ClickButtonType		Ja
type	enum	Gibt den Ereignistyp an. Für eine Klickaktion ist diese Eigenschaft immer click. Mögliche Werte: click	Ja
x	OpenAI.integer		Ja
y	OpenAI.integer		Ja

OpenAI.CodeInterpreterContainerAuto

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.	No
Speicherbegrenzung	OpenAI.ContainerMemoryLimit (nullable)		No
type	enum	Immer auto. Mögliche Werte: auto	Ja

OpenAI.CodeInterpreterOutputImage

Die Bildausgabe des Codedolmetschers.

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

OpenAI.CodeInterpreterOutputLogs

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

OpenAI.CodeInterpreterTool

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

Name	Typ	Description	Required	Vorgabe
container	string oder OpenAI.CodeInterpreterContainerAuto	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. Wenn nicht angegeben, wird der Dienst automatisch angenommen.	No
type	enum	Der Typ des Codedolmetschertools. Immer code_interpreter. Mögliche Werte: code_interpreter	Ja

OpenAI.CompactResource

Name	Typ	Description	Required	Vorgabe
erstellt_am	integer	Unix-Zeitstempel (in Sekunden), als die komprimierte Unterhaltung erstellt wurde.	Ja
id	Schnur	Der eindeutige Bezeichner für die komprimierte Antwort.	Ja
Objekt	enum	Der Objekttyp. Immer response.compaction. Mögliche Werte: response.compaction	Ja
Ausgabe	Array von OpenAI.OutputItem	Die komprimierte Liste der Ausgabeelemente. Dies ist eine Liste aller Benutzernachrichten, gefolgt von einem einzelnen Komprimierungselement.	Ja
usage	OpenAI.ResponseUsage	Stellt Tokenverwendungsdetails dar, einschließlich Eingabetoken, Ausgabetoken, eine Aufschlüsselung der Ausgabetoken und die verwendeten Gesamttoken.	Ja
└─ Eingabe-Tokens	OpenAI.integer	Die Anzahl der Eingabetoken.	Ja
└– input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Eine detaillierte Aufschlüsselung der Eingabetoken.	Ja
└– Ausgabe-Tokens	OpenAI.integer	Die Anzahl der Ausgabetoken.	Ja
└– output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Eine detaillierte Aufschlüsselung der Ausgabetoken.	Ja
└– total_tokens	OpenAI.integer	Die Gesamtzahl der verwendeten Token.	Ja

OpenAI.CompactResponseMethodPublicBody

Name	Typ	Description	Required	Vorgabe
input	Zeichenfolge oder Array von OpenAI.InputItem		No
instructions	String (nullierbar)		No
model	OpenAI.ModelIdsCompaction	Modell-ID, die zum Generieren der Antwort verwendet wird, z gpt-5 . B. oder o3. OpenAI bietet eine breite Palette von Modellen mit unterschiedlichen Funktionen, Leistungsmerkmalen und Preispunkten. In der Modellanleitung finden Sie Informationen zum Durchsuchen und Vergleichen der verfügbaren Modelle.	Ja
previous_response_id	String (nullierbar)		No

OpenAI.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, , , ltlte	Ja
value	String oder OpenAI.numeric oder boolean oder Array von OpenAI.ComparisonFilterValueItems	Der Wert, der mit dem Attributschlüssel verglichen werden soll; unterstützt Zeichenfolgen-, Zahlen- oder boolesche Typen.	Ja

OpenAI.ComparisonFilterValueItems

Typ: Zeichenfolge oder OpenAI.numeric

OpenAI.CompoundFilter

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.Drag
keypress	OpenAI.KeyPressAction
move	OpenAI.Move
screenshot	OpenAI.Screenshot
scroll	OpenAI.Scroll
type	OpenAI.Type
wait	OpenAI.Wait

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ComputerActionType		Ja

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	Vorgabe
Programmcode	String (nullierbar)		No
id	Schnur	Die ID der ausstehenden Sicherheitsprüfung	Ja
message	String (nullierbar)		No

OpenAI.ComputerEnvironment

Property	Wert
Typ	Schnur
Werte	windows mac linux ubuntu browser

OpenAI.ComputerScreenshotContent

Screenshot eines Computers.

Name	Typ	Description	Required	Vorgabe
Datei-ID	String (nullierbar)		Ja
image_url	Schnur		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

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

OpenAI.ComputerUsePreviewTool

Ein Tool, das einen virtuellen Computer steuert.

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

OpenAI.ContainerFileCitationBody

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	OpenAI.integer		Ja
Datei-ID	Schnur	Die ID der Datei.	Ja
filename	Schnur	Der Dateiname der zitierten Containerdatei.	Ja
start_index	OpenAI.integer		Ja
type	enum	Der Typ des Containerdateizitats. Immer container_file_citation. Mögliche Werte: container_file_citation	Ja

OpenAI.ContainerMemoryLimit

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

OpenAI.ConversationItem

Ein einzelnes Element in einer Unterhaltung. Der Satz möglicher Typen entspricht dem output Typ eines Response-Objekts.

Diskriminator für OpenAI.ConversationItem

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

Typwert	Schema
message	OpenAI.ConversationItemMessage
function_call	OpenAI.ConversationItemFunctionToolCallResource
function_call_output	OpenAI.ConversationItemFunctionToolCallOutputResource
file_search_call	OpenAI.ConversationItemFileSearchToolCall
web_search_call	OpenAI.ConversationItemWebSearchToolCall
image_generation_call	OpenAI.ConversationItemImageGenToolCall
computer_call	OpenAI.ConversationItemComputerToolCall
computer_call_output	OpenAI.ConversationItemComputerToolCallOutputResource
reasoning	OpenAI.ConversationItemReasoningItem
code_interpreter_call	OpenAI.ConversationItemCodeInterpreterToolCall
local_shell_call	OpenAI.ConversationItemLocalShellToolCall
local_shell_call_output	OpenAI.ConversationItemLocalShellToolCallOutput
shell_call	OpenAI.ConversationItemFunctionShellCall
shell_call_output	OpenAI.ConversationItemFunctionShellCallOutput
apply_patch_call	OpenAI.ConversationItemApplyPatchToolCall
apply_patch_call_output	OpenAI.ConversationItemApplyPatchToolCallOutput
mcp_list_tools	OpenAI.ConversationItemMcpListTools
mcp_approval_request	OpenAI.ConversationItemMcpApprovalRequest
mcp_approval_response	OpenAI.ConversationItemMcpApprovalResponseResource
mcp_call	OpenAI.ConversationItemMcpToolCall
custom_tool_call	OpenAI.ConversationItemCustomToolCall
custom_tool_call_output	OpenAI.ConversationItemCustomToolCallOutput

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ConversationItemType		Ja

OpenAI.ConversationItemApplyPatchToolCall

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

OpenAI.ConversationItemApplyPatchToolCallOutput

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	String (nullierbar)		No
status	OpenAI.ApplyPatchCallOutputStatus		Ja
type	enum	Der Typ des Elements. Immer apply_patch_call_output. Mögliche Werte: apply_patch_call_output	Ja

OpenAI.ConversationItemCodeInterpreterToolCall

Ein Toolaufruf zum Ausführen von Code.

Name	Typ	Description	Required	Vorgabe
Programmcode	String (nullierbar)		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		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

OpenAI.ConversationItemComputerToolCall

Ein Toolaufruf eines von einem Computer verwendeten Tools Weitere Informationen finden Sie im Handbuch zur Computerverwendung .

Name	Typ	Description	Required	Vorgabe
Aktion	OpenAI.ComputerAction		Ja
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, , completedoder 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

OpenAI.ConversationItemComputerToolCallOutputResource

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	Schnur	Die ID der Ausgabe des Computertoolsaufrufs	No
Ausgabe	OpenAI.ComputerScreenshotImage	Ein Screenshotbild des Computers, das mit dem Computerverwendungstool verwendet wird.	Ja
status	enum	Der Status der Nachrichteneingabe. Einer von in_progress, , completedoder 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

OpenAI.ConversationItemCustomToolCall

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

Name	Typ	Description	Required	Vorgabe
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
type	enum	Der Typ des benutzerdefinierten Toolaufrufs. Immer custom_tool_call. Mögliche Werte: custom_tool_call	Ja

OpenAI.ConversationItemCustomToolCallOutput

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

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

Die Ergebnisse eines Dateisuchtoolaufrufs. Weitere Informationen finden Sie im Dateisuchhandbuch .

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

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	OpenAI.integer (nullable)		Ja
└– timeout_ms	OpenAI.integer (nullable)		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
id	Schnur	Die eindeutige ID des Shelltoolaufrufs. Aufgefüllt, wenn dieses Element über die API zurückgegeben wird.	Ja
status	OpenAI.LocalShellCallStatus		Ja
type	enum	Der Typ des Elements. Immer shell_call. Mögliche Werte: shell_call	Ja

OpenAI.ConversationItemFunctionShellCallOutput

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	OpenAI.integer (nullable)		Ja
Ausgabe	Array von OpenAI.FunctionShellCallOutputContent	Ein Array von Shellaufrufausgabeinhalten	Ja
type	enum	Der Typ der Shellaufrufausgabe. Immer shell_call_output. Mögliche Werte: shell_call_output	Ja

OpenAI.ConversationItemFunctionToolCallOutputResource

Name	Typ	Description	Required	Vorgabe
call_id	Schnur	Die eindeutige ID des vom Modell generierten Funktionstoolaufrufs.	Ja
id	Schnur	Die eindeutige ID der Ausgabe des Funktionstoolaufrufs Aufgefüllt, wenn dieses Element wird über DIE API zurückgegeben.	No
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, , completedoder 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.ConversationItemFunctionToolCallResource

Name	Typ	Description	Required	Vorgabe
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	Schnur	Die eindeutige ID des Aufrufs des Funktionswerkzeugs.	No
Name	Schnur	Der Name der auszuführenden Funktion.	Ja
status	enum	Der Status des Elements. Einer von in_progress, , completedoder 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.ConversationItemImageGenToolCall

Eine Vom Modell vorgenommene Anforderung zur Bildgenerierung.

Name	Typ	Description	Required	Vorgabe
id	Schnur	Die eindeutige ID des Aufrufs der Bildgenerierung.	Ja
result	String (nullierbar)		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.ConversationItemList

Eine Liste von Unterhaltungselementen.

Name	Typ	Description	Required	Vorgabe
data	Array von OpenAI.ConversationItem	Eine Liste von Unterhaltungselementen.	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.ConversationItemLocalShellToolCall

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

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

Die Ausgabe eines Aufrufs eines lokalen Shell-Tools.

Name	Typ	Description	Required	Vorgabe
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	enum	Mögliche Werte: in_progress, , completedincomplete	No
type	enum	Der Typ der Ausgabe des lokalen Shelltools. Immer local_shell_call_output. Mögliche Werte: local_shell_call_output	Ja

OpenAI.ConversationItemMcpApprovalRequest

Eine Anforderung für menschliche Genehmigung eines Toolaufrufs.

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

Eine Antwort auf eine MCP-Genehmigungsanforderung.

Name	Typ	Description	Required	Vorgabe
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	String (nullierbar)		No
type	enum	Der Typ des Elements. Immer mcp_approval_response. Mögliche Werte: mcp_approval_response	Ja

OpenAI.ConversationItemMcpListTools

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

Name	Typ	Description	Required	Vorgabe
Fehler	String (nullierbar)		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.ConversationItemMcpToolCall

Ein Aufruf eines Tools auf einem MCP-Server.

Name	Typ	Description	Required	Vorgabe
approval_request_id	String (nullierbar)		No
Argumente	Schnur	Eine JSON-Zeichenfolge der Argumente, die an das Tool übergeben werden.	Ja
Fehler	String (nullierbar)		No
id	Schnur	Die eindeutige ID des Toolaufrufs.	Ja
Name	Schnur	Der Name des tools, das ausgeführt wurde.	Ja
Ausgabe	String (nullierbar)		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.ConversationItemMessage

Eine Nachricht an oder aus dem Modell.

Name	Typ	Description	Required	Vorgabe
Inhalt	Array von OpenAI.MessageContent	Der Inhalt der Nachricht	Ja
id	Schnur	Die eindeutige ID der Nachricht.	Ja
Rolle	OpenAI.MessageRole		Ja
status	OpenAI.MessageStatus		Ja
type	enum	Der Typ der Nachricht. Immer auf message festgelegt. Mögliche Werte: message	Ja

OpenAI.ConversationItemReasoningItem

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

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

OpenAI.ConversationItemType

Property	Wert
Typ	Schnur
Werte	message function_call function_call_output file_search_call web_search_call image_generation_call computer_call computer_call_output reasoning 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 custom_tool_call_output

OpenAI.ConversationItemWebSearchToolCall

Die Ergebnisse eines Aufrufs eines Websuchtools. Weitere Informationen finden Sie im Websuchhandbuch .

Name	Typ	Description	Required	Vorgabe
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 zur Verwendung des Modells im Web (Suche, open_page, Suchen).	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.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.

Typ: Zeichenfolge oder OpenAI.ConversationParam-2

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.

OpenAI.ConversationParam-2

Die Unterhaltung, zu der diese Antwort gehört.

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

OpenAI.ConversationReference

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

Name	Typ	Description	Required	Vorgabe
erstellt_am	integer	Die Zeit, zu der die Unterhaltung geschaffen wurde, gemessen in Sekunden seit der Unix-Epoche.	Ja
id	Schnur	Die eindeutige ID der Unterhaltung.	Ja
metadata	OpenAI.Metadata	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	Ja
Objekt	enum	Der Objekttyp, der immer conversationist. Mögliche Werte: conversation	Ja

OpenAI.CreateChatCompletionRequestResponseFormat

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

Diskriminator für OpenAI.CreateChatCompletionRequestResponseFormat

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

Typwert	Schema
text	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatResponseFormatText
json_object	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatResponseFormatJsonObject

Name	Typ	Description	Required	Vorgabe
type	OpenAI.CreateChatCompletionRequestResponseFormatType		Ja

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatResponseFormatJsonObject

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

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

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatResponseFormatText

Standardantwortformat. Wird verwendet, um Textantworten zu generieren.

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

OpenAI.CreateChatCompletionRequestResponseFormatType

Property	Wert
Typ	Schnur
Werte	text json_schema json_object

OpenAI.CreateConversationBody

Name	Typ	Description	Required	Vorgabe
items	Array von OpenAI.InputItem		No
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No

OpenAI.CreateEvalCompletionsRunDataSource

Ein CompletionsRunDataSource-Objekt, das eine Modellsamplingkonfiguration beschreibt.

Name	Typ	Description	Required	Vorgabe
Eingabenachrichten	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate oder OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	Wird beim Sampling aus einem Modell verwendet. Bestimmt die Struktur der Nachrichten, die an das Modell übergeben werden. Kann entweder ein Verweis auf eine vordefinierte Flugbahn (ie, item.input_trajectory) oder eine Vorlage mit variablen Verweisen auf den item Namespace sein.	No
model	Schnur	Der Name des Modells, das zum Generieren von Fertigstellungen verwendet werden soll (z. B. "o3-mini").	No
Parameter für Stichprobennahme	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		No
source	OpenAI.EvalJsonlFileContentSource oder OpenAI.EvalJsonlFileIdSource oder OpenAI.EvalStoredCompletionsSource	Bestimmt, was den Namespace in der item Datenquelle dieser Ausführung auffüllt.	Ja
type	enum	Der Typ der Ausführungsdatenquelle. Immer completions. Mögliche Werte: completions	Ja

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

Name	Typ	Description	Required	Vorgabe
item_reference	Schnur		Ja
type	enum	Mögliche Werte: item_reference	Ja

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Name	Typ	Description	Required	Vorgabe
template	Array von OpenAI.EasyInputMessage oder OpenAI.EvalItem		Ja
type	enum	Mögliche Werte: template	Ja

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Name	Typ	Description	Required	Vorgabe
max_completion_tokens	OpenAI.integer		No
Denkanstrengung	OpenAI.ReasoningEffort	Schränkt den Aufwand für die Begründung ein Begründungsmodelle. Derzeit unterstützte Werte sind none, , minimal, low, medium, highund 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, mediumund high. Toolaufrufe werden für alle Gründe in gpt-5.1 unterstützt. - Alle Modelle vor gpt-5.1 der Standardeinstellung des medium Grundaufwands und nicht unterstützen none. - Das gpt-5-pro Modell ist standardmäßig auf (und nur unterstützt) high Grunderlegungsaufwand festgelegt. - xhigh wird für alle Modelle nach gpt-5.1-codex-max.	No
Antwortformat	OpenAI.ResponseFormatText oder OpenAI.ResponseFormatJsonSchema oder OpenAI.ResponseFormatJsonObject		No
seed	OpenAI.integer		No	42
Temperatur	OpenAI.numeric		No	1
tools	Array von OpenAI.ChatCompletionTool		No
top_p	OpenAI.numeric		No	1

OpenAI.CreateEvalCustomDataSourceConfig

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

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

Name	Typ	Description	Required	Vorgabe
Beispielschema einfügen	boolean	Ob die Auswertung erwarten sollte, dass Sie den Beispiel-Namespace auffüllen (d. h. durch Generieren von Antworten aus der Datenquelle)	No
Artikel-Schema	Objekt	Das JSON-Schema für jede Zeile in der Datenquelle.	Ja
type	enum	Der Typ der Datenquelle. Immer custom. Mögliche Werte: custom	Ja

OpenAI.CreateEvalJsonlRunDataSource

Ein JsonlRunDataSource-Objekt, mit dem eine JSONL-Datei angegeben wird, die dem Bewertungsprozess entspricht.

Name	Typ	Description	Required	Vorgabe
source	OpenAI.EvalJsonlFileContentSource oder OpenAI.EvalJsonlFileIdSource	Bestimmt, was den item Namespace in der Datenquelle auffüllt.	Ja
type	enum	Der Typ der Datenquelle. Immer jsonl. Mögliche Werte: jsonl	Ja

OpenAI.CreateEvalLogsDataSourceConfig

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

Name	Typ	Description	Required	Vorgabe
metadata	Objekt	Metadatenfilter für die Protokolldatenquelle.	No
type	enum	Der Typ der Datenquelle. Immer logs. Mögliche Werte: logs	Ja

OpenAI.CreateEvalResponsesRunDataSource

Ein ResponsesRunDataSource-Objekt, das eine Modellsamplingkonfiguration beschreibt.

Name	Typ	Description	Required	Vorgabe
Eingabenachrichten	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate oder OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Wird beim Sampling aus einem Modell verwendet. Bestimmt die Struktur der Nachrichten, die an das Modell übergeben werden. Kann entweder ein Verweis auf eine vordefinierte Flugbahn (ie, item.input_trajectory) oder eine Vorlage mit variablen Verweisen auf den item Namespace sein.	No
model	Schnur	Der Name des Modells, das zum Generieren von Fertigstellungen verwendet werden soll (z. B. "o3-mini").	No
Parameter für Stichprobennahme	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		No
source	OpenAI.EvalJsonlFileContentSource oder OpenAI.EvalJsonlFileIdSource oder OpenAI.EvalResponsesSource	Bestimmt, was den Namespace in der item Datenquelle dieser Ausführung auffüllt.	Ja
type	enum	Der Typ der Ausführungsdatenquelle. Immer responses. Mögliche Werte: responses	Ja

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

Name	Typ	Description	Required	Vorgabe
item_reference	Schnur		Ja
type	enum	Mögliche Werte: item_reference	Ja

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Name	Typ	Description	Required	Vorgabe
template	Array des Objekts oder OpenAI.EvalItem		Ja
type	enum	Mögliche Werte: template	Ja

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Name	Typ	Description	Required	Vorgabe
max_completion_tokens	OpenAI.integer		No
Denkanstrengung	OpenAI.ReasoningEffort	Schränkt den Aufwand für die Begründung ein Begründungsmodelle. Derzeit unterstützte Werte sind none, , minimal, low, medium, highund 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, mediumund 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
seed	OpenAI.integer		No	42
Temperatur	OpenAI.numeric		No	1
Text	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		No
tools	Array von OpenAI.Tool		No
top_p	OpenAI.numeric		No	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

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

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

Veraltet zugunsten von LogsDataSourceConfig.

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

OpenAI.CreateFineTuningJobRequest

Gültige Modelle:

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

Name	Typ	Description	Required	Vorgabe
Hyperparameter	OpenAI.CreateFineTuningJobRequestHyperparameters		No
└- batch_size	String oder OpenAI.integer		No	auto
└– Lernraten-Multiplikator	Zeichenfolge oder OpenAI.numeric		No
└– n_epochs	String oder OpenAI.integer		No	auto
Integrationen	Array von OpenAI.CreateFineTuningJobRequestIntegrations	Eine Liste der Integrationen, die Für Ihren Feinabstimmungsauftrag aktiviert werden sollen.	No
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
method	OpenAI.FineTuneMethod	Die Methode, die für die Feinabstimmung verwendet wird.	No
model	string (siehe gültige Modelle unten)	Der Name des Modells, das optimiert werden soll. Sie können eine der Folgenden auswählen: unterstützte Modelle.	Ja
seed	OpenAI.integer (nullable)		No
Suffix	String (nullierbar)	Eine Zeichenfolge von bis zu 64 Zeichen, die ihrem fein abgestimmten Modellnamen hinzugefügt werden. Beispielsweise würde ein suffix "custom-model-name" einen Modellnamen wie ft:gpt-4o-mini:openai:custom-model-name:7p4lURel. Einschränkungen: minLength: 1, maxLength: 64	No
Trainingsdatei	Schnur	Die ID einer hochgeladenen Datei, die Schulungsdaten enthält. Informationen zum Hochladen einer Datei finden Sie unter "Hochladen einer Datei". Ihr Dataset muss als JSONL-Datei formatiert werden. Darüber hinaus müssen Sie Ihre Datei mit dem Zweck fine-tunehochladen. Der Inhalt der Datei sollte je nachdem, ob das Modell das Chat-, Abschlussformat verwendet oder wenn die Feinabstimmungsmethode das Einstellungsformat verwendet. Weitere Details finden Sie im Fine-Tuning-Leitfaden.	Ja
Validierungsdatei	String (nullierbar)	Die ID einer hochgeladenen Datei, die Überprüfungsdaten enthält. Wenn Sie diese Datei angeben, werden die Daten verwendet, um die Validierung zu generieren. Metriken werden während der Feinabstimmung regelmäßig überprüft. Diese Metriken können in die Feinabstimmungsergebnisdatei. Die gleichen Daten sollten nicht sowohl in Train- als auch in Validierungsdateien vorhanden sein. Ihr Dataset muss als JSONL-Datei formatiert werden. Sie müssen Ihre Datei mit dem Zweck fine-tunehochladen. Weitere Details finden Sie im Fine-Tuning-Leitfaden.	No

OpenAI.CreateFineTuningJobRequestHyperparameters

Name	Typ	Description	Required	Vorgabe
Batch-Größe	String oder OpenAI.integer		No
Lernratenmultiplikator	Zeichenfolge oder OpenAI.numeric		No
n_epochs	String oder OpenAI.integer		No

OpenAI.CreateFineTuningJobRequestIntegrations

Name	Typ	Description	Required	Vorgabe
type	enum	Mögliche Werte: wandb	Ja
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Ja

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Name	Typ	Description	Required	Vorgabe
entity	String (nullierbar)		No
Name	String (nullierbar)		No
project	Schnur		Ja
tags	Array von Strings		No

OpenAI.CreateResponseStreamingResponse

Typ: OpenAI.ResponseAudioDeltaEvent oder OpenAI.ResponseAudioTranscriptDeltaEvent oder OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent oder OpenAI.ResponseCodeInterpreterCallInProgressEvent oder OpenAI.ResponseCodeInterpreterCallInterpretingEvent oder OpenAI.ResponseContentPartAddedEvent oder OpenAI.ResponseCreatedEvent oder OpenAI.ResponseErrorEvent oder OpenAI.ResponseFileSearchCallInProgressEvent oder OpenAI.ResponseFileSearchCallSearchingEvent oder OpenAI.ResponseFunctionCallArgumentsDeltaEvent oder OpenAI.ResponseInProgressEvent oder OpenAI.ResponseFailedEvent oder OpenAI.ResponseIncompleteEvent oder OpenAI.ResponseOutputItemAddedEvent oder OpenAI.ResponseReasoningSummaryPartAddedEvent oder OpenAI.ResponseReasoningSummaryTextDeltaEvent oder OpenAI.ResponseReasoningTextDeltaEvent oder OpenAI.ResponseRefusalDeltaEvent oder OpenAI.ResponseTextDeltaEvent oder OpenAI.ResponseWebSearchCallInProgressEvent oder OpenAI.ResponseWebSearchCallSearchingEvent oder OpenAI.ResponseImageGenCallGeneratingEvent oder OpenAI.ResponseImageGenCallInProgressEvent oder OpenAI.ResponseImageGenCallIalImageEvent oder OpenAI.ResponseMCPCallArgumentsDeltaEvent oder OpenAI.ResponseMCPCallFailedEvent oder OpenAI.ResponseMCPCallInProgressEvent oder OpenAI.ResponseMCPListToolsFailedEvent oder OpenAI.ResponseMCPListToolsInProgressEvent oder OpenAI.ResponseOutputTextAnnotationAddedEvent oder OpenAI.ResponseQueuedEvent oder OpenAI.ResponseCustomToolCallInputDeltaEvent oder OpenAI.ResponseAudioDoneEvent oder OpenAI.ResponseAudioTranscriptDoneEvent oder OpenAI.ResponseCodeInterpreterCallCodeDoneEvent oder OpenAI.ResponseCodeInterpreterCallCompletedEvent oder OpenAI.ResponseCompletedEvent oder OpenAI.ResponseContentPartDoneEvent oder OpenAI.ResponseFileSearchCallCompletedEvent oder OpenAI.ResponseFunctionCallArgumentsDoneEvent oder OpenAI.ResponseOutputItemDoneEvent oder OpenAI.ResponseReasoningSummaryPartDoneEvent oder OpenAI.ResponseReasoningSummaryTextDoneEvent oder OpenAI.ResponseReasoningTextDoneEvent oder OpenAI.ResponseRefusalDoneEvent oder OpenAI.ResponseRefusalDoneEvent oder OpenAI.OpenAI. ResponseTextDoneEvent oder OpenAI.ResponseWebSearchCallCompletedEvent oder OpenAI.ResponseImageGenCallCompletedEvent oder OpenAI.ResponseMCPCallArgumentsDoneEvent oder OpenAI.ResponseMCPCallCompletedEvent oder OpenAI.ResponseMCPListToolsCompletedEvent oder OpenAI.ResponseCustomToolCallInputDoneEvent

OpenAI.CustomGrammarFormatParam

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

OpenAI.CustomTextFormatParam

Nicht eingeschränkter Freiformtext.

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

OpenAI.CustomToolParam

Ein benutzerdefiniertes Tool, das Eingaben mithilfe eines angegebenen Formats verarbeitet. Weitere Informationen zu benutzerdefinierten Tools

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

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

Name	Typ	Description	Required	Vorgabe
gelöscht	boolean		Ja
id	Schnur		Ja
Objekt	enum	Mögliche Werte: conversation.deleted	Ja

OpenAI.DetailEnum

Property	Wert
Typ	Schnur
Werte	low high auto

OpenAI.DoubleClickAction

Eine Doppelklickaktion

Name	Typ	Description	Required	Vorgabe
type	enum	Gibt den Ereignistyp an. Bei einer Doppelklickaktion ist diese Eigenschaft immer auf double_click gesetzt. Mögliche Werte: double_click	Ja
x	OpenAI.integer		Ja
y	OpenAI.integer		Ja

OpenAI.Drag

Eine Ziehaktion

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

OpenAI.DragPoint

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

Name	Typ	Description	Required	Vorgabe
x	OpenAI.integer		Ja
y	OpenAI.integer		Ja

OpenAI.EasyInputMessage

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	Vorgabe
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
Rolle	enum	Die Rolle der Nachrichteneingabe. Einer von user, assistant, , systemoder developer. Mögliche Werte: user, , assistant, systemdeveloper	Ja
status	enum	Der Status des Elements. Einer von in_progress, , completedoder 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.Error

Name	Typ	Description	Required	Vorgabe
zusätzlicheInformationen	Objekt		No
Programmcode	String (nullierbar)		Ja
Debuginfo	Objekt		No
details	Array von OpenAI.Error		No
message	Schnur		Ja
param	String (nullierbar)		No
type	Schnur		No

OpenAI.EvalApiError

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

Name	Typ	Description	Required	Vorgabe
Programmcode	Schnur	Der Fehlercode.	Ja
message	Schnur	Die Fehlermeldung.	Ja

OpenAI.EvalGraderLabelModel

Name	Typ	Description	Required	Vorgabe
input	Array von OpenAI.EvalItem		Ja
labels	Array von Strings	Die Bezeichnungen, die jedem Element in der Auswertung zugewiesen werden sollen.	Ja
model	Schnur	Das Modell, das für die Auswertung verwendet werden soll. Muss strukturierte Ausgaben unterstützen	Ja
Name	Schnur	Name des Bewerters (Graders)	Ja
passing_labels	Array von Strings	Bezeichnungen für ein bestandenes Ergebnis. Muss eine Teilmenge von „labels“ (Bezeichnungen) sein	Ja
type	enum	Der Objekttyp, der immer label_modelist. Mögliche Werte: label_model	Ja

OpenAI.EvalGraderPython

Name	Typ	Description	Required	Vorgabe
image_tag	Schnur	Das Bildtag, das für das Python-Skript verwendet werden soll.	No
Name	Schnur	Name des Bewerters (Graders)	Ja
Schwellenwert erreichen	OpenAI.numeric		No
source	Schnur	Der Quellcode des Python-Skripts.	Ja
type	enum	Der Objekttyp, der immer pythonist. Mögliche Werte: python	Ja

OpenAI.EvalGraderScoreModel

Name	Typ	Description	Required	Vorgabe
input	Array von OpenAI.EvalItem	Die vom Grader ausgewerteten Eingabemeldungen. Unterstützt Text-, Ausgabetext-, Eingabebild- und Eingabe-Audioinhaltsblöcke und kann Vorlagenzeichenfolgen enthalten.	Ja
model	Schnur	Das Modell, das für die Auswertung verwendet werden soll.	Ja
Name	Schnur	Name des Bewerters (Graders)	Ja
Schwellenwert erreichen	OpenAI.numeric		No
Bereich	Array von OpenAI.numeric	Der Bereich für den Score Wird standardmäßig auf [0, 1] festgelegt.	No
Parameter für Stichprobennahme	OpenAI.EvalGraderScoreModelSamplingParams		No
└– max_completions_tokens	OpenAI.integer (nullable)		No
└– reasoning_effort	OpenAI.ReasoningEffort	Schränkt den Aufwand für die Begründung ein Begründungsmodelle. Derzeit unterstützte Werte sind none, , minimal, low, medium, highund 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, mediumund 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
└- Samen	OpenAI.integer (nullable)		No
└– Temperatur	OpenAI.numeric (nullierbar)		No
└– top_p	OpenAI.numeric (nullierbar)		No	1
type	enum	Der Objekttyp, der immer score_modelist. Mögliche Werte: score_model	Ja

OpenAI.EvalGraderScoreModelSamplingParams

Name	Typ	Description	Required	Vorgabe
max_completions_tokens	OpenAI.integer (nullable)		No
Denkanstrengung	OpenAI.ReasoningEffort	Schränkt den Aufwand für die Begründung ein Begründungsmodelle. Derzeit unterstützte Werte sind none, , minimal, low, medium, highund 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, mediumund 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
seed	OpenAI.integer (nullable)		No
Temperatur	OpenAI.numeric (nullierbar)		No
top_p	OpenAI.numeric (nullierbar)		No	1

OpenAI.EvalGraderStringCheck

Name	Typ	Description	Required	Vorgabe
input	Schnur	Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten.	Ja
Name	Schnur	Name des Bewerters (Graders)	Ja
operation	enum	Der auszuführende Zeichenfolgenüberprüfungsvorgang Einer von eq, ne, , likeoder ilike. Mögliche Werte: eq, , ne, likeilike	Ja
Referenz	Schnur	Der Bezugstext. Dies kann Vorlagenzeichenfolgen enthalten.	Ja
type	enum	Der Objekttyp, der immer string_checkist. Mögliche Werte: string_check	Ja

OpenAI.EvalGraderTextSimilarity

Name	Typ	Description	Required	Vorgabe
Bewertungsmetrik	enum	Die zu verwendende Auswertungsmetrik. Einer von cosine, , fuzzy_match, bleu gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 oder rouge_l. Mögliche Werte: cosine, , fuzzy_match, bleu, gleumeteor, rouge_1, rouge_2rouge_3rouge_4rouge_5rouge_l	Ja
input	Schnur	Der Text, der benotet wird.	Ja
Name	Schnur	Name des Bewerters (Graders)	Ja
Schwellenwert erreichen	OpenAI.numeric		Ja
Referenz	Schnur	Der Text, für die Bewertung.	Ja
type	enum	Typ des Bewerters (Graders) Mögliche Werte: text_similarity	Ja

OpenAI.EvalItem

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	Vorgabe
Inhalt	OpenAI.EvalItemContent	Eingaben für das Modell – können Vorlagenzeichenfolgen enthalten. Unterstützt Text, Ausgabetext, Eingabebilder und Eingabeaudio, entweder als einzelnes Element oder als Array von Elementen.	Ja
Rolle	enum	Die Rolle der Nachrichteneingabe. Einer von user, assistant, , systemoder developer. Mögliche Werte: user, , assistant, systemdeveloper	Ja
type	enum	Der Typ der Nachrichteneingabe. Immer message. Mögliche Werte: message	No

OpenAI.EvalItemContent

Eingaben für das Modell – können Vorlagenzeichenfolgen enthalten. Unterstützt Text, Ausgabetext, Eingabebilder und Eingabeaudio, entweder als einzelnes Element oder als Array von Elementen.

Typ: OpenAI.EvalItemContentItem oder OpenAI.EvalItemContentArray

Eingaben für das Modell – können Vorlagenzeichenfolgen enthalten. Unterstützt Text, Ausgabetext, Eingabebilder und Eingabeaudio, entweder als einzelnes Element oder als Array von Elementen.

OpenAI.EvalItemContentArray

Eine Liste der Eingaben, von denen jedes ein Eingabetext, Ausgabetext, Eingabebild oder Eingabeaudioobjekt sein kann.

Array von: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Ein einzelnes Inhaltselement: Eingabetext, Ausgabetext, Eingabebild oder Eingabeaudio.

Typ: OpenAI.EvalItemContentText oder OpenAI.EvalItemContentItemObject

Ein einzelnes Inhaltselement: Eingabetext, Ausgabetext, Eingabebild oder Eingabeaudio.

OpenAI.EvalItemContentItemObject

Ein einzelnes Inhaltselement: Eingabetext, Ausgabetext, Eingabebild oder Eingabeaudio.

Diskriminator für OpenAI.EvalItemContentItemObject

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

Typwert	Schema
output_text	OpenAI.EvalItemContentOutputText
input_image	OpenAI.EvalItemInputImage
input_audio	OpenAI.InputAudio
input_text	OpenAI.EvalItemContentItemObjectInputTextContent

Name	Typ	Description	Required	Vorgabe
type	OpenAI.EvalItemContentItemObjectType		Ja

OpenAI.EvalItemContentItemObjectInputTextContent

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

OpenAI.EvalItemContentItemObjectType

Property	Wert
Typ	Schnur
Werte	input_text output_text input_image input_audio

OpenAI.EvalItemContentOutputText

Eine Textausgabe aus dem Modell.

Name	Typ	Description	Required	Vorgabe
Text	Schnur	Die Textausgabe aus dem Modell.	Ja
type	enum	Der Typ des Ausgabetexts. Immer output_text. Mögliche Werte: output_text	Ja

OpenAI.EvalItemContentText

Eine Texteingabe für das Modell.

Typ: Zeichenfolge

OpenAI.EvalItemInputImage

Ein Bildeingabeblock, der in EvalItem-Inhaltsarrays verwendet wird.

Name	Typ	Description	Required	Vorgabe
detail	Schnur	Die Detailebene des Bilds, das an das Modell gesendet werden soll. Einer der folgenden Werte: high, low oder auto. Wird standardmäßig auf auto festgelegt.	No
image_url	Schnur	Die URL der Bildeingabe.	Ja
type	enum	Der Typ der Bildeingabe. Immer input_image. Mögliche Werte: input_image	Ja

OpenAI.EvalJsonlFileContentSource

Name	Typ	Description	Required	Vorgabe
Inhalt	Array von OpenAI.EvalJsonlFileContentSourceContent	Der Inhalt der JSONL-Datei.	Ja
type	enum	Der Typ der JSONL-Quelle. Immer file_content. Mögliche Werte: file_content	Ja

OpenAI.EvalJsonlFileContentSourceContent

Name	Typ	Description	Required	Vorgabe
item	Objekt		Ja
Beispiel	Objekt		No

OpenAI.EvalJsonlFileIdSource

Name	Typ	Description	Required	Vorgabe
id	Schnur	Der Bezeichner der Datei.	Ja
type	enum	Der Typ der JSONL-Quelle. Immer file_id. Mögliche Werte: file_id	Ja

OpenAI.EvalResponsesSource

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

Name	Typ	Description	Required	Vorgabe
created_after	OpenAI.integer (nullable)		No
erstellt_vor	OpenAI.integer (nullable)		No
instructions_search	String (nullierbar)		No
metadata	Objekt (null)		No
model	String (nullierbar)		No
Denkanstrengung	OpenAI.ReasoningEffort (nullierbar)	Schränkt den Aufwand für die Begründung ein Begründungsmodelle. Derzeit unterstützte Werte sind none, , minimal, low, medium, highund 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, mediumund 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
Temperatur	OpenAI.numeric (nullierbar)		No
tools	Array von Strings		No
top_p	OpenAI.numeric (nullierbar)		No
type	enum	Der Typ der Ausführungsdatenquelle. Immer responses. Mögliche Werte: responses	Ja
users	Array von Strings		No

OpenAI.EvalRunOutputItemSample

Name	Typ	Description	Required	Vorgabe
Fehler	OpenAI.EvalApiError	Ein Objekt, das eine Fehlerantwort der Eval-API darstellt.	Ja
Beendigungsgrund	Schnur		Ja
input	Array von EvalRunOutputItemSampleInput		Ja
max_completion_tokens	OpenAI.integer		Ja
model	Schnur		Ja
Ausgabe	Array von EvalRunOutputItemSampleOutput		Ja
seed	OpenAI.integer		Ja
Temperatur	OpenAI.numeric		Ja
top_p	OpenAI.numeric		Ja
usage	OpenAI.EvalRunOutputItemSampleUsage		Ja

OpenAI.EvalRunOutputItemSampleUsage

Name	Typ	Description	Required	Vorgabe
cached_tokens	OpenAI.integer		Ja
completion_tokens	OpenAI.integer		Ja
prompt_tokens	OpenAI.integer		Ja
Gesamtanzahl Tokens	OpenAI.integer		Ja

OpenAI.EvalRunPerModelUsage

Name	Typ	Description	Required	Vorgabe
cached_tokens	OpenAI.integer		Ja
completion_tokens	OpenAI.integer		Ja
invocation_count	OpenAI.integer		Ja
model_name	Schnur		Ja
prompt_tokens	OpenAI.integer		Ja
Gesamtanzahl Tokens	OpenAI.integer		Ja

OpenAI.EvalRunPerTestingCriteriaResults

Name	Typ	Description	Required	Vorgabe
misslungen	OpenAI.integer		Ja
Übergeben	OpenAI.integer		Ja
Testkriterien	Schnur		Ja

OpenAI.EvalRunResultCounts

Name	Typ	Description	Required	Vorgabe
Fehlerhafte	OpenAI.integer		Ja
misslungen	OpenAI.integer		Ja
Übergeben	OpenAI.integer		Ja
gesamt	OpenAI.integer		Ja

OpenAI.EvalStoredCompletionsSource

Eine StoredCompletionsRunDataSource-Konfiguration, die eine Gruppe von Filtern beschreibt

Name	Typ	Description	Required	Vorgabe
created_after	OpenAI.integer (nullable)		No
erstellt_vor	OpenAI.integer (nullable)		No
Limit	OpenAI.integer (nullable)		No
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
model	String (nullierbar)		No
type	enum	Der Quelltyp. Immer stored_completions. Mögliche Werte: stored_completions	Ja

OpenAI.FileCitationBody

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	OpenAI.integer		Ja
type	enum	Der Typ des Dateizitats Immer file_citation. Mögliche Werte: file_citation	Ja

OpenAI.FilePath

Ein Pfad zu einer Datei.

Name	Typ	Description	Required	Vorgabe
Datei-ID	Schnur	Die ID der Datei.	Ja
index	OpenAI.integer		Ja
type	enum	Der Typ des Dateipfads. Immer file_path. Mögliche Werte: file_path	Ja

OpenAI.FileSearchTool

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

Name	Typ	Description	Required	Vorgabe
Filter	OpenAI.Filters (nullable)		No
max_anzahl_ergebnisse	OpenAI.integer		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	OpenAI.numeric	Der Schwellenwert für die Bewertung für die Dateisuche, eine Zahl zwischen 0 und 1. Zahlen, die näher an 1 sind, versuchen, nur die relevantesten Ergebnisse zurückzugeben, können aber weniger Ergebnisse zurückgeben.	No
type	enum	Der Typ des Dateisuchtools. Immer file_search. Mögliche Werte: file_search	Ja
vector_store_ids	Array von Strings	Die IDs der zu durchsuchenden Vektorspeicher.	Ja

OpenAI.FileSearchToolCallResults

Name	Typ	Description	Required	Vorgabe
attributes	OpenAI.VectorStoreFileAttributes (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit einer maximalen Länge von 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen, Booleanen oder Zahlen.	No
Datei-ID	Schnur		No
filename	Schnur		No
Punktzahl	Zahl		No
Text	Schnur		No

OpenAI.Filters

Typ: OpenAI.ComparisonFilter oder OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

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

Name	Typ	Description	Required	Vorgabe
Batch-Größe	String oder OpenAI.integer	Anzahl der Beispiele in jedem Batch. Eine größere Batchgröße bedeutet, dass Modellparameter weniger häufig aktualisiert werden, aber mit geringerer Varianz.	No
Beta	Zeichenfolge oder OpenAI.numeric	Der Betawert für die DPO-Methode. Ein höherer Betawert erhöht die Gewichtung der Strafe zwischen der Richtlinie und dem Referenzmodell.	No
Lernratenmultiplikator	Zeichenfolge oder OpenAI.numeric	Skalierungsfaktor für die Lernrate. Eine kleinere Lernrate kann nützlich sein, um überlastend zu vermeiden.	No
n_epochs	String oder OpenAI.integer	Die Anzahl der Epochen, für die das Modell trainiert werden soll. Eine Epoche bezieht sich auf einen vollständigen Zyklus durch die Schulungsdatensätze.	No

OpenAI.FineTuneDPOMethod

Konfiguration für die DPO-Feinabstimmungsmethode.

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

OpenAI.FineTuneMethod

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

Name	Typ	Description	Required	Vorgabe
Dsb	OpenAI.FineTuneDPOMethod	Konfiguration für die DPO-Feinabstimmungsmethode.	No
Verstärkung	OpenAI.FineTuneReinforcementMethod	Konfiguration für die Optimierungsmethode zur Verstärkung.	No
überwacht	OpenAI.FineTuneSupervisedMethod	Konfiguration für die überwachte Feinabstimmungsmethode.	No
type	enum	Der Typ der Methode. Ist entweder supervised, , dpooder reinforcement. Mögliche Werte: supervised, , dporeinforcement	Ja

OpenAI.FineTuneReinforcementHyperparameters

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

Name	Typ	Description	Required	Vorgabe
Batch-Größe	String oder OpenAI.integer	Anzahl der Beispiele in jedem Batch. Eine größere Batchgröße bedeutet, dass Modellparameter weniger häufig aktualisiert werden, aber mit geringerer Varianz.	No
compute_multiplier	Zeichenfolge oder OpenAI.numeric	Multiplizierer für die Berechnungsmenge, die für die Erkundung des Suchraums während der Schulung verwendet wird.	No
eval_interval	String oder OpenAI.integer	Die Anzahl der Schulungsschritte zwischen den Auswertungsläufen.	No
eval_samples	String oder OpenAI.integer	Anzahl der Auswertungsbeispiele, die pro Schulungsschritt generiert werden sollen.	No
Lernratenmultiplikator	Zeichenfolge oder OpenAI.numeric	Skalierungsfaktor für die Lernrate. Eine kleinere Lernrate kann nützlich sein, um überlastend zu vermeiden.	No
n_epochs	String oder OpenAI.integer	Die Anzahl der Epochen, für die das Modell trainiert werden soll. Eine Epoche bezieht sich auf einen vollständigen Zyklus durch die Schulungsdatensätze.	No
Denkanstrengung	enum	Ebene des Grundaufwands. Mögliche Werte: default, , low, mediumhigh	No

OpenAI.FineTuneReinforcementMethod

Konfiguration für die Optimierungsmethode zur Verstärkung.

Name	Typ	Description	Required	Vorgabe
Grader	OpenAI.GraderStringCheck oder OpenAI.GraderTextSimilarity oder OpenAI.GraderPython oder OpenAI.GraderScoreModel oder OpenAI.GraderMulti	Der Grader, der für den Feinabstimmungsauftrag verwendet wird.	Ja
Hyperparameter	OpenAI.FineTuneReinforcementHyperparameters	Die Hyperparameter, die für den Verstärkungs-Feinabstimmungsauftrag verwendet werden.	No

OpenAI.FineTuneSupervisedHyperparameters

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

Name	Typ	Description	Required	Vorgabe
Batch-Größe	String oder OpenAI.integer	Anzahl der Beispiele in jedem Batch. Eine größere Batchgröße bedeutet, dass Modellparameter weniger häufig aktualisiert werden, aber mit geringerer Varianz.	No
Lernratenmultiplikator	Zeichenfolge oder OpenAI.numeric	Skalierungsfaktor für die Lernrate. Eine kleinere Lernrate kann nützlich sein, um überlastend zu vermeiden.	No
n_epochs	String oder OpenAI.integer	Die Anzahl der Epochen, für die das Modell trainiert werden soll. Eine Epoche bezieht sich auf einen vollständigen Zyklus durch die Schulungsdatensätze.	No

OpenAI.FineTuneSupervisedMethod

Konfiguration für die überwachte Feinabstimmungsmethode.

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

OpenAI.FineTuningIntegration

Name	Typ	Description	Required	Vorgabe
type	enum	Der Typ der Integration, die für den Feinabstimmungsauftrag aktiviert wird Mögliche Werte: wandb	Ja
wandb	OpenAI.FineTuningIntegrationWandb		Ja
└– Entität	String (nullierbar)		No
└– Name	String (nullierbar)		No
└– Projekt	Schnur		Ja
└- Tags	Array von Strings		No

OpenAI.FineTuningIntegrationWandb

Name	Typ	Description	Required	Vorgabe
entity	String (nullierbar)		No
Name	String (nullierbar)		No
project	Schnur		Ja
tags	Array von Strings		No

OpenAI.FineTuningJob

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

Name	Typ	Description	Required	Vorgabe
erstellt_am	integer	Der Unix-Zeitstempel (in Sekunden) für die Erstellung des Feinabstimmungsauftrags.	Ja
Fehler	OpenAI.FineTuningJobError (nullable)		Ja
└– Code	Schnur		Ja
└– Nachricht	Schnur		Ja
└─ param	String (nullierbar)		Ja
geschätzte Fertigstellung	integer		No
fine_tuned_model	String (nullierbar)		Ja
finished_at	integer		Ja
Hyperparameter	OpenAI.FineTuningJobHyperparameters		Ja
└- batch_size	String oder OpenAI.integer		No	auto
└– Lernraten-Multiplikator	Zeichenfolge oder OpenAI.numeric		No
└– n_epochs	String oder OpenAI.integer		No	auto
id	Schnur	Der Objektbezeichner, auf den in den API-Endpunkten verwiesen werden kann.	Ja
Integrationen	Array von OpenAI.FineTuningIntegration		No
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
method	OpenAI.FineTuneMethod	Die Methode, die für die Feinabstimmung verwendet wird.	No
model	Schnur	Das Basismodell, das fein abgestimmt wird.	Ja
Objekt	enum	Der Objekttyp, der immer "fine_tuning.job" ist. Mögliche Werte: fine_tuning.job	Ja
organization_id	Schnur	Die Organisation, die den Feinabstimmungsauftrag besitzt.	Ja
Ergebnisdateien	Array von Strings	Die kompilierten Ergebnisdatei-ID(n) für den Feinabstimmungsauftrag. Sie können die Ergebnisse mit der Datei-API abrufen.	Ja
seed	OpenAI.integer		Ja
status	enum	Der aktuelle Status des Feinabstimmungsauftrags, der entweder validating_files, , queued, running, , succeeded, oder failedcancelled. Mögliche Werte: validating_files, , queued, runningsucceeded, , , failedcancelled	Ja
trainierte Token	OpenAI.integer (nullable)		Ja
Trainingsdatei	Schnur	Die datei-ID, die für die Schulung verwendet wird. Sie können die Schulungsdaten mit der Dateien-API abrufen.	Ja
Validierungsdatei	String (nullierbar)		Ja

OpenAI.FineTuningJobCheckpoint

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

Name	Typ	Description	Required	Vorgabe
erstellt_am	integer	Der Unix-Zeitstempel (in Sekunden) für den Zeitpunkt der Erstellung des Prüfpunkts.	Ja
fine_tuned_model_checkpoint	Schnur	Der Name des erstellten fein abgestimmten Prüfpunktmodells.	Ja
fine_tuning_job_id	Schnur	Name des Optimierungsauftrags, aus dem dieser Prüfpunkt erstellt wurde	Ja
id	Schnur	Der Prüfpunktbezeichner, auf den in den API-Endpunkten verwiesen werden kann.	Ja
metrics	OpenAI.FineTuningJobCheckpointMetrics		Ja
└– full_valid_loss	OpenAI.numeric		No
└– Durchschnittliche Token-Genauigkeit für die gültigen vollständigen Daten	OpenAI.numeric		No
└– Schritt	OpenAI.numeric		No
└– train_loss	OpenAI.numeric		No
└– train_mean_token_accuracy	OpenAI.numeric		No
└– valid_loss	OpenAI.numeric		No
└– valid_mean_token_accuracy	OpenAI.numeric		No
Objekt	enum	Der Objekttyp, der immer "fine_tuning.job.checkpoint" ist. Mögliche Werte: fine_tuning.job.checkpoint	Ja
Schrittnummer	OpenAI.integer		Ja

OpenAI.FineTuningJobCheckpointMetrics

Name	Typ	Description	Required	Vorgabe
full_valid_loss	OpenAI.numeric		No
full_valid_mean_token_accuracy	OpenAI.numeric		No
Schritt	OpenAI.numeric		No
train_loss	OpenAI.numeric		No
train_mean_token_accuracy	OpenAI.numeric		No
valid_loss	OpenAI.numeric		No
valid_mean_token_accuracy	OpenAI.numeric		No

OpenAI.FineTuningJobError

Name	Typ	Description	Required	Vorgabe
Programmcode	Schnur		Ja
message	Schnur		Ja
param	String (nullierbar)		Ja

OpenAI.FineTuningJobEvent

Feinabstimmung des Auftragsereignisobjekts

Name	Typ	Description	Required	Vorgabe
erstellt_am	integer	Der Unix-Zeitstempel (in Sekunden) für die Erstellung des Feinabstimmungsauftrags.	Ja
data	OpenAI.FineTuningJobEventData		No
id	Schnur	Der Objektbezeichner.	Ja
level	enum	Die Protokollebene des Ereignisses. Mögliche Werte: info, , warnerror	Ja
message	Schnur	Die Nachricht des Ereignisses.	Ja
Objekt	enum	Der Objekttyp, der immer "fine_tuning.job.event" ist. Mögliche Werte: fine_tuning.job.event	Ja
type	enum	Den Typ des Ereignisses Mögliche Werte: message, metrics	No

OpenAI.FineTuningJobEventData

Typ: Objekt

OpenAI.FineTuningJobHyperparameters

Name	Typ	Description	Required	Vorgabe
Batch-Größe	String oder OpenAI.integer		No
Lernratenmultiplikator	Zeichenfolge oder OpenAI.numeric		No
n_epochs	String oder OpenAI.integer		No

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

Eine Dateieingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
file_data	Schnur	Der Inhalt der Datei, die an das Modell gesendet werden soll.	No
Datei-ID	String (nullierbar)		No
file_url	Schnur	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

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

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

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.ImageDetail		Ja
Datei-ID	String (nullierbar)		No
image_url	Schnur		No
type	enum	Der Typ des Eingabeelements. Immer input_image. Mögliche Werte: input_image	Ja

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

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

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

Name	Typ	Description	Required	Vorgabe
description	Schnur	Eine Beschreibung der Funktion, die vom Modell verwendet wird, um auszuwählen, wann und wie die Funktion aufgerufen wird.	No
Name	Schnur	Der Name der funktion, die aufgerufen werden soll. Muss a-z, A-Z, 0-9 sein oder Unterstriche und Gedankenstriche enthalten, mit einer maximalen Länge von 64.	Ja
parameters	OpenAI.FunctionParameters	Die Parameter, die die Funktionen akzeptieren, die als JSON-Schemaobjekt beschrieben werden. Siehe die leitfaden für Beispiele und die JSON Schema Reference für Dokumentationen zum Format. Durch Weglassen parameters wird eine Funktion mit einer leeren Parameterliste definiert.	No
strict	boolescher Wert (nullable)		No

OpenAI.FunctionParameters

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

Typ: Objekt

OpenAI.FunctionShellAction

Führen Sie einen Shellbefehl aus.

Name	Typ	Description	Required	Vorgabe
commands	Array von Strings		Ja
max_output_length	OpenAI.integer (nullable)		Ja
timeout_ms	OpenAI.integer (nullable)		Ja

OpenAI.FunctionShellActionParam

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

Name	Typ	Description	Required	Vorgabe
commands	Array von Strings	Geordnete Shellbefehle für die Ausführungsumgebung.	Ja
max_output_length	OpenAI.integer (nullable)		No
timeout_ms	OpenAI.integer (nullable)		No

OpenAI.FunctionShellCallItemStatus

Für Shelltoolaufrufe gemeldete Statuswerte.

Property	Wert
Typ	Schnur
Werte	in_progress completed incomplete

OpenAI.FunctionShellCallOutputContent

Der Inhalt einer Shelltoolaufrufausgabe, die ausgegeben wurde.

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

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

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

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

Name	Typ	Description	Required	Vorgabe
exit_code	OpenAI.integer		Ja
type	enum	Der Ergebnistyp. Immer exit. Mögliche Werte: exit	Ja

OpenAI.FunctionShellCallOutputExitOutcomeParam

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

Name	Typ	Description	Required	Vorgabe
exit_code	OpenAI.integer		Ja
type	enum	Der Ergebnistyp. Immer exit. Mögliche Werte: exit	Ja

OpenAI.FunctionShellCallOutputOutcome

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

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

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

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

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

OpenAI.FunctionShellToolParam

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

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

OpenAI.FunctionTool

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

Name	Typ	Description	Required	Vorgabe
description	String (nullierbar)		No
Name	Schnur	Der Name der funktion, die aufgerufen werden soll.	Ja
parameters	Objekt (null)		Ja
strict	boolescher Wert (nullable)		Ja
type	enum	Der Typ des Funktionstools. Immer function. Mögliche Werte: function	Ja

OpenAI.GraderLabelModel

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

Name	Typ	Description	Required	Vorgabe
input	Array von OpenAI.EvalItem		Ja
labels	Array von Strings	Die Bezeichnungen, die jedem Element in der Auswertung zugewiesen werden sollen.	Ja
model	Schnur	Das Modell, das für die Auswertung verwendet werden soll. Muss strukturierte Ausgaben unterstützen	Ja
Name	Schnur	Name des Bewerters (Graders)	Ja
passing_labels	Array von Strings	Bezeichnungen für ein bestandenes Ergebnis. Muss eine Teilmenge von „labels“ (Bezeichnungen) sein	Ja
type	enum	Der Objekttyp, der immer label_modelist. Mögliche Werte: label_model	Ja

OpenAI.GraderMulti

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

Name	Typ	Description	Required	Vorgabe
calculate_output	Schnur	Eine Formel zum Berechnen der Ausgabe basierend auf den Benotungsergebnissen.	Ja
Grader	OpenAI.GraderStringCheck oder OpenAI.GraderTextSimilarity oder OpenAI.GraderPython oder OpenAI.GraderScoreModel oder OpenAI.GraderLabelModel		Ja
Name	Schnur	Name des Bewerters (Graders)	Ja
type	enum	Der Objekttyp, der immer multiist. Mögliche Werte: multi	Ja

OpenAI.GraderPython

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

Name	Typ	Description	Required	Vorgabe
image_tag	Schnur	Das Bildtag, das für das Python-Skript verwendet werden soll.	No
Name	Schnur	Name des Bewerters (Graders)	Ja
source	Schnur	Der Quellcode des Python-Skripts.	Ja
type	enum	Der Objekttyp, der immer pythonist. Mögliche Werte: python	Ja

OpenAI.GraderScoreModel

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

Name	Typ	Description	Required	Vorgabe
input	Array von OpenAI.EvalItem	Die vom Grader ausgewerteten Eingabemeldungen. Unterstützt Text-, Ausgabetext-, Eingabebild- und Eingabe-Audioinhaltsblöcke und kann Vorlagenzeichenfolgen enthalten.	Ja
model	Schnur	Das Modell, das für die Auswertung verwendet werden soll.	Ja
Name	Schnur	Name des Bewerters (Graders)	Ja
Bereich	Array von OpenAI.numeric	Der Bereich für den Score Wird standardmäßig auf [0, 1] festgelegt.	No
Parameter für Stichprobennahme	OpenAI.EvalGraderScoreModelSamplingParams		No
└– max_completions_tokens	OpenAI.integer (nullable)		No
└– reasoning_effort	OpenAI.ReasoningEffort	Schränkt den Aufwand für die Begründung ein Begründungsmodelle. Derzeit unterstützte Werte sind none, , minimal, low, medium, highund 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, mediumund 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
└- Samen	OpenAI.integer (nullable)		No
└– Temperatur	OpenAI.numeric (nullierbar)		No
└– top_p	OpenAI.numeric (nullierbar)		No	1
type	enum	Der Objekttyp, der immer score_modelist. Mögliche Werte: score_model	Ja

OpenAI.GraderStringCheck

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

Name	Typ	Description	Required	Vorgabe
input	Schnur	Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten.	Ja
Name	Schnur	Name des Bewerters (Graders)	Ja
operation	enum	Der auszuführende Zeichenfolgenüberprüfungsvorgang Einer von eq, ne, , likeoder ilike. Mögliche Werte: eq, , ne, likeilike	Ja
Referenz	Schnur	Der Bezugstext. Dies kann Vorlagenzeichenfolgen enthalten.	Ja
type	enum	Der Objekttyp, der immer string_checkist. Mögliche Werte: string_check	Ja

OpenAI.GraderTextSimilarity

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

Name	Typ	Description	Required	Vorgabe
Bewertungsmetrik	enum	Die zu verwendende Auswertungsmetrik. Einer von cosine, , fuzzy_match, bleu gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 oder rouge_l. Mögliche Werte: cosine, , fuzzy_match, bleu, gleumeteor, rouge_1, rouge_2rouge_3rouge_4rouge_5rouge_l	Ja
input	Schnur	Der Text, der benotet wird.	Ja
Name	Schnur	Name des Bewerters (Graders)	Ja
Referenz	Schnur	Der Text, für die Bewertung.	Ja
type	enum	Typ des Bewerters (Graders) Mögliche Werte: text_similarity	Ja

OpenAI.GrammarSyntax1

Property	Wert
Typ	Schnur
Werte	lark regex

OpenAI.HybridSearchOptions

Name	Typ	Description	Required	Vorgabe
embedding_weight	OpenAI.numeric		Ja
text_weight	OpenAI.numeric		Ja

OpenAI.ImageDetail

Property	Wert
Typ	Schnur
Werte	low high auto

OpenAI.ImageGenTool

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

Gültige Modelle:

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

Name	Typ	Description	Required	Vorgabe
Hintergrund	enum	Hintergrundtyp für das generierte Bild. Einer von transparent, opaque oder auto. Standardwert: auto. Mögliche Werte: transparent, , opaqueauto	No
input_fidelity	OpenAI.InputFidelity (nullable)	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. Nicht unterstützt für gpt-image-1-mini. Unterstützt high und low. Wird standardmäßig auf low festgelegt.	No
input_image_mask	OpenAI.ImageGenToolInputImageMask		No
└– file_id	Schnur		No
└– image_url	Schnur		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
Ausgabekomprimierung	OpenAI.integer		No	100
Ausgabeformat	enum	Das Ausgabeformat des generierten Bilds. Einer von png, , webpoder jpeg. Standardwert: png. Mögliche Werte: png, , webpjpeg	No
unvollständige Bilder	OpenAI.integer		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
size	enum	Die Größe des generierten Bilds. Einer von 1024x1024, 1024x1536 1536x1024 oder auto. Standardwert: auto. Mögliche Werte: 1024x1024, , 1024x1536, 1536x1024auto	No
type	enum	Der Typ des Tools zur Bildgenerierung. Immer image_generation. Mögliche Werte: image_generation	Ja

OpenAI.ImageGenToolInputImageMask

Name	Typ	Description	Required	Vorgabe
Datei-ID	Schnur		No
image_url	Schnur		No

OpenAI.IncludeEnum

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

• 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.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). | | Typ | string | | 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
memory_search_call.results |

OpenAI.InputAudio

Eine Audioeingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
input_audio	OpenAI.InputAudioInputAudio		Ja
type	enum	Der Typ des Eingabeelements. Immer input_audio. Mögliche Werte: input_audio	Ja

OpenAI.InputAudioInputAudio

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

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

Eine Dateieingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
file_data	Schnur	Der Inhalt der Datei, die an das Modell gesendet werden soll.	No
Datei-ID	String (nullierbar)		No
file_url	Schnur	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

OpenAI.InputContentInputImageContentContent

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

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.ImageDetail		Ja
Datei-ID	String (nullierbar)		No
image_url	Schnur		No
type	enum	Der Typ des Eingabeelements. Immer input_image. Mögliche Werte: input_image	Ja

OpenAI.InputContentInputTextContent

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

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. Nicht unterstützt für gpt-image-1-mini. Unterstützt high und low. Wird standardmäßig auf low festgelegt.

Property	Wert
Typ	Schnur
Werte	high low

OpenAI.InputFileContent

Eine Dateieingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
file_data	Schnur	Der Inhalt der Datei, die an das Modell gesendet werden soll.	No
Datei-ID	String (nullierbar)		No
file_url	Schnur	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

OpenAI.InputFileContentParam

Eine Dateieingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
file_data	String (nullierbar)		No
Datei-ID	String (nullierbar)		No
file_url	Schnur		No
filename	String (nullierbar)		No
type	enum	Der Typ des Eingabeelements. Immer input_file. Mögliche Werte: input_file	Ja

OpenAI.InputImageContent

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

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.ImageDetail		Ja
Datei-ID	String (nullierbar)		No
image_url	Schnur		No
type	enum	Der Typ des Eingabeelements. Immer input_image. Mögliche Werte: input_image	Ja

OpenAI.InputImageContentParamAutoParam

Eine Bildeingabe für das Modell. Informationen zu Bildeingaben

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.DetailEnum (nullable)		No
Datei-ID	String (nullierbar)		No
image_url	Schnur		No
type	enum	Der Typ des Eingabeelements. Immer input_image. Mögliche Werte: input_image	Ja

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

Name	Typ	Description	Required	Vorgabe
type	OpenAI.InputItemType		Ja

OpenAI.InputItemApplyPatchToolCallItemParam

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	String (nullierbar)		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

OpenAI.InputItemApplyPatchToolCallOutputItemParam

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	String (nullierbar)		No
Ausgabe	String (nullierbar)		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

OpenAI.InputItemCodeInterpreterToolCall

Ein Toolaufruf zum Ausführen von Code.

Name	Typ	Description	Required	Vorgabe
Programmcode	String (nullierbar)		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		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

OpenAI.InputItemCompactionSummaryItemParam

Ein von der v1/responses/compact API generiertes Komprimierungselement.

Name	Typ	Description	Required	Vorgabe
encrypted_content	Schnur	Der verschlüsselte Inhalt der Komprimierungszusammenfassung. Einschränkungen: maxLength: 10485760	Ja
id	String (nullierbar)		No
type	enum	Der Typ des Elements. Immer compaction. Mögliche Werte: compaction	Ja

OpenAI.InputItemComputerCallOutputItemParam

Die Ausgabe eines Computertoolaufrufs

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

OpenAI.InputItemComputerToolCall

Ein Toolaufruf eines von einem Computer verwendeten Tools Weitere Informationen finden Sie im Handbuch zur Computerverwendung .

Name	Typ	Description	Required	Vorgabe
Aktion	OpenAI.ComputerAction		Ja
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, , completedoder 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

OpenAI.InputItemCustomToolCall

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

Name	Typ	Description	Required	Vorgabe
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
type	enum	Der Typ des benutzerdefinierten Toolaufrufs. Immer custom_tool_call. Mögliche Werte: custom_tool_call	Ja

OpenAI.InputItemCustomToolCallOutput

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

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

Die Ergebnisse eines Dateisuchtoolaufrufs. Weitere Informationen finden Sie im Dateisuchhandbuch .

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

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	String (nullierbar)		No
Ausgabe	Zeichenfolge oder Array von OpenAI.InputTextContentParam oder OpenAI.InputImageContentParamAutoParam oder OpenAI.InputFileContentParam	Text-, Bild- oder Dateiausgabe des Funktionstoolaufrufs.	Ja
status	OpenAI.FunctionCallItemStatus (nullable)		No
type	enum	Der Typ der Ausgabe des Funktionstoolaufrufs Immer function_call_output. Mögliche Werte: function_call_output	Ja

OpenAI.InputItemFunctionShellCallItemParam

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	OpenAI.integer (nullable)		No
└– timeout_ms	OpenAI.integer (nullable)		No
call_id	Schnur	Die eindeutige ID des vom Modell generierten Shelltoolaufrufs. Einschränkungen: minLength: 1, maxLength: 64	Ja
id	String (nullierbar)		No
status	OpenAI.FunctionShellCallItemStatus (nullable)	Für Shelltoolaufrufe gemeldete Statuswerte.	No
type	enum	Der Typ des Elements. Immer shell_call. Mögliche Werte: shell_call	Ja

OpenAI.InputItemFunctionShellCallOutputItemParam

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	String (nullierbar)		No
max_output_length	OpenAI.integer (nullable)		No
Ausgabe	Array von OpenAI.FunctionShellCallOutputContentParam	Erfasste Blöcke der Stdout- und Stderr-Ausgabe zusammen mit den zugehörigen Ergebnissen.	Ja
type	enum	Der Typ des Elements. Immer shell_call_output. Mögliche Werte: shell_call_output	Ja

OpenAI.InputItemFunctionToolCall

Ein Toolaufruf zum Ausführen einer Funktion. Weitere Informationen finden Sie im Funktionsaufruf-Leitfaden.

Name	Typ	Description	Required	Vorgabe
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	Schnur	Die eindeutige ID des Aufrufs des Funktionswerkzeugs.	No
Name	Schnur	Der Name der auszuführenden Funktion.	Ja
status	enum	Der Status des Elements. Einer von in_progress, , completedoder 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

Eine Vom Modell vorgenommene Anforderung zur Bildgenerierung.

Name	Typ	Description	Required	Vorgabe
id	Schnur	Die eindeutige ID des Aufrufs der Bildgenerierung.	Ja
result	String (nullierbar)		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

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

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

Die Ausgabe eines Aufrufs eines lokalen Shell-Tools.

Name	Typ	Description	Required	Vorgabe
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	enum	Mögliche Werte: in_progress, , completedincomplete	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

Eine Anforderung für menschliche Genehmigung eines Toolaufrufs.

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

Eine Antwort auf eine MCP-Genehmigungsanforderung.

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

OpenAI.InputItemMcpListTools

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

Name	Typ	Description	Required	Vorgabe
Fehler	String (nullierbar)		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

Ein Aufruf eines Tools auf einem MCP-Server.

Name	Typ	Description	Required	Vorgabe
approval_request_id	String (nullierbar)		No
Argumente	Schnur	Eine JSON-Zeichenfolge der Argumente, die an das Tool übergeben werden.	Ja
Fehler	String (nullierbar)		No
id	Schnur	Die eindeutige ID des Toolaufrufs.	Ja
Name	Schnur	Der Name des tools, das ausgeführt wurde.	Ja
Ausgabe	String (nullierbar)		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

Eine Ausgabemeldung aus dem Modell.

Name	Typ	Description	Required	Vorgabe
Inhalt	Array von OpenAI.OutputMessageContent	Der Inhalt der Ausgabenachricht.	Ja
id	Schnur	Die eindeutige ID der Ausgabenachricht.	Ja
Rolle	enum	Die Rolle der Ausgabemeldung. Immer assistant. Mögliche Werte: assistant	Ja
status	enum	Der Status der Nachrichteneingabe. Einer von in_progress, , completedoder 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

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

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

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

OpenAI.InputItemWebSearchToolCall

Die Ergebnisse eines Aufrufs eines Websuchtools. Weitere Informationen finden Sie im Websuchhandbuch .

Name	Typ	Description	Required	Vorgabe
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 zur Verwendung des Modells im Web (Suche, open_page, Suchen).	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.InputMessage

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.

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
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, , completedoder 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

OpenAI.InputMessageContentList

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

Array von: OpenAI.InputContent

OpenAI.InputMessageResource

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	Schnur	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, , completedoder 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

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
• Konversationszustand
• Funktionsaufruf

Typ: Zeichenfolge oder Array von OpenAI.InputItem

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

• Texteingaben und -ausgaben
• Bildeingaben
• Dateieingaben
• Konversationszustand
• Funktionsaufruf

OpenAI.InputTextContent

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

OpenAI.InputTextContentParam

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

OpenAI.Item

Inhaltselement, das zum Generieren einer Antwort verwendet wird.

Diskriminator für OpenAI.Item

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

Typwert	Schema
memory_search_call	MemorySearchToolCallItemParam
message	OpenAI.InputMessage
output_message	OpenAI.ItemOutputMessage
file_search_call	OpenAI.ItemFileSearchToolCall
computer_call	OpenAI.ItemComputerToolCall
computer_call_output	OpenAI.ItemComputerCallOutputItemParam
web_search_call	OpenAI.ItemWebSearchToolCall
function_call	OpenAI.ItemFunctionToolCall
function_call_output	OpenAI.ItemFunctionCallOutputItemParam
reasoning	OpenAI.ItemReasoningItem
compaction	OpenAI.ItemCompactionSummaryItemParam
image_generation_call	OpenAI.ItemImageGenToolCall
code_interpreter_call	OpenAI.ItemCodeInterpreterToolCall
local_shell_call	OpenAI.ItemLocalShellToolCall
local_shell_call_output	OpenAI.ItemLocalShellToolCallOutput
shell_call	OpenAI.ItemFunctionShellCallItemParam
shell_call_output	OpenAI.ItemFunctionShellCallOutputItemParam
apply_patch_call	OpenAI.ItemApplyPatchToolCallItemParam
apply_patch_call_output	OpenAI.ItemApplyPatchToolCallOutputItemParam
mcp_list_tools	OpenAI.ItemMcpListTools
mcp_approval_request	OpenAI.ItemMcpApprovalRequest
mcp_approval_response	OpenAI.ItemMcpApprovalResponse
mcp_call	OpenAI.ItemMcpToolCall
custom_tool_call_output	OpenAI.ItemCustomToolCallOutput
custom_tool_call	OpenAI.ItemCustomToolCall

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ItemType		Ja

OpenAI.ItemApplyPatchToolCallItemParam

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	String (nullierbar)		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

OpenAI.ItemApplyPatchToolCallOutputItemParam

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	String (nullierbar)		No
Ausgabe	String (nullierbar)		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

OpenAI.ItemCodeInterpreterToolCall

Ein Toolaufruf zum Ausführen von Code.

Name	Typ	Description	Required	Vorgabe
Programmcode	String (nullierbar)		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		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

OpenAI.ItemCompactionSummaryItemParam

Ein von der v1/responses/compact API generiertes Komprimierungselement.

Name	Typ	Description	Required	Vorgabe
encrypted_content	Schnur	Der verschlüsselte Inhalt der Komprimierungszusammenfassung. Einschränkungen: maxLength: 10485760	Ja
id	String (nullierbar)		No
type	enum	Der Typ des Elements. Immer compaction. Mögliche Werte: compaction	Ja

OpenAI.ItemComputerCallOutputItemParam

Die Ausgabe eines Computertoolaufrufs

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

OpenAI.ItemComputerToolCall

Ein Toolaufruf eines von einem Computer verwendeten Tools Weitere Informationen finden Sie im Handbuch zur Computerverwendung .

Name	Typ	Description	Required	Vorgabe
Aktion	OpenAI.ComputerAction		Ja
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, , completedoder 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

OpenAI.ItemCustomToolCall

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

Name	Typ	Description	Required	Vorgabe
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
type	enum	Der Typ des benutzerdefinierten Toolaufrufs. Immer custom_tool_call. Mögliche Werte: custom_tool_call	Ja

OpenAI.ItemCustomToolCallOutput

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

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

Die Ergebnisse eines Dateisuchtoolaufrufs. Weitere Informationen finden Sie im Dateisuchhandbuch .

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

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	String (nullierbar)		No
Ausgabe	Zeichenfolge oder Array von OpenAI.InputTextContentParam oder OpenAI.InputImageContentParamAutoParam oder OpenAI.InputFileContentParam	Text-, Bild- oder Dateiausgabe des Funktionstoolaufrufs.	Ja
status	OpenAI.FunctionCallItemStatus (nullable)		No
type	enum	Der Typ der Ausgabe des Funktionstoolaufrufs Immer function_call_output. Mögliche Werte: function_call_output	Ja

OpenAI.ItemFunctionShellCallItemParam

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	OpenAI.integer (nullable)		No
└– timeout_ms	OpenAI.integer (nullable)		No
call_id	Schnur	Die eindeutige ID des vom Modell generierten Shelltoolaufrufs. Einschränkungen: minLength: 1, maxLength: 64	Ja
id	String (nullierbar)		No
status	OpenAI.FunctionShellCallItemStatus (nullable)	Für Shelltoolaufrufe gemeldete Statuswerte.	No
type	enum	Der Typ des Elements. Immer shell_call. Mögliche Werte: shell_call	Ja

OpenAI.ItemFunctionShellCallOutputItemParam

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	String (nullierbar)		No
max_output_length	OpenAI.integer (nullable)		No
Ausgabe	Array von OpenAI.FunctionShellCallOutputContentParam	Erfasste Blöcke der Stdout- und Stderr-Ausgabe zusammen mit den zugehörigen Ergebnissen.	Ja
type	enum	Der Typ des Elements. Immer shell_call_output. Mögliche Werte: shell_call_output	Ja

OpenAI.ItemFunctionToolCall

Ein Toolaufruf zum Ausführen einer Funktion. Weitere Informationen finden Sie im Funktionsaufruf-Leitfaden.

Name	Typ	Description	Required	Vorgabe
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	Schnur	Die eindeutige ID des Aufrufs des Funktionswerkzeugs.	No
Name	Schnur	Der Name der auszuführenden Funktion.	Ja
status	enum	Der Status des Elements. Einer von in_progress, , completedoder 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.ItemImageGenToolCall

Eine Vom Modell vorgenommene Anforderung zur Bildgenerierung.

Name	Typ	Description	Required	Vorgabe
id	Schnur	Die eindeutige ID des Aufrufs der Bildgenerierung.	Ja
result	String (nullierbar)		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.ItemLocalShellToolCall

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

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

Die Ausgabe eines Aufrufs eines lokalen Shell-Tools.

Name	Typ	Description	Required	Vorgabe
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	enum	Mögliche Werte: in_progress, , completedincomplete	No
type	enum	Der Typ der Ausgabe des lokalen Shelltools. Immer local_shell_call_output. Mögliche Werte: local_shell_call_output	Ja

OpenAI.ItemMcpApprovalRequest

Eine Anforderung für menschliche Genehmigung eines Toolaufrufs.

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

Eine Antwort auf eine MCP-Genehmigungsanforderung.

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

OpenAI.ItemMcpListTools

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

Name	Typ	Description	Required	Vorgabe
Fehler	String (nullierbar)		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.ItemMcpToolCall

Ein Aufruf eines Tools auf einem MCP-Server.

Name	Typ	Description	Required	Vorgabe
approval_request_id	String (nullierbar)		No
Argumente	Schnur	Eine JSON-Zeichenfolge der Argumente, die an das Tool übergeben werden.	Ja
Fehler	String (nullierbar)		No
id	Schnur	Die eindeutige ID des Toolaufrufs.	Ja
Name	Schnur	Der Name des tools, das ausgeführt wurde.	Ja
Ausgabe	String (nullierbar)		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.ItemOutputMessage

Eine Ausgabemeldung aus dem Modell.

Name	Typ	Description	Required	Vorgabe
Inhalt	Array von OpenAI.OutputMessageContent	Der Inhalt der Ausgabenachricht.	Ja
id	Schnur	Die eindeutige ID der Ausgabenachricht.	Ja
Rolle	enum	Die Rolle der Ausgabemeldung. Immer assistant. Mögliche Werte: assistant	Ja
status	enum	Der Status der Nachrichteneingabe. Einer von in_progress, , completedoder 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.ItemReasoningItem

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

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

OpenAI.ItemReferenceParam

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

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.InputMessageResource
output_message	OpenAI.ItemResourceOutputMessage
file_search_call	OpenAI.ItemResourceFileSearchToolCall
computer_call	OpenAI.ItemResourceComputerToolCall
computer_call_output	OpenAI.ItemResourceComputerToolCallOutputResource
web_search_call	OpenAI.ItemResourceWebSearchToolCall
function_call	OpenAI.ItemResourceFunctionToolCallResource
function_call_output	OpenAI.ItemResourceFunctionToolCallOutputResource
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

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ItemResourceType		Ja

OpenAI.ItemResourceApplyPatchToolCall

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

OpenAI.ItemResourceApplyPatchToolCallOutput

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	String (nullierbar)		No
status	OpenAI.ApplyPatchCallOutputStatus		Ja
type	enum	Der Typ des Elements. Immer apply_patch_call_output. Mögliche Werte: apply_patch_call_output	Ja

OpenAI.ItemResourceCodeInterpreterToolCall

Ein Toolaufruf zum Ausführen von Code.

Name	Typ	Description	Required	Vorgabe
Programmcode	String (nullierbar)		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		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

OpenAI.ItemResourceComputerToolCall

Ein Toolaufruf eines von einem Computer verwendeten Tools Weitere Informationen finden Sie im Handbuch zur Computerverwendung .

Name	Typ	Description	Required	Vorgabe
Aktion	OpenAI.ComputerAction		Ja
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, , completedoder 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

OpenAI.ItemResourceComputerToolCallOutputResource

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	Schnur	Die ID der Ausgabe des Computertoolsaufrufs	No
Ausgabe	OpenAI.ComputerScreenshotImage	Ein Screenshotbild des Computers, das mit dem Computerverwendungstool verwendet wird.	Ja
status	enum	Der Status der Nachrichteneingabe. Einer von in_progress, , completedoder 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

OpenAI.ItemResourceFileSearchToolCall

Die Ergebnisse eines Dateisuchtoolaufrufs. Weitere Informationen finden Sie im Dateisuchhandbuch .

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

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	OpenAI.integer (nullable)		Ja
└– timeout_ms	OpenAI.integer (nullable)		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
id	Schnur	Die eindeutige ID des Shelltoolaufrufs. Aufgefüllt, wenn dieses Element über die API zurückgegeben wird.	Ja
status	OpenAI.LocalShellCallStatus		Ja
type	enum	Der Typ des Elements. Immer shell_call. Mögliche Werte: shell_call	Ja

OpenAI.ItemResourceFunctionShellCallOutput

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	OpenAI.integer (nullable)		Ja
Ausgabe	Array von OpenAI.FunctionShellCallOutputContent	Ein Array von Shellaufrufausgabeinhalten	Ja
type	enum	Der Typ der Shellaufrufausgabe. Immer shell_call_output. Mögliche Werte: shell_call_output	Ja

OpenAI.ItemResourceFunctionToolCallOutputResource

Name	Typ	Description	Required	Vorgabe
call_id	Schnur	Die eindeutige ID des vom Modell generierten Funktionstoolaufrufs.	Ja
id	Schnur	Die eindeutige ID der Ausgabe des Funktionstoolaufrufs Aufgefüllt, wenn dieses Element wird über DIE API zurückgegeben.	No
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, , completedoder 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.ItemResourceFunctionToolCallResource

Name	Typ	Description	Required	Vorgabe
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	Schnur	Die eindeutige ID des Aufrufs des Funktionswerkzeugs.	No
Name	Schnur	Der Name der auszuführenden Funktion.	Ja
status	enum	Der Status des Elements. Einer von in_progress, , completedoder 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.ItemResourceImageGenToolCall

Eine Vom Modell vorgenommene Anforderung zur Bildgenerierung.

Name	Typ	Description	Required	Vorgabe
id	Schnur	Die eindeutige ID des Aufrufs der Bildgenerierung.	Ja
result	String (nullierbar)		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.ItemResourceLocalShellToolCall

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

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

Die Ausgabe eines Aufrufs eines lokalen Shell-Tools.

Name	Typ	Description	Required	Vorgabe
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	enum	Mögliche Werte: in_progress, , completedincomplete	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

Eine Anforderung für menschliche Genehmigung eines Toolaufrufs.

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

Eine Antwort auf eine MCP-Genehmigungsanforderung.

Name	Typ	Description	Required	Vorgabe
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	String (nullierbar)		No
type	enum	Der Typ des Elements. Immer mcp_approval_response. Mögliche Werte: mcp_approval_response	Ja

OpenAI.ItemResourceMcpListTools

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

Name	Typ	Description	Required	Vorgabe
Fehler	String (nullierbar)		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

Ein Aufruf eines Tools auf einem MCP-Server.

Name	Typ	Description	Required	Vorgabe
approval_request_id	String (nullierbar)		No
Argumente	Schnur	Eine JSON-Zeichenfolge der Argumente, die an das Tool übergeben werden.	Ja
Fehler	String (nullierbar)		No
id	Schnur	Die eindeutige ID des Toolaufrufs.	Ja
Name	Schnur	Der Name des tools, das ausgeführt wurde.	Ja
Ausgabe	String (nullierbar)		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

Eine Ausgabemeldung aus dem Modell.

Name	Typ	Description	Required	Vorgabe
Inhalt	Array von OpenAI.OutputMessageContent	Der Inhalt der Ausgabenachricht.	Ja
id	Schnur	Die eindeutige ID der Ausgabenachricht.	Ja
Rolle	enum	Die Rolle der Ausgabemeldung. Immer assistant. Mögliche Werte: assistant	Ja
status	enum	Der Status der Nachrichteneingabe. Einer von in_progress, , completedoder 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.ItemResourceType

Property	Wert
Typ	Schnur
Werte	message output_message file_search_call computer_call computer_call_output web_search_call function_call function_call_output 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 structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.ItemResourceWebSearchToolCall

Die Ergebnisse eines Aufrufs eines Websuchtools. Weitere Informationen finden Sie im Websuchhandbuch .

Name	Typ	Description	Required	Vorgabe
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 zur Verwendung des Modells im Web (Suche, open_page, Suchen).	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.ItemType

Property	Wert
Typ	Schnur
Werte	message output_message file_search_call computer_call computer_call_output web_search_call function_call function_call_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 structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.ItemWebSearchToolCall

Die Ergebnisse eines Aufrufs eines Websuchtools. Weitere Informationen finden Sie im Websuchhandbuch .

Name	Typ	Description	Required	Vorgabe
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 zur Verwendung des Modells im Web (Suche, open_page, Suchen).	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

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

OpenAI.ListFineTuningJobCheckpointsResponse

Name	Typ	Description	Required	Vorgabe
data	Array von OpenAI.FineTuningJobCheckpoint		Ja
first_id	String (nullierbar)		No
has_more	boolean		Ja
last_id	String (nullierbar)		No
Objekt	enum	Mögliche Werte: list	Ja

OpenAI.ListFineTuningJobEventsResponse

Name	Typ	Description	Required	Vorgabe
data	Array von OpenAI.FineTuningJobEvent		Ja
has_more	boolean		Ja
Objekt	enum	Mögliche Werte: list	Ja

OpenAI.ListPaginatedFineTuningJobsResponse

Name	Typ	Description	Required	Vorgabe
data	Array von OpenAI.FineTuningJob		Ja
has_more	boolean		Ja
Objekt	enum	Mögliche Werte: list	Ja

OpenAI.LocalShellCallStatus

Property	Wert
Typ	Schnur
Werte	in_progress completed incomplete

OpenAI.LocalShellExecAction

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	OpenAI.integer (nullable)		No
type	enum	Der Typ der lokalen Shellaktion. Immer exec. Mögliche Werte: exec	Ja
user	String (nullierbar)		No
working_directory	String (nullierbar)		No

OpenAI.LocalShellToolParam

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

OpenAI.LogProb

Die Protokollwahrscheinlichkeit eines Tokens.

Name	Typ	Description	Required	Vorgabe
Byte	Array von OpenAI.integer		Ja
logprob	OpenAI.numeric		Ja
token	Schnur		Ja
top_logprobs	Array von OpenAI.TopLogProb		Ja

OpenAI.MCPListToolsTool

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

Name	Typ	Description	Required	Vorgabe
annotations	OpenAI.MCPListToolsToolAnnotations (nullierbar)		No
description	String (nullierbar)		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Ja
Name	Schnur	Der Name des Tools.	Ja

OpenAI.MCPListToolsToolAnnotations

Typ: Objekt

OpenAI.MCPListToolsToolInputSchema

Typ: Objekt

OpenAI.MCPTool

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

Name	Typ	Description	Required	Vorgabe
erlaubte_Werkzeuge	Array von Zeichenfolge oder OpenAI.MCPToolFilter		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 Connectors hier. 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
headers	Objekt (null)		No
project_connection_id	Schnur	Die Verbindungs-ID im project für den MCP-Server. In der Verbindung werden die Authentifizierung und andere Verbindungsdetails gespeichert, die für die Verbindung mit dem MCP-Server erforderlich sind.	No
Genehmigung erforderlich	Objekt (siehe unten für gültige Modelle)		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	Schnur	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

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
summary_text	OpenAI.SummaryTextContent
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

Name	Typ	Description	Required	Vorgabe
type	OpenAI.MessageContentType		Ja

OpenAI.MessageContentInputFileContent

Eine Dateieingabe für das Modell.

Name	Typ	Description	Required	Vorgabe
file_data	Schnur	Der Inhalt der Datei, die an das Modell gesendet werden soll.	No
Datei-ID	String (nullierbar)		No
file_url	Schnur	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

OpenAI.MessageContentInputImageContent

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

Name	Typ	Description	Required	Vorgabe
detail	OpenAI.ImageDetail		Ja
Datei-ID	String (nullierbar)		No
image_url	Schnur		No
type	enum	Der Typ des Eingabeelements. Immer input_image. Mögliche Werte: input_image	Ja

OpenAI.MessageContentInputTextContent

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

OpenAI.MessageContentOutputTextContent

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		No
Text	Schnur	Die Textausgabe aus dem Modell.	Ja
type	enum	Der Typ des Ausgabetexts. Immer output_text. Mögliche Werte: output_text	Ja

OpenAI.MessageContentReasoningTextContent

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

OpenAI.MessageContentRefusalContent

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

OpenAI.MessageContentType

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

OpenAI.MessageRole

Property	Wert
Typ	Schnur
Werte	unknown user assistant system critic discriminator developer tool

OpenAI.MessageStatus

Property	Wert
Typ	Schnur
Werte	in_progress completed incomplete

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

Modell-ID, die zum Generieren der Antwort verwendet wird, z gpt-5 . B. oder o3. OpenAI bietet eine breite Palette von Modellen mit unterschiedlichen Funktionen, Leistungsmerkmalen und Preispunkten. In der Modellanleitung finden Sie Informationen zum Durchsuchen und Vergleichen der verfügbaren Modelle.

Typ: OpenAI.ModelIdsResponses oder Zeichenfolge

Modell-ID, die zum Generieren der Antwort verwendet wird, z gpt-5 . B. oder o3. OpenAI bietet eine breite Palette von Modellen mit unterschiedlichen Funktionen, Leistungsmerkmalen und Preispunkten. In der Modellanleitung finden Sie Informationen zum Durchsuchen und Vergleichen der verfügbaren Modelle.

OpenAI.ModelIdsResponses

Property	Wert
Typ	Schnur
Werte	o1-pro o1-pro-2025-03-19 o3-pro o3-pro-2025-06-10 o3-deep-research o3-deep-research-2025-06-26 o4-mini-deep-research o4-mini-deep-research-2025-06-26 computer-use-preview computer-use-preview-2025-03-11 gpt-5-codex gpt-5-pro gpt-5-pro-2025-10-06 gpt-5.1-codex-max

OpenAI.ModelIdsShared

Typ: Zeichenfolge oder OpenAI.ChatModel

OpenAI.Move

Aktion zur Änderung der Mauszeigerposition

Name	Typ	Description	Required	Vorgabe
type	enum	Gibt den Ereignistyp an. Bei einer Verschiebungsaktion ist diese Eigenschaft immer auf move festgelegt. Mögliche Werte: move	Ja
x	OpenAI.integer		Ja
y	OpenAI.integer		Ja

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

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		No
Text	Schnur	Die Textausgabe aus dem Modell.	Ja
type	enum	Der Typ des Ausgabetexts. Immer output_text. Mögliche Werte: output_text	Ja

OpenAI.OutputContentReasoningTextContent

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

OpenAI.OutputContentRefusalContent

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

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
structured_outputs	StructuredOutputsOutputItem
workflow_action	WorkflowActionOutputItem
oauth_consent_request	OAuthConsentRequestOutputItem
memory_search_call	MemorySearchToolCallItemResource
output_message	OpenAI.OutputItemOutputMessage
file_search_call	OpenAI.OutputItemFileSearchToolCall
function_call	OpenAI.OutputItemFunctionToolCall
web_search_call	OpenAI.OutputItemWebSearchToolCall
computer_call	OpenAI.OutputItemComputerToolCall
reasoning	OpenAI.OutputItemReasoningItem
compaction	OpenAI.OutputItemCompactionBody
image_generation_call	OpenAI.OutputItemImageGenToolCall
code_interpreter_call	OpenAI.OutputItemCodeInterpreterToolCall
local_shell_call	OpenAI.OutputItemLocalShellToolCall
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
custom_tool_call	OpenAI.OutputItemCustomToolCall

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
type	OpenAI.OutputItemType		Ja

OpenAI.OutputItemApplyPatchToolCall

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

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
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
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
status	OpenAI.ApplyPatchCallStatus		Ja
type	enum	Der Typ des Elements. Immer apply_patch_call. Mögliche Werte: apply_patch_call	Ja

OpenAI.OutputItemApplyPatchToolCallOutput

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

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
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	String (nullierbar)		No
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
status	OpenAI.ApplyPatchCallOutputStatus		Ja
type	enum	Der Typ des Elements. Immer apply_patch_call_output. Mögliche Werte: apply_patch_call_output	Ja

OpenAI.OutputItemCodeInterpreterToolCall

Ein Toolaufruf zum Ausführen von Code.

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
Programmcode	String (nullierbar)		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		Ja
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
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

OpenAI.OutputItemCompactionBody

Ein von der v1/responses/compact API generiertes Komprimierungselement.

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
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
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
type	enum	Der Typ des Elements. Immer compaction. Mögliche Werte: compaction	Ja

OpenAI.OutputItemComputerToolCall

Ein Toolaufruf eines von einem Computer verwendeten Tools Weitere Informationen finden Sie im Handbuch zur Computerverwendung .

Name	Typ	Description	Required	Vorgabe
Aktion	OpenAI.ComputerAction		Ja
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	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
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
status	enum	Der Status des Elements. Einer von in_progress, , completedoder 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

OpenAI.OutputItemCustomToolCall

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

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
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
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
type	enum	Der Typ des benutzerdefinierten Toolaufrufs. Immer custom_tool_call. Mögliche Werte: custom_tool_call	Ja

OpenAI.OutputItemFileSearchToolCall

Die Ergebnisse eines Dateisuchtoolaufrufs. Weitere Informationen finden Sie im Dateisuchhandbuch .

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
id	Schnur	Die eindeutige ID des Aufrufs des Dateisuchtools.	Ja
Abfragen	Array von Strings	Die Zum Suchen nach Dateien verwendeten Abfragen.	Ja
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
results	Array von OpenAI.FileSearchToolCallResults		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

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	OpenAI.integer (nullable)		Ja
└– timeout_ms	OpenAI.integer (nullable)		Ja
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
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
id	Schnur	Die eindeutige ID des Shelltoolaufrufs. Aufgefüllt, wenn dieses Element über die API zurückgegeben wird.	Ja
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
status	OpenAI.LocalShellCallStatus		Ja
type	enum	Der Typ des Elements. Immer shell_call. Mögliche Werte: shell_call	Ja

OpenAI.OutputItemFunctionShellCallOutput

Die Ausgabe eines Shelltoolaufrufs, der ausgegeben wurde.

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
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	OpenAI.integer (nullable)		Ja
Ausgabe	Array von OpenAI.FunctionShellCallOutputContent	Ein Array von Shellaufrufausgabeinhalten	Ja
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
type	enum	Der Typ der Shellaufrufausgabe. Immer shell_call_output. Mögliche Werte: shell_call_output	Ja

OpenAI.OutputItemFunctionToolCall

Ein Toolaufruf zum Ausführen einer Funktion. Weitere Informationen finden Sie im Funktionsaufruf-Leitfaden.

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
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	Schnur	Die eindeutige ID des Aufrufs des Funktionswerkzeugs.	No
Name	Schnur	Der Name der auszuführenden Funktion.	Ja
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
status	enum	Der Status des Elements. Einer von in_progress, , completedoder 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.OutputItemImageGenToolCall

Eine Vom Modell vorgenommene Anforderung zur Bildgenerierung.

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
id	Schnur	Die eindeutige ID des Aufrufs der Bildgenerierung.	Ja
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
result	String (nullierbar)		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

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

Name	Typ	Description	Required	Vorgabe
Aktion	OpenAI.LocalShellExecAction	Führen Sie einen Shellbefehl auf dem Server aus.	Ja
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
call_id	Schnur	Die eindeutige ID des vom Modell generierten aufrufs des lokalen Shelltools.	Ja
id	Schnur	Die eindeutige ID des lokalen Shellaufrufs.	Ja
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
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.OutputItemMcpApprovalRequest

Eine Anforderung für menschliche Genehmigung eines Toolaufrufs.

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
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
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
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.OutputItemMcpListTools

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

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
Fehler	String (nullierbar)		No
id	Schnur	Die eindeutige ID der Liste.	Ja
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
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

Ein Aufruf eines Tools auf einem MCP-Server.

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
approval_request_id	String (nullierbar)		No
Argumente	Schnur	Eine JSON-Zeichenfolge der Argumente, die an das Tool übergeben werden.	Ja
Fehler	String (nullierbar)		No
id	Schnur	Die eindeutige ID des Toolaufrufs.	Ja
Name	Schnur	Der Name des tools, das ausgeführt wurde.	Ja
Ausgabe	String (nullierbar)		No
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	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

Eine Ausgabemeldung aus dem Modell.

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
Inhalt	Array von OpenAI.OutputMessageContent	Der Inhalt der Ausgabenachricht.	Ja
id	Schnur	Die eindeutige ID der Ausgabenachricht.	Ja
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
Rolle	enum	Die Rolle der Ausgabemeldung. Immer assistant. Mögliche Werte: assistant	Ja
status	enum	Der Status der Nachrichteneingabe. Einer von in_progress, , completedoder 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

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

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
Inhalt	Array von OpenAI.ReasoningTextContent	Textinhalt wird mit Gründen versehen.	No
encrypted_content	String (nullierbar)		No
id	Schnur	Der eindeutige Bezeichner des Argumentationsinhalts.	Ja
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
status	enum	Der Status des Elements. Einer von in_progress, , completedoder incomplete. Wird ausgefüllt, wenn Elemente über die API zurückgegeben werden. Mögliche Werte: in_progress, , completedincomplete	No
summary	Array von OpenAI.Summary	Zusammenfassungsinhalt der Gründe.	Ja
type	enum	Der Typ des Objekts. Immer reasoning. Mögliche Werte: reasoning	Ja

OpenAI.OutputItemType

Property	Wert
Typ	Schnur
Werte	output_message file_search_call function_call web_search_call computer_call reasoning compaction image_generation_call code_interpreter_call local_shell_call shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_call mcp_list_tools mcp_approval_request custom_tool_call structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.OutputItemWebSearchToolCall

Die Ergebnisse eines Aufrufs eines Websuchtools. Weitere Informationen finden Sie im Websuchhandbuch .

Name	Typ	Description	Required	Vorgabe
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 zur Verwendung des Modells im Web (Suche, open_page, Suchen).	Ja
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
id	Schnur	Die eindeutige ID des Aufrufs des Websuchtools.	Ja
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
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

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		No
Text	Schnur	Die Textausgabe aus dem Modell.	Ja
type	enum	Der Typ des Ausgabetexts. Immer output_text. Mögliche Werte: output_text	Ja

OpenAI.OutputMessageContentRefusalContent

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

OpenAI.OutputMessageContentType

Property	Wert
Typ	Schnur
Werte	output_text refusal

OpenAI.Prompt

Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen. Erfahren Sie mehr.

Name	Typ	Description	Required	Vorgabe
id	Schnur	Der eindeutige Bezeichner der zu verwendenden Eingabeaufforderungsvorlage.	Ja
variables	OpenAI.ResponsePromptVariables (nullable)	Optionale Zuordnung von Werten zum Ersetzen von Variablen in ihrem Eingabeaufforderung Die Ersetzungswerte können entweder Zeichenfolgen oder andere Antworteingabetypen wie Bilder oder Dateien sein.	No
version	String (nullierbar)		No

OpenAI.RankerVersionType

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

OpenAI.RankingOptions

Name	Typ	Description	Required	Vorgabe
hybrid_search	OpenAI.HybridSearchOptions		No
└– embedding_weight	OpenAI.numeric	Das Gewicht der Einbettung in die gegenseitigen Rangfolgenfusion.	Ja
└– text_weight	OpenAI.numeric	Die Gewichtung des Texts in der gegenseitigen Rangfolgenfusion.	Ja
Bewerter	OpenAI.RankerVersionType		No
score-threshold	OpenAI.numeric		No

OpenAI.Reasoning

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

Name	Typ	Description	Required	Vorgabe
effort	OpenAI.ReasoningEffort	Schränkt den Aufwand für die Begründung ein Begründungsmodelle. Derzeit unterstützte Werte sind none, , minimal, low, medium, highund 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, mediumund 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	enum	Mögliche Werte: auto, , concisedetailed	No
summary	enum	Mögliche Werte: auto, , concisedetailed	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
Typ	Schnur
Nullable	Ja
Werte	none minimal low medium high xhigh

OpenAI.ReasoningTextContent

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

OpenAI.Response

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference (nullierbar)		Ja
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
Hintergrund	boolescher Wert (nullable)		No
abgeschlossen_am	integer		No
Gespräch	OpenAI.ConversationReference (nullierbar)	Die Unterhaltung, zu der diese Antwort gehörte. Eingabeelemente und Ausgabeelemente aus dieser Antwort wurden dieser Unterhaltung automatisch hinzugefügt.	No
└– ID	Schnur	Die eindeutige ID der Unterhaltung, der diese Antwort zugeordnet war.	Ja
erstellt_am	integer	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
Fehler	OpenAI.ResponseError (nullable)	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	Ja
└– Code	OpenAI.ResponseErrorCode	Der Fehlercode für die Antwort.	Ja
└– Nachricht	Schnur	Eine lesbare Beschreibung des Fehlers.	Ja
id	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
incomplete_details	OpenAI.ResponseIncompleteDetails (nullable)		Ja
└– Grund	enum	Mögliche Werte: max_output_tokens, content_filter	No
instructions	Zeichenfolge oder Array von OpenAI.InputItem		Ja
max_output_tokens	OpenAI.integer (nullable)		No
max_tool_calls	OpenAI.integer (nullable)		No
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
model	Schnur	Das Modell, das für die Erstellung dieser Antwort eingesetzt werden soll.	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	String (nullierbar)		No
Parallele Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
previous_response_id	String (nullierbar)		No
Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen. Erfahren Sie mehr.	No
prompt_cache_key	Schnur	Wird von OpenAI verwendet, um Antworten für ähnliche Anforderungen zwischenzuspeichern, um ihre Cachetreffraten zu optimieren. Ersetzt das user Feld. Erfahren Sie mehr.	No
prompt_cache_retention	enum	Mögliche Werte: in-memory, 24h	No
reasoning	OpenAI.Reasoning (nullierbar)	nur gpt-5- und o-Series-Modelle Konfigurationsoptionen für Begründungsmodelle.	No
└– Aufwand	OpenAI.ReasoningEffort	Schränkt den Aufwand für die Begründung ein Begründungsmodelle. Derzeit unterstützte Werte sind none, , minimal, low, medium, highund 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, mediumund 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	enum	Mögliche Werte: auto, , concisedetailed	No
└– Zusammenfassung	enum	Mögliche Werte: auto, , concisedetailed	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 Zeichenfolge sein, die jeden Benutzer eindeutig identifiziert. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Erfahren Sie mehr.	No
Dienststufe	OpenAI.ServiceTier	Gibt den Verarbeitungstyp an, der für die Bereitstellung der Anforderung verwendet wird. – Bei Festlegung auf "Auto" wird die Anforderung mit der in den Project Einstellungen konfigurierten Dienstebene verarbeitet. Sofern nicht anders konfiguriert, verwendet die Project "default". - Bei Festlegung auf "Standard" wird die Anforderung mit den Standardpreisen und der Leistung für das ausgewählte Modell verarbeitet. - Wenn sie auf "Flex" oder "Priorität" festgelegt ist, wird die Anforderung mit der entsprechenden Dienstebene verarbeitet. - Wenn sie nicht festgelegt ist, lautet das Standardverhalten "auto". Wenn der service_tier Parameter festgelegt ist, enthält der Antworttext den service_tier Wert basierend auf dem Verarbeitungsmodus, der tatsächlich für die Anforderung verwendet wird. Dieser Antwortwert kann sich von dem wert unterscheiden, der im Parameter festgelegt wurde.	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	OpenAI.numeric (nullierbar)		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
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 Funktionen des Modells, z. B. die Websuche oder Dateisuche. Weitere Informationen zu integrierte Tools. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Tools. - 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 Funktionsaufrufe. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
top_logprobs	OpenAI.integer (nullable)		No
top_p	OpenAI.numeric (nullierbar)		No	1
truncation	enum	Mögliche Werte: auto, disabled	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. Erfahren Sie mehr.	No

OpenAI.ResponseAudioDeltaEvent

Wird ausgegeben, wenn eine partielle Audioantwort vorhanden ist.

Name	Typ	Description	Required	Vorgabe
delta	Schnur	Ein Block der Base64-codierten Antwortaudiobytes	Ja
sequence_number	OpenAI.integer		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	OpenAI.integer		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	Vorgabe
delta	Schnur	Die partielle Transkription der Audioantwort.	Ja
sequence_number	OpenAI.integer		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	OpenAI.integer		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	Vorgabe
delta	Schnur	Der partielle Codeausschnitt, der vom Codedolmetscher gestreamt wird.	Ja
item_id	Schnur	Der eindeutige Bezeichner des Codedolmetscher-Toolaufrufelements.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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	Vorgabe
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	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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	Vorgabe
item_id	Schnur	Der eindeutige Bezeichner des Codedolmetscher-Toolaufrufelements.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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	Vorgabe
item_id	Schnur	Der eindeutige Bezeichner des Codedolmetscher-Toolaufrufelements.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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	Vorgabe
item_id	Schnur	Der eindeutige Bezeichner des Codedolmetscher-Toolaufrufelements.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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
└– agent_reference	AgentReference (nullierbar)	Der für diese Antwort verwendete Agent	Ja
└– Hintergrund	boolescher Wert (nullable)		No
└– completed_at	ganze Zahl (nullable)		No
└– Unterhaltung	OpenAI.ConversationReference (nullierbar)	Die Unterhaltung, zu der diese Antwort gehörte. Eingabeelemente und Ausgabeelemente aus dieser Antwort wurden dieser Unterhaltung automatisch hinzugefügt.	No
└– created_at	integer	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
└– Fehler	OpenAI.ResponseError (nullable)	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	Ja
└– ID	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
└─ unvollständige_Details	OpenAI.ResponseIncompleteDetails (nullable)		Ja
└– Anweisungen	Zeichenfolge oder Array von OpenAI.InputItem (nullable)		Ja
└– max_output_tokens	OpenAI.integer (nullable)		No
└– max_tool_calls	OpenAI.integer (nullable)		No
└- Metadaten	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
└─ Modell	Schnur	Das Modell, das für die Erstellung dieser Antwort eingesetzt werden soll.	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	String (nullierbar)		No
└─ parallele_Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
└– vorherige_Antwort_ID	String (nullierbar)		No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen. Erfahren Sie mehr.	No
└– prompt_cache_key	Schnur	Wird von OpenAI verwendet, um Antworten für ähnliche Anforderungen zwischenzuspeichern, um ihre Cachetreffraten zu optimieren. Ersetzt das user Feld. Erfahren Sie mehr.	No
└– prompt_cache_retention	enum	Mögliche Werte: in-memory, 24h	No
└– Begründung	OpenAI.Reasoning (nullierbar)	nur gpt-5- und o-Series-Modelle Konfigurationsoptionen für Begründungsmodelle.	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 Zeichenfolge sein, die jeden Benutzer eindeutig identifiziert. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Erfahren Sie mehr.	No
└- service_tier	OpenAI.ServiceTier	Gibt den Verarbeitungstyp an, der für die Bereitstellung der Anforderung verwendet wird. – Bei Festlegung auf "Auto" wird die Anforderung mit der in den Project Einstellungen konfigurierten Dienstebene verarbeitet. Sofern nicht anders konfiguriert, verwendet die Project "default". - Bei Festlegung auf "Standard" wird die Anforderung mit den Standardpreisen und der Leistung für das ausgewählte Modell verarbeitet. - Wenn sie auf "Flex" oder "Priorität" festgelegt ist, wird die Anforderung mit der entsprechenden Dienstebene verarbeitet. - Wenn sie nicht festgelegt ist, lautet das Standardverhalten "auto". Wenn der service_tier Parameter festgelegt ist, enthält der Antworttext den service_tier Wert basierend auf dem Verarbeitungsmodus, der tatsächlich für die Anforderung verwendet wird. Dieser Antwortwert kann sich von dem wert unterscheiden, der im Parameter festgelegt wurde.	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	OpenAI.numeric (nullierbar)		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 Funktionen des Modells, z. B. die Websuche oder Dateisuche. Weitere Informationen zu integrierte Tools. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Tools. - 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 Funktionsaufrufe. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
└– top_logprobs	OpenAI.integer (nullable)		No
└– top_p	OpenAI.numeric (nullierbar)		No	1
└– Abschneiden	enum	Mögliche Werte: auto, disabled	No
└– 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. Erfahren Sie mehr.	No
sequence_number	OpenAI.integer		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	Vorgabe
content_index	OpenAI.integer		Ja
item_id	Schnur	Die ID des Ausgabeelements, dem der Inhaltsteil hinzugefügt wurde.	Ja
output_index	OpenAI.integer		Ja
part	OpenAI.OutputContent		Ja
└– Typ	OpenAI.OutputContentType		Ja
sequence_number	OpenAI.integer		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	Vorgabe
content_index	OpenAI.integer		Ja
item_id	Schnur	Die ID des Ausgabeelements, dem der Inhaltsteil hinzugefügt wurde.	Ja
output_index	OpenAI.integer		Ja
part	OpenAI.OutputContent		Ja
└– Typ	OpenAI.OutputContentType		Ja
sequence_number	OpenAI.integer		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
└– agent_reference	AgentReference (nullierbar)	Der für diese Antwort verwendete Agent	Ja
└– Hintergrund	boolescher Wert (nullable)		No
└– completed_at	ganze Zahl (nullable)		No
└– Unterhaltung	OpenAI.ConversationReference (nullierbar)	Die Unterhaltung, zu der diese Antwort gehörte. Eingabeelemente und Ausgabeelemente aus dieser Antwort wurden dieser Unterhaltung automatisch hinzugefügt.	No
└– created_at	integer	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
└– Fehler	OpenAI.ResponseError (nullable)	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	Ja
└– ID	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
└─ unvollständige_Details	OpenAI.ResponseIncompleteDetails (nullable)		Ja
└– Anweisungen	Zeichenfolge oder Array von OpenAI.InputItem (nullable)		Ja
└– max_output_tokens	OpenAI.integer (nullable)		No
└– max_tool_calls	OpenAI.integer (nullable)		No
└- Metadaten	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
└─ Modell	Schnur	Das Modell, das für die Erstellung dieser Antwort eingesetzt werden soll.	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	String (nullierbar)		No
└─ parallele_Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
└– vorherige_Antwort_ID	String (nullierbar)		No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen. Erfahren Sie mehr.	No
└– prompt_cache_key	Schnur	Wird von OpenAI verwendet, um Antworten für ähnliche Anforderungen zwischenzuspeichern, um ihre Cachetreffraten zu optimieren. Ersetzt das user Feld. Erfahren Sie mehr.	No
└– prompt_cache_retention	enum	Mögliche Werte: in-memory, 24h	No
└– Begründung	OpenAI.Reasoning (nullierbar)	nur gpt-5- und o-Series-Modelle Konfigurationsoptionen für Begründungsmodelle.	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 Zeichenfolge sein, die jeden Benutzer eindeutig identifiziert. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Erfahren Sie mehr.	No
└- service_tier	OpenAI.ServiceTier	Gibt den Verarbeitungstyp an, der für die Bereitstellung der Anforderung verwendet wird. – Bei Festlegung auf "Auto" wird die Anforderung mit der in den Project Einstellungen konfigurierten Dienstebene verarbeitet. Sofern nicht anders konfiguriert, verwendet die Project "default". - Bei Festlegung auf "Standard" wird die Anforderung mit den Standardpreisen und der Leistung für das ausgewählte Modell verarbeitet. - Wenn sie auf "Flex" oder "Priorität" festgelegt ist, wird die Anforderung mit der entsprechenden Dienstebene verarbeitet. - Wenn sie nicht festgelegt ist, lautet das Standardverhalten "auto". Wenn der service_tier Parameter festgelegt ist, enthält der Antworttext den service_tier Wert basierend auf dem Verarbeitungsmodus, der tatsächlich für die Anforderung verwendet wird. Dieser Antwortwert kann sich von dem wert unterscheiden, der im Parameter festgelegt wurde.	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	OpenAI.numeric (nullierbar)		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 Funktionen des Modells, z. B. die Websuche oder Dateisuche. Weitere Informationen zu integrierte Tools. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Tools. - 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 Funktionsaufrufe. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
└– top_logprobs	OpenAI.integer (nullable)		No
└– top_p	OpenAI.numeric (nullierbar)		No	1
└– Abschneiden	enum	Mögliche Werte: auto, disabled	No
└– 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. Erfahren Sie mehr.	No
sequence_number	OpenAI.integer		Ja
type	enum	Typ des Ereignisses Immer response.created. Mögliche Werte: response.created	Ja

OpenAI.ResponseCustomToolCallInputDeltaEvent

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

Name	Typ	Description	Required	Vorgabe
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	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Der Ereignistypbezeichner. Mögliche Werte: response.custom_tool_call_input.delta	Ja

OpenAI.ResponseCustomToolCallInputDoneEvent

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

Name	Typ	Description	Required	Vorgabe
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	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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	Vorgabe
Programmcode	String (nullierbar)		Ja
message	Schnur	Die Fehlermeldung.	Ja
param	String (nullierbar)		Ja
sequence_number	OpenAI.integer		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
└– agent_reference	AgentReference (nullierbar)	Der für diese Antwort verwendete Agent	Ja
└– Hintergrund	boolescher Wert (nullable)		No
└– completed_at	ganze Zahl (nullable)		No
└– Unterhaltung	OpenAI.ConversationReference (nullierbar)	Die Unterhaltung, zu der diese Antwort gehörte. Eingabeelemente und Ausgabeelemente aus dieser Antwort wurden dieser Unterhaltung automatisch hinzugefügt.	No
└– created_at	integer	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
└– Fehler	OpenAI.ResponseError (nullable)	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	Ja
└– ID	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
└─ unvollständige_Details	OpenAI.ResponseIncompleteDetails (nullable)		Ja
└– Anweisungen	Zeichenfolge oder Array von OpenAI.InputItem (nullable)		Ja
└– max_output_tokens	OpenAI.integer (nullable)		No
└– max_tool_calls	OpenAI.integer (nullable)		No
└- Metadaten	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
└─ Modell	Schnur	Das Modell, das für die Erstellung dieser Antwort eingesetzt werden soll.	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	String (nullierbar)		No
└─ parallele_Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
└– vorherige_Antwort_ID	String (nullierbar)		No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen. Erfahren Sie mehr.	No
└– prompt_cache_key	Schnur	Wird von OpenAI verwendet, um Antworten für ähnliche Anforderungen zwischenzuspeichern, um ihre Cachetreffraten zu optimieren. Ersetzt das user Feld. Erfahren Sie mehr.	No
└– prompt_cache_retention	enum	Mögliche Werte: in-memory, 24h	No
└– Begründung	OpenAI.Reasoning (nullierbar)	nur gpt-5- und o-Series-Modelle Konfigurationsoptionen für Begründungsmodelle.	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 Zeichenfolge sein, die jeden Benutzer eindeutig identifiziert. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Erfahren Sie mehr.	No
└- service_tier	OpenAI.ServiceTier	Gibt den Verarbeitungstyp an, der für die Bereitstellung der Anforderung verwendet wird. – Bei Festlegung auf "Auto" wird die Anforderung mit der in den Project Einstellungen konfigurierten Dienstebene verarbeitet. Sofern nicht anders konfiguriert, verwendet die Project "default". - Bei Festlegung auf "Standard" wird die Anforderung mit den Standardpreisen und der Leistung für das ausgewählte Modell verarbeitet. - Wenn sie auf "Flex" oder "Priorität" festgelegt ist, wird die Anforderung mit der entsprechenden Dienstebene verarbeitet. - Wenn sie nicht festgelegt ist, lautet das Standardverhalten "auto". Wenn der service_tier Parameter festgelegt ist, enthält der Antworttext den service_tier Wert basierend auf dem Verarbeitungsmodus, der tatsächlich für die Anforderung verwendet wird. Dieser Antwortwert kann sich von dem wert unterscheiden, der im Parameter festgelegt wurde.	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	OpenAI.numeric (nullierbar)		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 Funktionen des Modells, z. B. die Websuche oder Dateisuche. Weitere Informationen zu integrierte Tools. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Tools. - 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 Funktionsaufrufe. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
└– top_logprobs	OpenAI.integer (nullable)		No
└– top_p	OpenAI.numeric (nullierbar)		No	1
└– Abschneiden	enum	Mögliche Werte: auto, disabled	No
└– 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. Erfahren Sie mehr.	No
sequence_number	OpenAI.integer		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	Vorgabe
item_id	Schnur	Die ID des Ausgabeelements, mit der der Dateisuchaufruf initiiert wird.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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	Vorgabe
item_id	Schnur	Die ID des Ausgabeelements, mit der der Dateisuchaufruf initiiert wird.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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	Vorgabe
item_id	Schnur	Die ID des Ausgabeelements, mit der der Dateisuchaufruf initiiert wird.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typ des Ereignisses Immer response.file_search_call.searching. Mögliche Werte: response.file_search_call.searching	Ja

OpenAI.ResponseFormatJsonObject

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

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

OpenAI.ResponseFormatJsonSchema

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

Name	Typ	Description	Required	Vorgabe
JSON-Schema	OpenAI.ResponseFormatJsonSchemaJsonSchema		Ja
└– Beschreibung	Schnur		No
└– Name	Schnur		Ja
└- Schema	OpenAI.ResponseFormatJsonSchemaSchema	Das Schema für das Antwortformat, das als JSON-Schemaobjekt beschrieben wird. Hier erfahren Sie, wie Sie JSON-Schemas erstellen.	No
└– streng	boolescher Wert (nullable)		No
type	enum	Der Typ des zu definierenden Antwortformats. Immer json_schema. Mögliche Werte: json_schema	Ja

OpenAI.ResponseFormatJsonSchemaJsonSchema

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

OpenAI.ResponseFormatJsonSchemaSchema

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

Typ: Objekt

OpenAI.ResponseFormatText

Standardantwortformat. Wird verwendet, um Textantworten zu generieren.

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

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

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

Name	Typ	Description	Required	Vorgabe
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	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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	Vorgabe
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	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Mögliche Werte: response.function_call_arguments.done	Ja

OpenAI.ResponseImageGenCallCompletedEvent

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

Name	Typ	Description	Required	Vorgabe
item_id	Schnur	Der eindeutige Bezeichner des verarbeiteten Bildgenerierungselements.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typ des Ereignisses Immer „response.image_generation_call.completed”. Mögliche Werte: response.image_generation_call.completed	Ja

OpenAI.ResponseImageGenCallGeneratingEvent

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

Name	Typ	Description	Required	Vorgabe
item_id	Schnur	Der eindeutige Bezeichner des verarbeiteten Bildgenerierungselements.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typ des Ereignisses Immer „response.image_generation_call.generating. Mögliche Werte: response.image_generation_call.generating	Ja

OpenAI.ResponseImageGenCallInProgressEvent

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

Name	Typ	Description	Required	Vorgabe
item_id	Schnur	Der eindeutige Bezeichner des verarbeiteten Bildgenerierungselements.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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

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

Name	Typ	Description	Required	Vorgabe
item_id	Schnur	Der eindeutige Bezeichner des verarbeiteten Bildgenerierungselements.	Ja
output_index	OpenAI.integer		Ja
partial_image_b64	Schnur	Base64-codierte Teilbilddaten, die für das Rendern als Bild geeignet sind.	Ja
partial_image_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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
└– agent_reference	AgentReference (nullierbar)	Der für diese Antwort verwendete Agent	Ja
└– Hintergrund	boolescher Wert (nullable)		No
└– completed_at	ganze Zahl (nullable)		No
└– Unterhaltung	OpenAI.ConversationReference (nullierbar)	Die Unterhaltung, zu der diese Antwort gehörte. Eingabeelemente und Ausgabeelemente aus dieser Antwort wurden dieser Unterhaltung automatisch hinzugefügt.	No
└– created_at	integer	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
└– Fehler	OpenAI.ResponseError (nullable)	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	Ja
└– ID	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
└─ unvollständige_Details	OpenAI.ResponseIncompleteDetails (nullable)		Ja
└– Anweisungen	Zeichenfolge oder Array von OpenAI.InputItem (nullable)		Ja
└– max_output_tokens	OpenAI.integer (nullable)		No
└– max_tool_calls	OpenAI.integer (nullable)		No
└- Metadaten	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
└─ Modell	Schnur	Das Modell, das für die Erstellung dieser Antwort eingesetzt werden soll.	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	String (nullierbar)		No
└─ parallele_Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
└– vorherige_Antwort_ID	String (nullierbar)		No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen. Erfahren Sie mehr.	No
└– prompt_cache_key	Schnur	Wird von OpenAI verwendet, um Antworten für ähnliche Anforderungen zwischenzuspeichern, um ihre Cachetreffraten zu optimieren. Ersetzt das user Feld. Erfahren Sie mehr.	No
└– prompt_cache_retention	enum	Mögliche Werte: in-memory, 24h	No
└– Begründung	OpenAI.Reasoning (nullierbar)	nur gpt-5- und o-Series-Modelle Konfigurationsoptionen für Begründungsmodelle.	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 Zeichenfolge sein, die jeden Benutzer eindeutig identifiziert. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Erfahren Sie mehr.	No
└- service_tier	OpenAI.ServiceTier	Gibt den Verarbeitungstyp an, der für die Bereitstellung der Anforderung verwendet wird. – Bei Festlegung auf "Auto" wird die Anforderung mit der in den Project Einstellungen konfigurierten Dienstebene verarbeitet. Sofern nicht anders konfiguriert, verwendet die Project "default". - Bei Festlegung auf "Standard" wird die Anforderung mit den Standardpreisen und der Leistung für das ausgewählte Modell verarbeitet. - Wenn sie auf "Flex" oder "Priorität" festgelegt ist, wird die Anforderung mit der entsprechenden Dienstebene verarbeitet. - Wenn sie nicht festgelegt ist, lautet das Standardverhalten "auto". Wenn der service_tier Parameter festgelegt ist, enthält der Antworttext den service_tier Wert basierend auf dem Verarbeitungsmodus, der tatsächlich für die Anforderung verwendet wird. Dieser Antwortwert kann sich von dem wert unterscheiden, der im Parameter festgelegt wurde.	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	OpenAI.numeric (nullierbar)		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 Funktionen des Modells, z. B. die Websuche oder Dateisuche. Weitere Informationen zu integrierte Tools. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Tools. - 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 Funktionsaufrufe. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
└– top_logprobs	OpenAI.integer (nullable)		No
└– top_p	OpenAI.numeric (nullierbar)		No	1
└– Abschneiden	enum	Mögliche Werte: auto, disabled	No
└– 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. Erfahren Sie mehr.	No
sequence_number	OpenAI.integer		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
└– agent_reference	AgentReference (nullierbar)	Der für diese Antwort verwendete Agent	Ja
└– Hintergrund	boolescher Wert (nullable)		No
└– completed_at	ganze Zahl (nullable)		No
└– Unterhaltung	OpenAI.ConversationReference (nullierbar)	Die Unterhaltung, zu der diese Antwort gehörte. Eingabeelemente und Ausgabeelemente aus dieser Antwort wurden dieser Unterhaltung automatisch hinzugefügt.	No
└– created_at	integer	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
└– Fehler	OpenAI.ResponseError (nullable)	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	Ja
└– ID	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
└─ unvollständige_Details	OpenAI.ResponseIncompleteDetails (nullable)		Ja
└– Anweisungen	Zeichenfolge oder Array von OpenAI.InputItem (nullable)		Ja
└– max_output_tokens	OpenAI.integer (nullable)		No
└– max_tool_calls	OpenAI.integer (nullable)		No
└- Metadaten	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
└─ Modell	Schnur	Das Modell, das für die Erstellung dieser Antwort eingesetzt werden soll.	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	String (nullierbar)		No
└─ parallele_Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
└– vorherige_Antwort_ID	String (nullierbar)		No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen. Erfahren Sie mehr.	No
└– prompt_cache_key	Schnur	Wird von OpenAI verwendet, um Antworten für ähnliche Anforderungen zwischenzuspeichern, um ihre Cachetreffraten zu optimieren. Ersetzt das user Feld. Erfahren Sie mehr.	No
└– prompt_cache_retention	enum	Mögliche Werte: in-memory, 24h	No
└– Begründung	OpenAI.Reasoning (nullierbar)	nur gpt-5- und o-Series-Modelle Konfigurationsoptionen für Begründungsmodelle.	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 Zeichenfolge sein, die jeden Benutzer eindeutig identifiziert. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Erfahren Sie mehr.	No
└- service_tier	OpenAI.ServiceTier	Gibt den Verarbeitungstyp an, der für die Bereitstellung der Anforderung verwendet wird. – Bei Festlegung auf "Auto" wird die Anforderung mit der in den Project Einstellungen konfigurierten Dienstebene verarbeitet. Sofern nicht anders konfiguriert, verwendet die Project "default". - Bei Festlegung auf "Standard" wird die Anforderung mit den Standardpreisen und der Leistung für das ausgewählte Modell verarbeitet. - Wenn sie auf "Flex" oder "Priorität" festgelegt ist, wird die Anforderung mit der entsprechenden Dienstebene verarbeitet. - Wenn sie nicht festgelegt ist, lautet das Standardverhalten "auto". Wenn der service_tier Parameter festgelegt ist, enthält der Antworttext den service_tier Wert basierend auf dem Verarbeitungsmodus, der tatsächlich für die Anforderung verwendet wird. Dieser Antwortwert kann sich von dem wert unterscheiden, der im Parameter festgelegt wurde.	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	OpenAI.numeric (nullierbar)		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 Funktionen des Modells, z. B. die Websuche oder Dateisuche. Weitere Informationen zu integrierte Tools. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Tools. - 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 Funktionsaufrufe. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
└– top_logprobs	OpenAI.integer (nullable)		No
└– top_p	OpenAI.numeric (nullierbar)		No	1
└– Abschneiden	enum	Mögliche Werte: auto, disabled	No
└– 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. Erfahren Sie mehr.	No
sequence_number	OpenAI.integer		Ja
type	enum	Typ des Ereignisses Immer response.incomplete. Mögliche Werte: response.incomplete	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	Vorgabe
logprob	OpenAI.numeric		Ja
token	Schnur	Ein mögliches Texttoken.	Ja
top_logprobs	Array von OpenAI.ResponseLogProbTopLogprobs	Die Protokollwahrscheinlichkeit der top 20 höchstwahrscheinlichen Token.	No

OpenAI.ResponseLogProbTopLogprobs

Name	Typ	Description	Required	Vorgabe
logprob	OpenAI.numeric		No
token	Schnur		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

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

Name	Typ	Description	Required	Vorgabe
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	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typ des Ereignisses Immer "response.mcp_call_arguments.delta". Mögliche Werte: response.mcp_call_arguments.delta	Ja

OpenAI.ResponseMCPCallArgumentsDoneEvent

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

Name	Typ	Description	Required	Vorgabe
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	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typ des Ereignisses Immer "response.mcp_call_arguments.done". Mögliche Werte: response.mcp_call_arguments.done	Ja

OpenAI.ResponseMCPCallCompletedEvent

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

Name	Typ	Description	Required	Vorgabe
item_id	Schnur	Die ID des MCP-Toolaufrufelements, das abgeschlossen wurde.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typ des Ereignisses Immer „response.mcp_call.completed“. Mögliche Werte: response.mcp_call.completed	Ja

OpenAI.ResponseMCPCallFailedEvent

Wird ausgegeben, wenn ein MCP-Toolaufruf fehlgeschlagen ist.

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

OpenAI.ResponseMCPCallInProgressEvent

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

Name	Typ	Description	Required	Vorgabe
item_id	Schnur	Der eindeutige Bezeichner des verarbeiteten MCP-Toolaufrufelements.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typ des Ereignisses Immer „response.mcp_call.in_progress”. Mögliche Werte: response.mcp_call.in_progress	Ja

OpenAI.ResponseMCPListToolsCompletedEvent

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

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

OpenAI.ResponseMCPListToolsFailedEvent

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

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

OpenAI.ResponseMCPListToolsInProgressEvent

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

Name	Typ	Description	Required	Vorgabe
item_id	Schnur	Die ID des MCP-Toolaufrufelements, das verarbeitet wird.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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	Vorgabe
item	OpenAI.OutputItem		Ja
└– agent_reference	AgentReference	Der Agent, der das Element erstellt hat.	No
└– response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
└– Typ	OpenAI.OutputItemType		Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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	Vorgabe
item	OpenAI.OutputItem		Ja
└– agent_reference	AgentReference	Der Agent, der das Element erstellt hat.	No
└– response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
└– Typ	OpenAI.OutputItemType		Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typ des Ereignisses Immer response.output_item.done. Mögliche Werte: response.output_item.done	Ja

OpenAI.ResponseOutputTextAnnotationAddedEvent

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

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

OpenAI.ResponsePromptVariables

Optionale Zuordnung von Werten, die durch Variablen in Ihrer Eingabeaufforderung ersetzt werden sollen. Die Ersetzungswerte können entweder Zeichenfolgen oder andere Antworteingabetypen wie Bilder oder Dateien sein.

Typ: Objekt

OpenAI.ResponseQueuedEvent

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

Name	Typ	Description	Required	Vorgabe
response	OpenAI.Response		Ja
└– agent_reference	AgentReference (nullierbar)	Der für diese Antwort verwendete Agent	Ja
└– Hintergrund	boolescher Wert (nullable)		No
└– completed_at	ganze Zahl (nullable)		No
└– Unterhaltung	OpenAI.ConversationReference (nullierbar)	Die Unterhaltung, zu der diese Antwort gehörte. Eingabeelemente und Ausgabeelemente aus dieser Antwort wurden dieser Unterhaltung automatisch hinzugefügt.	No
└– created_at	integer	Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.	Ja
└– Fehler	OpenAI.ResponseError (nullable)	Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.	Ja
└– ID	Schnur	Eindeutiger Bezeichner für diese Antwort	Ja
└─ unvollständige_Details	OpenAI.ResponseIncompleteDetails (nullable)		Ja
└– Anweisungen	Zeichenfolge oder Array von OpenAI.InputItem (nullable)		Ja
└– max_output_tokens	OpenAI.integer (nullable)		No
└– max_tool_calls	OpenAI.integer (nullable)		No
└- Metadaten	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
└─ Modell	Schnur	Das Modell, das für die Erstellung dieser Antwort eingesetzt werden soll.	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	String (nullierbar)		No
└─ parallele_Werkzeugaufrufe	boolean	Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.	Ja	Richtig
└– vorherige_Antwort_ID	String (nullierbar)		No
└– Eingabeaufforderung	OpenAI.Prompt	Verweisen Sie auf eine Eingabeaufforderungsvorlage und deren Variablen. Erfahren Sie mehr.	No
└– prompt_cache_key	Schnur	Wird von OpenAI verwendet, um Antworten für ähnliche Anforderungen zwischenzuspeichern, um ihre Cachetreffraten zu optimieren. Ersetzt das user Feld. Erfahren Sie mehr.	No
└– prompt_cache_retention	enum	Mögliche Werte: in-memory, 24h	No
└– Begründung	OpenAI.Reasoning (nullierbar)	nur gpt-5- und o-Series-Modelle Konfigurationsoptionen für Begründungsmodelle.	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 Zeichenfolge sein, die jeden Benutzer eindeutig identifiziert. Wir empfehlen, den Benutzernamen oder die E-Mail-Adresse zu hashen, um zu vermeiden, dass wir identifizierende Informationen senden. Erfahren Sie mehr.	No
└- service_tier	OpenAI.ServiceTier	Gibt den Verarbeitungstyp an, der für die Bereitstellung der Anforderung verwendet wird. – Bei Festlegung auf "Auto" wird die Anforderung mit der in den Project Einstellungen konfigurierten Dienstebene verarbeitet. Sofern nicht anders konfiguriert, verwendet die Project "default". - Bei Festlegung auf "Standard" wird die Anforderung mit den Standardpreisen und der Leistung für das ausgewählte Modell verarbeitet. - Wenn sie auf "Flex" oder "Priorität" festgelegt ist, wird die Anforderung mit der entsprechenden Dienstebene verarbeitet. - Wenn sie nicht festgelegt ist, lautet das Standardverhalten "auto". Wenn der service_tier Parameter festgelegt ist, enthält der Antworttext den service_tier Wert basierend auf dem Verarbeitungsmodus, der tatsächlich für die Anforderung verwendet wird. Dieser Antwortwert kann sich von dem wert unterscheiden, der im Parameter festgelegt wurde.	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	OpenAI.numeric (nullierbar)		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 Funktionen des Modells, z. B. die Websuche oder Dateisuche. Weitere Informationen zu integrierte Tools. - MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu MCP-Tools. - 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 Funktionsaufrufe. Sie können auch verwenden Benutzerdefinierte Tools zum Aufrufen ihres eigenen Codes.	No
└– top_logprobs	OpenAI.integer (nullable)		No
└– top_p	OpenAI.numeric (nullierbar)		No	1
└– Abschneiden	enum	Mögliche Werte: auto, disabled	No
└– 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. Erfahren Sie mehr.	No
sequence_number	OpenAI.integer		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	Vorgabe
item_id	Schnur	Die ID des Elements, dem dieser Zusammenfassungsteil zugeordnet ist.	Ja
output_index	OpenAI.integer		Ja
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Ja
└– Text	Schnur		Ja
└– Typ	enum	Mögliche Werte: summary_text	Ja
sequence_number	OpenAI.integer		Ja
summary_index	OpenAI.integer		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	Vorgabe
item_id	Schnur	Die ID des Elements, dem dieser Zusammenfassungsteil zugeordnet ist.	Ja
output_index	OpenAI.integer		Ja
part	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Ja
└– Text	Schnur		Ja
└– Typ	enum	Mögliche Werte: summary_text	Ja
sequence_number	OpenAI.integer		Ja
summary_index	OpenAI.integer		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	Vorgabe
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	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
summary_index	OpenAI.integer		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	Vorgabe
item_id	Schnur	Die ID des Elements, dem dieser Zusammenfassungstext zugeordnet ist.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
summary_index	OpenAI.integer		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	Vorgabe
content_index	OpenAI.integer		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	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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	Vorgabe
content_index	OpenAI.integer		Ja
item_id	Schnur	Die ID des Elements, dem dieser Grundtext zugeordnet ist.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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	Vorgabe
content_index	OpenAI.integer		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	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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	Vorgabe
content_index	OpenAI.integer		Ja
item_id	Schnur	Die ID des Ausgabeelements, bei dem der Ablehnungstext finalisiert wurde.	Ja
output_index	OpenAI.integer		Ja
Weigerung	Schnur	Der endgültige Ablehnungstext.	Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typ des Ereignisses Immer response.refusal.done. Mögliche Werte: response.refusal.done	Ja

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	Vorgabe
content_index	OpenAI.integer		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	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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	Vorgabe
content_index	OpenAI.integer		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	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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, mediumund high.	No

OpenAI.ResponseUsage

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

Name	Typ	Description	Required	Vorgabe
input_tokens	OpenAI.integer		Ja
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Ja
└– zwischengespeicherte_Token	OpenAI.integer		Ja
output_tokens	OpenAI.integer		Ja
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Ja
└– reasoning_tokens	OpenAI.integer		Ja
Gesamtanzahl Tokens	OpenAI.integer		Ja

OpenAI.ResponseUsageInputTokensDetails

Name	Typ	Description	Required	Vorgabe
cached_tokens	OpenAI.integer		Ja

OpenAI.ResponseUsageOutputTokensDetails

Name	Typ	Description	Required	Vorgabe
Begründungs_Token	OpenAI.integer		Ja

OpenAI.ResponseWebSearchCallCompletedEvent

Wird ausgegeben, wenn ein Websuchaufruf abgeschlossen ist.

Name	Typ	Description	Required	Vorgabe
item_id	Schnur	Eindeutige ID für das Ausgabeelement, das dem Websuchaufruf zugeordnet ist.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typ des Ereignisses Immer response.web_search_call.completed. Mögliche Werte: response.web_search_call.completed	Ja

OpenAI.ResponseWebSearchCallInProgressEvent

Wird ausgegeben, wenn ein Websuchaufruf initiiert wird.

Name	Typ	Description	Required	Vorgabe
item_id	Schnur	Eindeutige ID für das Ausgabeelement, das dem Websuchaufruf zugeordnet ist.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		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

Wird ausgegeben, wenn ein Websuchaufruf ausgeführt wird.

Name	Typ	Description	Required	Vorgabe
item_id	Schnur	Eindeutige ID für das Ausgabeelement, das dem Websuchaufruf zugeordnet ist.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typ des Ereignisses Immer response.web_search_call.searching. Mögliche Werte: response.web_search_call.searching	Ja

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

OpenAI.Scroll

Eine Scrollaktion

Name	Typ	Description	Required	Vorgabe
scroll_x	OpenAI.integer		Ja
scroll_y	OpenAI.integer		Ja
type	enum	Gibt den Ereignistyp an. Bei einer Bildlaufaktion ist diese Eigenschaft immer auf scroll festgelegt. Mögliche Werte: scroll	Ja
x	OpenAI.integer		Ja
y	OpenAI.integer		Ja

OpenAI.SearchContextSize

Property	Wert
Typ	Schnur
Werte	low medium high

OpenAI.ServiceTier

Gibt den Verarbeitungstyp an, der für die Bereitstellung der Anforderung verwendet wird.

• Wenn sie auf "auto" festgelegt ist, wird die Anforderung mit der in den Project Einstellungen konfigurierten Dienstebene verarbeitet. Sofern nicht anders konfiguriert, verwendet die Project "default".
• Wenn sie auf "Standard" festgelegt ist, wird die Anforderung mit den Standardpreisen und der Leistung für das ausgewählte Modell verarbeitet.
• Wenn sie auf "Flex" oder "Priorität" festgelegt ist, wird die Anforderung mit der entsprechenden Dienstebene verarbeitet.
• Wenn sie nicht festgelegt ist, lautet das Standardverhalten "auto". Wenn der service_tier Parameter festgelegt ist, enthält der Antworttext den service_tier Wert basierend auf dem Verarbeitungsmodus, der tatsächlich für die Anforderung verwendet wird. Dieser Antwortwert kann sich von dem wert unterscheiden, der im Parameter festgelegt wurde.

Property	Wert
Typ	Schnur
Nullable	Ja
Werte	auto default flex scale priority

OpenAI.SpecificApplyPatchParam

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

OpenAI.SpecificFunctionShellParam

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

OpenAI.Summary

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

OpenAI.SummaryTextContent

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

OpenAI.TextContent

Ein Textinhalt.

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

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, um den älteren JSON-Modus zu { "type": "json_object" } aktivieren, wodurch sichergestellt wird, dass die Nachricht, die das Modell generiert, gültig JSON ist. Die Verwendung json_schema wird für Modelle bevorzugt, die sie unterstützen.

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

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-Schemaantwortformat. Wird verwendet, um strukturierte JSON-Antworten zu generieren. Erfahren Sie mehr über Structured Outputs.

Name	Typ	Description	Required	Vorgabe
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 (nullable)		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
bing_grounding	BingGroundingTool
fabric_dataagent_preview	MicrosoftFabricPreviewTool
sharepoint_grounding_preview	SharepointPreviewTool
azure_ai_search	AzureAISearchTool
openapi	OpenApiTool
bing_custom_search_preview	BingCustomSearchPreviewTool
browser_automation_preview	BrowserAutomationPreviewTool
azure_function	AzureFunctionTool
capture_structured_outputs	CaptureStructuredOutputsTool
a2a_preview	A2APreviewTool
memory_search_preview	MemorySearchPreviewTool
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

Name	Typ	Description	Required	Vorgabe
type	OpenAI.ToolType		Ja

OpenAI.ToolChoiceAllowed

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

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

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

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

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

Name	Typ	Description	Required	Vorgabe
Name	String (nullierbar)		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

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
function	OpenAI.ToolChoiceFunction
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

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

OpenAI.ToolChoiceWebSearchPreview

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

Property	Wert
Typ	Schnur
Werte	function file_search computer_use_preview web_search mcp code_interpreter image_generation local_shell shell custom web_search_preview apply_patch a2a_preview bing_custom_search_preview browser_automation_preview fabric_dataagent_preview sharepoint_grounding_preview memory_search_preview azure_ai_search azure_function bing_grounding capture_structured_outputs openapi

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:

• Integrierte Tools: Tools, die von OpenAI bereitgestellt werden, die die Funktionen des Modells erweitern, z. B. Websuche oder Dateisuche. Erfahren Sie mehr über integrierte Tools.
• MCP-Tools: Integrationen mit Drittanbietersystemen über benutzerdefinierte MCP-Server oder vordefinierte Connectors wie Google Drive und SharePoint. Weitere Informationen zu 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 function calling. Sie können auch benutzerdefinierte Tools verwenden, um Ihren eigenen Code aufzurufen.

Array von: OpenAI.Tool

OpenAI.TopLogProb

Die oberste Protokollwahrscheinlichkeit eines Tokens.

Name	Typ	Description	Required	Vorgabe
Byte	Array von OpenAI.integer		Ja
logprob	OpenAI.numeric		Ja
token	Schnur		Ja

OpenAI.Type

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 ist diese Eigenschaft immer auf type festgelegt. Mögliche Werte: type	Ja

OpenAI.UpdateConversationBody

Name	Typ	Description	Required	Vorgabe
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	Ja

OpenAI.UrlCitationBody

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

Name	Typ	Description	Required	Vorgabe
end_index	OpenAI.integer		Ja
start_index	OpenAI.integer		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	Schnur	Die URL der Webressource.	Ja

OpenAI.VectorStoreFileAttributes

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

Typ: Objekt

OpenAI.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
Typ	Schnur
Nullable	Ja
Werte	low medium high

OpenAI.Wait

Eine Warteaktion.

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

OpenAI.WebSearchActionFind

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

Name	Typ	Description	Required	Vorgabe
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	Schnur	Die URL der Seite, die nach dem Muster gesucht wurde.	Ja

OpenAI.WebSearchActionOpenPage

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	Schnur	Die URL, die vom Modell geöffnet wurde.	Ja

OpenAI.WebSearchActionSearch

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

Name	Typ	Description	Required	Vorgabe
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	Schnur		Ja

OpenAI.WebSearchApproximateLocation

Die ungefähre Position des Benutzers.

Name	Typ	Description	Required	Vorgabe
Stadt	String (nullierbar)		No
country	String (nullierbar)		No
Region	String (nullierbar)		No
timezone	String (nullierbar)		No
type	enum	Der Typ der Standortannäherung. Immer approximate. Mögliche Werte: approximate	No

OpenAI.WebSearchPreviewTool

Dieses Tool durchsucht im Web nach relevanten Ergebnissen, die in einer Antwort verwendet werden können. Erfahren Sie mehr über das Web-Suchtool.

Name	Typ	Description	Required	Vorgabe
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
Benutzerstandort	OpenAI.ApproximateLocation (nullierbar)		No
└– Stadt	String (nullierbar)		No
└- Land	String (nullierbar)		No
└– Region	String (nullierbar)		No
└– Zeitzone	String (nullierbar)		No
└– Typ	enum	Der Typ der Standortannäherung. Immer approximate. Mögliche Werte: approximate	Ja

OpenAI.WebSearchTool

Suchen Sie im Internet nach Quellen, die mit dem Prompt zu tun haben. Erfahren Sie mehr über das Web-Suchtool.

Name	Typ	Description	Required	Vorgabe
custom_search_configuration	WebSearchConfiguration	Eine Websuchkonfiguration für bing benutzerdefinierte Suche	No
└– instance_name	Schnur	Name der benutzerdefinierten Konfigurationsinstanz, die für die Konfiguration angegeben wird.	Ja
└– project_connection_id	Schnur	Project Verbindungs-ID für das Erding mit der benutzerdefinierten Bing-Suche	Ja
Filter	OpenAI.WebSearchToolFilters (nullable)		No
└– allowed_domains	Array der Zeichenfolge (nullable)		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
type	enum	Der Typ des Websuchtools. Einer von web_search oder web_search_2025_08_26. Mögliche Werte: web_search	Ja
Benutzerstandort	OpenAI.WebSearchApproximateLocation (nullierbar)	Die ungefähre Position des Benutzers.	No
└– Stadt	String (nullierbar)		No
└- Land	String (nullierbar)		No
└– Region	String (nullierbar)		No
└– Zeitzone	String (nullierbar)		No
└– Typ	enum	Der Typ der Standortannäherung. Immer approximate. Mögliche Werte: approximate	No

OpenAI.WebSearchToolFilters

Name	Typ	Description	Required	Vorgabe
allowed_domains	Array von Strings		No

OpenAI.integer

Typ: ganze Zahl

Format: int64

OpenAI.numeric

Typ: Zahl

Format: doppelt

OpenApiAnonymousAuthDetails

Sicherheitsdetails für die anonyme OpenApi-Authentifizierung

Name	Typ	Description	Required	Vorgabe
type	enum	Der Objekttyp, der immer "anonym" ist. Mögliche Werte: anonymous	Ja

OpenApiAuthDetails

Authentifizierungsdetails für OpenApiFunctionDefinition

Diskriminator für OpenApiAuthDetails

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

Typwert	Schema
anonymous	OpenApiAnonymousAuthDetails
project_connection	OpenApiProjectConnectionAuthDetails
managed_identity	OpenApiManagedAuthDetails

Name	Typ	Description	Required	Vorgabe
type	OpenApiAuthType	Authentifizierungstyp für den OpenApi-Endpunkt. Folgende Typen sind zulässig: - Anonym (keine Authentifizierung erforderlich) - Project Verbindung (erfordert project_connection_id zum Endpunkt, wie setup in AI Foundry) - Managed_Identity (erfordert Zielgruppe für identitätsbasierte Authentifizierung)	Ja

OpenApiAuthType

Authentifizierungstyp für den OpenApi-Endpunkt. Folgende Typen sind zulässig:

• Anonym (keine Authentifizierung erforderlich)
• Project Verbindung (erfordert project_connection_id zum Endpunkt, wie in AI Foundry eingerichtet)
• Managed_Identity (erfordert Zielgruppe für identitätsbasierte Authentifizierung)

Property	Wert
Beschreibung	Authentifizierungstyp für den OpenApi-Endpunkt. Folgende Typen sind zulässig: - Anonym (keine Authentifizierung erforderlich) - Project Verbindung (erfordert project_connection_id zum Endpunkt, wie setup in AI Foundry) - Managed_Identity (erfordert Zielgruppe für identitätsbasierte Authentifizierung)
Typ	Schnur
Werte	anonymous project_connection managed_identity

OpenApiFunctionDefinition

Die Eingabedefinitionsinformationen für eine openapi-Funktion.

Name	Typ	Description	Required	Vorgabe
auth	OpenApiAuthDetails	Authentifizierungsdetails für OpenApiFunctionDefinition	Ja
└– Typ	OpenApiAuthType	Der Authentifizierungstyp muss anonym/project_connection/managed_identity sein.	Ja
default_params	Array von Strings	Liste der OpenAPI-Spezifikationsparameter, die vom Benutzer bereitgestellte Standardwerte verwenden	No
description	Schnur	Eine Beschreibung der Funktion, die vom Modell verwendet wird, um auszuwählen, wann und wie die Funktion aufgerufen wird.	No
functions	Objektarray	Liste der funktionsdefinitionen, die vom OpenApi-Tool verwendet werden	No
Name	Schnur	Der Name der funktion, die aufgerufen werden soll.	Ja
spec	Objekt	Das openapi-Funktions-Shape, das als JSON-Schemaobjekt beschrieben wird.	Ja

OpenApiManagedAuthDetails

Sicherheitsdetails für die OpenApi-managed_identity-Authentifizierung

Name	Typ	Description	Required	Vorgabe
security_scheme	OpenApiManagedSecurityScheme	Sicherheitsschema für die OpenApi-managed_identity-Authentifizierung	Ja
└– Publikum	Schnur	Authentifizierungsbereich für managed_identity Authentifizierungstyp	Ja
type	enum	Der Objekttyp, der immer "managed_identity" ist. Mögliche Werte: managed_identity	Ja

OpenApiManagedSecurityScheme

Sicherheitsschema für die OpenApi-managed_identity-Authentifizierung

Name	Typ	Description	Required	Vorgabe
audience	Schnur	Authentifizierungsbereich für managed_identity Authentifizierungstyp	Ja

OpenApiProjectConnectionAuthDetails

Sicherheitsdetails für die OpenApi-project Verbindungsauthentifizierung

Name	Typ	Description	Required	Vorgabe
security_scheme	OpenApiProjectConnectionSecurityScheme	Sicherheitsschema für die OpenApi-managed_identity-Authentifizierung	Ja
└– project_connection_id	Schnur	Project Verbindungs-ID für Project Verbindungsauthentifizierungstyp	Ja
type	enum	Der Objekttyp, der immer "project_connection" ist. Mögliche Werte: project_connection	Ja

OpenApiProjectConnectionSecurityScheme

Sicherheitsschema für die OpenApi-managed_identity-Authentifizierung

Name	Typ	Description	Required	Vorgabe
project_connection_id	Schnur	Project Verbindungs-ID für Project Verbindungsauthentifizierungstyp	Ja

OpenApiTool

Die Eingabedefinitionsinformationen für ein OpenAPI-Tool, das zum Konfigurieren eines Agents verwendet wird.

Name	Typ	Description	Required	Vorgabe
openapi	OpenApiFunctionDefinition	Die Eingabedefinitionsinformationen für eine openapi-Funktion.	Ja
└– Authentifizierung	OpenApiAuthDetails	Details zur offenen API-Authentifizierung	Ja
└- default_params	Array von Strings	Liste der OpenAPI-Spezifikationsparameter, die vom Benutzer bereitgestellte Standardwerte verwenden	No
└– Beschreibung	Schnur	Eine Beschreibung der Funktion, die vom Modell verwendet wird, um auszuwählen, wann und wie die Funktion aufgerufen wird.	No
└- Funktionen	Objektarray (schreibgeschützt)	Liste der funktionsdefinitionen, die vom OpenApi-Tool verwendet werden	No
└– Beschreibung	Schnur	Eine Beschreibung der Funktion, die vom Modell verwendet wird, um auszuwählen, wann und wie die Funktion aufgerufen wird.	No
└– Name	Schnur	Der Name der funktion, die aufgerufen werden soll.	Ja
└- Parameter	Objekt	Die Parameter, die die Funktionen akzeptieren, die als JSON-Schemaobjekt beschrieben werden.	Ja
└– Name	Schnur	Der Name der funktion, die aufgerufen werden soll.	Ja
└– Spezifikation	Objekt	Das openapi-Funktions-Shape, das als JSON-Schemaobjekt beschrieben wird.	Ja
type	enum	Der Objekttyp, der immer 'openapi' ist. Mögliche Werte: openapi	Ja

PageOrder

Property	Wert
Typ	Schnur
Werte	asc desc

PagedConnection

Ausgelagerte Sammlung von Verbindungselementen

Name	Typ	Description	Required	Vorgabe
nextLink	Schnur	Der Link zur nächsten Seite von Elementen	No
value	Array der Verbindung	Die Verbindungselemente auf dieser Seite	Ja

PagedDatasetVersion

Paged-Sammlung von DatasetVersion-Elementen

Name	Typ	Description	Required	Vorgabe
nextLink	Schnur	Der Link zur nächsten Seite von Elementen	No
value	Array von DatasetVersion	Die DatasetVersion-Elemente auf dieser Seite	Ja

PagedDeployment

Ausgelagerte Sammlung von Bereitstellungselementen

Name	Typ	Description	Required	Vorgabe
nextLink	Schnur	Der Link zur nächsten Seite von Elementen	No
value	Array der Bereitstellung	Die Bereitstellungselemente auf dieser Seite	Ja

PagedEvaluationRule

Paged-Auflistung von EvaluationRule-Elementen

Name	Typ	Description	Required	Vorgabe
nextLink	Schnur	Der Link zur nächsten Seite von Elementen	No
value	Array von EvaluationRule	Die EvaluationRule-Elemente auf dieser Seite	Ja

PagedEvaluationTaxonomy

Paged-Auflistung von EvaluationTaxonomy-Elementen

Name	Typ	Description	Required	Vorgabe
nextLink	Schnur	Der Link zur nächsten Seite von Elementen	No
value	Array von EvaluationTaxonomy	Die Elemente "EvaluationTaxonomy" auf dieser Seite	Ja

PagedEvaluatorVersion

Paged-Auflistung von EvaluatorVersion-Elementen

Name	Typ	Description	Required	Vorgabe
nextLink	Schnur	Der Link zur nächsten Seite von Elementen	No
value	Array von EvaluatorVersion	Die EvaluatorVersion-Elemente auf dieser Seite	Ja

PagedIndex

Paged-Auflistung von Indexelementen

Name	Typ	Description	Required	Vorgabe
nextLink	Schnur	Der Link zur nächsten Seite von Elementen	No
value	Array des Indexes	Die Indexelemente auf dieser Seite	Ja

PagedInsight

Paged-Sammlung von Insight-Elementen

Name	Typ	Description	Required	Vorgabe
nextLink	Schnur	Der Link zur nächsten Seite von Elementen	No
value	Array von Insight	Die Insights-Elemente auf dieser Seite	Ja

PagedRedTeam

Paged-Auflistung von RedTeam-Elementen

Name	Typ	Description	Required	Vorgabe
nextLink	Schnur	Der Link zur nächsten Seite von Elementen	No
value	Array von RedTeam	Die RedTeam-Elemente auf dieser Seite	Ja

PagedSchedule

Ausgelagerte Sammlung von Zeitplanelementen

Name	Typ	Description	Required	Vorgabe
nextLink	Schnur	Der Link zur nächsten Seite von Elementen	No
value	Array von Zeitplan	Die Elemente auf dieser Seite planen	Ja

PagedScheduleRun

Paged-Sammlung von ScheduleRun-Elementen

Name	Typ	Description	Required	Vorgabe
nextLink	Schnur	Der Link zur nächsten Seite von Elementen	No
value	Array von ScheduleRun	Die ScheduleRun-Elemente auf dieser Seite	Ja

PendingUploadRequest

Stellt eine Anforderung für einen ausstehenden Upload dar.

Name	Typ	Description	Required	Vorgabe
Connectionname	Schnur	Verbindungsname des Azure Storage-Kontos, der zum Generieren eines temporären SAS-Tokens verwendet werden soll	No
pendingUploadId	Schnur	Wenn PendingUploadId nicht angegeben wird, wird eine zufällige GUID verwendet.	No
pendingUploadType	enum	BlobReference ist der einzige unterstützte Typ. Mögliche Werte: BlobReference	Ja

PendingUploadResponse

Stellt die Antwort auf eine ausstehende Uploadanforderung dar

Name	Typ	Description	Required	Vorgabe
blobReference	BlobReference	Details zum Blobverweis.	Ja
└– blobUri	Schnur	Blob-URI-Pfad für den Client zum Hochladen von Daten. Beispiel: https://blob.windows.core.net/Container/Path	Ja
└– Anmeldeinformationen	SasCredential	Anmeldeinformationen für den Zugriff auf das Speicherkonto.	Ja
└– storageAccountArmId	Schnur	ARM-ID des zu verwendenden Speicherkontos.	Ja
pendingUploadId	Schnur	ID für diese Upload-Anforderung.	Ja
pendingUploadType	enum	BlobReference ist der einzige unterstützte Typ. Mögliche Werte: BlobReference	Ja
version	Schnur	Version des zu erstellenden Assets, wenn der Benutzer die Version beim ersten Erstellen des Uploads nicht angegeben hat	No

PromptAgentDefinition

Die Definition des Eingabeaufforderungs-Agents

Name	Typ	Description	Required	Vorgabe
instructions	String (nullierbar)	Eine Systemnachricht (oder Entwicklernachricht), die in den Kontext des Modells eingefügt wurde.	No
kind	enum	Mögliche Werte: prompt	Ja
model	Schnur	Die Modellbereitstellung, die für diesen Agent verwendet werden soll.	Ja
rai_config	RaiConfig	Konfiguration für die Inhaltsfilterung und Sicherheitsfunktionen von Responsible AI (RAI).	No
└– rai_policy_name	Schnur	Der Name der zu übernehmenden RAI-Richtlinie.	Ja
reasoning	OpenAI.Reasoning (nullierbar)	nur gpt-5- und o-Series-Modelle Konfigurationsoptionen für Begründungsmodelle.	No
└– Aufwand	OpenAI.ReasoningEffort	Schränkt den Aufwand für die Begründung ein Begründungsmodelle. Derzeit unterstützte Werte sind none, , minimal, low, medium, highund 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, mediumund 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	enum	Mögliche Werte: auto, , concisedetailed	No
└– Zusammenfassung	enum	Mögliche Werte: auto, , concisedetailed	No
structured_inputs	Objekt	Satz strukturierter Eingaben, die an der Ersetzung von Eingabeaufforderungsvorlagen oder an Werkzeugargumentbindungen teilnehmen können.	No
Temperatur	Zahl	Welche Probenahmetemperatur verwendet werden soll, zwischen 0 und 2. Durch höhere Werte wie 0,8 wird die Ausgabe zufälliger, während sie durch niedrigere Werte wie 0,2 fokussierter und deterministischer wird. Es wird in der Regel empfohlen, dies oder top_p nicht beides zu ändern.	No	1
Text	PromptAgentDefinitionTextOptions	Konfigurationsoptionen für eine Textantwort aus dem Modell. Kann Nur-Text- oder strukturierte JSON-Daten sein.	No
└─ 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
tool_choice	string oder 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.	No
tools	Array von OpenAI.Tool	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.	No
top_p	Zahl	Eine Alternative zur Probenahme mit Temperatur, die als Kernsampling bezeichnet wird, bei dem das Modell die Ergebnisse der Token mit der Wahrscheinlichkeitsmasse „top_p“ berücksichtigt. 0,1 bedeutet also nur die Token, die die top 10% Wahrscheinlichkeitsmasse umfassen. umfassen. Es wird in der Regel empfohlen, dies oder temperature nicht beides zu ändern.	No	1

PromptAgentDefinitionTextOptions

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

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

PromptBasedEvaluatorDefinition

Eingabeaufforderungsbasierter Evaluator

Name	Typ	Description	Required	Vorgabe
data_schema	Objekt	Das JSON-Schema (Entwurf 2020-12) für die Eingabedaten des Evaluators. Dazu gehören Parameter wie Typ, Eigenschaften, erforderlich.	No
init_parameters	Objekt	Das JSON-Schema (Entwurf 2020-12) für die Eingabeparameter des Evaluators. Dazu gehören Parameter wie Typ, Eigenschaften, erforderlich.	No
metrics	Objekt	Liste der von diesem Evaluator erzeugten Ausgabemetriken	No
prompt_text	Schnur	Der zur Auswertung verwendete Eingabeaufforderungstext	Ja
type	enum	Mögliche Werte: prompt	Ja

ProtocolVersionRecord

Ein Datensatz-Mapping für ein einzelnes Protokoll und seine Version.

Name	Typ	Description	Required	Vorgabe
protocol	AgentProtocol		Ja
version	Schnur	Die Versionszeichenfolge für das Protokoll, z. B. "v0.1.1".	Ja

RaiConfig

Konfiguration für die Inhaltsfilterung und Sicherheitsfunktionen von Responsible AI (RAI).

Name	Typ	Description	Required	Vorgabe
rai_policy_name	Schnur	Der Name der zu übernehmenden RAI-Richtlinie.	Ja

RecurrenceSchedule

Modell des Wiederholungszeitplans.

Diskriminator für RecurrenceSchedule

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

Typwert	Schema
Hourly	HourlyRecurrenceSchedule
Daily	DailyRecurrenceSchedule
Weekly	WeeklyRecurrenceSchedule
Monthly	MonthlyRecurrenceSchedule

Name	Typ	Description	Required	Vorgabe
type	RecurrenceType	Typ der Wiederholung.	Ja

RecurrenceTrigger

Wiederholungsbasierter Trigger.

Name	Typ	Description	Required	Vorgabe
endTime	Schnur	Endzeit für den Wiederholungszeitplan im ISO 8601-Format.	No
interval	integer	Intervall für den Wiederholungszeitplan.	Ja
schedule	RecurrenceSchedule	Modell des Wiederholungszeitplans.	Ja
└– Typ	RecurrenceType	Serientyp für den Serienzeitplan.	Ja
startTime	Schnur	Startzeit für den Wiederholungszeitplan im ISO 8601-Format.	No
timeZone	Schnur	Zeitzone für den Wiederholungszeitplan.	No	UTC
type	enum	Typ des Auslösers. Mögliche Werte: Recurrence	Ja

RecurrenceType

Typ der Wiederholung.

Property	Wert
Beschreibung	Typ der Wiederholung.
Typ	Schnur
Werte	Hourly Daily Weekly Monthly

RedTeam

Details zum roten Team.

Name	Typ	Description	Required	Vorgabe
applicationScenario	Schnur	Anwendungsszenario für den roten Teamvorgang, um szenariospezifische Angriffe zu generieren.	No
attackStrategies	Array von AttackStrategy	Liste der Angriffsstrategien oder geschachtelten Listen von Angriffsstrategien.	No
displayName	Schnur	Name der Rot-Team-Ausführung.	No
id	Zeichenfolge (schreibgeschützt)	Bezeichner der roten Teamausführung.	Ja
numTurns	integer	Anzahl der Simulationsrunden.	No
properties	Objekt	Eigenschaften des roten Teams. Im Gegensatz zu Tags sind Eigenschaften nur add-only. Nachdem eine Eigenschaft hinzugefügt wurde, kann keine Eigenschaft entfernt werden.	No
riskCategories	Array von RiskCategory	Liste der Risikokategorien, für die Angriffsziele generiert werden sollen.	No
simulationOnly	boolean	Nur Simulation oder Simulation + Auswertung. Standardwert "false", wenn "true" die Ausgabe des Unterhaltungsergebnisses ohne Auswertung ausgibt.	No	Falsch
status	Zeichenfolge (schreibgeschützt)	Status des roten Teams. Sie wird nach Dienst festgelegt und ist schreibgeschützt.	No
tags	Objekt	Die Tags des roten Teams. Im Gegensatz zu Eigenschaften sind Tags vollständig änderbar.	No
target	TargetConfig	Abstrakte Klasse für die Zielkonfiguration.	Ja
└– Typ	Schnur	Typ der Modellkonfiguration.	Ja

RedTeamEvalRunDataSource

Name	Typ	Description	Required	Vorgabe
item_generation_params	ItemGenerationParams	Stellt den Satz von Parametern dar, die zum Steuern von Elementgenerierungsvorgängen verwendet werden.	Ja
└– Typ	ItemGenerationParamsType	Der Typ der zu verwendenden Elementgenerierungsparameter.	Ja
target	Ziel	Basisklasse für Ziele mit Diskriminatorunterstützung.	Ja
└– Typ	Schnur	Der Zieltyp.	Ja
type	enum	Der Typ der Datenquelle. Immer azure_ai_red_team. Mögliche Werte: azure_ai_red_team	Ja

RedTeamItemGenerationParams

Name	Typ	Description	Required	Vorgabe
attack_strategies	Array von AttackStrategy	Die Sammlung der zu verwendenden Angriffsstrategien.	Ja
num_turns	integer	Die Anzahl der im Spiel zulässigen Wendungen.	Ja	20
type	enum	Der Typ der Elementgenerierungsparameter. Mögliche Werte: red_team	Ja

RedTeamSeedPromptsItemGenerationParams

Stellt die Parameter für die Elementgenerierung roter Team-Startaufforderungen dar.

Name	Typ	Description	Required	Vorgabe
attack_strategies	Array von AttackStrategy	Die Sammlung der zu verwendenden Angriffsstrategien.	Ja
num_turns	integer	Die Anzahl der im Spiel zulässigen Wendungen.	Ja	20
source	OpenAI.EvalJsonlFileContentSource		Ja
└– Inhalt	Array von OpenAI.EvalJsonlFileContentSourceContent	Der Inhalt der JSONL-Datei.	Ja
└– Typ	enum	Der Typ der JSONL-Quelle. Immer file_content. Mögliche Werte: file_content	Ja
type	enum	Der Typ der Elementgenerierungsparameter, immer red_team_seed_prompts. Mögliche Werte: red_team_seed_prompts	Ja

RedTeamTaxonomyItemGenerationParams

Stellt die Parameter für die Erstellung roter Teamtaxonomieelemente dar.

Name	Typ	Description	Required	Vorgabe
attack_strategies	Array von AttackStrategy	Die Sammlung der zu verwendenden Angriffsstrategien.	Ja
num_turns	integer	Die Anzahl der im Spiel zulässigen Wendungen.	Ja	20
source	OpenAI.EvalJsonlFileContentSource		Ja
└– Inhalt	Array von OpenAI.EvalJsonlFileContentSourceContent	Der Inhalt der JSONL-Datei.	Ja
└– Typ	enum	Der Typ der JSONL-Quelle. Immer file_content. Mögliche Werte: file_content	Ja
type	enum	Der Typ der Elementgenerierungsparameter, immer red_team_taxonomy. Mögliche Werte: red_team_taxonomy	Ja

ResponseRetrievalItemGenerationParams

Stellt die Parameter für die Generierung von Antwortabrufelementen dar.

Name	Typ	Description	Required	Vorgabe
Datenzuordnung	Objekt	Zuordnung von Quellfeldern zu response_id Feld, erforderlich zum Abrufen des Chatverlaufs.	Ja
max_num_turns	integer	Die maximale Anzahl der zu bewertenden Chatverlaufszahlen.	Ja
source	OpenAI.EvalJsonlFileContentSource oder OpenAI.EvalJsonlFileIdSource	Die Quelle, aus der JSONL-Inhalte gelesen werden.	Ja
type	enum	Der Typ der Elementgenerierungsparameter, immer response_retrieval. Mögliche Werte: response_retrieval	Ja

RiskCategory

Risikokategorie für das Angriffsziel.

Property	Wert
Beschreibung	Risikokategorie für das Angriffsziel.
Typ	Schnur
Werte	HateUnfairness Violence Sexual SelfHarm ProtectedMaterial CodeVulnerability UngroundedAttributes ProhibitedActions SensitiveDataLeakage TaskAdherence

SASCredentials

Definition der SAS-Anmeldeinformationen (Shared Access Signature)

Name	Typ	Description	Required	Vorgabe
SAS	Zeichenfolge (schreibgeschützt)	SAS-Token	No
type	enum	Der Anmeldeinformationstyp Mögliche Werte: SAS	Ja

Sampletype

Die Art der Probe, die für die Analyse verwendet wird.

Property	Wert
Beschreibung	Die Art der Probe, die für die Analyse verwendet wird.
Typ	Schnur
Werte	EvaluationResultSample

SasCredential

Definition der SAS-Anmeldeinformationen

Name	Typ	Description	Required	Vorgabe
sasUri	Zeichenfolge (schreibgeschützt)	SAS-URI	Ja
type	enum	Typ der Anmeldeinformationen Mögliche Werte: SAS	Ja

Schedule

Modell planen.

Name	Typ	Description	Required	Vorgabe
description	Schnur	Beschreibung des Zeitplans.	No
displayName	Schnur	Name des Zeitplans.	No
enabled	boolean	Aktivierter Status des Zeitplans.	Ja
id	Zeichenfolge (schreibgeschützt)	Bezeichner des Zeitplans.	Ja
properties	Objekt	Eigenschaften des Zeitplans. Im Gegensatz zu Tags sind Eigenschaften nur add-only. Nachdem eine Eigenschaft hinzugefügt wurde, kann keine Eigenschaft entfernt werden.	No
Stand der Bereitstellung	ScheduleProvisioningStatus (schreibgeschützt)	Planen Sie den Bereitstellungsstatus.	No
Systemdaten	-Objekt (schreibgeschützt)	Systemmetadaten für die Ressource.	Ja
tags	Objekt	Tags des Zeitplans. Im Gegensatz zu Eigenschaften sind Tags vollständig änderbar.	No
Aufgabe	ScheduleTask	Aufgabenmodell planen.	Ja
└– Konfiguration	Objekt	Konfiguration für die Aufgabe.	No
└– Typ	ScheduleTaskType	Typ des Vorgangs.	Ja
trigger	Auslösen	Basismodell für Trigger des Zeitplans.	Ja
└– Typ	Trigger-Typ	Typ des Auslösers.	Ja

ScheduleProvisioningStatus

Planen Sie den Bereitstellungsstatus.

Property	Wert
Beschreibung	Planen Sie den Bereitstellungsstatus.
Typ	Schnur
Werte	Creating Updating Deleting Succeeded Failed

ScheduleRun

Planen des Ausführungsmodells.

Name	Typ	Description	Required	Vorgabe
Fehler	Zeichenfolge (schreibgeschützt)	Fehlerinformationen für die Ausführung des Zeitplans.	No
id	Zeichenfolge (schreibgeschützt)	Bezeichner der Ausführung des Zeitplans.	Ja
properties	-Objekt (schreibgeschützt)	Eigenschaften der Ausführung des Zeitplans.	Ja
scheduleId	Schnur	Bezeichner des Zeitplans.	Ja
Erfolg	boolescher Wert (schreibgeschützt)	Auslösen des Erfolgsstatus der Ausführung des Zeitplans.	Ja
triggerTime	Schnur	Auslösen der Ausführungszeit des Zeitplans.	No

GeplanteAufgabe

Aufgabenmodell planen.

Diskriminator für ScheduleTask

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

Typwert	Schema
Evaluation	EvaluationScheduleTask
Insight	InsightScheduleTask

Name	Typ	Description	Required	Vorgabe
configuration	Objekt	Konfiguration für die Aufgabe.	No
type	ScheduleTaskType	Typ des Vorgangs.	Ja

ScheduleTaskType

Typ des Vorgangs.

Property	Wert
Beschreibung	Typ des Vorgangs.
Typ	Schnur
Werte	Evaluation Insight

SharepointGroundingToolParameters

Die Parameter des Sharepoint-Erdungstools.

Name	Typ	Description	Required	Vorgabe
project_connections	Array von ToolProjectConnection	Die an dieses Tool angefügten project Verbindungen. Es kann maximal 1 Verbindung bestehen. an das Tool angefügte Ressource.	No

SharepointPreviewTool

Die Eingabedefinitionsinformationen für ein SharePoint-Tool, wie zum Konfigurieren eines Agents verwendet.

Name	Typ	Description	Required	Vorgabe
sharepoint_grounding_preview	SharepointGroundingToolParameters	Die Parameter des Sharepoint-Erdungstools.	Ja
└– project_connections	Array von ToolProjectConnection	Die an dieses Tool angefügten project Verbindungen. Es kann maximal 1 Verbindung bestehen. an das Tool angefügte Ressource. Einschränkungen: maxItems: 1	No
type	enum	Der Objekttyp, der immer 'sharepoint_grounding_preview' ist. Mögliche Werte: sharepoint_grounding_preview	Ja

Sku

Sku-Informationen

Name	Typ	Description	Required	Vorgabe
capacity	integer	Sku-Kapazität	Ja
family	Schnur	Sku-Familie	Ja
Name	Schnur	Sku-Name	Ja
size	Schnur	Sku-Größe	Ja
tier	Schnur	Sku-Ebene	Ja

StructuredInputDefinition

Eine strukturierte Eingabe, die an der Ersetzung von Eingabeaufforderungsvorlagen und der Bindung von Werkzeugargumenten teilnehmen kann.

Name	Typ	Description	Required	Vorgabe
default_value		Der Standardwert für die Eingabe, wenn kein Laufzeitwert angegeben wird.	No
description	Schnur	Eine für Menschen lesbare Beschreibung der Eingabe.	No
required	boolean	Gibt an, ob die Eingabeeigenschaft beim Aufrufen des Agents erforderlich ist.	No	Falsch
schema	Objekt	Das JSON-Schema für die strukturierte Eingabe (optional).	No

StructuredOutputDefinition

Eine strukturierte Ausgabe, die vom Agenten erzeugt werden kann.

Name	Typ	Description	Required	Vorgabe
description	Schnur	Eine Beschreibung der Ausgabe, die ausgegeben werden soll. Wird vom Modell verwendet, um zu bestimmen, wann die Ausgabe ausgegeben werden soll.	Ja
Name	Schnur	Der Name der strukturierten Ausgabe.	Ja
schema	Objekt	Das JSON-Schema für die strukturierte Ausgabe.	Ja
strict	boolescher Wert (nullable)	Gibt an, ob eine strenge Überprüfung erzwungen werden soll. Standard-true.	Ja

StructuredOutputsOutputItem

Name	Typ	Description	Required	Vorgabe
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
Ausgabe		Die während der Antwort erfasste strukturierte Ausgabe.	Ja
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
type	enum	Mögliche Werte: structured_outputs	Ja

SyntheticDataGenerationPreviewEvalRunDataSource

Stellt eine Datenquelle für Auswertungsläufe dar, die basierend auf generierten synthetischen Daten zu Testzwecken ausgewertet werden.

Name	Typ	Description	Required	Vorgabe
Eingabenachrichten	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		No
└- Vorlage	Array des Objekts oder OpenAI.EvalItem		Ja
└– Typ	enum	Mögliche Werte: template	Ja
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Ja
└– model_deployment_name	Schnur	Der Name der Modellbereitstellung, die zum Generieren synthetischer Daten verwendet werden soll.	Ja
└– output_dataset_id	Zeichenfolge (schreibgeschützt)	Der Bezeichner des Ausgabe-Datasets, in dem generierte synthetische Daten gespeichert werden. Die generierten Daten sind eine JSONL-Datei mit Spalten-ID, Abfrage und test_description.	No
└– output_dataset_name	Schnur	Der Name des Ausgabedatensets, in dem generierte synthetische Daten gespeichert werden. Wenn nicht angegeben, generiert der Dienst den Datasetnamen automatisch.	No
└– Eingabeaufforderung	Schnur	Die Aufforderung zum Generieren synthetischer Daten. Dies ist die Option, wenn das Ziel vom Typ "azure_ai_agent" mit Anweisungen im Agent konfiguriert ist.	No
└– samples_count	integer	Die maximale Anzahl der zu generierenden Datenbeispiele.	Ja
└- Quellen	Array von OpenAI.EvalJsonlFileIdSource	Die optionalen Seed-Datenquellendateien für die Datengenerierung.	Ja
└– Typ	enum	Der Typ der Elementgenerierungsparameter. Mögliche Werte: synthetic_data_gen_preview	Ja
target	Ziel	Basisklasse für Ziele mit Diskriminatorunterstützung.	Ja
└– Typ	Schnur	Der Zieltyp.	Ja
type	enum	Der Typ der Datenquelle, immer azure_ai_synthetic_data_gen_preview. Mögliche Werte: azure_ai_synthetic_data_gen_preview	Ja

SyntheticDataGenerationPreviewItemGenerationParams

Name	Typ	Description	Required	Vorgabe
model_deployment_name (Modellbereitstellungsname)	Schnur	Der Name der Modellbereitstellung, die zum Generieren synthetischer Daten verwendet werden soll.	Ja
output_dataset_id	Zeichenfolge (schreibgeschützt)	Der Bezeichner des Ausgabe-Datasets, in dem generierte synthetische Daten gespeichert werden. Die generierten Daten sind eine JSONL-Datei mit Spalten-ID, Abfrage und test_description.	No
output_dataset_name	Schnur	Der Name des Ausgabedatensets, in dem generierte synthetische Daten gespeichert werden. Wenn nicht angegeben, generiert der Dienst den Datasetnamen automatisch.	No
Eingabeaufforderung	Schnur	Die Aufforderung zum Generieren synthetischer Daten. Dies ist die Option, wenn das Ziel vom Typ "azure_ai_agent" mit Anweisungen im Agent konfiguriert ist.	No
samples_count	integer	Die maximale Anzahl der zu generierenden Datenbeispiele.	Ja
Quellen	Array von OpenAI.EvalJsonlFileIdSource	Die optionalen Seed-Datenquellendateien für die Datengenerierung.	Ja
type	enum	Der Typ der Elementgenerierungsparameter. Mögliche Werte: synthetic_data_gen_preview	Ja

Ziel

Basisklasse für Ziele mit Diskriminatorunterstützung.

Diskriminator für Ziel

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

Typwert	Schema
azure_ai_model	AzureAIModelTarget
azure_ai_agent	AzureAIAgentTarget

Name	Typ	Description	Required	Vorgabe
type	Schnur	Der Zieltyp.	Ja

TargetCompletionEvalRunDataSource

Stellt eine Datenquelle für die zielbasierte Abschlussauswertungskonfiguration dar.

Name	Typ	Description	Required	Vorgabe
Eingabenachrichten	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		No
└– item_reference	Schnur		Ja
└– Typ	enum	Mögliche Werte: item_reference	Ja
source	OpenAI.EvalJsonlFileContentSource oder OpenAI.EvalJsonlFileIdSource	Die Quellkonfiguration für Inline- oder Dateidaten.	Ja
target	Ziel	Basisklasse für Ziele mit Diskriminatorunterstützung.	Ja
└– Typ	Schnur	Der Zieltyp.	Ja
type	enum	Der Typ der Datenquelle, immer azure_ai_target_completions. Mögliche Werte: azure_ai_target_completions	Ja

TargetConfig

Abstrakte Klasse für die Zielkonfiguration.

Diskriminator für TargetConfig

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

Typwert	Schema
AzureOpenAIModel	AzureOpenAIModelConfiguration

Name	Typ	Description	Required	Vorgabe
type	Schnur	Typ der Modellkonfiguration.	Ja

TargetUpdate

Basisklasse für Ziele mit Diskriminatorunterstützung.

Diskriminator für TargetUpdate

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

Typwert	Schema
azure_ai_model	AzureAIModelTargetUpdate
azure_ai_agent	AzureAIAgentTargetUpdate

Name	Typ	Description	Required	Vorgabe
type	Schnur	Der Zieltyp.	Ja

TaxonomyCategory

Definition der Taxonomie-Kategorie.

Name	Typ	Description	Required	Vorgabe
description	Schnur	Beschreibung der Taxonomiekategorie.	No
id	Schnur	Eindeutiger Bezeichner der Taxonomiekategorie.	Ja
Name	Schnur	Name der Taxonomiekategorie.	Ja
properties	Objekt	Zusätzliche Eigenschaften für die Taxonomiekategorie.	No
riskCategory	RiskCategory	Risikokategorie für das Angriffsziel.	Ja
Unterkategorie	Array von TaxonomySubCategory	Liste der Taxonomieunterkategorien.	Ja

TaxonomySubCategory

Definition der Taxonomie-Unterkategorie.

Name	Typ	Description	Required	Vorgabe
description	Schnur	Beschreibung der Taxonomieunterkategorie.	No
enabled	boolean	Liste der Taxonomieelemente unter dieser Unterkategorie.	Ja
id	Schnur	Eindeutiger Bezeichner der Taxonomieunterkategorie.	Ja
Name	Schnur	Name der Taxonomieunterkategorie.	Ja
properties	Objekt	Zusätzliche Eigenschaften für die Taxonomieunterkategorie.	No

ToolDescription

Beschreibung eines Werkzeugs, das von einem Agenten verwendet werden kann.

Name	Typ	Description	Required	Vorgabe
description	Schnur	Eine kurze Beschreibung des Zwecks des Tools.	No
Name	Schnur	Der Name des Tools.	No

ToolProjectConnection

Eine project Verbindungsressource.

Name	Typ	Description	Required	Vorgabe
project_connection_id	Schnur	Eine Projektverbindung in einem ToolProjectConnectionList, das diesem Tool zugeordnet ist.	Ja

TracesPreviewEvalRunDataSource

Stellt eine Datenquelle für Auswertungsläufe dar, die über agent-Ablaufverfolgungen ausgeführt werden, die in Application Insights gespeichert sind.

Name	Typ	Description	Required	Vorgabe
agent_id	Schnur	Die Agent-ID zum Filtern von Ablaufverfolgungen für die Auswertung.	No
agent_name	Schnur	Der Agentname, der zum Filtern von Ablaufverfolgungen für die Auswertung verwendet wird.	No
End_time	integer	Unix-Zeitstempel (in Sekunden) markieren das Ende des Ablaufverfolgungsabfragefensters. Standardmäßig ist die aktuelle Uhrzeit eingestellt.	No
ingestion_delay_seconds	integer	Die Verzögerung, die beim Abfragen von Ablaufverfolgungen für die Erfassung gilt.	No	300
lookback_hours	integer	Lookbackfenster (in Stunden), das beim Abrufen von Ablaufverfolgungen aus Application Insights angewendet wird. Bei geplanten Auswertungen wird dies aus dem Serienintervall abgeleitet.	No	168
max_traces	integer	Stichprobenlimit wird auf zur Auswertung abgerufene Spuren angewendet.	No	1.000
trace_ids	Array von Strings	Sammlung von Agent-Ablaufverfolgungs-IDs, die ausgewertet werden sollen.	No
type	enum	Der Typ der Datenquelle, immer azure_ai_traces_preview. Mögliche Werte: azure_ai_traces_preview	Ja

TreatmentEffectType

Art der Behandlungswirkung.

Property	Wert
Beschreibung	Art der Behandlungswirkung.
Typ	Schnur
Werte	TooFewSamples Inconclusive Changed Improved Degraded

Trigger

Basismodell für Trigger des Zeitplans.

Diskriminator für Trigger

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

Typwert	Schema
Cron	CronTrigger (Englisch)
Recurrence	RecurrenceTrigger-
OneTime	OneTimeTrigger

Name	Typ	Description	Required	Vorgabe
type	Trigger-Typ	Typ des Auslösers.	Ja

AuslöserTyp

Typ des Auslösers.

Property	Wert
Beschreibung	Typ des Auslösers.
Typ	Schnur
Werte	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

Name	Typ	Description	Required	Vorgabe
description	Schnur	Eine lesbare Beschreibung des Agents. Einschränkungen: maxLength: 512	No
manifest_id	Schnur	Die Manifest-ID, aus der die Agentversion importiert werden soll.	Ja
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
parameter_values	Objekt	Die Eingaben in das Manifest, die zu einem vollständig materialisierten Agent führen.	Ja

UpdateAgentRequest

Name	Typ	Description	Required	Vorgabe
Definition	AgentDefinition		Ja
└– Art	AgentKind		Ja
└- rai_config	RaiConfig	Konfiguration für die Inhaltsfilterung und Sicherheitsfunktionen von Responsible AI (RAI).	No
description	Schnur	Eine lesbare Beschreibung des Agents. Einschränkungen: maxLength: 512	No
metadata	Objekt	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No

UpdateEvalParametersBody

Name	Typ	Description	Required	Vorgabe
metadata	OpenAI.Metadata (nullable)	Satz von 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können. Dies kann sein. nützlich zum Speichern zusätzlicher Informationen über das Objekt in einer strukturierten Form. Formatieren und Abfragen von Objekten über die API oder das Dashboard. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit einer maximalen Länge von 512 Zeichen.	No
Name	Schnur		No
properties	Objekt	Satz unveränderlicher 16 Schlüsselwertpaare, die an ein Objekt angefügt werden können, um zusätzliche Informationen zu speichern. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.	No

UserProfileMemoryItem

Ein Speicherelement, das speziell Benutzerprofilinformationen enthält, die aus Unterhaltungen extrahiert wurden, z. B. Vorlieben, Interessen und persönliche Details.

Name	Typ	Description	Required	Vorgabe
Inhalt	Schnur	Der Inhalt des Speichers.	Ja
kind	enum	Die Art des Speicherelements. Mögliche Werte: user_profile	Ja
memory_id	Schnur	Die eindeutige ID des Speicherelements.	Ja
scope	Schnur	Der Namespace, der Speicher logisch gruppiert und isoliert, z. B. eine Benutzer-ID.	Ja
updated_at	integer	Der Zeitpunkt der letzten Aktualisierung des Speicherelements.	Ja

WebSearchConfiguration

Eine Websuchkonfiguration für bing benutzerdefinierte Suche

Name	Typ	Description	Required	Vorgabe
instance_name	Schnur	Name der benutzerdefinierten Konfigurationsinstanz, die für die Konfiguration angegeben wird.	Ja
project_connection_id	Schnur	Project Verbindungs-ID für das Erding mit der benutzerdefinierten Bing-Suche	Ja

WeeklyRecurrenceSchedule

Wöchentlicher Wiederholungsplan.

Name	Typ	Description	Required	Vorgabe
TageDerWoche	Array von DayOfWeek	Tage der Woche für den Terminplan der Serie.	Ja
type	enum	Wöchentlicher Serientyp. Mögliche Werte: Weekly	Ja

WorkflowActionOutputItem

Name	Typ	Description	Required	Vorgabe
action_id	Schnur	Eindeutiger Bezeichner für die Aktion.	Ja
agent_reference	AgentReference		No
└– Name	Schnur	Der Name des Agents. Einschränkungen: maxLength: 256	Ja
└– Typ	enum	Mögliche Werte: agent_reference	Ja
└– Version	Schnur	Der Versionsbezeichner des Agents.	No
kind	Schnur	Die Art der CSDL-Aktion (z. B. 'SetVariable', 'InvokeAzureAgent').	Ja
parent_action_id	Schnur	ID der übergeordneten Aktion, wenn dies eine geschachtelte Aktion ist.	No
previous_action_id	Schnur	ID der vorherigen Aktion, wenn diese Aktion einem anderen folgt.	No
response_id	Schnur	Die Antwort, auf der das Element erstellt wird.	No
status	enum	Status der Aktion (z. B. "in_progress", "abgeschlossen", "fehlgeschlagen", "abgebrochen"). Mögliche Werte: completed, , failed, in_progresscancelled	Ja
type	enum	Mögliche Werte: workflow_action	Ja

WorkflowAgentDefinition

Die Definition des Workflow-Agents.

Name	Typ	Description	Required	Vorgabe
kind	enum	Mögliche Werte: workflow	Ja
rai_config	RaiConfig	Konfiguration für die Inhaltsfilterung und Sicherheitsfunktionen von Responsible AI (RAI).	No
└– rai_policy_name	Schnur	Der Name der zu übernehmenden RAI-Richtlinie.	Ja
Arbeitsablauf	Schnur	Die CSDL YAML-Definition des Workflows.	No

integer

Typ: ganze Zahl

Format: int64