类 PdfChatGpt

信息

表示 PdfChatGpt 插件。

public sealed class PdfChatGpt : IDisposable

继承

object ← PdfChatGpt

实现

继承的成员

示例

该示例演示如何通过将消息添加到请求来使用 PdfChatGpt 插件。

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // 添加输出文件路径。
    options.ApiKey = "您的 API 密钥。"; // 您需要提供访问 API 的密钥。
    options.MaxTokens = 1000; // 在聊天完成中生成的最大令牌数。

    // 添加请求消息。
    options.Messages.Add(new Message
    {
        Content = "您是一个有帮助的助手。",
        Role = Role.System
    });
    options.Messages.Add(new Message
    {
        Content = "有史以来制作的最大比萨饼直径是多少？",
        Role = Role.User
    });

    // 处理请求。
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // ChatGPT API 聊天完成对象。
}

该示例演示如何通过添加一条消息来使用 PdfChatGpt 插件。

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // 添加输出文件路径。
    options.ApiKey = "您的 API 密钥。"; // 您需要提供访问 API 的密钥。
    options.MaxTokens = 1000; // 在聊天完成中生成的最大令牌数。

    // 添加请求消息。
    // 在这种情况下，系统消息 Content = "您是一个有帮助的助手。" 默认添加。
    // 查询消息的角色默认为 "user"。
    options.Query = "地球上记录的最低温度是多少？";

    // 处理请求。
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // ChatGPT API 聊天完成对象。
}

该示例演示如何通过添加文件作为消息源来使用 PdfChatGpt 插件。

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // 添加输出文件路径。

    // 添加 PDF 文本源。
    // 若有多个源，则每个文档的文本将作为角色为 "user" 的单独消息添加到请求消息集合中。
    options.AddInput(new FileDataSource("TextSource.pdf"));

    options.ApiKey = "您的 API 密钥。"; // 您需要提供访问 API 的密钥。
    options.MaxTokens = 1000; // 在聊天完成中生成的最大令牌数。

    // 添加请求消息。
    // 在这种情况下，系统消息 Content = "您是一个有帮助的助手。" 默认添加。
    // 查询消息的角色默认为 "user"。
    options.Query = "提供的文本中有多少个字母？";

    // 处理请求。
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // ChatGPT API 聊天完成对象。
}

备注

Documentize.PdfChatGpt 对象用于直接发送请求到 ChatGPT 或通过添加 PDF 文件源并将回复保存到输出源。

构造函数

PdfChatGpt()

初始化一个 Documentize.PdfChatGpt 对象的新实例。

public PdfChatGpt()

方法

Dispose()

IDisposable 的实现。实际上，对于 PdfChatGpt 来说并不是必需的。

public void Dispose()

Process(IPluginOptions)

该方法没有同步版本。请改用 ProcessAsync 方法。

public ResultContainer Process(IPluginOptions options)

参数

返回

ResultContainer : #### 异常

NotImplementedException

ProcessAsync(IPluginOptions)

以指定的参数启动 PdfChatGpt 处理。

public Task<resultcontainer> ProcessAsync(IPluginOptions options)

参数

返回

Task<ResultContainer&gt;

表示异步操作的任务对象。

异常

ArgumentException : InvalidOperationException

SetCancellationToken(CancellationToken)

设置取消令牌。

public void SetCancellationToken(CancellationToken cancellationToken)

参数

命名空间: Documentize 程序集: Documentize.dll

2024年12月29日
 中文