ThreadRun Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Data representing a single evaluation run of an assistant thread.
public class ThreadRun : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.ThreadRun>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.ThreadRun>type ThreadRun = class
interface IJsonModel<ThreadRun>
interface IPersistableModel<ThreadRun>Public Class ThreadRun
Implements IJsonModel(Of ThreadRun), IPersistableModel(Of ThreadRun)- Inheritance
-
ThreadRun
- Implements
Properties
| AssistantId |
The ID of the assistant associated with the thread this run was performed against. |
| CancelledAt |
The Unix timestamp, in seconds, representing when this was cancelled. |
| CompletedAt |
The Unix timestamp, in seconds, representing when this completed. |
| CreatedAt |
The Unix timestamp, in seconds, representing when this object was created. |
| ExpiresAt |
The Unix timestamp, in seconds, representing when this item expires. |
| FailedAt |
The Unix timestamp, in seconds, representing when this failed. |
| FileIds |
A list of attached file IDs, ordered by creation date in ascending order. |
| Id |
The identifier, which can be referenced in API endpoints. |
| Instructions |
The overridden system instructions used for this assistant thread run. |
| LastError |
The last error, if any, encountered by this assistant thread run. |
| Metadata |
A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. |
| Model |
The ID of the model to use. |
| RequiredAction |
The details of the action required for the assistant thread run to continue. Please note RequiredAction is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SubmitToolOutputsAction. |
| StartedAt |
The Unix timestamp, in seconds, representing when this item was started. |
| Status |
The status of the assistant thread run. |
| ThreadId |
The ID of the thread associated with this run. |
| Tools |
The overridden enabled tools used for this assistant thread run. Please note ToolDefinition is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include CodeInterpreterToolDefinition, FunctionToolDefinition and RetrievalToolDefinition. |
Explicit Interface Implementations
| IJsonModel<ThreadRun>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<ThreadRun>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<ThreadRun>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<ThreadRun>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<ThreadRun>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
