你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@azure/openai-assistants package

类

AssistantsClient	客户端处理助手相关操作。
AzureKeyCredential	支持更新基础键值的基于静态键的凭据。
OpenAIKeyCredential	OpenAIKeyCredential 类表示 OpenAI API 密钥，用于向 OpenAI 终结点的 Assistants 客户端进行身份验证。

接口

Assistant	表示可调用模型并使用工具的助手。
AssistantCreationOptions	创建新助手时要使用的请求详细信息。
AssistantDeletionStatus	助手删除操作的状态。
AssistantFile	有关附加到助手的文件的信息，可供可读取文件的工具使用。
AssistantFileDeletionStatus	助手文件删除操作的状态。
AssistantThread	有关与助手关联的单个线程的信息。
AssistantThreadCreationOptions	用于创建新助手线程的详细信息。
AssistantsClientOptions	用于创建助手客户端的详细信息 *
CancelRunOptions	用于取消运行的详细信息。
CodeInterpreterImageOutput	代码解释器工具为响应模型的工具调用而发出的图像输出的表示形式。
CodeInterpreterImageReference	代码解释器工具为响应模型的工具调用而发出的图像引用。
CodeInterpreterLogOutput	代码解释器工具为响应模型的工具调用而发出的日志输出的表示形式。
CodeInterpreterToolCall	调用代码解释器工具的记录，由模型在计算定义的工具时发出，表示代码解释器使用和发出的输入和输出。
CodeInterpreterToolCallDetails	有关模型调用代码解释器的详细信息。
CodeInterpreterToolDefinition	用于配置助手的代码解释器工具的输入定义信息。
CreateAndRunThreadOptions	创建并立即运行新助手线程时使用的详细信息。
CreateAssistantFileOptions	用于创建助手文件的详细信息。
CreateAssistantOptions	用于创建助手的详细信息。
CreateMessageOptions	用于创建消息的详细信息。
CreateRunOptions	创建助手线程的新运行时使用的详细信息。
CreateRunRequestOptions	用于创建运行请求的详细信息。
CreateThreadAndRunOptions	用于创建和运行线程的详细信息。
CreateThreadOptions	用于创建线程的详细信息。
DeleteAssistantFileOptions	用于删除助手文件的详细信息。
DeleteAssistantOptions	用于删除助手的详细信息。
DeleteFileOptions	用于删除文件的详细信息。
DeleteThreadOptions	用于删除线程的详细信息。
DeletionStatus	OpenAI 删除操作结果状态的抽象表示形式。
FileDeletionStatus	文件删除操作的状态响应。
FileListResponse	来自文件列表操作的响应数据。
FunctionDefinition	函数的输入定义信息。
FunctionToolCall	调用函数工具的记录，由模型在计算定义的工具时发出，表示指定函数使用和发出的输入和输出。
FunctionToolCallDetails	有关模型调用的函数的详细信息。
FunctionToolDefinition	用于配置助手的函数工具的输入定义信息。
GetAssistantFileOptions	用于获取助手文件的详细信息。
GetAssistantOptions	用于获取助手的详细信息。
GetFileOptions	用于获取文件的详细信息。
GetMessageFileOptions	用于获取消息文件的详细信息。
GetMessageOptions	用于获取消息的详细信息。
GetRunOptions	用于获取运行的详细信息。
GetRunStepOptions	用于获取运行步骤的详细信息。
GetThreadOptions	用于获取线程的详细信息。
InputFile	表示可调用模型并使用工具的助手。
ListAssistantFilesOptions	用于列出助手文件的详细信息。
ListAssistantsOptions	用于列出助手的详细信息。
ListFilesOptions	用于列出文件的详细信息。
ListMessageFilesOptions	用于列出消息文件的详细信息。
ListMessagesOptions	用于列出消息的详细信息。
ListResponseOf	请求的项列表的响应数据。
ListRunStepsOptions	用于列出运行步骤的详细信息。
ListRunsOptions	用于列出运行的详细信息。
MessageFile	有关附加到助手线程消息的文件的信息。
MessageImageFileContent	线程消息中图像文件内容的表示形式。
MessageImageFileDetails	一个图像引用，如线程消息内容中所示。
MessageTextContent	线程消息内容的文本项的表示形式。
MessageTextDetails	单项助手线程消息内容的文本和关联批注。
MessageTextFileCitationAnnotation	消息中的引文，指向与助手或消息关联的特定文件中的特定引号。 助手使用“检索”工具来搜索文件时生成。
MessageTextFileCitationDetails	基于文件的文本引文的表示形式，用于文本线程消息内容的基于文件的批注。
MessageTextFilePathAnnotation	消息中的引文，指向位于特定路径的文件。
MessageTextFilePathDetails	消息图像内容所使用的图像文件 ID 的封装。
RequiredAction	助手线程运行继续所需的操作的抽象表示形式。
RequiredFunctionToolCall	对函数工具的请求调用的表示形式，模型需要该调用才能继续计算运行。
RetrievalToolCall	调用检索工具的记录，由模型在计算定义的工具时发出，表示执行的检索操作。
RetrievalToolDefinition	用于配置助手的检索工具的输入定义信息。
RunError	助手线程运行时遇到的错误的详细信息。
RunStep	有关助手线程运行的单个步骤的详细信息。
RunStepError	与失败的运行步骤关联的错误信息。
RunStepMessageCreationDetails	与消息创建运行步骤关联的详细信息。
RunStepMessageCreationReference	作为运行步骤的一部分创建的消息的详细信息。
RunStepToolCallDetails	与运行步骤调用工具关联的详细信息。
SubmitToolOutputsDetails	描述应调用以提交工具输出的工具的详细信息。
SubmitToolOutputsToRunOptions	用于将工具输出提交到运行的详细信息。
ThreadDeletionStatus	线程删除操作的状态。
ThreadMessage	助手线程中的单个现有消息。
ThreadRun	表示助手线程的单个评估运行的数据。
ToolOutput	工具期间提供的数据输出提交以解决挂起的工具调用并允许模型继续。
UpdateAssistantOptions	修改现有助手时要使用的请求详细信息。
UpdateAssistantRequestOptions	用于更新助手的详细信息。
UpdateMessageOptions	用于更新消息的详细信息。
UpdateRunOptions	用于更新运行的详细信息。
UpdateThreadOptions	用于更新线程的详细信息。
UploadFileOptions	用于上传文件的详细信息。

类型别名

CodeInterpreterToolCallOutput	CodeInterpreterToolCallOutput 的别名
FilePurpose	“fine-tune”、“fine-tune-results”、“assistants”、“assistants_output”
ListSortOrder	“asc”、“desc”
MessageContent	MessageContent 的别名
MessageRole	“user”、“助手”
MessageTextAnnotation	MessageTextAnnotation 的别名
RequiredToolCall	RequiredToolCall 的别名
RunStatus	“queued”、“in_progress”、“requires_action”、“cancelling”、“cancelled”、“failed”、“completed”、“expired”
RunStepDetails	RunStepDetails 的别名
RunStepErrorCode	“server_error”、“rate_limit_exceeded”
RunStepStatus	“in_progress”、“已取消”、“失败”、“已完成”、“已过期”
RunStepType	“message_creation”、“tool_calls”
ToolCall	ToolCall 的别名
ToolDefinition	助手可以使用的输入工具定义的抽象表示形式。