Class RunRequest

Inheritance
object
RequestBody
ModelRequest
RunRequest
Inherited Members
Namespace: Glitch9.AIDevKit.OpenAI
Assembly: .dll
Syntax
public class RunRequest : ModelRequest

Properties

AdditionalInstructions

Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.

Declaration
public string AdditionalInstructions { get; set; }
Property Value
Type Description
string

AdditionalMessages

Adds additional messages to the thread before creating the run.

Declaration
public List<ThreadMessage> AdditionalMessages { get; set; }
Property Value
Type Description
List<ThreadMessage>

AssistantId

[Required] The ID of the AssistantObject to use to execute this run.

Declaration
public string AssistantId { get; set; }
Property Value
Type Description
string

Instructions

Override the default System message of the AssistantObject. This is useful for modifying the behavior on a per-run basis.

Declaration
public string Instructions { get; set; }
Property Value
Type Description
string

MaxCompletionTokens

The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status incomplete. See incomplete_details for more info.

Declaration
public int? MaxCompletionTokens { get; set; }
Property Value
Type Description
int?

MaxPromptTokens

The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status incomplete. See incomplete_details for more info.

Declaration
public int? MaxPromptTokens { get; set; }
Property Value
Type Description
int?

Stream

If true, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a data: [DONE] message.

Declaration
public bool? Stream { get; set; }
Property Value
Type Description
bool?

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.

Declaration
public float? Temperature { get; set; }
Property Value
Type Description
float?

ToolChoice

Controls which (if any) tool is called by the model. 'none' means the model will not call any tools and instead generates a message. 'auto' is the default value and means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools before responding to the user. Specifying a particular tool like {"type": "file_search"} or {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

Declaration
public ToolChoice ToolChoice { get; set; }
Property Value
Type Description
ToolChoice

Tools

Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.

Declaration
public List<ToolCall> Tools { get; set; }
Property Value
Type Description
List<ToolCall>

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.

Declaration
public float? TopP { get; set; }
Property Value
Type Description
float?

TruncationStrategy

Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.

Declaration
public TruncationStrategy TruncationStrategy { get; set; }
Property Value
Type Description
TruncationStrategy

Methods

ToString()

Returns a string that represents the current object.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents the current object.
Overrides
object.ToString()