AssistantsClient.SubmitToolOutputsToRun Method

Definition

Namespace:

Azure.AI.OpenAI.Assistants

Assembly:

Azure.AI.OpenAI.Assistants.dll

Package:

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

Overloads

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'.
SubmitToolOutputsToRun(String, String, IEnumerable<ToolOutput>, 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'.

SubmitToolOutputsToRun(ThreadRun, IEnumerable<ToolOutput>, CancellationToken)

Source:

AssistantsClient.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 Azure.Response<Azure.AI.OpenAI.Assistants.ThreadRun> SubmitToolOutputsToRun (Azure.AI.OpenAI.Assistants.ThreadRun run, System.Collections.Generic.IEnumerable<Azure.AI.OpenAI.Assistants.ToolOutput> toolOutputs, System.Threading.CancellationToken cancellationToken = default);

abstract member SubmitToolOutputsToRun : Azure.AI.OpenAI.Assistants.ThreadRun * seq<Azure.AI.OpenAI.Assistants.ToolOutput> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.OpenAI.Assistants.ThreadRun>
override this.SubmitToolOutputsToRun : Azure.AI.OpenAI.Assistants.ThreadRun * seq<Azure.AI.OpenAI.Assistants.ToolOutput> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.OpenAI.Assistants.ThreadRun>

Public Overridable Function SubmitToolOutputsToRun (run As ThreadRun, toolOutputs As IEnumerable(Of ToolOutput), Optional cancellationToken As CancellationToken = Nothing) As 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 assistant thread run.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<ThreadRun>

Exceptions

ArgumentNullException

run is null.

SubmitToolOutputsToRun(String, String, IEnumerable<ToolOutput>, CancellationToken)

Source:

AssistantsClient.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 Azure.Response<Azure.AI.OpenAI.Assistants.ThreadRun> SubmitToolOutputsToRun (string threadId, string runId, System.Collections.Generic.IEnumerable<Azure.AI.OpenAI.Assistants.ToolOutput> toolOutputs, System.Threading.CancellationToken cancellationToken = default);

abstract member SubmitToolOutputsToRun : string * string * seq<Azure.AI.OpenAI.Assistants.ToolOutput> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.OpenAI.Assistants.ThreadRun>
override this.SubmitToolOutputsToRun : string * string * seq<Azure.AI.OpenAI.Assistants.ToolOutput> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.OpenAI.Assistants.ThreadRun>

Public Overridable Function SubmitToolOutputsToRun (threadId As String, runId As String, toolOutputs As IEnumerable(Of ToolOutput), Optional cancellationToken As CancellationToken = Nothing) As Response(Of ThreadRun)

Parameters

threadId

String

The ID of the thread that was run.

runId

String

The ID of the run that requires tool outputs.

toolOutputs

IEnumerable<ToolOutput>

The list of tool outputs requested by tool calls from the specified run.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

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.