AgentsClient.SubmitToolOutputsToRunAsync Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

Azure.AI.Projects v1.0.0-beta.1

Overloads

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'.
SubmitToolOutputsToRunAsync(String, String, RequestContent, RequestContext)	[Protocol Method] Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler SubmitToolOutputsToRunAsync(String, String, IEnumerable<ToolOutput>, Nullable<Boolean>, CancellationToken) convenience overload with strongly typed models first.
SubmitToolOutputsToRunAsync(String, String, IEnumerable<ToolOutput>, Nullable<Boolean>, CancellationToken)	Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.

SubmitToolOutputsToRunAsync(ThreadRun, IEnumerable<ToolOutput>, CancellationToken)

Source:

AgentsClient.cs

Submits outputs from tool calls as requested by a run with a status of 'requires_action' with required_action.type of 'submit_tool_outputs'.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.ThreadRun>> SubmitToolOutputsToRunAsync (Azure.AI.Projects.ThreadRun run, System.Collections.Generic.IEnumerable<Azure.AI.Projects.ToolOutput> toolOutputs, System.Threading.CancellationToken cancellationToken = default);

abstract member SubmitToolOutputsToRunAsync : Azure.AI.Projects.ThreadRun * seq<Azure.AI.Projects.ToolOutput> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.ThreadRun>>
override this.SubmitToolOutputsToRunAsync : Azure.AI.Projects.ThreadRun * seq<Azure.AI.Projects.ToolOutput> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.ThreadRun>>

Public Overridable Function SubmitToolOutputsToRunAsync (run As ThreadRun, toolOutputs As IEnumerable(Of ToolOutput), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ThreadRun))

Parameters

run

ThreadRun

The ThreadRun that the tool outputs should be submitted to.

toolOutputs

IEnumerable<ToolOutput>

The list of tool call outputs to provide as part of an output submission to an agent thread run.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<ThreadRun>>

Exceptions

ArgumentNullException

run is null.

SubmitToolOutputsToRunAsync(String, String, RequestContent, RequestContext)

Source:

AgentsClient.cs

[Protocol Method] Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler SubmitToolOutputsToRunAsync(String, String, IEnumerable<ToolOutput>, Nullable<Boolean>, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> SubmitToolOutputsToRunAsync (string threadId, string runId, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member SubmitToolOutputsToRunAsync : string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.SubmitToolOutputsToRunAsync : string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function SubmitToolOutputsToRunAsync (threadId As String, runId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

threadId

String

Identifier of the thread.

runId

String

Identifier of the run.

content

RequestContent

The content to send as the body of the request.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

threadId, runId or content is null.

ArgumentException

threadId or runId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

SubmitToolOutputsToRunAsync(String, String, IEnumerable<ToolOutput>, Nullable<Boolean>, CancellationToken)

Source:

AgentsClient.cs

Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.ThreadRun>> SubmitToolOutputsToRunAsync (string threadId, string runId, System.Collections.Generic.IEnumerable<Azure.AI.Projects.ToolOutput> toolOutputs, bool? stream = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SubmitToolOutputsToRunAsync : string * string * seq<Azure.AI.Projects.ToolOutput> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.ThreadRun>>
override this.SubmitToolOutputsToRunAsync : string * string * seq<Azure.AI.Projects.ToolOutput> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.ThreadRun>>

Public Overridable Function SubmitToolOutputsToRunAsync (threadId As String, runId As String, toolOutputs As IEnumerable(Of ToolOutput), Optional stream As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ThreadRun))

Parameters

threadId

String

Identifier of the thread.

runId

String

Identifier of the run.

toolOutputs

IEnumerable<ToolOutput>

A list of tools for which the outputs are being submitted.

stream

Nullable<Boolean>

If true, returns a stream of events that happen during the Run as server-sent events, terminating when the run enters a terminal state.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<ThreadRun>>

Exceptions

ArgumentNullException

threadId, runId or toolOutputs is null.

ArgumentException

threadId or runId is an empty string, and was expected to be non-empty.