AssistantsClient class
Clientverarbeitung Assistent vorgänge.
Konstruktoren
| Assistants |
Initialisiert eine instance von AssistantsClient zur Verwendung mit dem Nicht-Azure OpenAI-Endpunkt. |
| Assistants |
Initialisiert eine instance von AssistantsClient zur Verwendung mit einer OpenAI-Ressource. |
| Assistants |
Initialisiert eine instance von AssistantsClient für die Verwendung mit einer Azure OpenAI-Ressource. |
Eigenschaften
| pipeline | Die Pipeline, die von diesem Client zum Senden von Anforderungen verwendet wird |
Methoden
| cancel |
Bricht eine Ausführung eines threads in Bearbeitung ab. |
| create |
Erstellt eine neue Assistent. |
| create |
Fügt eine zuvor hochgeladene Datei an eine Assistent zur Verwendung durch Tools an, die Dateien lesen können. |
| create |
Erstellt eine neue Nachricht für einen angegebenen Thread. |
| create |
Erstellt eine neue Ausführung für einen Assistent Thread. |
| create |
Erstellt einen neuen Thread. Threads enthalten Nachrichten und können von Assistenten ausgeführt werden. |
| create |
Erstellt einen neuen Assistent Thread und startet sofort eine Ausführung mit diesem neuen Thread. |
| delete |
Löscht einen Assistent. |
| delete |
Hebt die Verknüpfung einer zuvor angefügten Datei mit einem Assistent auf, sodass sie für die Verwendung durch Tools, die Dateien lesen können, nicht verfügbar ist. |
| delete |
Löschen Sie eine zuvor hochgeladene Datei. |
| delete |
Löscht einen vorhandenen Thread. |
| get |
Ruft eine vorhandene Assistent ab. |
| get |
Ruft eine Datei ab, die einer Assistent angefügt ist. |
| get |
Gibt Informationen zu einer bestimmten Datei zurück. Es werden keine Dateiinhalte abgerufen. |
| get |
Ruft eine vorhandene Nachricht aus einem vorhandenen Thread ab. |
| get |
Ruft Informationen zu einer Dateianlage zu einer Nachricht in einem Thread ab. |
| get |
Ruft eine vorhandene Ausführung aus einem vorhandenen Thread ab. |
| get |
Ruft einen einzelnen Ausführungsschritt aus einer Threadausführung ab. |
| get |
Ruft Informationen zu einem vorhandenen Thread ab. |
| list |
Ruft eine Liste der Dateien ab, die an einen bestimmten Assistent angefügt sind, wie sie von Tools verwendet werden, die Dateien lesen können. |
| list |
Ruft eine Liste der Assistenten ab, die zuvor erstellt wurden. |
| list |
Ruft eine Liste der zuvor hochgeladenen Dateien ab. |
| list |
Ruft eine Liste der zuvor hochgeladenen Dateien ab, die einer Nachricht aus einem Thread zugeordnet sind. |
| list |
Ruft eine Liste der Nachrichten ab, die in einem Thread vorhanden sind. |
| list |
Ruft eine Liste der Ausführungen für einen angegebenen Thread ab. |
| list |
Ruft eine Liste der Ausführungsschritte aus einer Threadausführung ab. |
| submit |
Übermittelt Ausgaben von Tools, wie von Toolaufrufen in einer Ausführung angefordert. Ausführungen, die übermittelte Toolausgaben benötigen, verfügen über eine status von "requires_action" mit einem required_action.type von "submit_tool_outputs". |
| update |
Ändert einen vorhandenen Assistent. |
| update |
Ändert eine vorhandene Nachricht in einem vorhandenen Thread. |
| update |
Ändert eine vorhandene Threadausführung. |
| update |
Ändert einen vorhandenen Thread. |
| upload |
Lädt eine Datei zur Verwendung durch andere Vorgänge hoch. |
Details zum Konstruktor
AssistantsClient(KeyCredential, AssistantsClientOptions)
Initialisiert eine instance von AssistantsClient zur Verwendung mit dem Nicht-Azure OpenAI-Endpunkt.
new AssistantsClient(openAiApiKey: KeyCredential, options?: AssistantsClientOptions)Parameter
- openAiApiKey
- KeyCredential
Der API-Schlüssel, der beim Herstellen einer Verbindung mit dem Nicht-Azure OpenAI-Endpunkt verwendet werden soll.
- options
- AssistantsClientOptions
Die Optionen zum Konfigurieren des Clients.
Hinweise
AssistantsClient-Objekte, die mit diesem Konstruktor initialisiert wurden, können nur mit dem Nicht-Azure OpenAI-Rückschlussendpunkt verwendet werden. Um AssistantsClient mit einer Azure OpenAI-Ressource zu verwenden, verwenden Sie stattdessen einen Konstruktor, der einen Ressourcen-URI und Azure-Authentifizierungsanmeldeinformationen akzeptiert.
AssistantsClient(string, KeyCredential, AssistantsClientOptions)
Initialisiert eine instance von AssistantsClient zur Verwendung mit einer OpenAI-Ressource.
new AssistantsClient(endpoint: string, credential: KeyCredential, options?: AssistantsClientOptions)Parameter
- endpoint
-
string
Der URI für eine Azure OpenAI-Ressource, einschließlich Protokoll und Hostname. Beispiel: https://my-resource.openai.azure.com.
- credential
- KeyCredential
Schlüsselanmeldeinformationen, die für die Authentifizierung bei einer Azure OpenAI-Ressource verwendet werden.
- options
- AssistantsClientOptions
Die Optionen zum Konfigurieren des Clients.
Hinweise
Dieser Konstruktor initialisiert ein AssistantsClient-Objekt, das nur mit Azure OpenAI-Ressourcen verwendet werden kann. Um AssistantsClient mit einem Nicht-Azure OpenAI-Rückschlussendpunkt zu verwenden, verwenden Sie stattdessen einen Konstruktor, der einen Nicht-Azure OpenAI-API-Schlüssel akzeptiert.
AssistantsClient(string, TokenCredential, AssistantsClientOptions)
Initialisiert eine instance von AssistantsClient für die Verwendung mit einer Azure OpenAI-Ressource.
new AssistantsClient(endpoint: string, credential: TokenCredential, options?: AssistantsClientOptions)Parameter
- endpoint
-
string
Der URI für eine Azure OpenAI-Ressource, einschließlich Protokoll und Hostname. Beispiel: https://my-resource.openai.azure.com.
- credential
- TokenCredential
Tokenanmeldeinformationen, die für die Authentifizierung bei einer Azure OpenAI-Ressource verwendet werden.
- options
- AssistantsClientOptions
Die Optionen zum Konfigurieren des Clients.
Details zur Eigenschaft
pipeline
Die Pipeline, die von diesem Client zum Senden von Anforderungen verwendet wird
pipeline: PipelineEigenschaftswert
Details zur Methode
cancelRun(string, string, CancelRunOptions)
Bricht eine Ausführung eines threads in Bearbeitung ab.
function cancelRun(threadId: string, runId: string, options?: CancelRunOptions): Promise<ThreadRun>Parameter
- threadId
-
string
- runId
-
string
- options
- CancelRunOptions
Gibt zurück
Promise<ThreadRun>
createAssistant(AssistantCreationOptions, CreateAssistantOptions)
Erstellt eine neue Assistent.
function createAssistant(body: AssistantCreationOptions, options?: CreateAssistantOptions): Promise<Assistant>Parameter
- options
- CreateAssistantOptions
Gibt zurück
Promise<Assistant>
createAssistantFile(string, string, CreateAssistantFileOptions)
Fügt eine zuvor hochgeladene Datei an eine Assistent zur Verwendung durch Tools an, die Dateien lesen können.
function createAssistantFile(assistantId: string, fileId: string, options?: CreateAssistantFileOptions): Promise<AssistantFile>Parameter
- assistantId
-
string
- fileId
-
string
- options
- CreateAssistantFileOptions
Gibt zurück
Promise<AssistantFile>
createMessage(string, string, string, CreateMessageOptions)
Erstellt eine neue Nachricht für einen angegebenen Thread.
function createMessage(threadId: string, role: string, content: string, options?: CreateMessageOptions): Promise<ThreadMessage>Parameter
- threadId
-
string
- role
-
string
- content
-
string
- options
- CreateMessageOptions
Gibt zurück
Promise<ThreadMessage>
createRun(string, CreateRunOptions, CreateRunRequestOptions)
Erstellt eine neue Ausführung für einen Assistent Thread.
function createRun(threadId: string, createRunOptions: CreateRunOptions, options?: CreateRunRequestOptions): Promise<ThreadRun>Parameter
- threadId
-
string
- createRunOptions
- CreateRunOptions
- options
- CreateRunRequestOptions
Gibt zurück
Promise<ThreadRun>
createThread(AssistantThreadCreationOptions, CreateThreadOptions)
Erstellt einen neuen Thread. Threads enthalten Nachrichten und können von Assistenten ausgeführt werden.
function createThread(body?: AssistantThreadCreationOptions, options?: CreateThreadOptions): Promise<AssistantThread>Parameter
- options
- CreateThreadOptions
Gibt zurück
Promise<AssistantThread>
createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)
Erstellt einen neuen Assistent Thread und startet sofort eine Ausführung mit diesem neuen Thread.
function createThreadAndRun(body: CreateAndRunThreadOptions, options?: CreateThreadAndRunOptions): Promise<ThreadRun>Parameter
- options
- CreateThreadAndRunOptions
Gibt zurück
Promise<ThreadRun>
deleteAssistant(string, DeleteAssistantOptions)
Löscht einen Assistent.
function deleteAssistant(assistantId: string, options?: DeleteAssistantOptions): Promise<AssistantDeletionStatus>Parameter
- assistantId
-
string
- options
- DeleteAssistantOptions
Gibt zurück
Promise<AssistantDeletionStatus>
deleteAssistantFile(string, string, DeleteAssistantFileOptions)
Hebt die Verknüpfung einer zuvor angefügten Datei mit einem Assistent auf, sodass sie für die Verwendung durch Tools, die Dateien lesen können, nicht verfügbar ist.
function deleteAssistantFile(assistantId: string, fileId: string, options?: DeleteAssistantFileOptions): Promise<AssistantFileDeletionStatus>Parameter
- assistantId
-
string
- fileId
-
string
- options
- DeleteAssistantFileOptions
Gibt zurück
Promise<AssistantFileDeletionStatus>
deleteFile(string, DeleteFileOptions)
Löschen Sie eine zuvor hochgeladene Datei.
function deleteFile(fileId: string, options?: DeleteFileOptions): Promise<FileDeletionStatus>Parameter
- fileId
-
string
- options
- DeleteFileOptions
Gibt zurück
Promise<FileDeletionStatus>
deleteThread(string, DeleteThreadOptions)
Löscht einen vorhandenen Thread.
function deleteThread(threadId: string, options?: DeleteThreadOptions): Promise<ThreadDeletionStatus>Parameter
- threadId
-
string
- options
- DeleteThreadOptions
Gibt zurück
Promise<ThreadDeletionStatus>
getAssistant(string, GetAssistantOptions)
Ruft eine vorhandene Assistent ab.
function getAssistant(assistantId: string, options?: GetAssistantOptions): Promise<Assistant>Parameter
- assistantId
-
string
- options
- GetAssistantOptions
Gibt zurück
Promise<Assistant>
getAssistantFile(string, string, GetAssistantFileOptions)
Ruft eine Datei ab, die einer Assistent angefügt ist.
function getAssistantFile(assistantId: string, fileId: string, options?: GetAssistantFileOptions): Promise<AssistantFile>Parameter
- assistantId
-
string
- fileId
-
string
- options
- GetAssistantFileOptions
Gibt zurück
Promise<AssistantFile>
getFile(string, GetFileOptions)
Gibt Informationen zu einer bestimmten Datei zurück. Es werden keine Dateiinhalte abgerufen.
function getFile(fileId: string, options?: GetFileOptions): Promise<InputFile>Parameter
- fileId
-
string
- options
- GetFileOptions
Gibt zurück
Promise<InputFile>
getMessage(string, string, GetMessageOptions)
Ruft eine vorhandene Nachricht aus einem vorhandenen Thread ab.
function getMessage(threadId: string, messageId: string, options?: GetMessageOptions): Promise<ThreadMessage>Parameter
- threadId
-
string
- messageId
-
string
- options
- GetMessageOptions
Gibt zurück
Promise<ThreadMessage>
getMessageFile(string, string, string, GetMessageFileOptions)
Ruft Informationen zu einer Dateianlage zu einer Nachricht in einem Thread ab.
function getMessageFile(threadId: string, messageId: string, fileId: string, options?: GetMessageFileOptions): Promise<MessageFile>Parameter
- threadId
-
string
- messageId
-
string
- fileId
-
string
- options
- GetMessageFileOptions
Gibt zurück
Promise<MessageFile>
getRun(string, string, GetRunOptions)
Ruft eine vorhandene Ausführung aus einem vorhandenen Thread ab.
function getRun(threadId: string, runId: string, options?: GetRunOptions): Promise<ThreadRun>Parameter
- threadId
-
string
- runId
-
string
- options
- GetRunOptions
Gibt zurück
Promise<ThreadRun>
getRunStep(string, string, string, GetRunStepOptions)
Ruft einen einzelnen Ausführungsschritt aus einer Threadausführung ab.
function getRunStep(threadId: string, runId: string, stepId: string, options?: GetRunStepOptions): Promise<RunStep>Parameter
- threadId
-
string
- runId
-
string
- stepId
-
string
- options
- GetRunStepOptions
Gibt zurück
Promise<RunStep>
getThread(string, GetThreadOptions)
Ruft Informationen zu einem vorhandenen Thread ab.
function getThread(threadId: string, options?: GetThreadOptions): Promise<AssistantThread>Parameter
- threadId
-
string
- options
- GetThreadOptions
Gibt zurück
Promise<AssistantThread>
listAssistantFiles(string, ListAssistantFilesOptions)
Ruft eine Liste der Dateien ab, die an einen bestimmten Assistent angefügt sind, wie sie von Tools verwendet werden, die Dateien lesen können.
function listAssistantFiles(assistantId: string, options?: ListAssistantFilesOptions): Promise<ListResponseOf<AssistantFile>>Parameter
- assistantId
-
string
- options
- ListAssistantFilesOptions
Gibt zurück
Promise<ListResponseOf<AssistantFile>>
listAssistants(ListAssistantsOptions)
Ruft eine Liste der Assistenten ab, die zuvor erstellt wurden.
function listAssistants(options?: ListAssistantsOptions): Promise<ListResponseOf<Assistant>>Parameter
- options
- ListAssistantsOptions
Gibt zurück
Promise<ListResponseOf<Assistant>>
listFiles(ListFilesOptions)
Ruft eine Liste der zuvor hochgeladenen Dateien ab.
function listFiles(options?: ListFilesOptions): Promise<FileListResponse>Parameter
- options
- ListFilesOptions
Gibt zurück
Promise<FileListResponse>
listMessageFiles(string, string, ListMessageFilesOptions)
Ruft eine Liste der zuvor hochgeladenen Dateien ab, die einer Nachricht aus einem Thread zugeordnet sind.
function listMessageFiles(threadId: string, messageId: string, options?: ListMessageFilesOptions): Promise<ListResponseOf<MessageFile>>Parameter
- threadId
-
string
- messageId
-
string
- options
- ListMessageFilesOptions
Gibt zurück
Promise<ListResponseOf<MessageFile>>
listMessages(string, ListMessagesOptions)
Ruft eine Liste der Nachrichten ab, die in einem Thread vorhanden sind.
function listMessages(threadId: string, options?: ListMessagesOptions): Promise<ListResponseOf<ThreadMessage>>Parameter
- threadId
-
string
- options
- ListMessagesOptions
Gibt zurück
Promise<ListResponseOf<ThreadMessage>>
listRuns(string, ListRunsOptions)
Ruft eine Liste der Ausführungen für einen angegebenen Thread ab.
function listRuns(threadId: string, options?: ListRunsOptions): Promise<ListResponseOf<ThreadRun>>Parameter
- threadId
-
string
- options
- ListRunsOptions
Gibt zurück
Promise<ListResponseOf<ThreadRun>>
listRunSteps(string, string, ListRunStepsOptions)
Ruft eine Liste der Ausführungsschritte aus einer Threadausführung ab.
function listRunSteps(threadId: string, runId: string, options?: ListRunStepsOptions): Promise<ListResponseOf<RunStep>>Parameter
- threadId
-
string
- runId
-
string
- options
- ListRunStepsOptions
Gibt zurück
Promise<ListResponseOf<RunStep>>
submitToolOutputsToRun(string, string, ToolOutput[], SubmitToolOutputsToRunOptions)
Übermittelt Ausgaben von Tools, wie von Toolaufrufen in einer Ausführung angefordert. Ausführungen, die übermittelte Toolausgaben benötigen, verfügen über eine status von "requires_action" mit einem required_action.type von "submit_tool_outputs".
function submitToolOutputsToRun(threadId: string, runId: string, toolOutputs: ToolOutput[], options?: SubmitToolOutputsToRunOptions): Promise<ThreadRun>Parameter
- threadId
-
string
- runId
-
string
- toolOutputs
- options
- SubmitToolOutputsToRunOptions
Gibt zurück
Promise<ThreadRun>
updateAssistant(string, UpdateAssistantOptions, UpdateAssistantRequestOptions)
Ändert einen vorhandenen Assistent.
function updateAssistant(assistantId: string, body: UpdateAssistantOptions, options?: UpdateAssistantRequestOptions): Promise<Assistant>Parameter
- assistantId
-
string
- options
- UpdateAssistantRequestOptions
Gibt zurück
Promise<Assistant>
updateMessage(string, string, UpdateMessageOptions)
Ändert eine vorhandene Nachricht in einem vorhandenen Thread.
function updateMessage(threadId: string, messageId: string, options?: UpdateMessageOptions): Promise<ThreadMessage>Parameter
- threadId
-
string
- messageId
-
string
- options
- UpdateMessageOptions
Gibt zurück
Promise<ThreadMessage>
updateRun(string, string, UpdateRunOptions)
Ändert eine vorhandene Threadausführung.
function updateRun(threadId: string, runId: string, options?: UpdateRunOptions): Promise<ThreadRun>Parameter
- threadId
-
string
- runId
-
string
- options
- UpdateRunOptions
Gibt zurück
Promise<ThreadRun>
updateThread(string, UpdateThreadOptions)
Ändert einen vorhandenen Thread.
function updateThread(threadId: string, options?: UpdateThreadOptions): Promise<AssistantThread>Parameter
- threadId
-
string
- options
- UpdateThreadOptions
Gibt zurück
Promise<AssistantThread>
uploadFile(Uint8Array, string, UploadFileOptions)
Lädt eine Datei zur Verwendung durch andere Vorgänge hoch.
function uploadFile(file: Uint8Array, purpose: string, options?: UploadFileOptions): Promise<InputFile>Parameter
- file
-
Uint8Array
- purpose
-
string
- options
- UploadFileOptions
Gibt zurück
Promise<InputFile>
Azure SDK for JavaScript
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für