ChatOptions Class

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.Abstractions.dll

Package:

Microsoft.Extensions.AI.Abstractions v9.3.0-preview.1.25114.11

Source:

ChatOptions.cs

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.
ChatThreadId	Gets or sets an optional identifier used to associate a request with an existing chat thread.
FrequencyPenalty	Gets or sets the penalty for repeated tokens in chat responses proportional to how many times they've appeared.
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 a value that influences the probability of generated tokens appearing based on their existing presence in generated text.
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 reproducibility of results.
StopSequences	Gets or sets the list of stop sequences.
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 the number of most probable tokens that the model considers 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.