InvokeAgentResponsesApiRoutineAction Class

Definition

Dispatches a routine through the responses API. Exactly one of agent_name or agent_endpoint_id must be provided.

public class InvokeAgentResponsesApiRoutineAction : Azure.AI.Projects.RoutineAction, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.InvokeAgentResponsesApiRoutineAction>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.InvokeAgentResponsesApiRoutineAction>
type InvokeAgentResponsesApiRoutineAction = class
    inherit RoutineAction
    interface IJsonModel<InvokeAgentResponsesApiRoutineAction>
    interface IPersistableModel<InvokeAgentResponsesApiRoutineAction>
Public Class InvokeAgentResponsesApiRoutineAction
Inherits RoutineAction
Implements IJsonModel(Of InvokeAgentResponsesApiRoutineAction), IPersistableModel(Of InvokeAgentResponsesApiRoutineAction)
Inheritance
InvokeAgentResponsesApiRoutineAction
Implements

Constructors

Name Description
InvokeAgentResponsesApiRoutineAction()

Initializes a new instance of InvokeAgentResponsesApiRoutineAction.

Properties

Name Description
AgentEndpointId

Legacy endpoint-scoped agent identifier for routine dispatch.

AgentName

The project-scoped agent name for routine dispatch.

Conversation

An optional existing conversation identifier to continue during the downstream dispatch.

Input

Static JSON value sent as the complete downstream input when the routine fires. The value is passed through as-is; no templating is applied.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<InvokeAgentResponsesApiRoutineAction>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<InvokeAgentResponsesApiRoutineAction>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<RoutineAction>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from RoutineAction)
IJsonModel<RoutineAction>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from RoutineAction)
IPersistableModel<InvokeAgentResponsesApiRoutineAction>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<InvokeAgentResponsesApiRoutineAction>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<InvokeAgentResponsesApiRoutineAction>.Write(ModelReaderWriterOptions)
IPersistableModel<RoutineAction>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from RoutineAction)
IPersistableModel<RoutineAction>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from RoutineAction)
IPersistableModel<RoutineAction>.Write(ModelReaderWriterOptions) (Inherited from RoutineAction)

Applies to