Azure AI Foundry Agent Service (Vorschau)

Integrieren Sie einfach Azure AI Foundry Agent Service Funktionen in Ihre Workflows.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Norm Alle Power Automate Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     - Azure Government Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Norm Alle Power Apps Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Norm Alle Power Automate Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Microsoft
URL https://support.microsoft.com
Connectormetadaten
Publisher Microsoft
Webseite https://learn.microsoft.com/en-us/azure/ai-services/agents/
Datenschutzrichtlinie https://learn.microsoft.com/en-us/legal/cognitive-services/agents/data-privacy-security
Kategorien Künstliche Intelligenz; Business Intelligence

Azure AI Agent Service ist ein vollständig verwalteter Dienst, der Entwicklern die Möglichkeit gibt, qualitativ hochwertige und erweiterbare KI-Agents sicher zu erstellen, bereitzustellen und zu skalieren, ohne die zugrunde liegenden Compute- und Speicherressourcen verwalten zu müssen. Azure AI Agent Service integriert Modelle, Tools und Technologien und ermöglicht Es Ihnen, Agents mit Wissen aus verbundenen Quellen (z. B. Bing Search, SharePoint, Fabric, Azure Blob Storage und lizenzierten Daten) und Aktionen mit Tools wie Azure Logic Apps, Azure Functions, OpenAPI 3.0 angegebene Tools und Code-Interpreter

Voraussetzungen

Holen Sie Ihre Anmeldeinformationen ab

Um Ihre API-Anforderungen zu authentifizieren, benötigen Sie den Endpunkt für Ihre Azure AI Agent Service-Ressourcen.

Für Ihre Azure AI Agent Service-Ressource:

  1. Navigieren Sie im portal Azure zu Ihrer Ressource.
  2. Wählen Sie auf der Seite für Ihre Ressource im linken Navigationsmenü "Schlüssel" und "Endpunkt " aus. Notieren Sie sich Ihre Anmeldeinformationen. Sie verwenden einen Ihrer Schlüssel und Ihren Endpunkt.

Bekannte Probleme und Einschränkungen

  • Nur Azure AI-Agent-Dienst wird als Agentdienst mit diesem Power Platform-Connector nur für Logik-Apps unterstützt. Nicht für Power Automate- und Power-Apps

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:
Verwaltete Identität Erstellen einer Verbindung mithilfe einer verwalteten Identität NUR LOGICAPPS Freigabefähig
Microsoft Entra ID Benutzeranmeldung Anmelden mit Microsoft Entra ID Anmeldeinformationen Alle Regionen Nicht teilbar
Standard [VERALTET] Diese Option ist nur für ältere Verbindungen ohne expliziten Authentifizierungstyp vorgesehen und wird nur aus Gründen der Abwärtskompatibilität bereitgestellt. Alle Regionen Nicht teilbar

Verwaltete Identität

Auth-ID: managedIdentityAuth

Anwendbar: NUR LOGICAPPS

Erstellen einer Verbindung mithilfe einer verwalteten Identität

Dies ist eine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird auch die Verbindung freigegeben. Weitere Informationen finden Sie in der Übersicht über Connectors für Canvas-Apps – Power Apps | Microsoft-Dokumentation

Name Typ Description Erforderlich
Verwaltete Identität managedIdentity Anmelden mit einer verwalteten Identität Richtig
Azure AI-Project-Endpunkt Schnur Der Name des Azure AI-Project Endpunkts wie https://{account-name}.services.ai.azure. com/api/projects/{project-name} Richtig

Microsoft Entra ID Benutzeranmeldung

Auth-ID: entraIDUserLogin

Anwendbar: Alle Regionen

Anmelden mit Microsoft Entra ID Anmeldeinformationen

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
Azure AI-Project-Endpunkt Schnur Der Name des Azure AI-Project Endpunkts wie https://{account-name}.services.ai.azure. com/api/projects/{project-name} Richtig

Standard [VERALTET]

Anwendbar: Alle Regionen

Diese Option ist nur für ältere Verbindungen ohne expliziten Authentifizierungstyp vorgesehen und wird nur aus Gründen der Abwärtskompatibilität bereitgestellt.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 1000 60 Sekunden

Aktionen

Agent holen

Ruft einen Agent und seine neueste Version ab.
Agent löschen

Löscht einen Agent und alle zugehörigen Versionen endgültig. Bei gehosteten Agents verursachen aktive Sitzungen einen Konflikt, es sei denn, das Löschen erzwingen ist aktiviert.
Agents auflisten (Agent-Dienst)

Agents von Agent-Dienst auflisten
Agentversion abrufen

Ruft eine bestimmte Version eines Agents ab.
Agentversion löschen

Löscht dauerhaft eine bestimmte Agentversion. Bei gehosteten Agents verursachen aktive Sitzungen einen Konflikt, es sei denn, das Löschen erzwingen ist aktiviert.
Agentversionen auflisten

Listet Versionen eines Agents auf.
Aktivieren des gehosteten Agents

Aktiviert einen gehosteten Agent-Endpunkt, damit er Anforderungen erfüllen kann.
Aktualisieren des Routings des gehosteten Agents

Aktualisiert den Endpunkt des gehosteten Agents, um 100 Prozent des Datenverkehrs an eine bestimmte aktive Agent-Version weiterzuleiten. Entwurfsversionen können keine Routingziele sein.
Auflisten von Agenten

Auflisten von Agenten
Aufrufen des Eingabeaufforderungs-Agents

Ruft einen Eingabeaufforderungs-Agent auf.
Aufrufen des gehosteten Agents (Antworten)

Ruft einen gehosteten Agent auf, der das Antwortprotokoll verfügbar macht. Die Aktion verwendet JSON-Antworten ohne Streaming.
Aufrufen des gehosteten Agents (Aufrufe)

Ruft einen gehosteten Agent auf, der das Aufrufprotokoll verfügbar macht. Die Anforderungs- und Antwort-JSON werden von der Implementierung des gehosteten Agents definiert.
Erstellen der Version des Eingabeaufforderungs-Agents

Erstellt eine neue Eingabeaufforderungs-Agent-Version mithilfe einer Modellbereitstellung, Anweisungen und optionalen Tools.
Erstellen der Version des gehosteten Agents

Erstellt eine neue gehostete Agent-Version aus einem Containerimage.
Erstellen eines gehosteten Agents

Erstellt einen gehosteten Agent und seine ursprüngliche Version aus einem Containerimage.
Gehostete Sitzung abrufen

Ruft eine gehostete Agent-Sitzung anhand des Sitzungsbezeichners ab.
Gehostete Sitzung erstellen

Erstellt eine gehostete Agentsitzung. Wählen Sie optional eine bestimmte Agentversion aus; andernfalls wählt die Routingkonfiguration des gehosteten Agents die Version aus.
Gehostete Sitzung löschen

Löscht eine gehostete Agentsitzung, beendet den Sandkasten und gibt seine Ressourcen frei.
Gehostete Sitzungen auflisten

Listet gehostete Sitzungen für einen Agent auf, auf den der Anrufer zugreifen kann.
Gehostete Sitzungsdatei herunterladen

Lädt den binären Inhalt einer Datei aus einer gehosteten Sitzung herunter.
Gehostete Sitzungsdatei hochladen

Lädt unformatierte Dateiinhalte in eine gehostete Sitzung hoch. Die maximale Dateigröße beträgt 50 MB.
Gehostete Sitzungsdatei löschen

Löscht eine Datei oder ein Verzeichnis aus einer gehosteten Sitzung.
Gehostete Sitzungsdateien auflisten

Listet Dateien und Verzeichnisse in einem Pfad in einer gehosteten Sitzung auf.
Gehosteter Agent deaktivieren

Deaktiviert einen gehosteten Agent-Endpunkt, ohne den Agent oder seine Versionen zu löschen.
Lauf erstellen

Lauf erstellen
Lauf starten

Lauf starten
Nachrichten auflisten

