OpenAI Assistants (Independent Publisher) (Vorschau)
Mit OpenAI Assistants können Sie KI-Assistenten in Ihren eigenen Anwendungen erstellen. Ein Assistent verfügt über Anweisungen und kann Modelle, Tools und Wissen nutzen, um auf Benutzerabfragen zu reagieren. Der Assistentdienst unterstützt derzeit drei Arten von Tools: Codedolmetscher, Abruf und Funktionsaufrufe.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - 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 | Premium | 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 | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Troy Taylor |
| Webseite | https://openai.com/ |
| Datenschutzrichtlinie | https://openai.com/policies/privacy-policy |
| Kategorien | Künstliche Intelligenz |
Eine Verbindung wird erstellt
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
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 |
|---|---|---|---|
| API-Schlüssel (im Format 'Bearer $OPENAI_API_KEY') | securestring | Der API-Schlüssel (im Format "Bearer $OPENAI_API_KEY" für diese API | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abbrechen einer Ausführung |
Abbrechen einer Ausführung für einen ausgeführten Thread. |
| Abrufen einer Nachrichtendatei |
Ruft eine Nachrichtendatei aus einem Thread ab. |
| Abrufen von Assistentendateien |
Ruft eine Liste der Assistentendateien ab. |
| Assistent abrufen |
Ruft Informationen zu einem Assistenten ab. |
| Assistent erstellen |
Erstellen Sie einen Assistenten mit einem Modell und Anweisungen. |
| Assistenten auflisten |
Ruft eine Liste der Assistenten ab. |
| Assistentendatei abrufen |
Ruft eine Assistentendatei ab. |
| Assistentendatei erstellen |
Erstellen Sie eine Assistentendatei, indem Sie eine Datei an einen Assistenten anfügen. |
| Assistentendatei löschen |
Löscht eine Assistentendatei. |
| Auflisten von Modellen |
Listet die derzeit verfügbaren Modelle auf und stellt grundlegende Informationen zu jedem Modell bereit, z. B. Besitzer und Verfügbarkeit. |
| Ausführen von Schritten auflisten |
Dient zum Abrufen einer Liste der Ausführungsschritte für einen Thread. |
| Ausführen ändern |
Ändert eine Ausführung für einen Thread. |
| Ausführungen auflisten |
Dient zum Abrufen einer Liste von Läufen für einen Thread. |
| Erstellen einer Ausführung |
Erstellt eine Ausführung für einen Thread. |
| Erstellen von Thread und Ausführen |
Erstellt einen Thread und führt ihn in einer Anforderung aus. |
| Get run (Ausführen) |
Abrufen einer Ausführung aus einem Thread. |
| Get run step |
Rufen Sie einen Ausführungsschritt für einen Thread ab. |
| Lösch-Assistent |
Löscht einen Assistenten. |
| Nachricht erstellen |
Erstellen Sie eine Nachricht in einem Thread. |
| Nachricht ändern |
Ändert eine Nachricht. |
| Nachrichten auflisten |
Dient zum Abrufen einer Liste von Nachrichten für einen bestimmten Thread. |
| Nachrichtendateien auflisten |
Ruft eine Liste der Nachrichtendateien für einen Thread ab. |
| Senden von Toolausgaben zur Ausführung |
Wenn eine Ausführung den Status "requires_action" aufweist und required_action.type submit_tool_outputs ist, kann diese Aktion verwendet werden, um die Ausgaben aus den Toolaufrufen zu übermitteln, sobald sie alle abgeschlossen sind. |
| Thread abrufen |
Abrufen eines Threads. |
| Thread erstellen |
Erstellt einen Thread, mit dem Assistenten interagieren können. |
| Thread löschen |
Löscht einen Thread. |
| Ändern eines Threads |
Ändert einen Thread. |
Abbrechen einer Ausführung
Abbrechen einer Ausführung für einen ausgeführten Thread.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
|
Ausführungs-ID
|
run_id | True | string |
Den Ausführungsbezeichner |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
Assistenten-ID
|
assistant_id | string |
Der Assistentbezeichner. |
|
Thread-ID
|
thread_id | string |
Der Threadbezeichner. |
|
Der Status
|
status | string |
Der Status. |
|
Begonnen am
|
started_at | integer |
Wann beginnen sie bei. |
|
Läuft ab
|
expires_at | integer |
Wann läuft ab. |
|
Abgebrochen am
|
cancelled_at | string |
Wann abgebrochen bei. |
|
Fehler bei
|
failed_at | string |
Wenn ein Fehler aufgetreten ist. |
|
Abgeschlossen bei
|
completed_at | string |
Nach Abschluss bei. |
|
Letzter Fehler
|
last_error | string |
Der letzte Fehler. |
|
Model
|
model | string |
Das Modell. |
|
Anweisungen
|
instructions | string |
Die Anweisungen. |
|
Tools
|
tools | array of object | |
|
Typ
|
tools.type | string |
Der Toolstyp. |
|
Datei-IDs
|
file_ids | array of string |
Die Datei-IDs. |
Abrufen einer Nachrichtendatei
Ruft eine Nachrichtendatei aus einem Thread ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
|
Nachrichten-ID
|
message_id | True | string |
Der Nachrichtenbezeichner. |
|
Datei-ID
|
file_id | True | string |
Der Dateibezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
Nachrichten-ID
|
message_id | string |
Der Nachrichtenbezeichner. |
Abrufen von Assistentendateien
Ruft eine Liste der Assistentendateien ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Assistenten-ID
|
assistant_id | True | string |
Der Assistentbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Object
|
object | string |
Das Objekt. |
|
Daten
|
data | array of object | |
|
ID
|
data.id | string |
Der Bezeichner. |
|
Object
|
data.object | string |
Das Objekt. |
|
Erstellt unter
|
data.created_at | integer |
Beim Erstellen bei. |
|
Assistenten-ID
|
data.assistant_id | string |
Der Assistentbezeichner. |
|
Erste ID
|
first_id | string |
Der erste Bezeichner. |
|
Letzte ID
|
last_id | string |
Der letzte Bezeichner. |
|
Hat mehr
|
has_more | boolean |
Ob mehr. |
Assistent abrufen
Ruft Informationen zu einem Assistenten ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Assistenten-ID
|
assistant_id | True | string |
Der Assistentbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
Name
|
name | string |
Der Name. |
|
Description
|
description | string |
Die Beschreibung. |
|
Model
|
model | string |
Das Modell. |
|
Anweisungen
|
instructions | string |
Die Anweisungen. |
|
Tools
|
tools | array of object | |
|
Typ
|
tools.type | string |
Der Toolstyp. |
|
Datei-IDs
|
file_ids | array of string |
Die Datei-IDs. |
Assistent erstellen
Erstellen Sie einen Assistenten mit einem Modell und Anweisungen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Model
|
model | True | string |
Das Modell. |
|
Anweisungen
|
instructions | string |
Die Anweisungen. |
|
|
Name
|
name | string |
Der Name. |
|
|
Description
|
description | string |
Die Beschreibung. |
|
|
Typ
|
type | string |
Der Toolstyp. |
|
|
Datei-IDs
|
file_ids | array of string |
Die Datei-IDs. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
Name
|
name | string |
Der Name. |
|
Description
|
description | string |
Die Beschreibung. |
|
Model
|
model | string |
Das Modell. |
|
Anweisungen
|
instructions | string |
Die Anweisungen. |
|
Tools
|
tools | array of object | |
|
Typ
|
tools.type | string |
Der Tooltyp. |
|
Datei-IDs
|
file_ids | array of string |
Die Datei-IDs. |
Assistenten auflisten
Ruft eine Liste der Assistenten ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Object
|
object | string |
Das Objekt. |
|
Daten
|
data | array of object | |
|
ID
|
data.id | string |
Der Bezeichner. |
|
Object
|
data.object | string |
Das Objekt. |
|
Erstellt unter
|
data.created_at | integer |
Beim Erstellen bei. |
|
Name
|
data.name | string |
Der Name. |
|
Description
|
data.description | string |
Die Beschreibung. |
|
Model
|
data.model | string |
Das Modell. |
|
Anweisungen
|
data.instructions | string |
Die Anweisungen. |
|
Tools
|
data.tools | array of object | |
|
Typ
|
data.tools.type | string |
Der Typ. |
|
Datei-IDs
|
data.file_ids | array of string |
Die Datei-IDs. |
|
Erste ID
|
first_id | string |
Der erste Bezeichner. |
|
Letzte ID
|
last_id | string |
Der letzte Bezeichner. |
|
Hat mehr
|
has_more | boolean |
Ob mehr. |
Assistentendatei abrufen
Ruft eine Assistentendatei ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Assistenten-ID
|
assistant_id | True | string |
Der Assistentbezeichner. |
|
Datei-ID
|
file_id | True | string |
Der Dateibezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
Assistenten-ID
|
assistant_id | string |
Der Assistentbezeichner. |
Assistentendatei erstellen
Erstellen Sie eine Assistentendatei, indem Sie eine Datei an einen Assistenten anfügen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Assistenten-ID
|
assistant_id | True | string |
Der Assistentbezeichner. |
|
Datei-ID
|
file_id | True | string |
Der Dateibezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
Assistenten-ID
|
assistant_id | string |
Der Assistentbezeichner. |
Assistentendatei löschen
Löscht eine Assistentendatei.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Assistenten-ID
|
assistant_id | True | string |
Der Assistentbezeichner. |
|
Datei-ID
|
file_id | True | string |
Der Dateibezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Gelöscht
|
deleted | boolean |
Gibt an, ob gelöscht wurde. |
Auflisten von Modellen
Listet die derzeit verfügbaren Modelle auf und stellt grundlegende Informationen zu jedem Modell bereit, z. B. Besitzer und Verfügbarkeit.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Object
|
object | string |
Das Objekt. |
|
Daten
|
data | array of object | |
|
ID
|
data.id | string |
Der Bezeichner. |
|
Object
|
data.object | string |
Das Objekt. |
|
Erstellt
|
data.created | integer |
Beim Erstellen. |
|
Im Besitz von
|
data.owned_by | string |
Eigentum von. |
Ausführen von Schritten auflisten
Dient zum Abrufen einer Liste der Ausführungsschritte für einen Thread.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
|
Ausführungs-ID
|
run_id | True | string |
Den Ausführungsbezeichner |
|
Limit
|
limit | integer |
Die Grenze. |
|
|
Bestellung
|
order | string |
Die Bestellung. |
|
|
Nach
|
after | string |
Das Nachher. |
|
|
Vorher
|
before | string |
Das vorher. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Object
|
object | string |
Das Objekt. |
|
Daten
|
data | array of object | |
|
ID
|
data.id | string |
Der Bezeichner. |
|
Object
|
data.object | string |
Das Objekt. |
|
Erstellt unter
|
data.created_at | integer |
Beim Erstellen bei. |
|
Ausführungs-ID
|
data.run_id | string |
Den Ausführungsbezeichner |
|
Assistenten-ID
|
data.assistant_id | string |
Der Assistentbezeichner. |
|
Thread-ID
|
data.thread_id | string |
Der Threadbezeichner. |
|
Typ
|
data.type | string |
Der Toolstyp. |
|
Der Status
|
data.status | string |
Der Status. |
|
Abgebrochen am
|
data.cancelled_at | string |
Wann abgebrochen bei. |
|
Abgeschlossen bei
|
data.completed_at | integer |
Nach Abschluss bei. |
|
Abgelaufen bei
|
data.expired_at | string |
Ist abgelaufen bei. |
|
Fehler bei
|
data.failed_at | string |
Wenn ein Fehler aufgetreten ist. |
|
Letzter Fehler
|
data.last_error | string |
Der letzte Fehler. |
|
Typ
|
data.step_details.type | string |
Der Typ. |
|
Nachrichten-ID
|
data.step_details.message_creation.message_id | string |
Der Nachrichtenbezeichner. |
|
Erste ID
|
first_id | string |
Der erste Bezeichner. |
|
Letzte ID
|
last_id | string |
Der letzte Bezeichner. |
|
Hat mehr
|
has_more | boolean |
Ob mehr. |
Ausführen ändern
Ändert eine Ausführung für einen Thread.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
|
Ausführungs-ID
|
run_id | True | string |
Den Ausführungsbezeichner |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
Assistenten-ID
|
assistant_id | string |
Der Assistentbezeichner. |
|
Thread-ID
|
thread_id | string |
Der Threadbezeichner. |
|
Der Status
|
status | string |
Der Status. |
|
Begonnen am
|
started_at | integer |
Wann beginnen sie bei. |
|
Läuft ab
|
expires_at | string |
Wann läuft ab. |
|
Abgebrochen am
|
cancelled_at | string |
Wann abgebrochen bei. |
|
Fehler bei
|
failed_at | string |
Wenn ein Fehler aufgetreten ist. |
|
Abgeschlossen bei
|
completed_at | integer |
Nach Abschluss bei. |
|
Letzter Fehler
|
last_error | string |
Der letzte Fehler. |
|
Model
|
model | string |
Das Modell. |
|
Anweisungen
|
instructions | string |
Die Anweisungen. |
|
Tools
|
tools | array of object | |
|
Typ
|
tools.type | string |
Der Toolstyp. |
|
Datei-IDs
|
file_ids | array of string |
Die Datei-IDs. |
Ausführungen auflisten
Dient zum Abrufen einer Liste von Läufen für einen Thread.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
|
Limit
|
limit | integer |
Die Grenze. |
|
|
Bestellung
|
order | string |
Die Bestellung. |
|
|
Nach
|
after | string |
Das Nachher. |
|
|
Vorher
|
before | string |
Das vorher. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Object
|
object | string |
Das Objekt. |
|
Daten
|
data | array of object | |
|
ID
|
data.id | string |
Der Bezeichner. |
|
Object
|
data.object | string |
Das Objekt. |
|
Erstellt unter
|
data.created_at | integer |
Beim Erstellen bei. |
|
Assistenten-ID
|
data.assistant_id | string |
Der Assistentbezeichner. |
|
Thread-ID
|
data.thread_id | string |
Der Threadbezeichner. |
|
Der Status
|
data.status | string |
Der Status. |
|
Begonnen am
|
data.started_at | integer |
Wann beginnen sie bei. |
|
Läuft ab
|
data.expires_at | string |
Wann läuft ab. |
|
Abgebrochen am
|
data.cancelled_at | string |
Wann abgebrochen bei. |
|
Fehler bei
|
data.failed_at | string |
Wenn ein Fehler aufgetreten ist. |
|
Abgeschlossen bei
|
data.completed_at | integer |
Nach Abschluss bei. |
|
Letzter Fehler
|
data.last_error | string |
Der letzte Fehler. |
|
Model
|
data.model | string |
Das Modell. |
|
Anweisungen
|
data.instructions | string |
Die Anweisungen. |
|
Tools
|
data.tools | array of object | |
|
Typ
|
data.tools.type | string |
Der Typ. |
|
Datei-IDs
|
data.file_ids | array of string |
Die Datei-IDs. |
|
Erste ID
|
first_id | string |
Der erste Bezeichner. |
|
Letzte ID
|
last_id | string |
Der letzte Bezeichner. |
|
Hat mehr
|
has_more | boolean |
Ob mehr. |
Erstellen einer Ausführung
Erstellt eine Ausführung für einen Thread.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
|
Assistenten-ID
|
assistant_id | string |
Der Assistentbezeichner. |
|
|
Model
|
model | True | string |
Das Modell. |
|
Anweisungen
|
instructions | string |
Die Anweisungen. |
|
|
Typ
|
type | string |
Der Toolstyp. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
Assistenten-ID
|
assistant_id | string |
Der Assistentbezeichner. |
|
Thread-ID
|
thread_id | string |
Der Threadbezeichner. |
|
Der Status
|
status | string |
Der Status. |
|
Begonnen am
|
started_at | integer |
Wann beginnen sie bei. |
|
Läuft ab
|
expires_at | string |
Wann läuft ab. |
|
Abgebrochen am
|
cancelled_at | string |
Wann abgebrochen bei. |
|
Fehler bei
|
failed_at | string |
Wenn ein Fehler aufgetreten ist. |
|
Abgeschlossen bei
|
completed_at | integer |
Nach Abschluss bei. |
|
Letzter Fehler
|
last_error | string |
Der letzte Fehler. |
|
Model
|
model | string |
Das Modell. |
|
Anweisungen
|
instructions | string |
Die Anweisungen. |
|
Tools
|
tools | array of object | |
|
Typ
|
tools.type | string |
Der Toolstyp. |
|
Datei-IDs
|
file_ids | array of string |
Die Datei-IDs. |
Erstellen von Thread und Ausführen
Erstellt einen Thread und führt ihn in einer Anforderung aus.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Assistenten-ID
|
assistant_id | string |
Der Assistentbezeichner. |
|
|
Rolle
|
role | string |
Die Rolle. |
|
|
Content
|
content | string |
Der Inhalt. |
|
|
Model
|
model | string |
Das Modell. |
|
|
Anweisungen
|
instructions | string |
Die Anweisungen. |
|
|
Typ
|
type | string |
Der Toolstyp. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
Assistenten-ID
|
assistant_id | string |
Der Assistentbezeichner. |
|
Thread-ID
|
thread_id | string |
Der Threadbezeichner. |
|
Der Status
|
status | string |
Der Status. |
|
Begonnen am
|
started_at | string |
Wann beginnen sie bei. |
|
Läuft ab
|
expires_at | integer |
Wann läuft ab. |
|
Abgebrochen am
|
cancelled_at | string |
Wann abgebrochen bei. |
|
Fehler bei
|
failed_at | string |
Wenn ein Fehler aufgetreten ist. |
|
Abgeschlossen bei
|
completed_at | string |
Nach Abschluss bei. |
|
Letzter Fehler
|
last_error | string |
Der letzte Fehler. |
|
Model
|
model | string |
Das Modell. |
|
Anweisungen
|
instructions | string |
Die Anweisungen. |
|
Tools
|
tools | array of object | |
|
Typ
|
tools.type | string |
Der Toolstyp. |
|
Datei-IDs
|
file_ids | array of string |
Die Datei-IDs. |
Get run (Ausführen)
Abrufen einer Ausführung aus einem Thread.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
|
Ausführungs-ID
|
run_id | True | string |
Den Ausführungsbezeichner |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
Assistenten-ID
|
assistant_id | string |
Der Assistentbezeichner. |
|
Thread-ID
|
thread_id | string |
Der Threadbezeichner. |
|
Der Status
|
status | string |
Der Status. |
|
Begonnen am
|
started_at | integer |
Wann beginnen sie bei. |
|
Läuft ab
|
expires_at | string |
Wann läuft ab. |
|
Abgebrochen am
|
cancelled_at | string |
Wann abgebrochen bei. |
|
Fehler bei
|
failed_at | string |
Wenn ein Fehler aufgetreten ist. |
|
Abgeschlossen bei
|
completed_at | integer |
Nach Abschluss bei. |
|
Letzter Fehler
|
last_error | string |
Der letzte Fehler. |
|
Model
|
model | string |
Das Modell. |
|
Anweisungen
|
instructions | string |
Die Anweisungen. |
|
Tools
|
tools | array of object | |
|
Typ
|
tools.type | string |
Der Toolstyp. |
|
Datei-IDs
|
file_ids | array of string |
Die Datei-IDs. |
Get run step
Rufen Sie einen Ausführungsschritt für einen Thread ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
|
Ausführungs-ID
|
run_id | True | string |
Den Ausführungsbezeichner |
|
Schritt-ID
|
step_id | True | string |
Der Schrittbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
Ausführungs-ID
|
run_id | string |
Den Ausführungsbezeichner |
|
Assistenten-ID
|
assistant_id | string |
Der Assistentbezeichner. |
|
Thread-ID
|
thread_id | string |
Der Threadbezeichner. |
|
Typ
|
type | string |
Der Typ. |
|
Der Status
|
status | string |
Der Status. |
|
Abgebrochen am
|
cancelled_at | string |
Wann abgebrochen bei. |
|
Abgeschlossen bei
|
completed_at | integer |
Nach Abschluss bei. |
|
Abgelaufen bei
|
expired_at | string |
Ist abgelaufen bei. |
|
Fehler bei
|
failed_at | string |
Wenn ein Fehler aufgetreten ist. |
|
Letzter Fehler
|
last_error | string |
Der letzte Fehler. |
|
Typ
|
step_details.type | string |
Der Typ. |
|
Nachrichten-ID
|
step_details.message_creation.message_id | string |
Der Nachrichtenbezeichner. |
Lösch-Assistent
Löscht einen Assistenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Assistenten-ID
|
assistant_id | True | string |
Der Assistentbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Gelöscht
|
deleted | boolean |
Gibt an, ob gelöscht wurde. |
Nachricht erstellen
Erstellen Sie eine Nachricht in einem Thread.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
Thread-ID
|
thread_id | string |
Der Threadbezeichner. |
|
Rolle
|
role | string |
Die Rolle. |
|
Content
|
content | array of object | |
|
Typ
|
content.type | string |
Der Toolstyp. |
|
Wert
|
content.text.value | string |
Der Wert. |
|
Anmerkungen
|
content.text.annotations | array of string |
Die Anmerkungen. |
|
Datei-IDs
|
file_ids | array of string |
Die Datei-IDs. |
|
Assistenten-ID
|
assistant_id | string |
Der Assistentbezeichner. |
|
Ausführungs-ID
|
run_id | string |
Den Ausführungsbezeichner |
Nachricht ändern
Ändert eine Nachricht.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
|
Nachrichten-ID
|
message_id | True | string |
Der Nachrichtenbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
Thread-ID
|
thread_id | string |
Der Threadbezeichner. |
|
Rolle
|
role | string |
Die Rolle. |
|
Content
|
content | array of object | |
|
Typ
|
content.type | string |
Der Toolstyp. |
|
Wert
|
content.text.value | string |
Der Wert. |
|
Anmerkungen
|
content.text.annotations | array of string |
Die Anmerkungen. |
|
Datei-IDs
|
file_ids | array of string |
Die Datei-IDs. |
|
Assistenten-ID
|
assistant_id | string |
Der Assistentbezeichner. |
|
Ausführungs-ID
|
run_id | string |
Den Ausführungsbezeichner |
Nachrichten auflisten
Dient zum Abrufen einer Liste von Nachrichten für einen bestimmten Thread.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
|
Limit
|
limit | integer |
Die Grenze. |
|
|
Bestellung
|
order | string |
Die Bestellung. |
|
|
Nach
|
after | string |
Das Nachher. |
|
|
Vorher
|
before | string |
Das vorher. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Object
|
object | string |
Das Objekt. |
|
Daten
|
data | array of object | |
|
ID
|
data.id | string |
Der Bezeichner. |
|
Object
|
data.object | string |
Das Objekt. |
|
Erstellt unter
|
data.created_at | integer |
Beim Erstellen bei. |
|
Thread-ID
|
data.thread_id | string |
Der Threadbezeichner. |
|
Rolle
|
data.role | string |
Die Rolle. |
|
Content
|
data.content | array of object | |
|
Typ
|
data.content.type | string |
Der Typ. |
|
Wert
|
data.content.text.value | string |
Der Wert. |
|
Anmerkungen
|
data.content.text.annotations | array of string |
Die Anmerkungen. |
|
Datei-IDs
|
data.file_ids | array of string |
Die Datei-IDs. |
|
Assistenten-ID
|
data.assistant_id | string |
Der Assistentbezeichner. |
|
Ausführungs-ID
|
data.run_id | string |
Den Ausführungsbezeichner |
|
Erste ID
|
first_id | string |
Der erste Bezeichner. |
|
Letzte ID
|
last_id | string |
Der letzte Bezeichner. |
|
Hat mehr
|
has_more | boolean |
Ob mehr. |
Nachrichtendateien auflisten
Ruft eine Liste der Nachrichtendateien für einen Thread ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
|
Nachrichten-ID
|
message_id | True | string |
Der Nachrichtenbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Object
|
object | string |
Das Objekt. |
|
Daten
|
data | array of object | |
|
ID
|
data.id | string |
Der Bezeichner. |
|
Object
|
data.object | string |
Das Objekt. |
|
Erstellt unter
|
data.created_at | integer |
Beim Erstellen bei. |
|
Nachrichten-ID
|
data.message_id | string |
Der Nachrichtenbezeichner. |
|
Erste ID
|
first_id | string |
Der erste Bezeichner. |
|
Letzte ID
|
last_id | string |
Der letzte Bezeichner. |
|
Hat mehr
|
has_more | boolean |
Ob mehr. |
Senden von Toolausgaben zur Ausführung
Wenn eine Ausführung den Status "requires_action" aufweist und required_action.type submit_tool_outputs ist, kann diese Aktion verwendet werden, um die Ausgaben aus den Toolaufrufen zu übermitteln, sobald sie alle abgeschlossen sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
|
Ausführungs-ID
|
run_id | True | string |
Den Ausführungsbezeichner |
|
Toolanruf-ID
|
tool_call_id | string |
Der Bezeichner für gebührenpflichtige Anrufe. |
|
|
Output
|
output | string |
Die Ausgabe. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
Assistenten-ID
|
assistant_id | string |
Der Assistentbezeichner. |
|
Thread-ID
|
thread_id | string |
Der Threadbezeichner. |
|
Der Status
|
status | string |
Der Status. |
|
Begonnen am
|
started_at | integer |
Wann beginnen sie bei. |
|
Läuft ab
|
expires_at | integer |
Wann läuft ab. |
|
Abgebrochen am
|
cancelled_at | string |
Wann abgebrochen bei. |
|
Fehler bei
|
failed_at | string |
Wenn ein Fehler aufgetreten ist. |
|
Abgeschlossen bei
|
completed_at | string |
Nach Abschluss bei. |
|
Letzter Fehler
|
last_error | string |
Der letzte Fehler. |
|
Model
|
model | string |
Das Modell. |
|
Anweisungen
|
instructions | string |
Die Anweisungen. |
|
Tools
|
tools | array of object | |
|
Typ
|
tools.type | string |
Der Toolstyp. |
|
Name
|
tools.function.name | string |
Der Name. |
|
Description
|
tools.function.description | string |
Die Beschreibung. |
|
Typ
|
tools.function.parameters.type | string |
Der Typ. |
|
Datei-IDs
|
file_ids | array of string |
Die Datei-IDs. |
Thread abrufen
Abrufen eines Threads.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
Thread erstellen
Erstellt einen Thread, mit dem Assistenten interagieren können.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
ID
|
id | string |
Der Bezeichner. |
|
|
Object
|
object | string |
Das Objekt. |
|
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
|
|
Thread-ID
|
thread_id | string |
Der Threadbezeichner. |
|
|
Rolle
|
role | True | string |
Die Rolle. |
|
Content
|
content | True | string |
Der Inhalt. |
|
Datei-IDs
|
file_ids | array of string |
Die Datei-IDs. |
|
|
Assistenten-ID
|
assistant_id | string |
Der Assistentbezeichner. |
|
|
Ausführungs-ID
|
run_id | string |
Den Ausführungsbezeichner |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |
Thread löschen
Löscht einen Thread.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Gelöscht
|
deleted | boolean |
Gibt an, ob gelöscht wurde. |
Ändern eines Threads
Ändert einen Thread.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betaheader
|
OpenAI-Beta | True | string |
Der Betaheader. Muss festgelegt werden, während sich die API in der Betaversion befindet. |
|
Thread-ID
|
thread_id | True | string |
Der Threadbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Object
|
object | string |
Das Objekt. |
|
Erstellt unter
|
created_at | integer |
Beim Erstellen bei. |