RequiredActionUpdate Class

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Source:

RequiredActionUpdate.cs

The update type presented when the status of a ThreadRun has changed to requires_action, indicating that tool output submission or another intervention is needed for the run to continue.

public class RequiredActionUpdate : Azure.AI.Projects.RunUpdate

type RequiredActionUpdate = class
    inherit RunUpdate

Public Class RequiredActionUpdate
Inherits RunUpdate

Inheritance

Object

StreamingUpdate

StreamingUpdate<ThreadRun>

RunUpdate

RequiredActionUpdate

Remarks

Distinct RequiredActionUpdate instances will generated for each required action, meaning that parallel function calling will present multiple updates even if the tool calls arrive at the same time.

Properties

FunctionArguments	The arguments to use when invoking the named function, as provided by the model. Arguments are presented as a JSON document that should be validated and parsed for evaluation.
FunctionName	The name of the function.
ToolCallId
UpdateKind	A value indicating what type of event this update represents. (Inherited from StreamingUpdate)
Value	The underlying response value received with the streaming event. (Inherited from StreamingUpdate<T>)

Methods

GetThreadRun()

Gets the full, deserialized ThreadRun instance associated with this streaming required action update.