Class OpenAIClient

OpenAIClient 类

提供与 OpenAI API 交互的方法，用于管理向量存储文件批次。

提供与 OpenAI API 交互的方法，用于管理向量存储文件。

提供与 OpenAI API 交互的方法，用于管理向量存储。

表示一个与 OpenAI API 交互的客户端，扩展基本的 AI 客户端功能。

提供与 OpenAI API 交互的方法，用于管理线程中的运行步骤。

提供与 OpenAI API 交互的方法，用于管理文件。

提供与 OpenAI API 交互的方法，用于管理线程消息。

提供与 OpenAI API 交互的方法，用于管理线程。

提供与 OpenAI API 交互的方法，用于管理助手。

提供与 OpenAI API 交互的方法，用于创建完成。

提供与 OpenAI API 交互的方法，用于管理线程中的运行。

public class OpenAIClient : AIClientBase, IChatClient<OpenAIChatCopilotOptions>, 
    IImageDescriptionClient<OpenAIImageDescriptionCopilotOptions>, IOpenAIClient, 
    ISummaryClient<OpenAISummaryCopilotOptions>

属性

名称描述
BackoffDelaySeconds { get; set; }获取或设置回退延迟（以秒为单位）。
HttpRequestMaxRetries { get; set; }获取或设置最大 HTTP 请求重试次数。
PollingIntervalSeconds { get; set; }获取或设置轮询间隔（以秒为单位）。
PollingTimeoutSeconds { get; set; }获取或设置轮询超时（以秒为单位）。

方法

名称描述
CancelRunAsync(string, string, CancellationToken?)异步取消线程中的现有运行。
CancelVectorStoreFileBatchAsync(string, string, CancellationToken?)异步取消特定的向量存储文件批次。
CreateAssistantAsync(AssistantCreateRequest, CancellationToken?)异步创建一个新的助手。
CreateCompletionAsync(CompletionCreateRequest, CancellationToken?)异步创建一个新的完成。
CreateRunAsync(string, RunCreateRequest, CancellationToken?)异步在指定线程中创建一个运行。
CreateThreadAndRunAsync(RunThreadCreateRequest, CancellationToken?)异步创建一个线程及其运行。
CreateThreadAsync(ThreadCreateRequest, CancellationToken?)异步创建一个新的线程。
CreateThreadMessageAsync(string, ThreadMessageCreateRequest, CancellationToken?)异步在线程中创建一条新消息。
CreateVectorStoreAndWaitToCompleteAsync(VectorStoreCreateRequest, CancellationToken?)异步创建一个新的向量存储并等待其完成。
CreateVectorStoreAsync(VectorStoreCreateRequest, CancellationToken?)异步创建一个新的向量存储。
CreateVectorStoreFileAsync(string, VectorStoreFileCreateRequest, CancellationToken?)异步创建一个新的向量存储文件。
CreateVectorStoreFileBatchAsync(string, VectorStoreFileBatchCreateRequest, CancellationToken?)异步创建一个新的向量存储文件批次。
DeleteAssistantAsync(string, CancellationToken?)异步删除现有助手。
DeleteFileAsync(string, CancellationToken?)异步删除特定文件。
DeleteThreadAsync(string, CancellationToken?)异步删除现有线程。
DeleteThreadMessageAsync(string, string, CancellationToken?)异步删除线程中的一条消息。
DeleteVectorStoreAsync(string, CancellationToken?)异步删除一个向量存储。
DeleteVectorStoreFileAsync(string, string)异步删除向量存储中的一条文件。
Dispose()释放 AIClientBase 使用的资源。
GetAssistantAsync(string, CancellationToken?)异步检索特定助手的详细信息。
GetAssistantsAsync(AssistantListQueryParameters, CancellationToken?)异步检索助手列表。
GetChatCopilot(IChatCopilotOptions<OpenAIChatCopilotOptions>)获取具有指定选项的 IChatCopilot 实例。
GetFileAsync(string, CancellationToken?)异步检索特定文件的详细信息。
GetFilesAsync(string, CancellationToken?)根据指定目的异步检索文件列表。
GetImageDescriptionCopilot(IImageDescriptionCopilotOptions<OpenAIImageDescriptionCopilotOptions>)获取具有指定选项的 IImageDescriptionCopilot 实例。
GetRunAsync(string, string, CancellationToken?)异步检索线程中特定运行的详细信息。
GetRunsAsync(string, RunListQueryParameters, CancellationToken?)异步检索指定线程的运行列表。
GetRunStepAsync(string, string, string, CancellationToken?)异步检索运行中某个步骤的详细信息。
GetRunStepsAsync(string, string, RunStepListQueryParameters, CancellationToken?)异步检索线程中特定运行的步骤列表。
GetSummaryCopilot(ISummaryCopilotOptions<OpenAISummaryCopilotOptions>)获取具有指定选项的 ISummaryCopilot 实例。
GetThreadAsync(string, CancellationToken?)异步检索特定线程的详细信息。
GetThreadMessageAsync(string, string, CancellationToken?)异步检索线程中特定消息的详细信息。
GetThreadMessagesAsync(string, ThreadMessageListQueryParameters, CancellationToken?)异步检索特定线程的消息列表。
GetVectorStoreAsync(string, CancellationToken?)异步检索特定向量存储的详细信息。
GetVectorStoreFileAsync(string, string)异步检索向量存储中特定文件的详细信息。
GetVectorStoreFileBatchAsync(string, string)异步检索特定向量存储文件批次的详细信息。
GetVectorStoreFileBatchFilesAsync(string, string, VectorStoreFileBatchFileListQueryParameters, CancellationToken?)异步检索特定向量存储文件批次中的文件列表。
GetVectorStoreFilesAsync(string, VectorStoreFileListQueryParameters, CancellationToken?)异步检索特定向量存储中的文件列表。
GetVectorStoresAsync(VectorStoreListQueryParameters, CancellationToken?)异步检索向量存储列表。
ModifyAssistantAsync(string, AssistantModifyRequest, CancellationToken?)异步修改现有助手。
ModifyRunAsync(string, string, RunModifyRequest, CancellationToken?)异步修改线程中的现有运行。
ModifyThreadAsync(string, ThreadModifyRequest, CancellationToken?)异步修改现有线程。
ModifyThreadMessageAsync(string, string, ThreadMessageModifyRequest, CancellationToken?)异步修改线程中的现有消息。
ModifyVectorStoreAsync(string, VectorStoreModifyRequest, CancellationToken?)异步修改现有向量存储。
RunAndGetAssistantResponseAsync(string, RunCreateRequest, CancellationToken?)使用指定的 threadId 和 runCreateRequest 运行助手，并异步获取助手响应。
UploadFileAsync(string, string, byte[], CancellationToken?)异步将文件上传到 OpenAI 服务器。
WaitForAssistantMessageAsync(string, ThreadMessageListQueryParameters, CancellationToken?)异步等待线程中助手的第一条消息。
WaitForRunToCompleteAsync(string, string, CancellationToken?)异步等待线程中的运行完成。
WaitForThreadMessageToCompleteAsync(string, string)异步等待特定线程消息完成。
WaitForVectorStoreFileToCompleteAsync(string, string)异步等待特定向量存储文件完成。
WaitForVectorStoreToCompleteAsync(string, CancellationToken?)异步等待特定向量存储完成。
static CreateWithApiKey(string)使用提供的 API 密钥创建 Builder 的新实例。

其他成员

名称描述
class Builder用于创建 OpenAIClient 实例的 Builder 类。

另见

Class OpenAIChatCopilotOptions Class OpenAIClient.Builder