AssistantsClient class
クライアント処理アシスタント関連する操作。
コンストラクター
| Assistants |
Azure 以外の OpenAI エンドポイントで使用するために AssistantsClient のインスタンスを初期化します。 |
| Assistants |
OpenAI リソースで使用する AssistantsClient のインスタンスを初期化します。 |
| Assistants |
Azure OpenAI リソースで使用するために AssistantsClient のインスタンスを初期化します。 |
プロパティ
| pipeline | このクライアントが要求を行うために使用するパイプライン |
メソッド
コンストラクターの詳細
AssistantsClient(KeyCredential, AssistantsClientOptions)
Azure 以外の OpenAI エンドポイントで使用するために AssistantsClient のインスタンスを初期化します。
new AssistantsClient(openAiApiKey: KeyCredential, options?: AssistantsClientOptions)パラメーター
- openAiApiKey
- KeyCredential
Azure OpenAI 以外のエンドポイントに接続するときに使用する API キー。
- options
- AssistantsClientOptions
クライアントを構成するためのオプション。
注釈
このコンストラクターで初期化された AssistantsClient オブジェクトは、Azure OpenAI 以外の推論エンドポイントでのみ使用できます。 Azure OpenAI リソースで AssistantsClient を使用するには、代わりにリソース URI と Azure 認証資格情報を受け入れるコンストラクターを使用します。
AssistantsClient(string, KeyCredential, AssistantsClientOptions)
OpenAI リソースで使用する AssistantsClient のインスタンスを初期化します。
new AssistantsClient(endpoint: string, credential: KeyCredential, options?: AssistantsClientOptions)パラメーター
- endpoint
-
string
プロトコルとホスト名を含む Azure OpenAI リソースの URI。 (例: https://my-resource.openai.azure.com)。
- credential
- KeyCredential
Azure OpenAI リソースに対する認証に使用されるキー資格情報。
- options
- AssistantsClientOptions
クライアントを構成するためのオプション。
注釈
このコンストラクターは、Azure OpenAI リソースでのみ使用できる AssistantsClient オブジェクトを初期化します。 Azure OpenAI 以外の推論エンドポイントで AssistantsClient を使用するには、代わりに Azure 以外の OpenAI API キーを受け入れるコンストラクターを使用します。
AssistantsClient(string, TokenCredential, AssistantsClientOptions)
Azure OpenAI リソースで使用するために AssistantsClient のインスタンスを初期化します。
new AssistantsClient(endpoint: string, credential: TokenCredential, options?: AssistantsClientOptions)パラメーター
- endpoint
-
string
プロトコルとホスト名を含む Azure OpenAI リソースの URI。 (例: https://my-resource.openai.azure.com)。
- credential
- TokenCredential
Azure OpenAI リソースで認証するために使用されるトークン資格情報。
- options
- AssistantsClientOptions
クライアントを構成するためのオプション。
プロパティの詳細
pipeline
メソッドの詳細
cancelRun(string, string, CancelRunOptions)
進行中のスレッドの実行を取り消します。
function cancelRun(threadId: string, runId: string, options?: CancelRunOptions): Promise<ThreadRun>パラメーター
- threadId
-
string
- runId
-
string
- options
- CancelRunOptions
戻り値
Promise<ThreadRun>
createAssistant(AssistantCreationOptions, CreateAssistantOptions)
新しいアシスタントを作成します。
function createAssistant(body: AssistantCreationOptions, options?: CreateAssistantOptions): Promise<Assistant>パラメーター
- options
- CreateAssistantOptions
戻り値
Promise<Assistant>
createAssistantFile(string, string, CreateAssistantFileOptions)
ファイルを読み取ることができるツールで使用するために、以前にアップロードしたファイルをアシスタントに添付します。
function createAssistantFile(assistantId: string, fileId: string, options?: CreateAssistantFileOptions): Promise<AssistantFile>パラメーター
- assistantId
-
string
- fileId
-
string
- options
- CreateAssistantFileOptions
戻り値
Promise<AssistantFile>
createMessage(string, string, string, CreateMessageOptions)
指定したスレッドに新しいメッセージを作成します。
function createMessage(threadId: string, role: string, content: string, options?: CreateMessageOptions): Promise<ThreadMessage>パラメーター
- threadId
-
string
- role
-
string
- content
-
string
- options
- CreateMessageOptions
戻り値
Promise<ThreadMessage>
createRun(string, CreateRunOptions, CreateRunRequestOptions)
アシスタント スレッドの新しい実行を作成します。
function createRun(threadId: string, createRunOptions: CreateRunOptions, options?: CreateRunRequestOptions): Promise<ThreadRun>パラメーター
- threadId
-
string
- createRunOptions
- CreateRunOptions
- options
- CreateRunRequestOptions
戻り値
Promise<ThreadRun>
createThread(AssistantThreadCreationOptions, CreateThreadOptions)
新しいスレッドを作成します。 スレッドにはメッセージが含まれており、アシスタントが実行できます。
function createThread(body?: AssistantThreadCreationOptions, options?: CreateThreadOptions): Promise<AssistantThread>パラメーター
- options
- CreateThreadOptions
戻り値
Promise<AssistantThread>
createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)
新しいアシスタント スレッドを作成し、その新しいスレッドを使用してすぐに実行を開始します。
function createThreadAndRun(body: CreateAndRunThreadOptions, options?: CreateThreadAndRunOptions): Promise<ThreadRun>パラメーター
- options
- CreateThreadAndRunOptions
戻り値
Promise<ThreadRun>
deleteAssistant(string, DeleteAssistantOptions)
アシスタントを削除します。
function deleteAssistant(assistantId: string, options?: DeleteAssistantOptions): Promise<AssistantDeletionStatus>パラメーター
- assistantId
-
string
- options
- DeleteAssistantOptions
戻り値
Promise<AssistantDeletionStatus>
deleteAssistantFile(string, string, DeleteAssistantFileOptions)
以前に添付したファイルのリンクをアシスタントから解除し、ファイルを読み取ることができるツールで使用できないようにします。
function deleteAssistantFile(assistantId: string, fileId: string, options?: DeleteAssistantFileOptions): Promise<AssistantFileDeletionStatus>パラメーター
- assistantId
-
string
- fileId
-
string
- options
- DeleteAssistantFileOptions
戻り値
Promise<AssistantFileDeletionStatus>
deleteFile(string, DeleteFileOptions)
以前にアップロードしたファイルを削除します。
function deleteFile(fileId: string, options?: DeleteFileOptions): Promise<FileDeletionStatus>パラメーター
- fileId
-
string
- options
- DeleteFileOptions
戻り値
Promise<FileDeletionStatus>
deleteThread(string, DeleteThreadOptions)
既存のスレッドを削除します。
function deleteThread(threadId: string, options?: DeleteThreadOptions): Promise<ThreadDeletionStatus>パラメーター
- threadId
-
string
- options
- DeleteThreadOptions
戻り値
Promise<ThreadDeletionStatus>
getAssistant(string, GetAssistantOptions)
既存のアシスタントを取得します。
function getAssistant(assistantId: string, options?: GetAssistantOptions): Promise<Assistant>パラメーター
- assistantId
-
string
- options
- GetAssistantOptions
戻り値
Promise<Assistant>
getAssistantFile(string, string, GetAssistantFileOptions)
アシスタントにアタッチされているファイルを取得します。
function getAssistantFile(assistantId: string, fileId: string, options?: GetAssistantFileOptions): Promise<AssistantFile>パラメーター
- assistantId
-
string
- fileId
-
string
- options
- GetAssistantFileOptions
戻り値
Promise<AssistantFile>
getFile(string, GetFileOptions)
特定のファイルに関する情報を返します。 ファイルの内容を取得しません。
function getFile(fileId: string, options?: GetFileOptions): Promise<InputFile>パラメーター
- fileId
-
string
- options
- GetFileOptions
戻り値
Promise<InputFile>
getMessage(string, string, GetMessageOptions)
既存のスレッドから既存のメッセージを取得します。
function getMessage(threadId: string, messageId: string, options?: GetMessageOptions): Promise<ThreadMessage>パラメーター
- threadId
-
string
- messageId
-
string
- options
- GetMessageOptions
戻り値
Promise<ThreadMessage>
getMessageFile(string, string, string, GetMessageFileOptions)
スレッド内のメッセージへの添付ファイルに関する情報を取得します。
function getMessageFile(threadId: string, messageId: string, fileId: string, options?: GetMessageFileOptions): Promise<MessageFile>パラメーター
- threadId
-
string
- messageId
-
string
- fileId
-
string
- options
- GetMessageFileOptions
戻り値
Promise<MessageFile>
getRun(string, string, GetRunOptions)
既存のスレッドから既存の実行を取得します。
function getRun(threadId: string, runId: string, options?: GetRunOptions): Promise<ThreadRun>パラメーター
- threadId
-
string
- runId
-
string
- options
- GetRunOptions
戻り値
Promise<ThreadRun>
getRunStep(string, string, string, GetRunStepOptions)
スレッド実行から 1 つの実行ステップを取得します。
function getRunStep(threadId: string, runId: string, stepId: string, options?: GetRunStepOptions): Promise<RunStep>パラメーター
- threadId
-
string
- runId
-
string
- stepId
-
string
- options
- GetRunStepOptions
戻り値
Promise<RunStep>
getThread(string, GetThreadOptions)
既存のスレッドに関する情報を取得します。
function getThread(threadId: string, options?: GetThreadOptions): Promise<AssistantThread>パラメーター
- threadId
-
string
- options
- GetThreadOptions
戻り値
Promise<AssistantThread>
listAssistantFiles(string, ListAssistantFilesOptions)
ファイルを読み取ることができるツールで使用される、特定のアシスタントに添付されたファイルの一覧を取得します。
function listAssistantFiles(assistantId: string, options?: ListAssistantFilesOptions): Promise<ListResponseOf<AssistantFile>>パラメーター
- assistantId
-
string
- options
- ListAssistantFilesOptions
戻り値
Promise<ListResponseOf<AssistantFile>>
listAssistants(ListAssistantsOptions)
以前に作成されたアシスタントの一覧を取得します。
function listAssistants(options?: ListAssistantsOptions): Promise<ListResponseOf<Assistant>>パラメーター
- options
- ListAssistantsOptions
戻り値
Promise<ListResponseOf<Assistant>>
listFiles(ListFilesOptions)
以前にアップロードしたファイルの一覧を取得します。
function listFiles(options?: ListFilesOptions): Promise<FileListResponse>パラメーター
- options
- ListFilesOptions
戻り値
Promise<FileListResponse>
listMessageFiles(string, string, ListMessageFilesOptions)
スレッドからメッセージに関連付けられている以前にアップロードされたファイルの一覧を取得します。
function listMessageFiles(threadId: string, messageId: string, options?: ListMessageFilesOptions): Promise<ListResponseOf<MessageFile>>パラメーター
- threadId
-
string
- messageId
-
string
- options
- ListMessageFilesOptions
戻り値
Promise<ListResponseOf<MessageFile>>
listMessages(string, ListMessagesOptions)
スレッドに存在するメッセージの一覧を取得します。
function listMessages(threadId: string, options?: ListMessagesOptions): Promise<ListResponseOf<ThreadMessage>>パラメーター
- threadId
-
string
- options
- ListMessagesOptions
戻り値
Promise<ListResponseOf<ThreadMessage>>
listRuns(string, ListRunsOptions)
指定したスレッドの実行の一覧を取得します。
function listRuns(threadId: string, options?: ListRunsOptions): Promise<ListResponseOf<ThreadRun>>パラメーター
- threadId
-
string
- options
- ListRunsOptions
戻り値
Promise<ListResponseOf<ThreadRun>>
listRunSteps(string, string, ListRunStepsOptions)
スレッド実行から実行ステップの一覧を取得します。
function listRunSteps(threadId: string, runId: string, options?: ListRunStepsOptions): Promise<ListResponseOf<RunStep>>パラメーター
- threadId
-
string
- runId
-
string
- options
- ListRunStepsOptions
戻り値
Promise<ListResponseOf<RunStep>>
submitToolOutputsToRun(string, string, ToolOutput[], SubmitToolOutputsToRunOptions)
実行時のツール呼び出しによって要求されたツールから出力を送信します。 送信されたツールの出力が必要な実行の状態は 、"requires_action" で、required_action.type は 'submit_tool_outputs' になります。
function submitToolOutputsToRun(threadId: string, runId: string, toolOutputs: ToolOutput[], options?: SubmitToolOutputsToRunOptions): Promise<ThreadRun>パラメーター
- threadId
-
string
- runId
-
string
- toolOutputs
- options
- SubmitToolOutputsToRunOptions
戻り値
Promise<ThreadRun>
updateAssistant(string, UpdateAssistantOptions, UpdateAssistantRequestOptions)
既存のアシスタントを変更します。
function updateAssistant(assistantId: string, body: UpdateAssistantOptions, options?: UpdateAssistantRequestOptions): Promise<Assistant>パラメーター
- assistantId
-
string
- options
- UpdateAssistantRequestOptions
戻り値
Promise<Assistant>
updateMessage(string, string, UpdateMessageOptions)
既存のスレッド上の既存のメッセージを変更します。
function updateMessage(threadId: string, messageId: string, options?: UpdateMessageOptions): Promise<ThreadMessage>パラメーター
- threadId
-
string
- messageId
-
string
- options
- UpdateMessageOptions
戻り値
Promise<ThreadMessage>
updateRun(string, string, UpdateRunOptions)
既存のスレッド実行を変更します。
function updateRun(threadId: string, runId: string, options?: UpdateRunOptions): Promise<ThreadRun>パラメーター
- threadId
-
string
- runId
-
string
- options
- UpdateRunOptions
戻り値
Promise<ThreadRun>
updateThread(string, UpdateThreadOptions)
既存のスレッドを変更します。
function updateThread(threadId: string, options?: UpdateThreadOptions): Promise<AssistantThread>パラメーター
- threadId
-
string
- options
- UpdateThreadOptions
戻り値
Promise<AssistantThread>
uploadFile(Uint8Array, string, UploadFileOptions)
他の操作で使用するファイルをアップロードします。
function uploadFile(file: Uint8Array, purpose: string, options?: UploadFileOptions): Promise<InputFile>パラメーター
- file
-
Uint8Array
- purpose
-
string
- options
- UploadFileOptions
戻り値
Promise<InputFile>
Azure SDK for JavaScript