ThreadRuns Class

Definition

Namespace:: Azure.AI.Agents.Persistent

Assembly:: Azure.AI.Agents.Persistent.dll

Package:: Azure.AI.Agents.Persistent v1.0.0

Package:: Azure.AI.Agents.Persistent v1.1.0-beta.2

Source:: ThreadRuns.cs

Source:: ThreadRuns.cs

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.

A collection of run operations under /threads/{threadId}/runs.

public class ThreadRuns

type ThreadRuns = class

Public Class ThreadRuns

Inheritance: Object
ThreadRuns

Constructors

ThreadRuns()

Initializes a new instance of ThreadRuns for mocking.

Properties

Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

CancelRun(String, String, CancellationToken)	Cancels a run of an in‐progress thread.
CancelRun(String, String, RequestContext)	[Protocol Method] Cancels a run of an in‐progress thread. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CancelRun(String, String, CancellationToken) convenience overload with strongly typed models first.
CancelRunAsync(String, String, CancellationToken)	Cancels a run of an in‐progress thread.
CancelRunAsync(String, String, RequestContext)	[Protocol Method] Cancels a run of an in‐progress thread. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CancelRunAsync(String, String, CancellationToken) convenience overload with strongly typed models first.
CreateRun(PersistentAgentThread, PersistentAgent, CancellationToken)	Creates a new run of the specified thread using a specified agent.
CreateRun(String, RequestContent, IEnumerable<RunAdditionalFieldList>, RequestContext)	[Protocol Method] Creates a new run for an agent thread. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CreateRun(String, String, String, String, String, IEnumerable<ThreadMessageOptions>, IEnumerable<ToolDefinition>, Nullable<Boolean>, Nullable<Single>, Nullable<Single>, Nullable<Int32>, Nullable<Int32>, Truncation, BinaryData, BinaryData, Nullable<Boolean>, IReadOnlyDictionary<String, String>, IEnumerable<RunAdditionalFieldList>, CancellationToken) convenience overload with strongly typed models first.
CreateRun(String, String, String, String, String, IEnumerable<ThreadMessageOptions>, IEnumerable<ToolDefinition>, Nullable<Boolean>, Nullable<Single>, Nullable<Single>, Nullable<Int32>, Nullable<Int32>, Truncation, BinaryData, BinaryData, Nullable<Boolean>, IReadOnlyDictionary<String, String>, IEnumerable<RunAdditionalFieldList>, CancellationToken)	Creates a new run for an agent thread.
CreateRunAsync(PersistentAgentThread, PersistentAgent, CancellationToken)	Creates a new run of the specified thread using a specified agent.
CreateRunAsync(String, RequestContent, IEnumerable<RunAdditionalFieldList>, RequestContext)	[Protocol Method] Creates a new run for an agent thread. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CreateRunAsync(String, String, String, String, String, IEnumerable<ThreadMessageOptions>, IEnumerable<ToolDefinition>, Nullable<Boolean>, Nullable<Single>, Nullable<Single>, Nullable<Int32>, Nullable<Int32>, Truncation, BinaryData, BinaryData, Nullable<Boolean>, IReadOnlyDictionary<String, String>, IEnumerable<RunAdditionalFieldList>, CancellationToken) convenience overload with strongly typed models first.
CreateRunAsync(String, String, String, String, String, IEnumerable<ThreadMessageOptions>, IEnumerable<ToolDefinition>, Nullable<Boolean>, Nullable<Single>, Nullable<Single>, Nullable<Int32>, Nullable<Int32>, Truncation, BinaryData, BinaryData, Nullable<Boolean>, IReadOnlyDictionary<String, String>, IEnumerable<RunAdditionalFieldList>, CancellationToken)	Creates a new run for an agent thread.
CreateRunStreaming(String, String, String, String, String, IEnumerable<ThreadMessageOptions>, IEnumerable<ToolDefinition>, Nullable<Single>, Nullable<Single>, Nullable<Int32>, Nullable<Int32>, Truncation, BinaryData, BinaryData, Nullable<Boolean>, IReadOnlyDictionary<String,String>, CancellationToken)	Begins a new streaming ThreadRun that evaluates a PersistentAgentThread using a specified PersistentAgent.
CreateRunStreamingAsync(String, String, String, String, String, IEnumerable<ThreadMessageOptions>, IEnumerable<ToolDefinition>, Nullable<Single>, Nullable<Single>, Nullable<Int32>, Nullable<Int32>, Truncation, BinaryData, BinaryData, Nullable<Boolean>, IReadOnlyDictionary<String, String>, CancellationToken)	Begins a new streaming ThreadRun that evaluates a PersistentAgentThread using a specified PersistentAgent.
GetRun(String, String, CancellationToken)	Gets an existing run from an existing thread.
GetRun(String, String, RequestContext)	[Protocol Method] Gets an existing run from an existing thread. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetRun(String, String, CancellationToken) convenience overload with strongly typed models first.
GetRunAsync(String, String, CancellationToken)	Gets an existing run from an existing thread.
GetRunAsync(String, String, RequestContext)	[Protocol Method] Gets an existing run from an existing thread. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetRunAsync(String, String, CancellationToken) convenience overload with strongly typed models first.
GetRuns(String, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken)	Gets a list of runs for a specified thread.
GetRunsAsync(String, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken)	Gets a list of runs for a specified thread.
GetRunStep(String, String, String, IEnumerable<RunAdditionalFieldList>, CancellationToken)	Retrieves a single run step from a thread run.
GetRunStepAsync(String, String, String, IEnumerable<RunAdditionalFieldList>, CancellationToken)	Retrieves a single run step from a thread run.
GetRunSteps(String, String, IEnumerable<RunAdditionalFieldList>, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken)	Gets a list of run steps from a thread run.
GetRunSteps(ThreadRun, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken)	Returns a list of run steps associated an agent thread run.
GetRunStepsAsync(String, String, IEnumerable<RunAdditionalFieldList>, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken)	Gets a list of run steps from a thread run.
GetRunStepsAsync(ThreadRun, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken)	Returns a list of run steps associated an agent thread run.
SubmitToolOutputsToRun(String, String, RequestContent, RequestContext)	Submits outputs from tools as requested by tool calls in a stream. Stream updates that need submitted tool outputs will have a status of 'RunStatus.RequiresAction'.
SubmitToolOutputsToRun(ThreadRun, IEnumerable<ToolOutput>, CancellationToken)	Submits outputs from tool calls as requested by a run with a status of 'requires_action' with required_action.type of 'submit_tool_outputs'.
SubmitToolOutputsToRunAsync(String, String, RequestContent, RequestContext)	Submits outputs from tools as requested by tool calls in a stream. Stream updates that need submitted tool outputs will have a status of 'RunStatus.RequiresAction'.
SubmitToolOutputsToRunAsync(ThreadRun, IEnumerable<ToolOutput>, CancellationToken)	Submits outputs from tool calls as requested by a run with a status of 'requires_action' with required_action.type of 'submit_tool_outputs'.
SubmitToolOutputsToStream(ThreadRun, IEnumerable<ToolOutput>, CancellationToken)	Submits outputs from tools as requested by tool calls in a stream. Stream updates that need submitted tool outputs will have a status of 'RunStatus.RequiresAction'.
SubmitToolOutputsToStreamAsync(ThreadRun, IEnumerable<ToolOutput>, CancellationToken)	Submits outputs from tools as requested by tool calls in a stream. Stream updates that need submitted tool outputs will have a status of 'RunStatus.RequiresAction'.
UpdateRun(String, String, IReadOnlyDictionary<String,String>, CancellationToken)	Modifies an existing thread run.
UpdateRun(String, String, RequestContent, RequestContext)	[Protocol Method] Modifies an existing thread run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler UpdateRun(String, String, IReadOnlyDictionary<String,String>, CancellationToken) convenience overload with strongly typed models first.
UpdateRunAsync(String, String, IReadOnlyDictionary<String,String>, CancellationToken)	Modifies an existing thread run.
UpdateRunAsync(String, String, RequestContent, RequestContext)	[Protocol Method] Modifies an existing thread run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler UpdateRunAsync(String, String, IReadOnlyDictionary<String,String>, CancellationToken) convenience overload with strongly typed models first.

Applies to