你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
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 推理终结点一起使用。 若要将 AssistantsClient 与 Azure OpenAI 资源配合使用，请改用接受资源 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
用于配置客户端的选项。
注解
此构造函数初始化只能与 Azure OpenAI 资源一起使用的 AssistantsClient 对象。 若要将 AssistantsClient 与非 Azure OpenAI 推理终结点配合使用，请改用接受非 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.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>
