Class RunResponse
- Namespace
- OpenAI.ObjectModels.SharedModels
- Assembly
- AntRunnerLib.dll
public class RunResponse : BaseResponse, IEquatable<ObjectBaseResponse>, IEquatable<BaseResponse>, IOpenAiModels.IId, IOpenAiModels.IModel, IOpenAiModels.ICreatedAt, IOpenAiModels.IFileIds, IOpenAiModels.IMetaData, IEquatable<RunResponse>- Inheritance
-
System.ObjectRunResponse
- Implements
-
System.IEquatable<ObjectBaseResponse>System.IEquatable<BaseResponse>System.IEquatable<RunResponse>
- 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
AssistantId
The ID of the assistant used for execution of this run.
[JsonPropertyName("assistant_id")]
public string AssistantId { get; set; }Property Value
- System.String
CancelledAt
The Unix timestamp (in seconds) for when the run was cancelled.
[JsonPropertyName("cancelled_at")]
public int? CancelledAt { get; set; }Property Value
- System.Nullable<System.Int32>
CompletedAt
The Unix timestamp (in seconds) for when the run was completed.
[JsonPropertyName("completed_at")]
public int? CompletedAt { get; set; }Property Value
- System.Nullable<System.Int32>
CreatedAt
The Unix timestamp (in seconds) for when the run was created.
[JsonPropertyName("created_at")]
public int CreatedAt { get; set; }Property Value
- System.Int32
ExpiresAt
The Unix timestamp (in seconds) for when the run will expire.
[JsonPropertyName("expires_at")]
public int? ExpiresAt { get; set; }Property Value
- System.Nullable<System.Int32>
FailedAt
The Unix timestamp (in seconds) for when the run failed.
[JsonPropertyName("failed_at")]
public int? FailedAt { get; set; }Property Value
- System.Nullable<System.Int32>
FileIds
The list of File IDs the assistant used for this run.
[JsonPropertyName("file_ids")]
public List<string>? FileIds { get; set; }Property Value
- System.Nullable<List<System.String>>
Id
The identifier, which can be referenced in API endpoints.
[JsonPropertyName("id")]
public string Id { get; set; }Property Value
- System.String
IncompleteDetails
Details on why the run is incomplete. Will be null if the run is not incomplete.
[JsonPropertyName("incomplete_details")]
public IncompleteDetails IncompleteDetails { get; set; }Property Value
Instructions
The instructions that the assistant used for this run.
[JsonPropertyName("instructions")]
public string Instructions { get; set; }Property Value
- System.String
LastError
The last error associated with this run. Will be null if there are no errors.
[JsonPropertyName("last_error")]
public Error LastError { get; set; }Property Value
MaxCompletionTokens
The maximum number of completion tokens specified to have been used over the course of the run.
[JsonPropertyName("max_completion_tokens")]
public int? MaxCompletionTokens { get; set; }Property Value
- System.Nullable<System.Int32>
MaxPromptTokens
The maximum number of prompt tokens specified to have been used over the course of the run.
[JsonPropertyName("max_prompt_tokens")]
public int? MaxPromptTokens { get; set; }Property Value
- System.Nullable<System.Int32>
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
The model that the assistant used for this run.
[JsonPropertyName("model")]
public string Model { get; set; }Property Value
- System.String
RequiredAction
Details on the action required to continue the run. Will be null if no action is required.
[JsonPropertyName("required_action")]
public RequiredAction RequiredAction { get; set; }Property Value
ResponseFormat
Specifies the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models newer than gpt-3.5-turbo-1106.
[JsonPropertyName("response_format")]
public object ResponseFormat { get; set; }Property Value
- System.Object
StartedAt
The Unix timestamp (in seconds) for when the run was started.
[JsonPropertyName("started_at")]
public int? StartedAt { get; set; }Property Value
- System.Nullable<System.Int32>
Status
The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, or expired.
[JsonPropertyName("status")]
public string Status { get; set; }Property Value
- System.String
Temperature
The sampling temperature used for this run. If not set, defaults to 1.
[JsonPropertyName("temperature")]
public double? Temperature { get; set; }Property Value
- System.Nullable<System.Double>
ThreadId
The ID of the thread that was executed on as a part of this run.
[JsonPropertyName("thread_id")]
public string ThreadId { get; set; }Property Value
- System.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 a tool. Specifying a particular tool like {"type": "TOOL_TYPE"} or {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.
[JsonPropertyName("tool_choice")]
public object ToolChoice { get; set; }Property Value
- System.Object
Tools
The list of tools that the assistant used for this run.
[JsonPropertyName("tools")]
public List<ToolDefinition>? Tools { get; set; }Property Value
- System.Nullable<List<ToolDefinition>>
TruncationStrategy
The truncation strategy to use for the thread. The default is auto.
[JsonPropertyName("truncation_strategy")]
public TruncationStrategy TruncationStrategy { get; set; }Property Value
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.).
[JsonPropertyName("usage")]
public UsageResponse Usage { get; set; }