AssistantsClient class

Azure 以外の OpenAI エンドポイントで使用するために AssistantsClient のインスタンスを初期化します。

new AssistantsClient(openAiApiKey: KeyCredential, options?: AssistantsClientOptions)

パラメーター

注釈

このコンストラクターで初期化された AssistantsClient オブジェクトは、Azure OpenAI 以外の推論エンドポイントでのみ使用できます。 Azure OpenAI リソースで AssistantsClient を使用するには、代わりにリソース URI と Azure 認証資格情報を受け入れるコンストラクターを使用します。

OpenAI リソースで使用する AssistantsClient のインスタンスを初期化します。

new AssistantsClient(endpoint: string, credential: KeyCredential, options?: AssistantsClientOptions)

パラメーター

注釈

このコンストラクターは、Azure OpenAI リソースでのみ使用できる AssistantsClient オブジェクトを初期化します。 Azure OpenAI 以外の推論エンドポイントで AssistantsClient を使用するには、代わりに Azure 以外の OpenAI API キーを受け入れるコンストラクターを使用します。

Azure OpenAI リソースで使用するために AssistantsClient のインスタンスを初期化します。

new AssistantsClient(endpoint: string, credential: TokenCredential, options?: AssistantsClientOptions)

パラメーター

このクライアントが要求を行うために使用するパイプライン

pipeline: Pipeline

プロパティ値

進行中のスレッドの実行を取り消します。

function cancelRun(threadId: string, runId: string, options?: CancelRunOptions): Promise<ThreadRun>

パラメーター

戻り値

新しいアシスタントを作成します。

function createAssistant(body: AssistantCreationOptions, options?: CreateAssistantOptions): Promise<Assistant>

パラメーター

戻り値

ファイルを読み取ることができるツールで使用するために、以前にアップロードしたファイルをアシスタントに添付します。

function createAssistantFile(assistantId: string, fileId: string, options?: CreateAssistantFileOptions): Promise<AssistantFile>

パラメーター

戻り値

指定したスレッドに新しいメッセージを作成します。

function createMessage(threadId: string, role: string, content: string, options?: CreateMessageOptions): Promise<ThreadMessage>

パラメーター

戻り値

アシスタント スレッドの新しい実行を作成します。

function createRun(threadId: string, createRunOptions: CreateRunOptions, options?: CreateRunRequestOptions): Promise<ThreadRun>

パラメーター

戻り値

新しいスレッドを作成します。 スレッドにはメッセージが含まれており、アシスタントが実行できます。

function createThread(body?: AssistantThreadCreationOptions, options?: CreateThreadOptions): Promise<AssistantThread>

パラメーター

戻り値

新しいアシスタント スレッドを作成し、その新しいスレッドを使用してすぐに実行を開始します。

function createThreadAndRun(body: CreateAndRunThreadOptions, options?: CreateThreadAndRunOptions): Promise<ThreadRun>

パラメーター

戻り値

アシスタントを削除します。

function deleteAssistant(assistantId: string, options?: DeleteAssistantOptions): Promise<AssistantDeletionStatus>

パラメーター

戻り値

以前に添付したファイルのリンクをアシスタントから解除し、ファイルを読み取ることができるツールで使用できないようにします。

function deleteAssistantFile(assistantId: string, fileId: string, options?: DeleteAssistantFileOptions): Promise<AssistantFileDeletionStatus>

パラメーター

戻り値

以前にアップロードしたファイルを削除します。

function deleteFile(fileId: string, options?: DeleteFileOptions): Promise<FileDeletionStatus>

パラメーター

戻り値

既存のスレッドを削除します。

function deleteThread(threadId: string, options?: DeleteThreadOptions): Promise<ThreadDeletionStatus>

パラメーター

戻り値

既存のアシスタントを取得します。

function getAssistant(assistantId: string, options?: GetAssistantOptions): Promise<Assistant>

パラメーター

戻り値

アシスタントにアタッチされているファイルを取得します。

function getAssistantFile(assistantId: string, fileId: string, options?: GetAssistantFileOptions): Promise<AssistantFile>

