Class OpenAIChatCopilotOptions

OpenAIChatCopilotOptions class

表示配置 OpenAICopilot 的选项。

public class OpenAIChatCopilotOptions : OpenAIAssistantCopilotOptionsBase, 
    IChatCopilotOptions<OpenAIChatCopilotOptions>

Properties

NameDescription
AssistantName { get; set; }获取或设置助手的名称。
ContextBackupJsonPath { get; set; }获取或设置上下文备份 JSON 的文件路径。
DocumentCollection { get; set; }获取或设置要处理的文档集合。
MaxCompletionTokens { get; set; }获取或设置在运行过程中可以使用的最大完成令牌数。
MaxPromptTokens { get; set; }获取或设置在运行过程中可以使用的最大提示令牌数。
virtual Model { get; set; }获取或设置用于助手的模型。
RestoreContextFromBackup { get; set; }获取或设置一个值，指示是否从备份恢复上下文。
SystemInstructions { get; set; }获取或设置包含助手系统指令的文本文件的文件路径。
Temperature { get; set; }获取或设置用于模型的采样温度。
TopP { get; set; }获取或设置用于核采样的 top-p 值。
TruncationStrategy { get; set; }获取或设置线程的截断策略。
VectorStoreExpireDays { get; set; }获取或设置向量存储过期前的天数。

Methods

NameDescription
static Create()创建 OpenAIChatCopilotOptions 的新实例。
static Create(Action<OpenAIChatCopilotOptions>)创建 OpenAIChatCopilotOptions 的实例，并使用提供的委托进行配置。
GetOptions()获取当前的 OpenAIChatCopilotOptions。
WithAssistantName(string)为聊天助手选项设置助手名称。
WithContextBackupJsonPath(string)为聊天助手选项设置上下文备份 JSON 的文件路径。
WithDocument(PdfDocument)将 PDF 文档添加到聊天助手选项的文档集合中。
WithDocument(string)将文档路径添加到聊天助手选项的文档集合中。
WithDocument(TextDocument)将文本文档添加到聊天助手选项的文档集合中。
WithDocuments(DocumentCollection)为聊天助手选项设置文档集合。
WithDocuments(List<PdfDocument>)将多个 PDF 文档添加到聊天助手选项的文档集合中。
WithDocuments(List<string>)将多个文档路径添加到聊天助手选项的文档集合中。
WithDocuments(List<TextDocument>)将多个文本文档添加到聊天助手选项的文档集合中。
WithInstructions(string)为聊天助手选项设置指令。
WithMaxCompletionTokens(int?)为聊天助手选项设置最大完成令牌。
WithMaxPromptTokens(int?)为聊天助手选项设置最大提示令牌。
WithModel(string)为聊天助手选项设置模型。
WithRestoreContextFromBackup(bool)设置是否在聊天助手选项中从备份恢复上下文。
WithTemperature(double?)为聊天助手选项设置温度。
WithTopP(double?)为聊天助手选项设置 top P 值。
WithTruncationStrategy(TruncationStrategy)为聊天助手选项设置截断策略。
WithVectorStoreExpireDays(int)为聊天助手选项设置向量存储过期的天数。

See Also

Class OpenAIChatCopilot Class OpenAIClient