Class ChatGptRequestOptions

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

継承

object ← PluginBaseOptions ← ChatGptRequestOptions

実装

• IPluginOptions

継承されたメンバー

• 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()

コンストラクター

ChatGptRequestOptions()

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

public ChatGptRequestOptions()

ChatGptRequestOptions(string, string, string, string)

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

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

パラメーター

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

プロパティ

ApiKey

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

public string ApiKey { get; set; }

プロパティ値

string

ApiUrl

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

public string ApiUrl { get; set; }

プロパティ値

string

CancellationToken

キャンセルトークン。

public CancellationToken CancellationToken { get; set; }

プロパティ値

CancellationToken

MaxTokens

レスポンス内の最大トークン数。デフォルトは null で、無限を意味します。

public int? MaxTokens { get; set; }

プロパティ値

int?

Messages

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

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

プロパティ値

List<Message>

Remarks

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

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

Model

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

public string Model { get; set; }

プロパティ値

string

NumberOfChoices

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

public int NumberOfChoices { get; set; }

プロパティ値

int

Query

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

public string Query { get; set; }

プロパティ値

string

Temperature

0 から 2 の範囲で使用するサンプリング温度。0.8 のような高い値は出力をよりランダムにし、0.2 のような低い値はより焦点が合い決定的になります。デフォルトは 1 です。

public double Temperature { get; set; }

プロパティ値

double