Nachrichten auflisten
Thread erstellen

Thread erstellen

Agent holen

Vorgangs-ID:
GetAgentFromService

Ruft einen Agent und seine neueste Version ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.

Gibt zurück

Body
AgentRecord

Agent löschen

Vorgangs-ID:
DeleteAgent

Löscht einen Agent und alle zugehörigen Versionen endgültig. Bei gehosteten Agents verursachen aktive Sitzungen einen Konflikt, es sei denn, das Löschen erzwingen ist aktiviert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Löschen erzwingen
 force boolean

Löschen Sie für gehostete Agents aktive Sitzungen, die dem Agent oder der Version zugeordnet sind.

Agents auflisten (Agent-Dienst)

Vorgangs-ID:
ListAgentsFromService

Agents von Agent-Dienst auflisten

Gibt zurück

Body
listAgentsServiceResponse

Agentversion abrufen

Vorgangs-ID:
GetAgentVersion

Ruft eine bestimmte Version eines Agents ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Agent-Version
 AgentVersion True string

Der Versionsbezeichner des Agents.

Gibt zurück

Body
AgentVersionRecord

Agentversion löschen

Vorgangs-ID:
DeleteAgentVersion

Löscht dauerhaft eine bestimmte Agentversion. Bei gehosteten Agents verursachen aktive Sitzungen einen Konflikt, es sei denn, das Löschen erzwingen ist aktiviert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Agent-Version
 AgentVersion True string

Der Versionsbezeichner des Agents.
Löschen erzwingen
 force boolean

Löschen Sie für gehostete Agents aktive Sitzungen, die dem Agent oder der Version zugeordnet sind.

Agentversionen auflisten

Vorgangs-ID:
ListAgentVersions

Listet Versionen eines Agents auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Entwurfsversionen einschließen
 include_drafts boolean

Gibt an, ob Entwurfsversionen eingeschlossen werden sollen. Der Dienst schließt standardmäßig Entwürfe aus.
Limit
 limit integer

Die maximale Anzahl der zurückzugebenden Versionen.
Bestellung
 order string

Sortierreihenfolge nach dem created_at Zeitstempel.
Nach dem Cursor
 after string

Gibt Versionen nach diesem Cursor zurück.
Vor dem Cursor
 before string

Gibt Versionen vor diesem Cursor zurück.

Gibt zurück

Body
AgentVersionListResponse

Aktivieren des gehosteten Agents

Vorgangs-ID:
EnableHostedAgent

Aktiviert einen gehosteten Agent-Endpunkt, damit er Anforderungen erfüllen kann.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.

Aktualisieren des Routings des gehosteten Agents

Vorgangs-ID:
UpdateHostedAgentRouting

Aktualisiert den Endpunkt des gehosteten Agents, um 100 Prozent des Datenverkehrs an eine bestimmte aktive Agent-Version weiterzuleiten. Entwurfsversionen können keine Routingziele sein.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Agent-Version
 agent_version True string

Die aktive, Nicht-Entwurfs-Agent-Version, die Endpunktdatenverkehr empfängt.

Gibt zurück

Body
AgentRecord

Auflisten von Agenten

Vorgangs-ID:
ListAgents

Auflisten von Agenten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
API-Version
 api-version True string

API-Version

Gibt zurück

Body
listAgentsResponse

Aufrufen des Eingabeaufforderungs-Agents

Vorgangs-ID:
InvokeAgent

Ruft einen Eingabeaufforderungs-Agent auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
API-Version
 api-version True string

API-Version
metadata
 metadata object

16 Schlüssel-Wert-Paare, 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.
user
 user string

Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen. Erfahren Sie mehr.
top_logprobs
 top_logprobs integer

Eine ganze Zahl zwischen 0 und 20, die die Anzahl der Token angibt, die an jeder Tokenposition höchstwahrscheinlich zurückgegeben werden, jeweils mit einer zugeordneten Protokollwahrscheinlichkeit.
previous_response_id
 previous_response_id string

Die eindeutige ID der vorherigen Antwort auf das Modell. Verwenden Sie diese Option, um Multi-Turn-Unterhaltungen zu erstellen. Erfahren Sie mehr über den Unterhaltungsstatus.
background
 background boolean

Gibt an, ob die Modellantwort im Hintergrund ausgeführt werden soll. Erfahren Sie mehr.
max_output_tokens
 max_output_tokens integer

Eine obere Grenze für die Anzahl der Token, die für eine Antwort generiert werden können, einschließlich sichtbarer Ausgabetoken und Begründungstoken.
max_tool_calls
 max_tool_calls integer

Die maximale Anzahl aller Aufrufe an integrierte Tools, die in einer Antwort verarbeitet werden können. Diese maximale Anzahl gilt für alle integrierten Toolaufrufe, nicht pro einzelnes Tool. Alle weiteren Versuche, ein Tool durch das Modell aufzurufen, werden ignoriert.
type
 type True string

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 in der Anleitung „Strukturierte Ausgaben“.

Das Standardformat ist { "type": "text" } ohne zusätzliche Optionen verfügbar.

Nicht empfohlen für gpt-4o und neuere Modelle:

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.
type
 type True string

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

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.
id
 id True string

Der eindeutige Bezeichner der zu verwendenden Promptvorlage.
Ausgabe
 version string

Optionale Version der Promptvorlage.
variables
 variables object

Optionale Zuordnung von Werten, die Variablen in Ihrem Prompt ersetzen sollen. Die Ersetzungswerte können entweder Zeichenfolgen oder andere Antworteingabetypen wie Bilder oder Dateien sein.
truncation
 truncation string

Die Abkürzungsstrategie, die für die Modellantwort verwendet werden soll.

  • auto: Wenn der Kontext dieser Antwort und früherer Antworten die Größe des Kontextfensters des Modells überschreitet, schneidet das Modell die Antwort ab, um das Kontextfenster anzupassen, indem Eingabeelemente in der Mitte der Unterhaltung gelöscht werden.
  • disabled (Standard): Wenn eine Modellantwort die Kontextfenstergröße für ein Modell überschreitet, schlägt die Anforderung mit einem Fehler von 400 fehl.
Eingabe
 input

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

Weitere Informationen:
einschließen
 include string

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

  • code_interpreter_call.outputs: Enthält die Ausgaben der Python-Codeausführung in den Toolaufrufelementen des Code-Interpreters.
  • 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 Protokollwahrscheinlichkeiten (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).
Parallele Werkzeugaufrufe
 parallel_tool_calls boolean

Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.
store
 store boolean

Gibt an, ob die generierte Modellantwort für den späteren Abruf über die API gespeichert werden soll.
instructions
 instructions string

Eine Systemnachricht (oder Entwicklernachricht), die in den Kontext des Modells eingefügt wurde.

Bei gleichzeitiger Verwendung mit previous_response_id werden die Anweisungen aus einer vorherigen Antwort nicht in die nächste Antwort übernommen. Dies erleichtert das Austauschen von Systemnachrichten (oder Entwicklernachrichten) in neuen Antworten.
Unterhaltungs-ID
 id True string

Unterhaltungs-ID. Wählen Sie "Neue Unterhaltung erstellen" aus, um eine neue Unterhaltung zu erstellen.
type
 type True string
name
 name True string

Der Name des Agents.
Ausgabe
 version True string

Der Versionsbezeichner des Agents.

Gibt zurück

Body
OpenAI.Response

Aufrufen des gehosteten Agents (Antworten)

Vorgangs-ID:
InvokeHostedAgentResponses

Ruft einen gehosteten Agent auf, der das Antwortprotokoll verfügbar macht. Die Aktion verwendet JSON-Antworten ohne Streaming.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Input
 input True

Text, Bild, Datei oder strukturierte Eingabe für den gehosteten Agent.
Vorherige Antwort-ID
 previous_response_id string

Der vorherige Antwortbezeichner, um eine Multi-Turn-Interaktion fortzusetzen.
Instructions
 instructions string

