Class OpenAIOcrCopilotOptions

OpenAIOcrCopilotOptions class

Represents the options for configuring the OpenAIOcrCopilot.

public class OpenAIOcrCopilotOptions : OpenAIAssistantCopilotOptionsBase, 
    IOcrCopilotOptions<OpenAIOcrCopilotOptions>

Properties

NameDescription
Detail { get; set; }Gets or sets the level of detail for image analysis.
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.
Model { get; set; }Gets or sets the model to use for the assistant.
Resolution { get; set; }Gets or sets the resolution used to convert PDF pages into images. The default value is 300 dpi.
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.
UserInstructions { get; set; }Gets or sets the user prompt.

Methods

NameDescription
static Create()Creates a new instance of OpenAIOcrCopilotOptions.
static Create(Action<OpenAIOcrCopilotOptions>)Creates an instance of OpenAIOcrCopilotOptions and configures it using the provided delegate.
GetOptions()Gets the current OpenAIOcrCopilotOptions.
WithDetail(Detail)Sets the level of detail for image analysis.
WithDocument(PdfDocument)Adds a PDF document to the document collection.
WithDocument(string)Adds a document path to the document collection.
WithDocuments(DocumentCollection)Sets the document collection.
WithDocuments(List<PdfDocument>)Adds multiple PDF documents to the document collection.
WithDocuments(List<string>)Adds multiple document paths to the document collection.
WithMaxCompletionTokens(int?)Sets the max completion tokens.
WithModel(string)Sets the model.
WithResolution(int)Sets the resolution used to convert PDF pages into images. The default value is 300 dpi.
WithSystemInstructions(string)Sets the instructions for the ocr copilot options.
WithTemperature(double?)Sets the temperature.
WithTopP(double?)Sets the top P value.
WithUserInstructions(string)Sets the user prompt.

See Also