Table of Contents

Class ChatRequest

Namespace
OpenAI.Chat
Assembly
OpenAI-DotNet.dll
public sealed class ChatRequest
Inheritance
ChatRequest
Inherited Members

Constructors

ChatRequest(IEnumerable<Message>, IEnumerable<Tool>, string, string, double?, IReadOnlyDictionary<string, double>, int?, int?, double?, ChatResponseFormat, int?, string[], double?, double?, int?, bool?, JsonSchema, AudioConfig, ReasoningEffort?, string) 

public ChatRequest(IEnumerable<Message> messages, IEnumerable<Tool> tools, string toolChoice = null, string model = null, double? frequencyPenalty = null, IReadOnlyDictionary<string, double> logitBias = null, int? maxTokens = null, int? number = null, double? presencePenalty = null, ChatResponseFormat responseFormat = ChatResponseFormat.Auto, int? seed = null, string[] stops = null, double? temperature = null, double? topP = null, int? topLogProbs = null, bool? parallelToolCalls = null, JsonSchema jsonSchema = null, AudioConfig audioConfig = null, ReasoningEffort? reasoningEffort = null, string user = null)

Parameters

messages IEnumerable<Message>
tools IEnumerable<Tool>
toolChoice string
model string
frequencyPenalty double?
logitBias IReadOnlyDictionary<string, double>
maxTokens int?
number int?
presencePenalty double?
responseFormat ChatResponseFormat
seed int?
stops string[]
temperature double?
topP double?
topLogProbs int?
parallelToolCalls bool?
jsonSchema JsonSchema
audioConfig AudioConfig
reasoningEffort ReasoningEffort?
user string

ChatRequest(IEnumerable<Message>, string, double?, IReadOnlyDictionary<string, double>, int?, int?, double?, ChatResponseFormat, int?, string[], double?, double?, int?, bool?, JsonSchema, AudioConfig, ReasoningEffort?, string)

Constructor.

public ChatRequest(IEnumerable<Message> messages, string model = null, double? frequencyPenalty = null, IReadOnlyDictionary<string, double> logitBias = null, int? maxTokens = null, int? number = null, double? presencePenalty = null, ChatResponseFormat responseFormat = ChatResponseFormat.Auto, int? seed = null, string[] stops = null, double? temperature = null, double? topP = null, int? topLogProbs = null, bool? parallelToolCalls = null, JsonSchema jsonSchema = null, AudioConfig audioConfig = null, ReasoningEffort? reasoningEffort = null, string user = null)

Parameters

messages IEnumerable<Message>

The list of messages for the current chat session.

model string

Id of the model to use.

frequencyPenalty double?

Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
Defaults to 0