Zusätzliche Anweisungen für diese Antwort.
Store-Antwort
 store boolean

Gibt an, ob die Antwort für den späteren Abruf gespeichert werden soll.
Ausführen im Hintergrund
 background boolean

Gibt an, ob die Antwort im Hintergrund ausgeführt werden soll.
Maximale Ausgabetoken
 max_output_tokens integer

Die maximale Anzahl von Ausgabetoken.
Metadata
 metadata object

Metadaten, die der Antwort zugeordnet werden sollen.
User
 user string

Ein eindeutiger Bezeichner für den Endbenutzer.

Gibt zurück

Body
OpenAI.Response

Aufrufen des gehosteten Agents (Aufrufe)

Vorgangs-ID:
InvokeHostedAgentInvocations

Ruft einen gehosteten Agent auf, der das Aufrufprotokoll verfügbar macht. Die Anforderungs- und Antwort-JSON werden von der Implementierung des gehosteten Agents definiert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
object

Die JSON-Nutzlast, die vom Aufrufhandler des gehosteten Agents erwartet wird.

Gibt zurück

response
object

Erstellen der Version des Eingabeaufforderungs-Agents

Vorgangs-ID:
CreatePromptAgentVersion

Erstellt eine neue Eingabeaufforderungs-Agent-Version mithilfe einer Modellbereitstellung, Anweisungen und optionalen Tools.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Description
 description string

Eine lesbare Beschreibung der Eingabeaufforderungs-Agent-Version.
Metadata
 metadata object

Metadaten, die der Eingabeaufforderungs-Agent-Version zugeordnet werden sollen.
Als Entwurf erstellen
 draft boolean

Gibt an, ob eine Entwurfsversion erstellt werden soll.
Modellbereitstellung
 model True string

Der Name einer Modellbereitstellung, die im aktuellen Foundry-Projekt verfügbar ist. Unterstützte Direkte Foundry-Modellnamen können auch manuell eingegeben werden.
Instructions
 instructions string

Systemanweisungen, die das Verhalten des Eingabeaufforderungs-Agents definieren.
Tools
 Tools object
Toolauswahl
 tool_choice

Steuert, wie der Eingabeaufforderungs-Agent Tools auswählt.
Temperatur
 temperature float

Probenahmetemperatur zwischen 0 und 2.
Bester P
 top_p float

Kernsamplingwahrscheinlichkeit zwischen 0 und 1.
Textkonfiguration
 text object

Optionale Text- und strukturierte Ausgabekonfiguration.
Begründungskonfiguration
 reasoning object

Optionale Begründungskonfiguration für unterstützte Modelle.
Fähigkeiten
 Skills object
Strukturierte Eingaben
 structured_inputs object

Optionale strukturierte Eingabedefinitionen.
Harness
 harness object

Optionale Konfiguration der Agent-Nutzung.

Gibt zurück

Body
AgentVersionRecord

Erstellen der Version des gehosteten Agents

Vorgangs-ID:
CreateHostedAgentVersion

Erstellt eine neue gehostete Agent-Version aus einem Containerimage.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Description
 description string

Eine lesbare Beschreibung der gehosteten Agent-Version.
Metadata
 metadata object

Metadaten, die der gehosteten Agentversion zugeordnet werden sollen.
Als Entwurf erstellen
 draft boolean

Gibt an, ob eine Entwurfsversion erstellt werden soll. Entwurfsversionen werden von normalem Routing und Auflistungen ausgeschlossen.
Containerimage
 image True string

Der vollständige Containerimageverweis, z. B. myregistry.azurecr.io/my-agent:v1.
Registrierungsverbindungs-ID
 registry_connection_id string

Der Verbindungsbezeichner des Foundry-Projekts für die Containerregistrierung, falls erforderlich.
CPU
 cpu True string

Die Anzahl der FÜR den gehosteten Agentcontainer angeforderten CPU-Kerne, z. B. 1.
Gedächtnis
 memory True string

Der für den gehosteten Agentcontainer angeforderte Arbeitsspeicher, z. B. 2Gi.
Protocol
 protocol True string

Das Protokoll, das vom gehosteten Agent verfügbar gemacht wird. Wählen Sie Antworten oder Aufrufe aus.
Umgebungsvariablen
 environment_variables object

Umgebungsvariablen, die an den gehosteten Agentcontainer übergeben werden.
Verantwortungsvolle KI-Konfiguration
 rai_config object

Optionale verantwortungsvolle KI-Inhaltsfilterkonfiguration.
Telemetriekonfiguration
 telemetry_config object

Optionale Telemetriekonfiguration.
Sitzungskonfiguration
 session_configuration object

Optionale Konfiguration für gehostete Agent-Sitzungen.

Gibt zurück

Body
AgentVersionRecord

Erstellen eines gehosteten Agents

Vorgangs-ID:
CreateHostedAgent

Erstellt einen gehosteten Agent und seine ursprüngliche Version aus einem Containerimage.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 name True string

Der Name des gehosteten Agents.
Description
 description string

Eine lesbare Beschreibung des gehosteten Agents.
Metadata
 metadata object

Metadaten, die dem gehosteten Agent zugeordnet werden sollen.
Containerimage
 image True string

Der vollständige Containerimageverweis, z. B. myregistry.azurecr.io/my-agent:v1.
Registrierungsverbindungs-ID
 registry_connection_id string

Der Verbindungsbezeichner des Foundry-Projekts für die Containerregistrierung, falls erforderlich.
CPU
 cpu True string

Die Anzahl der FÜR den gehosteten Agentcontainer angeforderten CPU-Kerne, z. B. 1.
Gedächtnis
 memory True string

Der für den gehosteten Agentcontainer angeforderte Arbeitsspeicher, z. B. 2Gi.
Protocol
 protocol True string

Das Protokoll, das vom gehosteten Agent verfügbar gemacht wird. Wählen Sie Antworten oder Aufrufe aus.
Umgebungsvariablen
 environment_variables object

Umgebungsvariablen, die an den gehosteten Agentcontainer übergeben werden.
Verantwortungsvolle KI-Konfiguration
 rai_config object

Optionale verantwortungsvolle KI-Inhaltsfilterkonfiguration.
Telemetriekonfiguration
 telemetry_config object

Optionale Telemetriekonfiguration.
Sitzungskonfiguration
 session_configuration object

Optionale Konfiguration für gehostete Agent-Sitzungen.

Gibt zurück

Body
AgentVersionRecord

Gehostete Sitzung abrufen

Vorgangs-ID:
GetHostedSession

Ruft eine gehostete Agent-Sitzung anhand des Sitzungsbezeichners ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Benutzerisolationsschlüssel
 x-ms-user-isolation-key string

Ein optionaler Partitionierungsschlüssel für gehostete Agents, die mit headerbasierter Sitzungsisolation konfiguriert sind. Verwenden Sie für jeden Vorgang in der Sitzung denselben Wert. Dieser Schlüssel stellt keine Authentifizierung bereit.
Sitzungs-ID
 SessionId True string

Der gehostete Sitzungsbezeichner.

Gibt zurück

Body
HostedSession

Gehostete Sitzung erstellen

Vorgangs-ID:
CreateHostedSession

Erstellt eine gehostete Agentsitzung. Wählen Sie optional eine bestimmte Agentversion aus; andernfalls wählt die Routingkonfiguration des gehosteten Agents die Version aus.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Benutzerisolationsschlüssel
 x-ms-user-isolation-key string

Ein optionaler Partitionierungsschlüssel für gehostete Agents, die mit headerbasierter Sitzungsisolation konfiguriert sind. Verwenden Sie für jeden Vorgang in der Sitzung denselben Wert. Dieser Schlüssel stellt keine Authentifizierung bereit.
Agent-Version
 agent_version string

Eine bestimmte version des gehosteten Agents für die Sitzung. Lassen Sie den Wert leer, um die Routingkonfiguration des gehosteten Agents zu verwenden.

