AssistantsModelFactory.ThreadRun Method

Definition

Namespace:

Azure.AI.OpenAI.Assistants

Assembly:

Azure.AI.OpenAI.Assistants.dll

Package:

Azure.AI.OpenAI.Assistants v1.0.0-beta.4

Source:

AssistantsModelFactory.cs

Initializes a new instance of ThreadRun.

public static Azure.AI.OpenAI.Assistants.ThreadRun ThreadRun (string id = default, string threadId = default, string assistantId = default, Azure.AI.OpenAI.Assistants.RunStatus status = default, Azure.AI.OpenAI.Assistants.RequiredAction requiredAction = default, Azure.AI.OpenAI.Assistants.RunError lastError = default, string model = default, string instructions = default, System.Collections.Generic.IEnumerable<Azure.AI.OpenAI.Assistants.ToolDefinition> tools = default, System.Collections.Generic.IEnumerable<string> fileIds = default, DateTimeOffset createdAt = default, DateTimeOffset? expiresAt = default, DateTimeOffset? startedAt = default, DateTimeOffset? completedAt = default, DateTimeOffset? cancelledAt = default, DateTimeOffset? failedAt = default, System.Collections.Generic.IReadOnlyDictionary<string,string> metadata = default);

static member ThreadRun : string * string * string * Azure.AI.OpenAI.Assistants.RunStatus * Azure.AI.OpenAI.Assistants.RequiredAction * Azure.AI.OpenAI.Assistants.RunError * string * string * seq<Azure.AI.OpenAI.Assistants.ToolDefinition> * seq<string> * DateTimeOffset * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * System.Collections.Generic.IReadOnlyDictionary<string, string> -> Azure.AI.OpenAI.Assistants.ThreadRun

Public Shared Function ThreadRun (Optional id As String = Nothing, Optional threadId As String = Nothing, Optional assistantId As String = Nothing, Optional status As RunStatus = Nothing, Optional requiredAction As RequiredAction = Nothing, Optional lastError As RunError = Nothing, Optional model As String = Nothing, Optional instructions As String = Nothing, Optional tools As IEnumerable(Of ToolDefinition) = Nothing, Optional fileIds As IEnumerable(Of String) = Nothing, Optional createdAt As DateTimeOffset = Nothing, Optional expiresAt As Nullable(Of DateTimeOffset) = Nothing, Optional startedAt As Nullable(Of DateTimeOffset) = Nothing, Optional completedAt As Nullable(Of DateTimeOffset) = Nothing, Optional cancelledAt As Nullable(Of DateTimeOffset) = Nothing, Optional failedAt As Nullable(Of DateTimeOffset) = Nothing, Optional metadata As IReadOnlyDictionary(Of String, String) = Nothing) As ThreadRun

Parameters

id

String

The identifier, which can be referenced in API endpoints.

threadId

String

The ID of the thread associated with this run.

assistantId

String

The ID of the assistant associated with the thread this run was performed against.

status

RunStatus

The status of the assistant thread run.

requiredAction

RequiredAction

The details of the action required for the assistant thread run to continue.

lastError

RunError

The last error, if any, encountered by this assistant thread run.

model

String

The ID of the model to use.

instructions

String

The overridden system instructions used for this assistant thread run.

tools

IEnumerable<ToolDefinition>

The overridden enabled tools used for this assistant thread run.

fileIds

IEnumerable<String>

A list of attached file IDs, ordered by creation date in ascending order.

createdAt

DateTimeOffset

The Unix timestamp, in seconds, representing when this object was created.

expiresAt

Nullable<DateTimeOffset>

The Unix timestamp, in seconds, representing when this item expires.

startedAt

Nullable<DateTimeOffset>

The Unix timestamp, in seconds, representing when this item was started.

completedAt

Nullable<DateTimeOffset>

The Unix timestamp, in seconds, representing when this completed.

cancelledAt

Nullable<DateTimeOffset>

The Unix timestamp, in seconds, representing when this was cancelled.

failedAt

Nullable<DateTimeOffset>

The Unix timestamp, in seconds, representing when this failed.

metadata

IReadOnlyDictionary<String,String>

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.

Returns

ThreadRun

A new ThreadRun instance for mocking.