@azure/openai-assistants package
Klassen
AssistantsClient |
Clientverarbeitung Assistent bezogene Vorgänge. |
AzureKeyCredential |
Eine auf statischen Schlüsseln basierende 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 Assistentenclient für einen OpenAI-Endpunkt zu authentifizieren. |
Schnittstellen
Assistant |
Stellt einen Assistent dar, der das Modell aufrufen und Tools verwenden kann. |
AssistantCreationOptions |
Die Anforderungsdetails, die beim Erstellen eines neuen Assistent verwendet werden sollen. |
AssistantDeletionStatus |
Die status eines Assistent Löschvorgangs. |
AssistantFile |
Informationen zu einer Datei, die an eine Assistent angefügt ist, wie sie von Tools verwendet werden, die Dateien lesen können. |
AssistantFileDeletionStatus |
Die status eines Assistent Dateilöschvorgangs. |
AssistantThread |
Informationen zu einem einzelnen Thread, der einem Assistent zugeordnet ist. |
AssistantThreadCreationOptions |
Die Details, die zum Erstellen eines neuen Assistent Threads verwendet werden. |
AssistantsClientOptions |
Die Details, die zum Erstellen eines Assistent Clients * verwendet werden |
CancelRunOptions |
Die Details, die zum Abbrechen einer Ausführung verwendet werden. |
CodeInterpreterImageOutput |
Eine Darstellung einer Bildausgabe, die von einem Codeinterpretertool als Reaktion auf einen Toolaufruf des Modells ausgegeben wird. |
CodeInterpreterImageReference |
Ein Bildverweis, der von einem Codeinterpretertool als Reaktion auf einen Toolaufruf durch das Modell ausgegeben wird. |
CodeInterpreterLogOutput |
Eine Darstellung einer Protokollausgabe, die von einem Codeinterpretertool als Reaktion auf einen Toolaufruf des Modells ausgegeben wird. |
CodeInterpreterToolCall |
Ein Datensatz eines Aufrufs an ein Codeinterpretertool, der vom Modell in der Auswertung eines definierten Tools ausgegeben wird und die vom Codeinterpreter verbrauchten und ausgegebenen Eingaben und Ausgaben darstellt. |
CodeInterpreterToolCallDetails |
Die detaillierten Informationen zum Aufruf eines Codeinterpreters durch das Modell. |
CodeInterpreterToolDefinition |
Die Eingabedefinitionsinformationen für ein Codeinterpretertool, wie sie zum Konfigurieren einer Assistent verwendet werden. |
CreateAndRunThreadOptions |
Die Details, die beim Erstellen und sofortigen Ausführen eines neuen Assistent Threads verwendet werden. |
CreateAssistantFileOptions |
Die Details, die zum Erstellen einer Assistent-Datei verwendet werden. |
CreateAssistantOptions |
Die Details, die zum Erstellen einer Assistent verwendet werden. |
CreateMessageOptions |
Die Details, die zum Erstellen einer Nachricht verwendet werden. |
CreateRunOptions |
Die Details, die beim Erstellen einer neuen Ausführung eines Assistent Threads 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 Assistent-Datei verwendet werden. |
DeleteAssistantOptions |
Die Details, die zum Löschen einer Assistent verwendet werden. |
DeleteFileOptions |
Die Zum Löschen von Dateien verwendeten Details. |
DeleteThreadOptions |
Die Details, die zum Löschen eines Threads verwendet werden. |
DeletionStatus |
Eine abstrakte Darstellung eines OpenAI-Löschvorgangsergebnisses status. |
FileDeletionStatus |
Eine status Antwort eines Dateilöschvorgangs. |
FileListResponse |
Die Antwortdaten aus einem Dateilistenvorgang. |
FunctionDefinition |
Die Eingabedefinitionsinformationen für eine Funktion. |
FunctionToolCall |
Ein Datensatz eines Aufrufs an ein Funktionstool, der vom Modell bei der Auswertung eines definierten Tools ausgegeben wird und die von der angegebenen Funktion verbrauchten und ausgegebenen Eingaben und Ausgaben darstellt. |
FunctionToolCallDetails |
Die detaillierten Informationen zur Funktion, die vom Modell aufgerufen wird. |
FunctionToolDefinition |
Die Eingabedefinitionsinformationen für ein Funktionstool, wie sie zum Konfigurieren einer Assistent verwendet werden. |
GetAssistantFileOptions |
Die Details, die zum Abrufen einer Assistent-Datei verwendet werden. |
GetAssistantOptions |
Die Details, die zum Abrufen einer Assistent verwendet werden. |
GetFileOptions |
Die Zum Abrufen von Dateien verwendeten Details. |
GetMessageFileOptions |
Die Details, die zum Abrufen einer Nachrichtendatei verwendet werden. |
GetMessageOptions |
Die Details, die zum Abrufen einer Nachricht verwendet werden. |
GetRunOptions |
Die Details, die zum Abrufen einer Ausführung verwendet werden. |
GetRunStepOptions |
Die Details, die zum Abrufen eines Ausführungsschritts verwendet werden. |
GetThreadOptions |
Die Details, die zum Abrufen eines Threads verwendet werden. |
InputFile |
Stellt einen Assistent dar, der das Modell aufrufen und Tools verwenden kann. |
ListAssistantFilesOptions |
Die Details, die zum Auflisten Assistent Dateien verwendet werden. |
ListAssistantsOptions |
Die Details, die zum Auflisten von Assistenten verwendet werden. |
ListFilesOptions |
Die Zum Auflisten von Dateien verwendeten Details. |
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 der Ausführungsschritte verwendet werden. |
ListRunsOptions |
Die Details, die zum Auflisten von Ausführungen verwendet werden. |
MessageFile |
Informationen zu einer Datei, die an eine Assistent Threadnachricht angefügt ist. |
MessageImageFileContent |
Eine Darstellung des Bilddateiinhalts in einer Threadnachricht. |
MessageImageFileDetails |
Ein Bildverweis, wie im Threadnachrichteninhalt dargestellt. |
MessageTextContent |
Eine Darstellung eines Textelements des Threadnachrichteninhalts. |
MessageTextDetails |
Der Text und die zugehörigen Anmerkungen für ein einzelnes Element von Assistent Threadnachrichteninhalt. |
MessageTextFileCitationAnnotation |
Ein Zitat innerhalb der Nachricht, das auf ein bestimmtes Zitat aus einer bestimmten Datei verweist, die dem Assistent oder der Nachricht zugeordnet ist. Wird generiert, wenn der Assistent das Tool "Abruf" zum Durchsuchen von Dateien verwendet. |
MessageTextFileCitationDetails |
Eine Darstellung eines dateibasierten Textzitats, wie es in einer dateibasierten Anmerkung des Inhalts von Textthreadnachrichten verwendet wird. |
MessageTextFilePathAnnotation |
Ein Zitat innerhalb der Nachricht, das auf eine Datei verweist, die sich an einem bestimmten Pfad befindet. |
MessageTextFilePathDetails |
Eine Kapselung einer Bilddatei-ID, wie sie vom Nachrichtenbildinhalt verwendet wird. |
RequiredAction |
Eine abstrakte Darstellung einer erforderlichen Aktion, damit eine Assistent Threadausführung fortgesetzt werden kann. |
RequiredFunctionToolCall |
Eine Darstellung eines angeforderten Aufrufs eines Funktionstools, der vom Modell benötigt wird, um die Auswertung einer Ausführung fortzusetzen. |
RetrievalToolCall |
Ein Datensatz eines Aufrufs an ein Abruftool, der vom Modell in der Auswertung eines definierten Tools ausgegeben wird und ausgeführte Abrufaktionen darstellt. |
RetrievalToolDefinition |
Die Eingabedefinitionsinformationen für ein Abruftool, wie sie zum Konfigurieren einer Assistent verwendet werden. |
RunError |
Die Details eines Fehlers, der bei einer Assistent Threadausführung auftritt. |
RunStep |
Ausführliche Informationen zu einem einzelnen Schritt einer Assistent Threadausführung. |
RunStepError |
Die Fehlerinformationen, die einem Fehlerhaften Ausführungsschritt zugeordnet sind. |
RunStepMessageCreationDetails |
Die detaillierten Informationen, die einem Schritt zur Ausführung der Nachrichtenerstellung zugeordnet sind. |
RunStepMessageCreationReference |
Die Details einer Nachricht, die im Rahmen eines Ausführungsschritts erstellt wurde. |
RunStepToolCallDetails |
Die detaillierten Informationen, die tools für den Ausführungsschrittaufruf zugeordnet sind. |
SubmitToolOutputsDetails |
Die Details, die Tools beschreiben, die aufgerufen werden sollen, um Toolausgaben zu übermitteln. |
SubmitToolOutputsToRunOptions |
Die Details, die zum Übermitteln von Toolausgaben an eine Ausführung verwendet werden. |
ThreadDeletionStatus |
Die status eines Threadlöschvorgangs. |
ThreadMessage |
Eine einzelne, vorhandene Nachricht innerhalb eines Assistent Threads. |
ThreadRun |
Daten, die eine einzelne Auswertungsausführung eines Assistent Threads darstellen. |
ToolOutput |
Die während eines Tools bereitgestellten Daten geben die Übermittlung aus, um ausstehende Toolaufrufe aufzulösen und das Fortsetzen des Modells zu ermöglichen. |
UpdateAssistantOptions |
Die Anforderungsdetails, die beim Ändern eines vorhandenen Assistent verwendet werden sollen. |
UpdateAssistantRequestOptions |
Die Details, die zum Aktualisieren eines Assistent 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 Zum Hochladen von Dateien verwendeten Details. |
Typaliase
CodeInterpreterToolCallOutput |
Alias für CodeInterpreterToolCallOutput |
FilePurpose |
"fine-tune", "fine-tune-results", "assistants", "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", "cancelled", "failed", "completed", "expired" |
RunStepType |
"message_creation", "tool_calls" |
ToolCall |
Alias für ToolCall |
ToolDefinition |
Eine abstrakte Darstellung einer Eingabetooldefinition, die ein Assistent verwenden kann. |
Azure SDK for JavaScript