Gibt zurück

Body
HostedSession

Gehostete Sitzung löschen

Vorgangs-ID:
DeleteHostedSession

Löscht eine gehostete Agentsitzung, beendet den Sandkasten und gibt seine Ressourcen frei.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Benutzerisolationsschlüssel
 x-ms-user-isolation-key string

Ein optionaler Partitionierungsschlüssel für gehostete Agents, die mit headerbasierter Sitzungsisolation konfiguriert sind. Verwenden Sie für jeden Vorgang in der Sitzung denselben Wert. Dieser Schlüssel stellt keine Authentifizierung bereit.
Sitzungs-ID
 SessionId True string

Der gehostete Sitzungsbezeichner.

Gehostete Sitzungen auflisten

Vorgangs-ID:
ListHostedSessions

Listet gehostete Sitzungen für einen Agent auf, auf den der Anrufer zugreifen kann.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Benutzerisolationsschlüssel
 x-ms-user-isolation-key string

Ein optionaler Partitionierungsschlüssel für gehostete Agents, die mit headerbasierter Sitzungsisolation konfiguriert sind. Verwenden Sie für jeden Vorgang in der Sitzung denselben Wert. Dieser Schlüssel stellt keine Authentifizierung bereit.

Gibt zurück

Body
HostedSessionListResponse

Gehostete Sitzungsdatei herunterladen

Vorgangs-ID:
DownloadHostedSessionFile

Lädt den binären Inhalt einer Datei aus einer gehosteten Sitzung herunter.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Benutzerisolationsschlüssel
 x-ms-user-isolation-key string

Ein optionaler Partitionierungsschlüssel für gehostete Agents, die mit headerbasierter Sitzungsisolation konfiguriert sind. Verwenden Sie für jeden Vorgang in der Sitzung denselben Wert. Dieser Schlüssel stellt keine Authentifizierung bereit.
Sitzungs-ID
 SessionId True string

Der gehostete Sitzungsbezeichner.
Dateipfad
 path True string

Der Pfad der Datei oder des Verzeichnisses in der gehosteten Sitzung.

Gibt zurück

Der Inhalt der gehosteten Sitzungsdatei.

Dateiinhalt
binary

Gehostete Sitzungsdatei hochladen

Vorgangs-ID:
UploadHostedSessionFile

Lädt unformatierte Dateiinhalte in eine gehostete Sitzung hoch. Die maximale Dateigröße beträgt 50 MB.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Benutzerisolationsschlüssel
 x-ms-user-isolation-key string

Ein optionaler Partitionierungsschlüssel für gehostete Agents, die mit headerbasierter Sitzungsisolation konfiguriert sind. Verwenden Sie für jeden Vorgang in der Sitzung denselben Wert. Dieser Schlüssel stellt keine Authentifizierung bereit.
Sitzungs-ID
 SessionId True string

Der gehostete Sitzungsbezeichner.
Dateipfad
 path True string

Der Pfad der Datei oder des Verzeichnisses in der gehosteten Sitzung.
Dateiinhalt
 body True binary

Der binäre Inhalt der hochzuladenden Datei.

Gibt zurück

Body
HostedSessionFileUploadResponse

Gehostete Sitzungsdatei löschen

Vorgangs-ID:
DeleteHostedSessionFile

Löscht eine Datei oder ein Verzeichnis aus einer gehosteten Sitzung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Benutzerisolationsschlüssel
 x-ms-user-isolation-key string

Ein optionaler Partitionierungsschlüssel für gehostete Agents, die mit headerbasierter Sitzungsisolation konfiguriert sind. Verwenden Sie für jeden Vorgang in der Sitzung denselben Wert. Dieser Schlüssel stellt keine Authentifizierung bereit.
Sitzungs-ID
 SessionId True string

Der gehostete Sitzungsbezeichner.
Dateipfad
 path True string

Der Pfad der Datei oder des Verzeichnisses in der gehosteten Sitzung.

Gehostete Sitzungsdateien auflisten

Vorgangs-ID:
ListHostedSessionFiles

Listet Dateien und Verzeichnisse in einem Pfad in einer gehosteten Sitzung auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.
Benutzerisolationsschlüssel
 x-ms-user-isolation-key string

Ein optionaler Partitionierungsschlüssel für gehostete Agents, die mit headerbasierter Sitzungsisolation konfiguriert sind. Verwenden Sie für jeden Vorgang in der Sitzung denselben Wert. Dieser Schlüssel stellt keine Authentifizierung bereit.
Sitzungs-ID
 SessionId True string

Der gehostete Sitzungsbezeichner.
Verzeichnispfad
 path string

Der Verzeichnispfad zur Liste. Der Standardwert ist das aktuelle Verzeichnis der Sitzung.

Gibt zurück

Body
HostedSessionFileListResponse

Gehosteter Agent deaktivieren

Vorgangs-ID:
DisableHostedAgent

Deaktiviert einen gehosteten Agent-Endpunkt, ohne den Agent oder seine Versionen zu löschen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Agentname
 AgentName True string

Der Name des Agents.

Lauf erstellen

Vorgangs-ID:
CreateRun

Lauf erstellen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
API-Version
 api-version True string

API-Version
Die ID des Threads, für den eine Nachricht erstellt werden soll.
 ThreadId True string

Die ID des Threads, für den eine Nachricht erstellt werden soll.
assistant_id
 assistant_id True string

Die ID des Assistenten, der für diese Ausführung verwendet werden soll
Modell
 model string

Der Name der Modellbereitstellung, der zum Ausführen dieser Ausführung verwendet werden soll. Wenn angegeben, überschreibt er den Modellbereitstellungsnamen des Assistenten.
instructions
 instructions string

Überschreibt die Anweisungen des Assistenten. Nützlich für das Ändern des Verhaltens pro Ausführung.
additional_instructions
 additional_instructions string

Fügt zusätzliche Anweisungen am Ende der Anweisungen für die Ausführung an.
role
 role string

Die Rolle der Entität, die die Nachricht erstellt. Kann Benutzer oder Assistent sein. "Benutzer" gibt an, dass die Nachricht von einem tatsächlichen Benutzer gesendet wird und in den meisten Fällen verwendet werden soll, um vom Benutzer generierte Nachrichten darzustellen. "Assistent" gibt an, dass die Nachricht vom Assistenten generiert wird. Verwenden Sie diesen Wert, um Nachrichten aus dem Assistenten in die Unterhaltung einzufügen.
Inhalt
 content string

Der Inhalt der Nachricht.
name
 name string

Liste der Datei-IDs oder Nachrichten, die in der Ausführung verwendet werden können.
metadata
 metadata object

16 Schlüssel-Wert-Paare, 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. Schlüssel dürfen maximal 64 Zeichen und Werte dürfen höchstens 512 Zeichen lang sein.
name
 name string

Liste der Tools, die in der Ausführung verwendet werden können.
metadata
 metadata object

Set of 16 key-value pairs attached to an object. Schlüssel max. Länge: 64 Zeichen, Maximale Länge der Werte: 512 Zeichen.
Temperatur
 temperature number

Probenahmetemperatur (0-2). Höhere Werte (z. B. 0,8) erhöhen die Zufallszahlen, niedrigere Werte (z. B. 0,2) erhöhen die Ausgabe deterministisch.
top_p
 top_p number

Kernsampling alternative zu Temperatur. 0,1 bedeutet, dass top 10% Wahrscheinlichkeitsmasse berücksichtigt wird.
Datenstrom
 stream boolean

Wenn true, gibt einen Datenstrom von Ereignissen während der Ausführung als servergesendete Ereignisse zurück, die mit einer Nachricht vom Typ "Data: [DONE]" beendet werden.
max_prompt_tokens
 max_prompt_tokens integer

