Class OpenAIChatCopilot

OpenAIChatCopilot 类

表示一个聊天助手，用于通过 AI 模型与文档进行交互。创建 OpenAI 客户端、配置选项以及使用 ChatCopilot 与用户查询进行交互和管理对话上下文的示例用法。

// Create AI client.
var openAiClient = OpenAIClient
    .CreateWithApiKey(ApiKey) // Create OpenAI client with the API key.
    .WithProject("proj_RoywW1DLqDC89GoAW5ngoVN8") // Configure optional parameters.
    .WithOrganization("org_123")
    .Build(); // Build.

// Create copilot options.
var options = OpenAIChatCopilotOptions
    .Create() // Create options like this, or...
    //.Create(options => { options.Model = OpenAIModels.Gpt35Turbo; }) // ...create using delegate.
    .WithModel(OpenAIModels.Gpt35Turbo) // Configure other optional parameters.
    .WithTemperature(0.5)
    .WithTopP(1)
    .WithDocument("DocumentInputPath") // Attach documents using .WithDocument(s) methods allows to add text, pdf and paths to documents.
    .WithContextBackupJsonPath("PathToContextBackup") // Supply context backup to resume the conversation session.
    .WithRestoreContextFromBackup(true); // If set to true, the context 

// Create summary copilot.
var chatCopilot = AICopilotFactory.CreateChatCopilot(openAiClient, options);

// Get response on a user query.
string copilotResponse1 = await chatCopilot.GetResponseAsync("user message");

// Get response on a list of queries.
string copilotResponse2 = await chatCopilot.GetResponseAsync(new List<string>
{
    "message1",
    "message2"
});

// Save summary as PDF document.
await chatCopilot.SaveResponseAsync("message1", "outputPath");

// Save summary with specified format.
await chatCopilot.SaveResponseAsync("message1", "outputPath", SaveFormat.DocX);

// Save summary as PDF document.
await chatCopilot.SaveResponseAsync(new List<string>
{
    "message1",
    "message2"
}, "outputPath");

// Save summary with specified format.
await chatCopilot.SaveResponseAsync(new List<string>
{
    "message1",
    "message2"
}, "outputPath", SaveFormat.DocX);

// Save the context.
await chatCopilot.SaveContextAsync("outputPath");

// Delete the context.
await chatCopilot.DeleteContextAsync();

public class OpenAIChatCopilot : IChatCopilot

构造函数

名称描述
OpenAIChatCopilot(IOpenAIClient, IChatCopilotOptions<OpenAIChatCopilotOptions>)使用指定的客户端和选项初始化 OpenAIChatCopilot 类的新实例。

属性

名称描述
HasContext { get; }

方法

名称描述
DeleteContextAsync(CancellationToken?)
GetResponseAsync(List<string>, CancellationToken?)
GetResponseAsync(string, CancellationToken?)
SaveContextAsync(string, CancellationToken?)
SaveResponseAsync(List<string>, string, CancellationToken?)
SaveResponseAsync(string, string, CancellationToken?)
SaveResponseAsync(List<string>, string, SaveFormat, CancellationToken?)
SaveResponseAsync(string, string, SaveFormat, CancellationToken?)

另请参阅

Class OpenAIAssistantCopilotOptionsBase Class OpenAIChatCopilotOptions