Class OpenAISummaryCopilotOptions

OpenAISummaryCopilotOptions class

Represents the options for configuring the OpenAICopilot.

public class OpenAISummaryCopilotOptions : OpenAIAssistantCopilotOptionsBase, 
    ISummaryCopilotOptions<OpenAISummaryCopilotOptions>

Properties

NameDescription
AssistantName { get; set; }Gets or sets the name of the assistant.
DocumentCollection { get; set; }Gets or sets the collection of documents to be processed.
MaxCompletionTokens { get; set; }Gets or sets the maximum number of completion tokens that may be used over the course of the run.
MaxPromptTokens { get; set; }Gets or sets the maximum number of prompt tokens that may be used over the course of the run.
Model { get; set; }Gets or sets the model to use for the assistant.
SummaryPrompt { get; set; }Gets or sets the prompt to instruct the model to provide a document summary.
SystemInstructions { get; set; }Gets or sets the file path for the text file containing assistant system instructions.
Temperature { get; set; }Gets or sets the sampling temperature to use for the model.
TopP { get; set; }Gets or sets the top-p value for nucleus sampling.

Methods

NameDescription
static Create()Creates a new instance of OpenAISummaryCopilotOptions.
static Create(Action<OpenAISummaryCopilotOptions>)Creates an instance of OpenAISummaryCopilotOptions and configures it using the provided delegate.
GetOptions()Gets the current OpenAISummaryCopilotOptions.
WithAssistantName(string)Sets the assistant name for the summary copilot options.
WithDocument(PdfDocument)Adds a PDF document to the document collection for the summary copilot options.
WithDocument(string)Adds a document path to the document collection for the summary copilot options.
WithDocument(TextDocument)Adds a text document to the document collection for the summary copilot options.
WithDocuments(DocumentCollection)Sets the document collection for the summary copilot options.
WithDocuments(List<PdfDocument>)Adds multiple PDF documents to the document collection for the summary copilot options.
WithDocuments(List<string>)Adds multiple document paths to the document collection for the summary copilot options.
WithDocuments(List<TextDocument>)Adds multiple text documents to the document collection for the summary copilot options.
WithInstructions(string)Sets the instructions for the summary copilot options.
WithMaxCompletionTokens(int?)Sets the max completion tokens for the summary copilot options.
WithMaxPromptTokens(int?)Sets the max prompt tokens for the summary copilot options.
WithModel(string)Sets the model for the summary copilot options.
WithSummaryPrompt(string)Sets the summary prompt for the summary copilot options.
WithTemperature(double?)Sets the temperature for the summary copilot options.
WithTopP(double?)Sets the top P value for the summary copilot options.

See Also

Class OpenAISummaryCopilot Class PdfDocument