Die maximale Anzahl von Abschlusstoken, die möglicherweise für die Ausführung verwendet werden. Wenn dieser Wert überschritten wird, endet die Ausführung als unvollständig.
max_completion_tokens
 max_completion_tokens integer

Die maximale Anzahl von Abschlusstoken, die möglicherweise für die Ausführung verwendet werden. Wenn dieser Wert überschritten wird, endet die Ausführung als unvollständig.
truncation_strategy
 truncation_strategy object

Steuert, wie ein Thread vor der Ausführung abgeschnitten wird, um das anfängliche Kontextfenster zu verwalten.
tool_choice
 tool_choice

Steuert, welches Tool das Modell aufruft. Der Standardwert ist "auto", sodass das Modell entscheiden kann. Kann auf 'none' festgelegt werden, um die Toolverwendung zu deaktivieren.
Antwortformat
 response_format object

Gibt das Ausgabeformat an. Einstellung { 'type': 'json_object' } aktiviert den JSON-Modus für gültige JSON-Antworten.

Gibt zurück

Body
createRunResponse

Lauf starten

Vorgangs-ID:
GetRun

Lauf starten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
API-Version
 api-version True string

API-Version
Die ID des Threads, für den eine Nachricht erstellt werden soll.
 ThreadId True string

Die ID des Threads, für den eine Nachricht erstellt werden soll.
Die ID der Ausführung.
 RunId True string

Die ID der Ausführung.

Gibt zurück

Body
getRunResponse

Nachrichten auflisten

Vorgangs-ID:
ListMessages

Nachrichten auflisten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
API-Version
 api-version True string

API-Version
Die ID des Threads, für den eine Nachricht erstellt werden soll.
 ThreadId True string

Die ID des Threads, für den eine Nachricht erstellt werden soll.

Gibt zurück

Body
listMessageResponse

Thread erstellen

Vorgangs-ID:
CreateThread

Thread erstellen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
API-Version
 api-version True string

API-Version
role
 role string

Die Rolle der Entität, die die Nachricht erstellt. Kann Benutzer oder Assistent sein. "Benutzer" gibt an, dass die Nachricht von einem tatsächlichen Benutzer gesendet wird und in den meisten Fällen verwendet werden soll, um vom Benutzer generierte Nachrichten darzustellen. "Assistent" gibt an, dass die Nachricht vom Assistenten generiert wird. Verwenden Sie diesen Wert, um Nachrichten aus dem Assistenten in die Unterhaltung einzufügen.
Inhalt
 content string

Der Inhalt der Nachricht.
name
 name string

Liste der Datei-IDs oder Nachrichten, die in der Ausführung verwendet werden können.
metadata
 metadata object

16 Schlüssel-Wert-Paare, 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. Schlüssel dürfen maximal 64 Zeichen und Werte dürfen höchstens 512 Zeichen lang sein.
metadata
 metadata object

16 Schlüssel-Wert-Paare, 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. Schlüssel dürfen maximal 64 Zeichen und Werte dürfen höchstens 512 Zeichen lang sein.
tool_resources
 tool_resources object

Eine Reihe von Ressourcen, die für die Tools des Assistenten in diesem Thread verfügbar gemacht werden. Die Ressourcen sind spezifisch für den Tooltyp. Beispielsweise erfordert das tool code_interpreter eine Liste von Datei-IDs, während das file_search Tool eine Liste von Vektorspeicher-IDs erfordert.

Gibt zurück

Body
createThreadResponse

Definitionen

listAgentsResponse

Name Pfad Typ Beschreibung
Objekt
 object string

Details des Antwortobjekttyps.
Daten
 data array of Data

Die Liste der vom Dienst zurückgegebenen Nachrichten.
first_id
 first_id string

Details zur ersten ID.
last_id
 last_id string

Details zur letzten ID.
has_more
 has_more boolean

Gibt an, ob mehr Agents vorhanden sind.

listAgentsServiceResponse

Name Pfad Typ Beschreibung
Daten
 data array of AgentServiceData

Die Liste der vom Dienst zurückgegebenen Agents.

AgentServiceData

Name Pfad Typ Beschreibung
id
 id string

Der eindeutige Bezeichner des Agents.
name
 name string

Der Name des Agents.
Beschreibung
 description string

Die Beschreibung des Agenten.
Ausgabe
 version string

Die Version des Agents.
createdAt
 createdAt date-time

Wann der Agent erstellt wurde.

AgentRecord

Name Pfad Typ Beschreibung
Objekt
 object string

Der Objekttyp.
id
 id string

Der eindeutige Bezeichner des Agents.
name
 name string

Der Name des Agents.
state
 state string

Der Betriebszustand des Agenten.
configuration_state
 configuration_state string

Der Konfigurationsstatus des Agents.
state_source
 state_source string

Die Quelle des aktuellen Zustands.
versions
 versions AgentRecordVersions
agent_endpoint
 agent_endpoint object

Die Endpunktkonfiguration für den Agent.
digital_worker_type
 digital_worker_type string

Der Typ des digitalen Workers, falls zutreffend.
instance_identity
 instance_identity object

Die Instanzidentität des Agents.
Bauplan
 blueprint object

Die Blueprint-Identität des Agents.
blueprint_reference
 blueprint_reference object

Die Blaupausenreferenz für den Agenten.
agent_card
 agent_card object

Die Agentkarte, sofern verfügbar.

AgentRecordVersions

Name Pfad Typ Beschreibung
Neueste
 latest AgentVersionRecord

AgentVersionRecord

Name Pfad Typ Beschreibung
metadata
 metadata object

Metadaten, die der Agentversion zugeordnet sind.
Objekt
 object string

Der Objekttyp.
id
 id string

Die eindeutige Kennung der Agent-Version.
name
 name string

Der Name des Agents.
Ausgabe
 version string

Die Versionskennung.
Beschreibung
 description string

Eine lesbare Beschreibung der Agentversion.
erstellt_am
 created_at integer

Der Unix-Zeitstempel in Sekunden, als die Agent-Version erstellt wurde.
Definition
 definition object

Die Agentdefinition.
draft
 draft boolean

Gibt an, ob es sich um eine Entwurfsversion handelt.
status
 status string

Der Bereitstellungsstatus der Agentenversion.
instance_identity
 instance_identity object

Die Instanzidentität der Agentversion.
Bauplan
 blueprint object

Die Blueprint-Identität der Agentversion.
blueprint_reference
 blueprint_reference object

Der Blueprintverweis für die Agentversion.
agent_guid
 agent_guid string

Die eindeutige GUID-Kennung des Agenten.

AgentVersionListResponse

Name Pfad Typ Beschreibung
Objekt
 object string

Der Objekttyp.
Daten
 data array of AgentVersionRecord

Die Liste der vom Dienst zurückgegebenen Agentversionen.
first_id
 first_id string

Der erste Objektbezeichner auf der Seite.
last_id
 last_id string

Der letzte Objektbezeichner auf der Seite.
has_more
 has_more boolean

Gibt an, ob weitere Ergebnisse verfügbar sind.

HostedSession

Name Pfad Typ Beschreibung
agent_session_id
 agent_session_id string

Der gehostete Sitzungsbezeichner.
version_indicator
 version_indicator HostedSessionVersionIndicator
status
 status string

Der aktuelle Sitzungsstatus.
erstellt_am
 created_at integer

Der Unix-Zeitstempel in Sekunden, als die Sitzung erstellt wurde.
last_accessed_at
 last_accessed_at integer

Der Unix-Zeitstempel in Sekunden, als die Sitzung zuletzt zugegriffen wurde.
läuft_ab_am
 expires_at integer

Der Unix-Zeitstempel in Sekunden, wenn die Sitzung abläuft.
stopped_at
 stopped_at integer

Der Unix-Zeitstempel in Sekunden, wenn die Sitzung beendet wurde, falls zutreffend.

HostedSessionVersionIndicator

Name Pfad Typ Beschreibung
type
 type string

Der Typ der Versionsauswahlanzeige.
agent_version
 agent_version string

