AgentInvocationsApiRoutineAction Class

Definition

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

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

Constructors

Name Description
AgentInvocationsApiRoutineAction()

Initializes a new instance of AgentInvocationsApiRoutineAction.

Properties

Name Description
AgentEndpointId

Legacy endpoint-scoped agent identifier for routine dispatch.

AgentName

The project-scoped agent name for routine 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" }.

SessionId

An optional existing hosted-agent session identifier to continue during the downstream dispatch.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<AgentInvocationsApiRoutineAction>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<AgentInvocationsApiRoutineAction>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<RoutineAction>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from RoutineAction)
IJsonModel<RoutineAction>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from RoutineAction)
IPersistableModel<AgentInvocationsApiRoutineAction>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<AgentInvocationsApiRoutineAction>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<AgentInvocationsApiRoutineAction>.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