パラメーター

戻り値

特定のファイルに関する情報を返します。 ファイルの内容を取得しません。

function getFile(fileId: string, options?: GetFileOptions): Promise<InputFile>

パラメーター

戻り値

既存のスレッドから既存のメッセージを取得します。

function getMessage(threadId: string, messageId: string, options?: GetMessageOptions): Promise<ThreadMessage>

パラメーター

戻り値

スレッド内のメッセージへの添付ファイルに関する情報を取得します。

function getMessageFile(threadId: string, messageId: string, fileId: string, options?: GetMessageFileOptions): Promise<MessageFile>

パラメーター

戻り値

既存のスレッドから既存の実行を取得します。

function getRun(threadId: string, runId: string, options?: GetRunOptions): Promise<ThreadRun>

パラメーター

戻り値

スレッド実行から 1 つの実行ステップを取得します。

function getRunStep(threadId: string, runId: string, stepId: string, options?: GetRunStepOptions): Promise<RunStep>

パラメーター

戻り値

既存のスレッドに関する情報を取得します。

function getThread(threadId: string, options?: GetThreadOptions): Promise<AssistantThread>

パラメーター

戻り値

ファイルを読み取ることができるツールで使用される、特定のアシスタントに添付されたファイルの一覧を取得します。

function listAssistantFiles(assistantId: string, options?: ListAssistantFilesOptions): Promise<ListResponseOf<AssistantFile>>

パラメーター

戻り値

以前に作成されたアシスタントの一覧を取得します。

function listAssistants(options?: ListAssistantsOptions): Promise<ListResponseOf<Assistant>>

パラメーター

戻り値

以前にアップロードしたファイルの一覧を取得します。

function listFiles(options?: ListFilesOptions): Promise<FileListResponse>

パラメーター

戻り値

スレッドからメッセージに関連付けられている以前にアップロードされたファイルの一覧を取得します。

function listMessageFiles(threadId: string, messageId: string, options?: ListMessageFilesOptions): Promise<ListResponseOf<MessageFile>>

パラメーター

戻り値

スレッドに存在するメッセージの一覧を取得します。

function listMessages(threadId: string, options?: ListMessagesOptions): Promise<ListResponseOf<ThreadMessage>>

パラメーター

戻り値

指定したスレッドの実行の一覧を取得します。

function listRuns(threadId: string, options?: ListRunsOptions): Promise<ListResponseOf<ThreadRun>>

パラメーター

戻り値

スレッド実行から実行ステップの一覧を取得します。

function listRunSteps(threadId: string, runId: string, options?: ListRunStepsOptions): Promise<ListResponseOf<RunStep>>

パラメーター

戻り値

実行時のツール呼び出しによって要求されたツールから出力を送信します。 送信されたツールの出力が必要な実行の状態は 、"requires_action" で、required_action.type は 'submit_tool_outputs' になります。

function submitToolOutputsToRun(threadId: string, runId: string, toolOutputs: ToolOutput[], options?: SubmitToolOutputsToRunOptions): Promise<ThreadRun>

パラメーター

戻り値

既存のアシスタントを変更します。

function updateAssistant(assistantId: string, body: UpdateAssistantOptions, options?: UpdateAssistantRequestOptions): Promise<Assistant>

パラメーター

戻り値

既存のスレッド上の既存のメッセージを変更します。

function updateMessage(threadId: string, messageId: string, options?: UpdateMessageOptions): Promise<ThreadMessage>

パラメーター

戻り値

既存のスレッド実行を変更します。

function updateRun(threadId: string, runId: string, options?: UpdateRunOptions): Promise<ThreadRun>

パラメーター

戻り値

既存のスレッドを変更します。

function updateThread(threadId: string, options?: UpdateThreadOptions): Promise<AssistantThread>

パラメーター

戻り値

他の操作で使用するファイルをアップロードします。

function uploadFile(file: Uint8Array, purpose: string, options?: UploadFileOptions): Promise<InputFile>

パラメーター

戻り値