Die der Sitzung zugewiesene version des gehosteten Agents.

HostedSessionListResponse

Name Pfad Typ Beschreibung
Daten
 data array of HostedSession

Die vom Dienst zurückgegebenen gehosteten Sitzungen.
first_id
 first_id string

Der erste gehostete Sitzungsbezeichner auf der Seite.
last_id
 last_id string

Der letzte gehostete Sitzungsbezeichner auf der Seite.
has_more
 has_more boolean

Gibt an, ob mehr gehostete Sitzungen verfügbar sind.

HostedSessionFileUploadResponse

Name Pfad Typ Beschreibung
path
 path string

Der Pfad der hochgeladenen Datei.
bytes_written
 bytes_written integer

Die Anzahl der geschriebenen Byte
Erfolg
 success boolean

Gibt an, ob der Upload erfolgreich war.
Quelltyp
 source_type string

Der für den Upload verwendete Quelltyp.

HostedSessionFileListResponse

Name Pfad Typ Beschreibung
path
 path string

Der Verzeichnispfad, der aufgelistet wurde.
Einträge
 entries array of HostedSessionFileEntry

Die Dateien und Verzeichnisse im angeforderten Pfad.
has_more
 has_more boolean

Gibt an, ob weitere Einträge verfügbar sind.

HostedSessionFileEntry

Name Pfad Typ Beschreibung
name
 name string

Der Datei- oder Verzeichnisname.
size
 size integer

Die Größe der Datei in Byte.
is_directory
 is_directory boolean

Gibt an, ob es sich bei dem Eintrag um ein Verzeichnis handelt.
modified_time
 modified_time integer

Die Änderungszeit des Eintrags, wie von der gehosteten Sitzung gemeldet.

createThreadResponse

Name Pfad Typ Beschreibung
id
 id string

Der Bezeichner, auf den in API-Endpunkten verwiesen werden kann
Objekt
 object string

Der Objekttyp, der immer Thread ist.
erstellt_am
 created_at integer

Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts, zu dem der Thread erstellt wurde.
metadata
 metadata object

16 Schlüssel-Wert-Paare, 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. Schlüssel dürfen maximal 64 Zeichen und Werte dürfen höchstens 512 Zeichen lang sein.

createRunResponse

Name Pfad Typ Beschreibung
id
 id string

Der Bezeichner, auf den in API-Endpunkten verwiesen werden kann
Objekt
 object string

Der Objekttyp, der immer thread.run ist.
erstellt_am
 created_at integer

Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts, zu dem die Ausführung erstellt wurde
thread_id
 thread_id string

Die ID des Threads, der als Teil dieser Ausführung ausgeführt wurde.
assistant_id
 assistant_id string

Die ID des Assistenten, der für diese Ausführung verwendet wird
status
 status string

Der Status der Ausführung, die entweder in die Warteschlange eingereiht, in_progress, requires_action, abgebrochen, abgebrochen, fehlgeschlagen, abgeschlossen oder abgelaufen sein kann.
required_action
 required_action object

Details zu der Aktion, die zum Fortsetzen der Ausführung erforderlich ist. Ist null, wenn keine Aktion erforderlich ist.
last_error
 last_error object

Der letzte Fehler im Zusammenhang mit dieser Ausführung. Wird null sein, wenn keine Fehler vorhanden sind.
läuft_ab_am
 expires_at integer

Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts, zu dem die Ausführung abläuft
started_at
 started_at integer

Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts, zu dem die Ausführung gestartet wurde
cancelled_at
 cancelled_at integer

Der Unix-Zeitstempel (in Sekunden) für den Zeitpunkt, an dem die Ausführung abgebrochen wurde.
failed_at
 failed_at integer

Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts, zu dem die Ausführung fehlgeschlagen ist
abgeschlossen_am
 completed_at integer

Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts, zu dem die Ausführung abgeschlossen wurde
Modell
 model string

Der Modellbereitstellungsname, den der Assistent für diese Ausführung verwendet hat.
instructions
 instructions string

Die Anweisungen, die der Assistent für diese Ausführung verwendet hat
Werkzeuge
 tools array of tools

Die Liste der Tools, die der Assistent für diese Ausführung verwendet hat
Datei-IDs
 file_ids array of fileIds

Die Liste der Datei-IDs, die der Assistent für diese Ausführung verwendet hat.
metadata
 metadata object

16 Schlüssel-Wert-Paare, die an ein Objekt angefügt werden können. Schlüssel können maximal 64 Zeichen lang sein, und Werte können maximal 512 Zeichen lang sein.
tool_choice
 tool_choice

Steuert, welches Tool (falls vorhanden) vom Modell aufgerufen wird. "none" bedeutet, dass das Modell keine Tools aufruft und stattdessen eine Nachricht generiert. "Auto" bedeutet, dass das Modell zwischen dem Generieren einer Nachricht oder dem Aufrufen eines Tools auswählen kann. Angeben eines Tools wie {'type': 'file_search'} oder {'type': 'function', 'function': {'name': 'my_function'}} erzwingt das Modell, dieses Tool aufzurufen.
max_prompt_tokens
 max_prompt_tokens number

Die maximale Anzahl an Eingabeaufforderungstoken, die im Laufe der Ausführung verwendet wurden
max_completion_tokens
 max_completion_tokens number

Die maximale Anzahl an Abschlusstoken, die im Laufe der Ausführung verwendet wurden
usage
 usage object

Verwendungsstatistiken im Zusammenhang mit der Ausführung. Dieser Wert ist null, wenn sich die Ausführung nicht im Terminalzustand befindet (z. B. in_progress, in die Warteschlange eingereiht).
truncation_strategy
 truncation_strategy object

Steuert, wie ein Thread vor der Ausführung abgeschnitten wird.
Antwortformat
 response_format string

Das Format, das das Modell ausgeben muss. Kompatibel mit GPT-4 Turbo und allen GPT-3.5 Turbo-Modellen seit gpt-3.5-Turbo-1106.

getRunResponse

Name Pfad Typ Beschreibung
id
 id string

Der Bezeichner, auf den in API-Endpunkten verwiesen werden kann
Objekt
 object string

Der Objekttyp, der immer thread.run ist.
erstellt_am
 created_at integer

Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts, zu dem die Ausführung erstellt wurde
thread_id
 thread_id string

Die ID des Threads, der als Teil dieser Ausführung ausgeführt wurde.
assistant_id
 assistant_id string

Die ID des Assistenten, der für diese Ausführung verwendet wird
status
 status string

Der Status der Ausführung, die entweder in die Warteschlange eingereiht, in_progress, requires_action, abgebrochen, abgebrochen, fehlgeschlagen, abgeschlossen oder abgelaufen sein kann.
required_action
 required_action object

Details zu der Aktion, die zum Fortsetzen der Ausführung erforderlich ist. Ist null, wenn keine Aktion erforderlich ist.
last_error
 last_error object

Der letzte Fehler im Zusammenhang mit dieser Ausführung. Wird null sein, wenn keine Fehler vorhanden sind.
läuft_ab_am
 expires_at integer

Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts, zu dem die Ausführung abläuft
started_at
 started_at integer

Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts, zu dem die Ausführung gestartet wurde
cancelled_at
 cancelled_at integer

Der Unix-Zeitstempel (in Sekunden) für den Zeitpunkt, an dem die Ausführung abgebrochen wurde.
failed_at
 failed_at integer

Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts, zu dem die Ausführung fehlgeschlagen ist
abgeschlossen_am
 completed_at integer

Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts, zu dem die Ausführung abgeschlossen wurde
Modell
 model string

Der Modellbereitstellungsname, den der Assistent für diese Ausführung verwendet hat.
instructions
 instructions string

Die Anweisungen, die der Assistent für diese Ausführung verwendet hat
Werkzeuge
 tools array of tools

Die Liste der Tools, die der Assistent für diese Ausführung verwendet hat
Datei-IDs
 file_ids array of fileIds

