Table of Contents

Class RunResponse

Namespace
OpenAI.Threads
Assembly
OpenAI-DotNet.dll

An invocation of an Assistant on a Thread. The Assistant uses it's configuration and the Thread's Messages to perform tasks by calling models and tools. As part of a Run, the Assistant appends Messages to the Thread.

public sealed class RunResponse : BaseResponse, IServerSentEvent
Inheritance
RunResponse
Implements
Inherited Members
Extension Methods

Constructors

RunResponse() 

public RunResponse()

Properties

AssistantId

The ID of the assistant used for execution of this run.

[JsonInclude]
[JsonPropertyName("assistant_id")]
public string AssistantId { get; }

Property Value

string

CancelledAt 

[JsonIgnore]
public DateTime? CancelledAt { get; }

Property Value

DateTime?

CancelledAtUnixTimeSeconds

The Unix timestamp (in seconds) for when the run was cancelled.

[JsonInclude]
[JsonPropertyName("cancelled_at")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? CancelledAtUnixTimeSeconds { get; }

Property Value

int?

CompletedAt 

[JsonIgnore]
public DateTime? CompletedAt { get; }

Property Value

DateTime?

CompletedAtUnixTimeSeconds

The Unix timestamp (in seconds) for when the run was completed.

[JsonInclude]
[JsonPropertyName("completed_at")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? CompletedAtUnixTimeSeconds { get; }

Property Value

int?

CreatedAt 

[JsonIgnore]
public DateTime CreatedAt { get; }

Property Value

DateTime

CreatedAtUnixTimeSeconds

The Unix timestamp (in seconds) for when the thread was created.

[JsonInclude]
[JsonPropertyName("created_at")]
public int CreatedAtUnixTimeSeconds { get; }

Property Value

int

ExpiresAt 

[JsonIgnore]
public DateTime? ExpiresAt { get; }

Property Value

DateTime?

ExpiresAtUnixTimeSeconds

The Unix timestamp (in seconds) for when the run will expire.

[JsonInclude]
[JsonPropertyName("expires_at")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? ExpiresAtUnixTimeSeconds { get; }

Property Value

int?

FailedAt 

[JsonIgnore]
public DateTime? FailedAt { get; }

Property Value

DateTime?

FailedAtUnixTimeSeconds

The Unix timestamp (in seconds) for when the run failed.

[JsonInclude]
[JsonPropertyName("failed_at")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? FailedAtUnixTimeSeconds { get; }

Property Value

int?

FileIds

The list of File IDs the assistant used for this run.

[JsonIgnore]
[Obsolete("Removed")]
public IReadOnlyList<string> FileIds { get; }

Property Value

IReadOnlyList<string>

Id

The identifier, which can be referenced in API endpoints.

[JsonInclude]
[JsonPropertyName("id")]
public string Id { get; }

Property Value

string

IncompleteDetails 

[JsonInclude]
[JsonPropertyName("incomplete_details")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public IncompleteDetails IncompleteDetails { get; }

Property Value

IncompleteDetails

Instructions

The instructions that the assistant used for this run.

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

Property Value

string

LastError

The Last error Associated with this run. Will be null if there are no errors.

[JsonInclude]
[JsonPropertyName("last_error")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Error LastError { get; }

Property Value

Error

MaxCompletionTokens

The maximum number of completion tokens specified to have been used over the course of the run.

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

Property Value

int?

MaxPromptTokens

The maximum number of prompt tokens specified to have been used over the course of the run.

[JsonInclude]
[JsonPropertyName("max_prompt_tokens")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? MaxPromptTokens { get; }

Property Value

int?

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 maximum of 512 characters long.

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

Property Value

IReadOnlyDictionary<string, string>

Model

The model that the assistant used for this run.

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

Property Value

string

Object

The object type, which is always run.

[JsonInclude]
[JsonPropertyName("object")]
public string Object { get; }

Property Value

string

ParallelToolCalls 

[JsonInclude]
[JsonPropertyName("parallel_tool_calls")]
public bool ParallelToolCalls { get; }

Property Value

bool

RequiredAction

Details on the action required to continue the run. Will be null if no action is required.

[JsonInclude]
[JsonPropertyName("required_action")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public RequiredAction RequiredAction { get; }

Property Value

RequiredAction

ResponseFormat 

[JsonIgnore]
public ChatResponseFormat ResponseFormat { get; }

Property Value

ChatResponseFormat

ResponseFormatObject

Specifies 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.

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

Property Value

ResponseFormatObject

Remarks

Important: When using JSON mode you must still instruct the model to produce JSON yourself via some conversation message, for example via your system message. If you don't do this, the model may generate an unending stream of whitespace until the generation reaches the token limit, which may take a lot of time and give the appearance of a "stuck" request. Also note that the message content may be partial (i.e. cut off) if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

StartedAt 

[JsonIgnore]
public DateTime? StartedAt { get; }

Property Value

DateTime?

StartedAtUnixTimeSeconds

The Unix timestamp (in seconds) for when the run was started.

[JsonInclude]
[JsonPropertyName("started_at")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? StartedAtUnixTimeSeconds { get; }

Property Value

int?

Status

The status of the run.

[JsonInclude]
[JsonPropertyName("status")]
[JsonConverter(typeof(JsonStringEnumConverter<RunStatus>))]
public RunStatus Status { get; }

Property Value

RunStatus

Temperature

The sampling temperature used for this run. If not set, defaults to 1.

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

Property Value

double?

ThreadId

The thread ID that this run belongs to.

[JsonInclude]
[JsonPropertyName("thread_id")]
public string ThreadId { get; }

Property Value

string

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.

[JsonInclude]
[JsonPropertyName("tool_choice")]
public dynamic ToolChoice { get; }

Property Value

dynamic

Tools

The list of tools that the assistant used for this run.

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

Property Value

IReadOnlyList<Tool>

TopP

The nucleus sampling value used for this run. If not set, defaults to 1.

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

Property Value

double?

TruncationStrategy

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

[JsonInclude]
[JsonPropertyName("truncation_strategy")]
public TruncationStrategy TruncationStrategy { get; }

Property Value

TruncationStrategy

Usage

Usage statistics related to the run. This value will be null if the run is not in a terminal state (i.e. in_progress, queued, etc.).

[JsonInclude]
[JsonPropertyName("usage")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Usage Usage { get; }

Property Value

Usage

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Operators

implicit operator string(RunResponse) 

public static implicit operator string(RunResponse run)

Parameters

run RunResponse

Returns

string
Edit this page