logitBias IReadOnlyDictionary<string, double>

Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens(specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling.The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.
Defaults to null

maxTokens int?

An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

number int?

How many chat completion choices to generate for each input message.
Defaults to 1

presencePenalty double?

Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
Defaults to 0

responseFormat ChatResponseFormat

An object specifying the format that the model must output. Setting to Json or JsonSchema enables JSON mode, which guarantees the message the model generates is valid JSON.

seed int?
stops string[]

Up to 4 sequences where the API will stop generating further tokens.

temperature double?

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.
Defaults to 1

topP double?

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.
Defaults to 1

topLogProbs int?

An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability.

parallelToolCalls bool?

Whether to enable parallel function calling during tool use.

jsonSchema JsonSchema

The JsonSchema to use for structured JSON outputs.
https://platform.openai.com/docs/guides/structured-outputs
https://json-schema.org/overview/what-is-jsonschema

audioConfig AudioConfig

Parameters for audio output. AudioConfig.

reasoningEffort ReasoningEffort?

Constrains the effort of reasoning for Reasoning Models.
Currently supported values are: Low, Medium, High. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning response.
Reasoning models only!

user string

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

Properties

AudioConfig

Parameters for audio output. Required when audio output is requested with modalities: ["audio"].

[JsonPropertyName("audio")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public AudioConfig AudioConfig { get; }

Property Value

AudioConfig

FrequencyPenalty

Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
Defaults to 0

[JsonPropertyName("frequency_penalty")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public double? FrequencyPenalty { get; }

Property Value

double?

LogProbs

Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

[JsonPropertyName("logprobs")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? LogProbs { get; }

Property Value

bool?

Remarks

This option is currently not available on the gpt-4-vision-preview model.

LogitBias

Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens(specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling.The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.
Defaults to null

[JsonPropertyName("logit_bias")]
public IReadOnlyDictionary<string, double> LogitBias { get; }

Property Value

IReadOnlyDictionary<string, double>

MaxCompletionTokens

An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

[JsonPropertyName("max_completion_tokens")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? MaxCompletionTokens { get; }

Property Value

int?

MaxTokens

The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens).

[JsonPropertyName("max_tokens")]
[Obsolete("use MaxCompletionTokens instead")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? MaxTokens { get; set; }

Property Value

int?

Remarks

Still used for older models that support it.

Messages

The messages to generate chat completions for, in the chat format.

[JsonPropertyName("messages")]
public IReadOnlyList<Message> Messages { get; }

Property Value

IReadOnlyList<Message>

Metadata

Developer-defined tags and values used for filtering completions in the dashboard.

[JsonPropertyName("metadata")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IReadOnlyDictionary<string, object> Metadata { get; set; }

Property Value

IReadOnlyDictionary<string, object>

Modalities 

[JsonPropertyName("modalities")]
[JsonConverter(typeof(ModalityConverter))]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Modality Modalities { get; }

Property Value

Modality

Model

ID of the model to use.

[JsonPropertyName("model")]
public string Model { get; }

Property Value

string

Number

How many chat completion choices to generate for each input message.
Defaults to 1

[JsonPropertyName("n")]
public int? Number { get; }

Property Value

int?

ParallelToolCalls

Whether to enable parallel function calling during tool use.

[JsonPropertyName("parallel_tool_calls")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? ParallelToolCalls { get; }

Property Value

bool?

Prediction

Configuration for a Predicted Output, which can greatly improve response times when large parts of the model response are known ahead of time. This is most common when you are regenerating a file with only minor changes to most of the content.

[JsonPropertyName("prediction")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public object Prediction { get; set; }

Property Value

object

PresencePenalty

Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
Defaults to 0

[JsonPropertyName("presence_penalty")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public double? PresencePenalty { get; }

Property Value

double?

ReasoningEffort

Constrains the effort of reasoning for Reasoning Models.
Currently supported values are: Low, Medium, High. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning response.

[JsonPropertyName("reasoning_effort")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public ReasoningEffort? ReasoningEffort { get; }

Property Value

ReasoningEffort?

Remarks

Reasoning models only!

ResponseFormat

An object specifying the format that the model must output. Setting to Json or JsonSchema enables JSON mode, which guarantees the message the model generates is valid JSON.

[JsonIgnore]
public ChatResponseFormat ResponseFormat { get; }

Property Value

ChatResponseFormat

Remarks

Important: When using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

ResponseFormatObject 

[JsonPropertyName("response_format")]
[JsonConverter(typeof(ResponseFormatConverter))]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public ResponseFormatObject ResponseFormatObject { get; }

Property Value

ResponseFormatObject

Seed

This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.

[JsonPropertyName("seed")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? Seed { get; }

Property Value

int?

ServiceTier

Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service:

  • If set to 'auto', and the Project is Scale tier enabled, the system will utilize scale tier credits until they are exhausted.
  • If set to 'auto', and the Project is not Scale tier enabled, the request will be processed using the default service tier with a lower uptime SLA and no latency guarantee.
  • If set to 'default', the request will be processed using the default service tier with a lower uptime SLA and no latency guarantee.
  • When not set, the default behavior is 'auto'.
    When this parameter is set, the response body will include the service_tier utilized.
[JsonPropertyName("service_tier")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string ServiceTier { get; set; }

Property Value

string

Stops

Up to 4 sequences where the API will stop generating further tokens.

[JsonPropertyName("stop")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string[] Stops { get; }

Property Value

string[]

Store

Whether or not to store the output of this chat completion request for use in our model distillation or evals products.

[JsonPropertyName("store")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? Store { get; set; }

Property Value

bool?

Stream

Specifies where the results should stream and be returned at one time. Do not set this yourself, use the appropriate methods on ChatEndpoint instead.
Defaults to false

[JsonPropertyName("stream")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool Stream { get; }

Property Value

bool

StreamOptions 

[JsonPropertyName("stream_options")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public StreamOptions StreamOptions { get; }

Property Value

StreamOptions

Temperature

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.
Defaults to 1

[JsonPropertyName("temperature")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public double? Temperature { get; }

Property Value

double?

ToolChoice

Controls which (if any) function is called by the model.
'none' means the model will not call a function and instead generates a message.<br/> 'auto' means the model can pick between generating a message or calling a function.<br/> Specifying a particular function via {"type: "function", "function": {"name": "my_function"}} forces the model to call that function.
'none' is the default when no functions are present.
'auto' is the default if functions are present.

[JsonPropertyName("tool_choice")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public dynamic ToolChoice { get; }

Property Value

dynamic

Tools

A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for.

[JsonPropertyName("tools")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IReadOnlyList<Tool> Tools { get; }

Property Value

IReadOnlyList<Tool>

TopLogProbs

An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability.

[JsonPropertyName("top_logprobs")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? TopLogProbs { get; }

Property Value

int?

Remarks

LogProbs must be set to true if this parameter is used.

TopP

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.
Defaults to 1

[JsonPropertyName("top_p")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public double? TopP { get; }

Property Value

double?

User

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

[JsonPropertyName("user")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string User { get; }

Property Value

string

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Edit this page