Die Liste der Datei-IDs, die der Assistent für diese Ausführung verwendet hat.
metadata
 metadata object

16 Schlüssel-Wert-Paare, die an ein Objekt angefügt werden können. Schlüssel können maximal 64 Zeichen lang sein, und Werte können maximal 512 Zeichen lang sein.
tool_choice
 tool_choice

Steuert, welches Tool (falls vorhanden) vom Modell aufgerufen wird. "none" bedeutet, dass das Modell keine Tools aufruft und stattdessen eine Nachricht generiert. "Auto" bedeutet, dass das Modell zwischen dem Generieren einer Nachricht oder dem Aufrufen eines Tools auswählen kann. Angeben eines Tools wie {'type': 'file_search'} oder {'type': 'function', 'function': {'name': 'my_function'}} erzwingt das Modell, dieses Tool aufzurufen.
max_prompt_tokens
 max_prompt_tokens number

Die maximale Anzahl an Eingabeaufforderungstoken, die im Laufe der Ausführung verwendet wurden
max_completion_tokens
 max_completion_tokens number

Die maximale Anzahl an Abschlusstoken, die im Laufe der Ausführung verwendet wurden
usage
 usage object

Verwendungsstatistiken im Zusammenhang mit der Ausführung. Dieser Wert ist null, wenn sich die Ausführung nicht im Terminalzustand befindet (z. B. in_progress, in die Warteschlange eingereiht).
truncation_strategy
 truncation_strategy object

Steuert, wie ein Thread vor der Ausführung abgeschnitten wird.
Antwortformat
 response_format string

Das Format, das das Modell ausgeben muss. Kompatibel mit GPT-4 Turbo und allen GPT-3.5 Turbo-Modellen seit gpt-3.5-Turbo-1106.

listMessageResponse

Name Pfad Typ Beschreibung
Objekt
 object string

Details des Antwortobjekttyps
Daten
 data array of Data

Die Liste der vom Dienst zurückgegebenen Nachrichten.
first_id
 first_id string

Details der ersten ID
last_id
 last_id string

Details der letzten ID
has_more
 has_more boolean

Gibt an, ob mehr Agents vorhanden sind.

Daten

Name Pfad Typ Beschreibung
id
 id string

Der Bezeichner, auf den in API-Endpunkten verwiesen werden kann
Objekt
 object string

Der Objekttyp, der immer Assistent ist.
erstellt_am
 created_at integer

Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts, zu dem der Assistent erstellt wurde.
name
 name string

Der Name des Assistenten. Die maximale Länge beträgt 256 Zeichen.
Beschreibung
 description string

Die Beschreibung des Assistenten. Die maximale Länge beträgt 512 Zeichen.
Modell
 model string

Name des zu verwendenden Modellbereitstellungsnamens.
instructions
 instructions string

Die Systemanweisungen, die der Assistent verwendet. Die maximale Länge beträgt 32.768 Zeichen.
Werkzeuge
 tools array of tools

Eine Liste der im Assistenten aktivierten Tools. Jeder Assistent kann maximal 128 Tools enthalten. Tools können Typen code_interpreter oder Funktion sein. Eine Funktionsbeschreibung kann maximal 1.024 Zeichen umfassen.
metadata
 metadata object

16 Schlüssel-Wert-Paare, die an ein Objekt angefügt werden können. Nützlich zum Speichern zusätzlicher Informationen in einem strukturierten Format. Schlüssel können maximal 64 Zeichen lang sein, und Werte können maximal 512 Zeichen lang sein.
Temperatur
 temperature number

Der Standardwert lautet 1. Bestimmt, welche Probenahmetemperatur zwischen 0 und 2 verwendet werden soll. 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.
top_p
 top_p number

Der Standardwert lautet 1. Eine Alternative zur Stichprobenentnahme mit Temperatur, die sogenannte Kernstichprobenentnahme (Nucleus Sampling), bei dem das Modell die Ergebnisse der Token mit der Wahrscheinlichkeitsmasse „top_p“ berücksichtigt. Daher bedeutet 0,1, dass nur die Token berücksichtigt werden, die die oberen 10 % der Wahrscheinlichkeitsmasse umfassen.
Antwortformat
 response_format object

Gibt das Format an, das das Modell ausgeben muss. Durch Festlegen dieses Parameters auf { 'type': 'json_object' } wird der JSON-Modus aktiviert, um sicherzustellen, dass die Nachricht gültig ist.
tool_resources
 tool_resources object

Eine Reihe von Ressourcen, die von den Tools des Assistenten verwendet werden. Die Ressourcen sind spezifisch für den Tooltyp. Beispielsweise erfordert das tool code_interpreter eine Liste von Datei-IDs, während das file_search Tool eine Liste von Vektorspeicher-IDs erfordert.

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. Wenden Sie sich an den Vertrieb , um mehr über die Prioritätsverarbeitung zu erfahren.
  • 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.

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. Wenden Sie sich an den Vertrieb , um mehr über die Prioritätsverarbeitung zu erfahren.
  • 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.

string

OpenAI.Reasoning

Nur o-Serienmodelle

Konfigurationsoptionen für Begründungsmodelle.

Name Pfad Typ Beschreibung
effort
 effort string
summary
 summary string

Eine Zusammenfassung der vom Modell durchgeführten Begründung. Dies kann nützlich sein, um das Debuggen und den Begründungsprozess des Modells besser zu verstehen. Einer von auto, concise oder detailed.
generate_summary
 generate_summary string

Veraltet: Verwenden Sie summary stattdessen.

Eine Zusammenfassung der vom Modell durchgeführten Begründung. Dies kann nützlich sein, um das Debuggen und den Begründungsprozess des Modells besser zu verstehen. Einer von auto, concise oder detailed.

OpenAI.ResponseTextFormatConfiguration

Name Pfad Typ Beschreibung
type
 type OpenAI.ResponseTextFormatConfigurationType

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 in der Anleitung „Strukturierte Ausgaben“.

Das Standardformat ist { "type": "text" } ohne zusätzliche Optionen verfügbar.

Nicht empfohlen für gpt-4o und neuere Modelle:

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.

OpenAI.ResponseTextFormatConfigurationType

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 in der Anleitung „Strukturierte Ausgaben“.

Das Standardformat ist { "type": "text" } ohne zusätzliche Optionen verfügbar.

Nicht empfohlen für gpt-4o und neuere Modelle:

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.

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 in der Anleitung „Strukturierte Ausgaben“.

Das Standardformat ist { "type": "text" } ohne zusätzliche Optionen verfügbar.

Nicht empfohlen für gpt-4o und neuere Modelle:

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.

string

OpenAI.Tool

Name Pfad Typ Beschreibung
type
 type OpenAI.ToolType

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

OpenAI.ToolType

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

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

string

OpenAI.Prompt

Verweisen Sie auf eine Promptvorlage und deren Variablen. Erfahren Sie mehr.

Name Pfad Typ Beschreibung
id
 id string

Der eindeutige Bezeichner der zu verwendenden Promptvorlage.
Ausgabe
 version string

Optionale Version der Promptvorlage.
variables
 variables OpenAI.ResponsePromptVariables

Optionale Zuordnung von Werten, die Variablen in Ihrem Prompt ersetzen sollen. Die Ersetzungswerte können entweder Zeichenfolgen oder andere Antworteingabetypen wie Bilder oder Dateien sein.

OpenAI.Response

Name Pfad Typ Beschreibung
metadata
 metadata object

16 Schlüssel-Wert-Paare, 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.
Temperatur
 temperature float

Die zu verwendende Temperatur für die Stichprobenentnahme 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. Wir empfehlen im Allgemeinen, dies oder top_p zu ändern, aber nicht beides.
top_p
 top_p float

