Class ChatGptRequestOptions

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← ChatGptRequestOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

ChatGptRequestOptions()

Documentize.ChatGptRequestOptions オブジェクトのインスタンスをデフォルトオプションで初期化します。

public ChatGptRequestOptions()

ChatGptRequestOptions(string, string, string, string)

Documentize.ChatGptRequestOptions オブジェクトのインスタンスを指定したオプションで初期化します。

public ChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)

Parameters

• apiKey string: ChatGPT API へアクセスするためのキー。
• model string: ChatGPT のモデル名。デフォルトモデルは gpt-3.5-turbo-1106 です。
• apiUrl string: ChatGPT API の URL。デフォルトは https://api.openai.com/v1/chat/completions です。
• query string: ChatGPT への文字列リクエスト。

Properties

ApiKey

ChatGPT API へアクセスするためのキーを取得または設定します。

public string ApiKey { get; set; }

Property Value

string

ApiUrl

ChatGPT API の URL を取得または設定します。

public string ApiUrl { get; set; }

Property Value

string

CancellationToken

キャンセル トークン。

public CancellationToken CancellationToken { get; set; }

Property Value

CancellationToken

MaxTokens

レスポンス内の最大トークン数。デフォルトは null（無制限）です。

public int? MaxTokens { get; set; }

Property Value

int?

Messages

Documentize.Message オブジェクトのコレクションを取得または設定します。

public List<message> Messages { get; set; }

Property Value

List<Message>

Remarks

オプションに複数のメッセージを追加する場合、コレクション内の順序は次のとおりです。

• 最初のメッセージ（存在する場合）は options.Query から取得され、内容が「You are a helpful assistant.」でロールが「system」のメッセージが先行します。
• 次に（存在する場合）options.Messages コレクションのメッセージが追加されます。
• ファイル ソースからのメッセージ（存在する場合）は最後に追加され、各ドキュメントにつき「user」ロールのメッセージが 1 つ作成されます。
  1 つもメッセージが提供されない場合は ArgumentException がスローされます。

Model

使用するモデルの ID を取得または設定します。

public string Model { get; set; }

Property Value

string

NumberOfChoices

各入力メッセージに対して生成するチャット完了の選択肢数。

public int NumberOfChoices { get; set; }

Property Value

int

Query

ChatGPT への文字列リクエストを取得または設定します。
空でない場合、これはコレクション内の最初のメッセージとなり、リクエスト時に送信されます。

public string Query { get; set; }

Property Value

string

Temperature

使用するサンプリング温度（0〜2 の範囲）。
0.8 のような高い値は出力をよりランダムにし、0.2 のような低い値は出力をより集中させ決定的にします。デフォルトは 1 です。

public double Temperature { get; set; }

Property Value

double