Class RunResponse
Contents
[
Hide
]RunResponse class
Represents an execution run on a thread.
public class RunResponse : BaseResponse, IStatus
Constructors
| Name | Description |
|---|---|
| RunResponse() | The default constructor. |
Properties
| Name | Description |
|---|---|
| AssistantId { get; set; } | Gets or sets the ID of the assistant used for execution of this run. |
| CancelledAt { get; set; } | Gets or sets the Unix timestamp (in seconds) for when the run was cancelled. |
| CompletedAt { get; set; } | Gets or sets the Unix timestamp (in seconds) for when the run was completed. |
| CreatedAt { get; set; } | Gets or sets the Unix timestamp (in seconds) for when the run was created. |
| Detail { get; set; } | Gets or sets the response detail. |
| Error { get; set; } | Gets or sets the HTTP response error. |
| ErrorMessage { get; } | Gets or sets the error information. |
| ExpiresAt { get; set; } | Gets or sets the Unix timestamp (in seconds) for when the run will expire. |
| FailedAt { get; set; } | Gets or sets the Unix timestamp (in seconds) for when the run failed. |
| HttpResponseHeaders { get; set; } | Gets or sets the HTTP response headers. |
| HttpStatusCode { get; set; } | Gets or sets the HTTP status code. |
| Id { get; set; } | Gets or sets the identifier, which can be referenced in API endpoints. |
| IncompleteDetails { get; set; } | Gets or sets the details on why the run is incomplete. Will be null if the run is not incomplete. |
| Instructions { get; set; } | Gets or sets the instructions that the assistant used for this run. |
| IsSuccessful { get; } | Indicates if the response was successful. |
| LastError { get; set; } | Gets or sets the last error associated with this run. Will be null if there are no errors. |
| MaxCompletionTokens { get; set; } | Gets or sets the maximum number of completion tokens specified to have been used over the course of the run. |
| MaxPromptTokens { get; set; } | Gets or sets the maximum number of prompt tokens specified to have been used over the course of the run. |
| Metadata { get; set; } | Gets or sets a 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. |
| Model { get; set; } | Gets or sets the model that the assistant used for this run. |
| Object { get; set; } | Gets or sets the object type, which is always thread.run. |
| ReasonPhrase { get; } | Gets the error reason phrase. |
| RequiredAction { get; set; } | Gets or sets the details on the action required to continue the run. Will be null if no action is required. |
| ResponseFormat { get; set; } | Gets or sets 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. |
| StartedAt { get; set; } | Gets or sets the Unix timestamp (in seconds) for when the run was started. |
| Status { get; set; } | Gets or sets the status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired. |
| Temperature { get; set; } | Gets or sets the sampling temperature used for this run. If not set, defaults to 1. |
| ThreadId { get; set; } | Gets or sets the ID of the thread that was executed on as a part of this run. |
| ToolChoice { get; set; } | Gets or sets 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. |
| Tools { get; set; } | Gets or sets the list of tools that the assistant used for this run. |
| TopP { get; set; } | Gets or sets the nucleus sampling value used for this run. If not set, defaults to 1. |
| TruncationStrategy { get; set; } | Gets or sets the truncation strategy that controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. |
| Usage { get; set; } | Gets or sets the 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.). |
See Also
- class BaseResponse
- interface IStatus
- namespace Aspose.Pdf.AI
- assembly Aspose.PDF
