AgentResponsesApiDispatchPayload Class

Definition

A manual payload used to test a responses API routine dispatch.

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

Constructors

Name Description
AgentResponsesApiDispatchPayload(BinaryData)

Initializes a new instance of AgentResponsesApiDispatchPayload.

Properties

Name Description
Input

The JSON value sent as the complete downstream responses input. The value is passed through as-is and can be an object, string, number, boolean, array, or null.

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<AgentResponsesApiDispatchPayload>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<AgentResponsesApiDispatchPayload>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<RoutineDispatchPayload>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from RoutineDispatchPayload)
IJsonModel<RoutineDispatchPayload>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from RoutineDispatchPayload)
IPersistableModel<AgentResponsesApiDispatchPayload>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<AgentResponsesApiDispatchPayload>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<AgentResponsesApiDispatchPayload>.Write(ModelReaderWriterOptions)
IPersistableModel<RoutineDispatchPayload>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from RoutineDispatchPayload)
IPersistableModel<RoutineDispatchPayload>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from RoutineDispatchPayload)
IPersistableModel<RoutineDispatchPayload>.Write(ModelReaderWriterOptions) (Inherited from RoutineDispatchPayload)

Applies to