@azure/openai-assistants package

Klassen

AssistantsClient	Assistent-bezogene Clientbehandlungsvorgänge.
AzureKeyCredential	Statische Schlüsselbasierte Anmeldeinformationen, die das Aktualisieren des zugrunde liegenden Schlüsselwerts unterstützen.
OpenAIKeyCredential	Die OpenAIKeyCredential-Klasse stellt einen OpenAI-API-Schlüssel dar und wird verwendet, um sich bei einem Assistants-Client für einen OpenAI-Endpunkt zu authentifizieren.

Schnittstellen

Assistant	Stellt einen Assistenten dar, der das Modell aufrufen und Werkzeuge verwenden kann.
AssistantCreationOptions	Die Anforderungsdetails, die beim Erstellen eines neuen Assistenten verwendet werden sollen.
AssistantDeletionStatus	Der Status eines Assistenten-Löschvorgangs.
AssistantFile	Informationen zu einer Datei, die an einen Assistenten angehängt ist, wie sie von Tools verwendet werden, die Dateien lesen können.
AssistantFileDeletionStatus	Der Status eines Assistenten-Dateilöschvorgangs.
AssistantThread	Informationen zu einem einzelnen Thread, der einem Assistenten zugeordnet ist.
AssistantThreadCreationOptions	Die Details, die zum Erstellen eines neuen Assistenten-Threads verwendet werden.
AssistantsClientOptions	Die Details zum Erstellen eines Assistentenclients *
CancelRunOptions	Die Details, die zum Abbrechen einer Ausführung verwendet werden.
CodeInterpreterImageOutput	Eine Darstellung einer Bildausgabe, die von einem Codedolmetschertool als Reaktion auf einen Toolaufruf des Modells ausgegeben wird.
CodeInterpreterImageReference	Ein Bildverweis, der von einem Codedolmetschertool als Reaktion auf einen Toolaufruf des Modells ausgegeben wird.
CodeInterpreterLogOutput	Eine Darstellung einer Protokollausgabe, die von einem Codedolmetschertool als Reaktion auf einen Toolaufruf des Modells ausgegeben wird.
CodeInterpreterToolCall	Eine Aufzeichnung eines Aufrufs an ein Codedolmetschertool, das vom Modell bei der Auswertung eines definierten Tools ausgegeben wird, das Eingaben und Ausgaben darstellt, die vom Codedolmetscher verbraucht und ausgegeben werden.
CodeInterpreterToolCallDetails	Die detaillierten Informationen über einen Codedolmetscheraufruf durch das Modell.
CodeInterpreterToolDefinition	Die Eingabedefinitionsinformationen für ein Codeinterpreter-Tool, die zum Konfigurieren eines Assistenten verwendet werden.
CreateAndRunThreadOptions	Die Details, die beim Erstellen und sofortigen Ausführen eines neuen Assistententhreads verwendet werden.
CreateAssistantFileOptions	Die Details, die zum Erstellen einer Assistentendatei verwendet werden.
CreateAssistantOptions	Die Details, die zum Erstellen eines Assistenten verwendet werden.
CreateMessageOptions	Die Details, die zum Erstellen einer Nachricht verwendet werden.
CreateRunOptions	Die Details, die beim Erstellen einer neuen Ausführung eines Assistententhreads verwendet werden.
CreateRunRequestOptions	Die Details, die zum Erstellen einer Ausführungsanforderung verwendet werden.
CreateThreadAndRunOptions	Die Details, die zum Erstellen und Ausführen eines Threads verwendet werden.
CreateThreadOptions	Die Details, die zum Erstellen eines Threads verwendet werden.
DeleteAssistantFileOptions	Die Details, die zum Löschen einer Assistentendatei verwendet werden.
DeleteAssistantOptions	Die Details, die zum Löschen eines Assistenten verwendet werden.
DeleteFileOptions	Die Details, die zum Löschen von Dateien verwendet werden.
DeleteThreadOptions	Die Details, die zum Löschen eines Threads verwendet werden.
DeletionStatus	Eine abstrakte Darstellung des Ergebnisstatus einer OpenAI-Löschoperation.
FileDeletionStatus	Eine Statusantwort eines Dateilöschvorgangs.
FileListResponse	Die Antwortdaten aus einem Dateilistenvorgang.
FunctionDefinition	Die Eingabedefinitionsinformationen für eine Funktion.
FunctionToolCall	Ein Datensatz eines Aufrufs an ein Funktionstool, das vom Modell bei der Auswertung eines definierten Tools ausgegeben wird, das die von der angegebenen Funktion verbrauchten Eingaben und Ausgaben darstellt.
FunctionToolCallDetails	Die detaillierten Informationen zur Funktion, die vom Modell aufgerufen wird.
FunctionToolDefinition	Die Eingabedefinitionsinformationen für ein Funktionswerkzeug, wie sie zum Konfigurieren eines Assistenten verwendet werden.
GetAssistantFileOptions	Die Details, die zum Abrufen einer Assistentendatei verwendet werden.
GetAssistantOptions	Die Details, die verwendet werden, um einen Assistenten zu erhalten.
GetFileOptions	Die Details, die zum Abrufen von Dateien verwendet werden.
GetMessageFileOptions	Die Details, die zum Abrufen einer Nachrichtendatei verwendet werden.
GetMessageOptions	Die Details, die zum Abrufen einer Nachricht verwendet werden.
GetRunOptions	Die Details, die verwendet werden, um einen Lauf zu erhalten.
GetRunStepOptions	Die Details, die zum Abrufen eines Ausführungsschritts verwendet werden.
GetThreadOptions	Die Details, die zum Abrufen eines Threads verwendet werden.
InputFile	Stellt einen Assistenten dar, der das Modell aufrufen und Werkzeuge verwenden kann.
ListAssistantFilesOptions	Die Details, die zum Auflisten von Assistentendateien verwendet werden.
ListAssistantsOptions	Die Details, die zum Auflisten von Assistenten verwendet werden.
ListFilesOptions	Die Details, die zum Auflisten von Dateien verwendet werden.
ListMessageFilesOptions	Die Details, die zum Auflisten von Nachrichtendateien verwendet werden.
ListMessagesOptions	Die Details, die zum Auflisten von Nachrichten verwendet werden.
ListResponseOf	Die Antwortdaten für eine angeforderte Liste von Elementen.
ListRunStepsOptions	Die Details, die zum Auflisten von Ausführungsschritten verwendet werden.
ListRunsOptions	Die Details, die zum Auflisten von Ausführungen verwendet werden.
MessageFile	Informationen zu einer Datei, die an eine Assistenten-Threadnachricht angefügt ist.
MessageImageFileContent	Eine Darstellung des Bilddateiinhalts in einer Threadnachricht.
MessageImageFileDetails	Ein Bildverweis, wie in Threadnachrichteninhalt dargestellt.
MessageTextContent	Eine Darstellung eines textbezogenen Elements von Threadnachrichteninhalten.
MessageTextDetails	Der Text und die zugehörigen Anmerkungen für ein einzelnes Element des Inhalts von Threadnachrichten des Assistenten.
MessageTextFileCitationAnnotation	Ein Zitat innerhalb der Nachricht, das auf ein bestimmtes Zitat aus einer bestimmten Datei verweist, die dem Assistenten oder der Nachricht zugeordnet ist. Wird generiert, wenn der Assistent das Tool "Abrufen" verwendet, um Dateien zu durchsuchen.
MessageTextFileCitationDetails	Eine Darstellung eines dateibasierten Textzitats, wie in einer dateibasierten Anmerkung des Textthreadnachrichteninhalts verwendet.
MessageTextFilePathAnnotation	Ein Zitat innerhalb der Nachricht, das auf eine Datei verweist, die sich in einem bestimmten Pfad befindet.
MessageTextFilePathDetails	Eine Kapselung einer Bilddatei-ID, wie sie von Nachrichtenbildinhalten verwendet wird.
RequiredAction	Eine abstrakte Darstellung einer Aktion, die erforderlich ist, damit ein Assistententhread ausgeführt werden kann, um fortzufahren.
RequiredFunctionToolCall	Eine Darstellung eines angeforderten Aufrufs eines Funktionstools, die vom Modell benötigt wird, um die Auswertung einer Ausführung fortzusetzen.
RetrievalToolCall	Ein Datensatz eines Aufrufs eines Abrufwerkzeugs, der vom Modell bei der Auswertung eines definierten Werkzeugs ausgegeben wird und ausgeführte Abrufaktionen darstellt.
RetrievalToolDefinition	Die Eingabedefinitionsinformationen für ein Abrufwerkzeug, wie sie zum Konfigurieren eines Assistenten verwendet werden.
RunError	Die Details eines Fehlers, wie sie bei der Threadausführung eines Assistenten aufgetreten sind.
RunStep	Detaillierte Informationen zu einem einzelnen Schritt eines Assistenten-Threadlaufs.
RunStepError	Die Fehlerinformationen, die einem fehlgeschlagenen Ausführungsschritt zugeordnet sind.
RunStepMessageCreationDetails	Die detaillierten Informationen, die einem Schritt zur Erstellung von Nachrichten zugeordnet sind.
RunStepMessageCreationReference	Die Details einer Nachricht, die als Teil eines Ausführungsschritts erstellt wurde.
RunStepToolCallDetails	Die detaillierten Informationen, die mit den Aufrufen von Ausführungsschritten verknüpft sind.
SubmitToolOutputsDetails	Die Details, die Tools beschreiben, die aufgerufen werden sollten, um Toolausgaben zu übermitteln.
SubmitToolOutputsToRunOptions	Die Details, die zum Übermitteln von Werkzeugausgaben an eine Ausführung verwendet werden.
ThreadDeletionStatus	Der Status eines Threadlöschvorgangs.
ThreadMessage	Eine einzelne, vorhandene Nachricht innerhalb eines Assistententhreads.
ThreadRun	Daten, die einen einzelnen Auswertungslauf eines Assistenten-Threads darstellen.
ToolOutput	Die daten, die während einer Toolübermittlung bereitgestellt werden, um ausstehende Toolaufrufe aufzulösen und den Vorgang des Modells zu ermöglichen.
UpdateAssistantOptions	Die Anforderungsdetails, die beim Ändern eines vorhandenen Assistenten verwendet werden sollen.
UpdateAssistantRequestOptions	Die Details, die zum Aktualisieren eines Assistenten verwendet werden.
UpdateMessageOptions	Die Details, die zum Aktualisieren einer Nachricht verwendet werden.
UpdateRunOptions	Die Details, die zum Aktualisieren einer Ausführung verwendet werden.
UpdateThreadOptions	Die Details, die zum Aktualisieren eines Threads verwendet werden.
UploadFileOptions	Die Details, die zum Hochladen von Dateien verwendet werden.

Typaliase

CodeInterpreterToolCallOutput	Alias für CodeInterpreterToolCallOutput
FilePurpose	"Feinabstimmung", "Feinabstimmungsergebnisse", "Assistenten", "assistants_output"
ListSortOrder	"asc", "desc"
MessageContent	Alias für MessageContent
MessageRole	"Benutzer", "Assistent"
MessageTextAnnotation	Alias für MessageTextAnnotation
RequiredToolCall	Alias für RequiredToolCall
RunStatus	"queued", "in_progress", "requires_action", "cancelling", "cancelled", "failed", "completed", "expired"
RunStepDetails	Alias für RunStepDetails
RunStepErrorCode	"server_error", "rate_limit_exceeded"
RunStepStatus	"in_progress", "storniert", "nicht bestanden", "abgeschlossen", "abgelaufen"
RunStepType	"message_creation", "tool_calls"
ToolCall	Alias für ToolCall
ToolDefinition	Eine abstrakte Darstellung einer Eingabewerkzeugdefinition, die von einem Assistenten verwendet werden kann.