ChatOptions Class

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.Abstractions.dll

Package:

Microsoft.Extensions.AI.Abstractions v9.0.0-preview.9.24556.5

Represents the options for a chat request.

public ref class ChatOptions

public class ChatOptions

type ChatOptions = class

Public Class ChatOptions

Inheritance

Object

ChatOptions

Constructors

ChatOptions()

Properties

AdditionalProperties	Gets or sets any additional properties associated with the options.
FrequencyPenalty	Gets or sets the frequency penalty for generating chat responses.
MaxOutputTokens	Gets or sets the maximum number of tokens in the generated chat response.
ModelId	Gets or sets the model ID for the chat request.
PresencePenalty	Gets or sets the presence penalty for generating chat responses.
ResponseFormat	Gets or sets the response format for the chat request.
Seed	Gets or sets a seed value used by a service to control the reproducability of results.
StopSequences	Gets or sets the stop sequences for generating chat responses.
Temperature	Gets or sets the temperature for generating chat responses.
ToolMode	Gets or sets the tool mode for the chat request.
Tools	Gets or sets the list of tools to include with a chat request.
TopK	Gets or sets a count indicating how many of the most probable tokens the model should consider when generating the next part of the text.
TopP	Gets or sets the "nucleus sampling" factor (or "top p") for generating chat responses.

Methods

Clone()	Produces a clone of the current ChatOptions instance.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)