Class OpenAIImageDescriptionCopilotOptions

OpenAIImageDescriptionCopilotOptions class

Represents the options for configuring the OpenAICopilot.

public class OpenAIImageDescriptionCopilotOptions : OpenAIAssistantCopilotOptionsBase, 
    IImageDescriptionCopilotOptions<OpenAIImageDescriptionCopilotOptions>

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.
ImageDescriptionPrompt { get; set; }Gets or sets the prompt to instruct the model to provide image description.
ImageDetail { get; set; }Gets or sets the detail level of the image if specified by the user. “low” uses fewer tokens, you can opt in to high resolution using “high”. If not set defaults to “auto”.
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.
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 OpenAIImageDescriptionCopilotOptions.
static Create(Action<OpenAIImageDescriptionCopilotOptions>)Creates an instance of OpenAIImageDescriptionCopilotOptions and configures it using the provided delegate.
GetOptions()Gets the current OpenAIImageDescriptionCopilotOptions.
WithAssistantName(string)Sets the assistant name for the image description copilot options.
WithDocument(PdfDocument)Adds a PDF document to the document collection for the image description copilot options.
WithDocument(string)Adds a document path to the document collection for the image description copilot options.
WithDocuments(DocumentCollection)Sets the document collection for the image description copilot options.
WithDocuments(List<PdfDocument>)Adds multiple PDF documents to the document collection for the image description copilot options.
WithDocuments(List<string>)Adds multiple document paths to the document collection for the image description copilot options.
WithImageDescriptionPrompt(string)Sets the prompt for the image description copilot options.
WithImageDetail(string)Sets the image detail level.
WithInstructions(string)Sets the instructions for the image description copilot options.
WithMaxCompletionTokens(int?)Sets the max completion tokens for the image description copilot options.
WithMaxPromptTokens(int?)Sets the max prompt tokens for the image description copilot options.
WithModel(string)Sets the model for the image description copilot options.
WithTemperature(double?)Sets the temperature for the image description copilot options.
WithTopP(double?)Sets the top P value for the image description copilot options.

See Also

Class OpenAIImageDescriptionCopilotExtensions Class OpenAIModels