Class PdfChatGpt

情報

PdfChatGptプラグインを表します。

public static class PdfChatGpt

継承

object ← PdfChatGpt

継承されたメンバー

例

この例では、リクエストにメッセージを追加することで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 = "あなたは役立つアシスタントです。",
    Role = Role.System
});
options.Messages.Add(new Message
{
    Content = "これまでに作られた最大のピザの直径はどれくらいですか？",
    Role = Role.User
});

// リクエストを処理します。
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // ChatGPT APIチャット完了オブジェクト。

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

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

// リクエストメッセージを追加します。
// この場合、Content = "あなたは役立つアシスタントです。"というシステムメッセージがデフォルトで追加されます。
// クエリメッセージの役割はデフォルトで"user"です。
options.Query = "地球上で記録された最低気温は何度ですか？";

// リクエストを処理します。
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // ChatGPT APIチャット完了オブジェクト。

この例では、メッセージソースとしてファイルを追加することで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 = "あなたは役立つアシスタントです。"というシステムメッセージがデフォルトで追加されます。
// クエリメッセージの役割はデフォルトで"user"です。
options.Query = "提供されたテキストには何文字ありますか？";

// リクエストを処理します。
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // ChatGPT APIチャット完了オブジェクト。

注意事項

Documentize.PdfChatGptは、ChatGPTに直接リクエストを送信するために使用されるか、PDFファイルソースを追加し、返信を出力ソースに保存します。

メソッド

Process(IPluginOptions)

このメソッドには同期バージョンはありません。代わりにProcessAsyncメソッドを使用してください。

public static ResultContainer Process(IPluginOptions options)

パラメーター

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

戻り値

ResultContainer : #### 例外

NotImplementedException

ProcessAsync(IPluginOptions)

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

public static Task<resultcontainer> ProcessAsync(IPluginOptions options)

パラメーター

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

戻り値

Task<ResultContainer>

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

例外

ArgumentException : InvalidOperationException

Namespace: Documentize Assembly: Documentize.dll

 日本語