Eine Alternative zur Stichprobenentnahme mit Temperatur, die sogenannte Kernstichprobenentnahme (Nucleus Sampling), bei dem das Modell die Ergebnisse der Token mit der Wahrscheinlichkeitsmasse „top_p“ berücksichtigt. Daher bedeutet 0,1, dass nur die Token berücksichtigt werden, die die oberen 10 % der Wahrscheinlichkeitsmasse umfassen.

Wir empfehlen im Allgemeinen, dies oder temperature zu ändern, aber nicht beides.
user
 user string

Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen. Erfahren Sie mehr.
Dienststufe
 service_tier 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. Wenden Sie sich an den Vertrieb , um mehr über die Prioritätsverarbeitung zu erfahren.
  • 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.
top_logprobs
 top_logprobs integer

Eine ganze Zahl zwischen 0 und 20, die die Anzahl der Token angibt, die an jeder Tokenposition höchstwahrscheinlich zurückgegeben werden, jeweils mit einer zugeordneten Protokollwahrscheinlichkeit.
previous_response_id
 previous_response_id string

Die eindeutige ID der vorherigen Antwort auf das Modell. Verwenden Sie diese Option, um Multi-Turn-Unterhaltungen zu erstellen. Erfahren Sie mehr über den Unterhaltungsstatus.
Modell
 model string

Das Modell, das für die Erstellung dieser Antwort eingesetzt werden soll.
reasoning
 reasoning OpenAI.Reasoning

Nur o-Serienmodelle

Konfigurationsoptionen für Begründungsmodelle.
background
 background boolean

Gibt an, ob die Modellantwort im Hintergrund ausgeführt werden soll. Erfahren Sie mehr.
max_output_tokens
 max_output_tokens integer

Eine obere Grenze für die Anzahl der Token, die für eine Antwort generiert werden können, einschließlich sichtbarer Ausgabetoken und Begründungstoken.
max_tool_calls
 max_tool_calls integer

Die maximale Anzahl aller Aufrufe an integrierte Tools, die in einer Antwort verarbeitet werden können. Diese maximale Anzahl gilt für alle integrierten Toolaufrufe, nicht pro einzelnes Tool. Alle weiteren Versuche, ein Tool durch das Modell aufzurufen, werden ignoriert.
format
 text.format OpenAI.ResponseTextFormatConfiguration
Werkzeuge
 tools array of OpenAI.Tool

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.

Sie können die beiden folgenden Kategorien von Tools bereitstellen:

  • 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.
  • Funktionsaufrufe (benutzerdefinierte Tools):Funktionen, die von Ihnen definiert werden, sodass das Modell Ihren eigenen Code aufrufen kann. Erfahren Sie mehr über den Funktionsaufruf.
tool_choice
 tool_choice

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.
prompt
 prompt OpenAI.Prompt

Verweisen Sie auf eine Promptvorlage und deren Variablen. Erfahren Sie mehr.
truncation
 truncation string

Die Abkürzungsstrategie, die für die Modellantwort verwendet werden soll.

  • auto: Wenn der Kontext dieser Antwort und früherer Antworten die Größe des Kontextfensters des Modells überschreitet, schneidet das Modell die Antwort ab, um das Kontextfenster anzupassen, indem Eingabeelemente in der Mitte der Unterhaltung gelöscht werden.
  • disabled (Standard): Wenn eine Modellantwort die Kontextfenstergröße für ein Modell überschreitet, schlägt die Anforderung mit einem Fehler von 400 fehl.
id
 id string

Eindeutiger Bezeichner für diese Antwort
Objekt
 object string

Der Objekttyp dieser Ressource, immer auf response festgelegt.
status
 status string

Der Status der Antwortgenerierung. Einer von der folgenden Werte: completed, failed, in_progress, cancelled, queued oder incomplete.
erstellt_am
 created_at unixtime

Unix-Zeitstempel (in Sekunden) des Zeitpunkts der Erstellung dieser Antwort.
Fehler
 error OpenAI.ResponseError

Ein Fehlerobjekt, das zurückgegeben wird, wenn das Modell keine Antwort generiert.
Grund
 incomplete_details.reason string

Der Grund, warum die Antwort unvollständig ist.
output
 output array of OpenAI.ItemResource

Ein Array von Inhaltselementen, die vom Modell generiert werden.

  • Die Länge und Reihenfolge der Elemente im output Array hängt von der Antwort des Modells ab.
  • Anstatt auf das erste Element im output Array zuzugreifen und davon auszugehen, dass es sich um eine assistant Nachricht mit dem vom Modell generierten Inhalt handelt, sollten Sie die Eigenschaft verwenden output_text , die in SDKs unterstützt wird.
instructions
 instructions

Eine Systemnachricht (oder Entwicklernachricht), die in den Kontext des Modells eingefügt wurde.

Bei gleichzeitiger Verwendung mit previous_response_id werden die Anweisungen aus einer vorherigen Antwort nicht in die nächste Antwort übernommen. Dies erleichtert das Austauschen von Systemnachrichten (oder Entwicklernachrichten) in neuen Antworten.
output_text
 output_text string

SDK-spezifische Komforteigenschaft, die die aggregierte Textausgabe aller output_text-Elemente im output-Array enthält, sofern vorhanden. Unterstützt in den Python- und JavaScript-SDKs.
usage
 usage OpenAI.ResponseUsage

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

Gibt an, ob das Modell Toolaufrufe parallel ausführen darf.
id
 conversation.id string

Unterhaltungs-ID zum Festlegen der Unterhaltung für diese Antwort. Wenn "Neue Unterhaltung erstellen" bereitgestellt wird, wird eine neue Unterhaltung mit dieser Antwort als erste Nachricht gestartet.
Agent
 agent AgentId

OpenAI.ResponseError

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

Name Pfad Typ Beschreibung
Code
 code OpenAI.ResponseErrorCode

Der Fehlercode für die Antwort.
message
 message string

Eine für Menschen lesbare Beschreibung des Fehlers.

OpenAI.ResponseErrorCode

Der Fehlercode für die Antwort.

Der Fehlercode für die Antwort.

string

OpenAI.ItemResource

Inhaltselement, das zum Generieren einer Antwort verwendet wird.

Name Pfad Typ Beschreibung
type
 type OpenAI.ItemType
id
 id string

OpenAI.ItemType

string

OpenAI.ResponseUsage

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

Name Pfad Typ Beschreibung
input_tokens
 input_tokens integer

Die Anzahl der Eingabetoken.
cached_tokens
 input_tokens_details.cached_tokens integer

Die Anzahl der Token, die aus dem Cache abgerufen wurden. Weitere Informationen zum Zwischenspeichern von Prompts.
output_tokens
 output_tokens integer

Die Anzahl der Ausgabetoken.
Begründungs_Token
 output_tokens_details.reasoning_tokens integer

Die Anzahl der Begründungstoken
Gesamtanzahl Tokens
 total_tokens integer

Die Gesamtzahl der verwendeten Token.

AgentId

Name Pfad Typ Beschreibung
type
 type string
name
 name string

Der Name des Agents.
Ausgabe
 version string

Der Versionsbezeichner des Agents.

OpenAI.ResponsePromptVariables

Optionale Zuordnung von Werten, die Variablen in Ihrem Prompt ersetzen sollen. Die Ersetzungswerte können entweder Zeichenfolgen oder andere Antworteingabetypen wie Bilder oder Dateien sein.

Name Pfad Typ Beschreibung
object

Optionale Zuordnung von Werten, die Variablen in Ihrem Prompt ersetzen sollen. Die Ersetzungswerte können entweder Zeichenfolgen oder andere Antworteingabetypen wie Bilder oder Dateien sein.

Werkzeuge

Name Pfad Typ Beschreibung
name
 name string

Liste der Tools, die in der Ausführung verwendet werden können.

fileIds

Name Pfad Typ Beschreibung
name
 name string

Liste der Datei-IDs, die in der Ausführung verwendet werden können.

binary

Dies ist der grundlegende Datentyp "binary".

Objekt

Dies ist der Typ 'object'.