クラス 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 = "Your API key."; // APIにアクセスするためのキーを提供する必要があります。
    options.MaxTokens = 1000; // チャットの完成に生成する最大トークン数。

    // リクエストメッセージを追加します。
    options.Messages.Add(new Message
    {
        Content = "You are a helpful assistant.",
        Role = Role.System
    });
    options.Messages.Add(new Message
    {
        Content = "What is the biggest pizza diameter ever made?",
        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のチャット補完オブジェクト。
}

この例では、リクエストに1つのメッセージを追加することでPdfChatGptプラグインを使用する方法を示します。

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // 出力ファイルパスを追加します。
    options.ApiKey = "Your API key."; // APIにアクセスするためのキーを提供する必要があります。
    options.MaxTokens = 1000; // チャットの完成に生成する最大トークン数。

    // リクエストメッセージを追加します。
    // この場合、Content = "You are a helpful assistant." のシステムメッセージがデフォルトで追加されます。
    // クエリメッセージの役割はデフォルトで "user" です。
    options.Query = "What is the lowest temperature recorded on the Earth?";

    // リクエストを処理します。
    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 = "Your API key."; // APIにアクセスするためのキーを提供する必要があります。
    options.MaxTokens = 1000; // チャットの完成に生成する最大トークン数。

    // リクエストメッセージを追加します。
    // この場合、Content = "You are a helpful assistant." のシステムメッセージがデフォルトで追加されます。
    // クエリメッセージの役割はデフォルトで "user" です。
    options.Query = "How many letters in the provided text?";

    // リクエストを処理します。
    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)

パラメータ

  • options IPluginOptions: PdfChatGptへの指示を含むオプションオブジェクト。

戻り値

ResultContainer : #### 例外

NotImplementedException

ProcessAsync(IPluginOptions)

指定されたパラメータでPdfChatGpt処理を開始します。

public Task<resultcontainer> ProcessAsync(IPluginOptions options)

パラメータ

  • options IPluginOptions: PdfChatGptへの指示を含むオプションオブジェクト。

戻り値

Task<ResultContainer&gt;

非同期操作を表すタスクオブジェクト。

例外

ArgumentException : InvalidOperationException

SetCancellationToken(CancellationToken)

キャンセルトークンを設定します。

public void SetCancellationToken(CancellationToken cancellationToken)

パラメータ

名前空間: Documentize アセンブリ: Documentize.dll

 日本語