Interface IOpenAIClient

IOpenAIClient接口

表示与OpenAI API交互的客户端接口,扩展基本的AI客户端功能。

public interface IOpenAIClient

方法

名称描述
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, CancellationToken?)异步删除向量存储中的一个文件。
GetAssistantAsync(string, CancellationToken?)异步检索特定助手的详细信息。
GetAssistantsAsync(AssistantListQueryParameters, CancellationToken?)异步检索助手列表。
GetFileAsync(string, CancellationToken?)异步检索特定文件的详细信息。
GetFilesAsync(string, CancellationToken?)基于指定目的异步检索文件列表。
GetRunAsync(string, string, CancellationToken?)异步检索线程中指定运行的详细信息。
GetRunsAsync(string, RunListQueryParameters, CancellationToken?)异步检索指定线程的运行列表。
GetRunStepAsync(string, string, string, CancellationToken?)异步检索运行中的特定步骤的详细信息。
GetRunStepsAsync(string, string, RunStepListQueryParameters, CancellationToken?)异步检索线程中指定运行的步骤列表。
GetThreadAsync(string, CancellationToken?)异步检索特定线程的详细信息。
GetThreadMessageAsync(string, string)异步检索线程中指定消息的详细信息。
GetThreadMessagesAsync(string, ThreadMessageListQueryParameters, CancellationToken?)异步检索特定线程的消息列表。
GetVectorStoreAsync(string, CancellationToken?)异步检索特定向量存储的详细信息。
GetVectorStoreFileAsync(string, string, CancellationToken?)异步检索向量存储中指定文件的详细信息。
GetVectorStoreFileBatchAsync(string, string, CancellationToken?)异步检索特定向量存储文件批次的详细信息。
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?)异步等待特定向量存储完成。

另见