Table of Contents

Class AssistantCreateRequest

Namespace
OpenAI.ObjectModels.RequestModels
Assembly
AntRunnerLib.dll
public class AssistantCreateRequest : IOpenAiModels.IModel, IOpenAiModels.IMetaData, IOpenAiModels.ITemperature
Inheritance
System.Object
AssistantCreateRequest
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Extension Methods

Properties

Description

The description of the assistant. The maximum length is 512 characters.

[JsonPropertyName("description")]
public string Description { get; set; }

Property Value

System.String

Instructions

The system instructions that the assistant uses. The maximum length is 256,000 characters.

[JsonPropertyName("instructions")]
public string Instructions { get; set; }

Property Value

System.String

Metadata

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

[JsonPropertyName("metadata")]
public Dictionary<string, string>? Metadata { get; set; }

Property Value

System.Nullable<Dictionary<System.String, System.String>>

Model

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

[JsonPropertyName("model")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string Model { get; set; }

Property Value

System.String

Name

The name of the assistant. The maximum length is 256 characters.

[JsonPropertyName("name")]
public string Name { get; set; }

Property Value

System.String

ResponseFormat

Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106. Setting to { "type": "json_object" } enables JSON mode, which guarantees the message the model generates is valid JSON.
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.

[JsonPropertyName("response_format")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public ResponseFormatOneOfType ResponseFormat { get; set; }

Property Value

ResponseFormatOneOfType

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.

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

Property Value

System.Nullable<System.Single>

ToolResources

A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

[JsonPropertyName("tool_resources")]
public ToolResources ToolResources { get; set; }

Property Value

ToolResources

Tools

A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

[JsonPropertyName("tools")]
public List<ToolDefinition>? Tools { get; set; }

Property Value

System.Nullable<List<ToolDefinition>>

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.

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

Property Value

System.Nullable<System.Double>
Edit this page