Class ChatGptRequestOptions

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

继承

object ← PluginBaseOptions ← ChatGptRequestOptions

实现

• IPluginOptions

继承的成员

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• 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>

备注

当向选项中添加多个消息时，消息集合的顺序如下：

• 第一条消息（如果有）来自 options.Query，前面加上内容为：“You are a helpful assistant.” 的消息，并且角色为“system”。
• 然后（如果有）添加来自 options.Messages 集合的消息。
• 最后，来自文件源的消息（如果有）会添加，针对每个文档添加一个具有“user”角色的消息对象。 如果没有提供任何消息，将抛出 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