AssistantsClient class
用戶端處理 助理 相關作業。
建構函式
| Assistants |
初始化 AssistantsClient 的實例，以搭配非 Azure OpenAI 端點使用。 |
| Assistants |
初始化 AssistantsClient 的實例，以搭配 OpenAI 資源使用。 |
| Assistants |
初始化 AssistantsClient 的實例，以搭配 Azure OpenAI 資源使用。 |
屬性
| pipeline | 此客戶端用來提出要求的管線 |
方法
建構函式詳細資料
AssistantsClient(KeyCredential, AssistantsClientOptions)
初始化 AssistantsClient 的實例，以搭配非 Azure OpenAI 端點使用。
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)
初始化 AssistantsClient 的實例，以搭配 OpenAI 資源使用。
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
用來設定客戶端的選項。
備註
這個建構函式會初始化 AssistantsClient 物件，該物件只能與 Azure OpenAI 資源搭配使用。 若要搭配非 Azure OpenAI 推斷端點使用 AssistantsClient，請改用接受非 Azure OpenAI API 密鑰的建構函式。
AssistantsClient(string, TokenCredential, AssistantsClientOptions)
初始化 AssistantsClient 的實例，以搭配 Azure OpenAI 資源使用。
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)
從線程執行取得單一執行步驟。
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類型為 『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>
