AzureCreateResponseOptions Class

  • java.lang.Object
    • com.azure.ai.agents.models.AzureCreateResponseOptions

Implements

public final class AzureCreateResponseOptions
implements JsonSerializable<AzureCreateResponseOptions>

Azure specific fields used in the creation of "Response" object (i.e. "AgentReference").

Constructor Summary

Constructor Description
AzureCreateResponseOptions()

Creates an instance of AzureCreateResponseOptions class.

Method Summary

Modifier and Type Method and Description
static AzureCreateResponseOptions fromJson(JsonReader jsonReader)

Reads an instance of AzureCreateResponseOptions from the JsonReader.

AgentReference getAgentReference()

Get the agentReference property: The agent to use for generating the response.

RoutingConfiguration getRoutingConfig()

Get the routingConfig property: Per-request configuration for Model Router inference calls.

Map<String,BinaryData> getStructuredInputs()

Get the structuredInputs property: The structured inputs to the response that can participate in prompt template substitution or tool argument bindings.

AzureUserSecurityContext getUserSecurityContext()

Get the userSecurityContext property: User security context contains several parameters that describe the application itself, and the end user that interacts with the application.

AzureCreateResponseOptions setAgentReference(AgentReference agentReference)

Set the agentReference property: The agent to use for generating the response.

AzureCreateResponseOptions setRoutingConfig(RoutingConfiguration routingConfig)

Set the routingConfig property: Per-request configuration for Model Router inference calls.

AzureCreateResponseOptions setStructuredInputs(Map<String,BinaryData> structuredInputs)

Set the structuredInputs property: The structured inputs to the response that can participate in prompt template substitution or tool argument bindings.

AzureCreateResponseOptions setUserSecurityContext(AzureUserSecurityContext userSecurityContext)

Set the userSecurityContext property: User security context contains several parameters that describe the application itself, and the end user that interacts with the application.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Constructor Details

AzureCreateResponseOptions

public AzureCreateResponseOptions()

Creates an instance of AzureCreateResponseOptions class.

Method Details

fromJson

public static AzureCreateResponseOptions fromJson(JsonReader jsonReader)

Reads an instance of AzureCreateResponseOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AzureCreateResponseOptions if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the AzureCreateResponseOptions.

getAgentReference

public AgentReference getAgentReference()

Get the agentReference property: The agent to use for generating the response.

Returns:

the agentReference value.

getRoutingConfig

public RoutingConfiguration getRoutingConfig()

Get the routingConfig property: Per-request configuration for Model Router inference calls. Supported on Model Router endpoints (deployed or instant if supported). Returns a 400 (Bad Request) error when the target is not a Model Router endpoint.

Returns:

the routingConfig value.

getStructuredInputs

public Map<String,BinaryData> getStructuredInputs()

Get the structuredInputs property: The structured inputs to the response that can participate in prompt template substitution or tool argument bindings.

Returns:

the structuredInputs value.

getUserSecurityContext

public AzureUserSecurityContext getUserSecurityContext()

Get the userSecurityContext property: User security context contains several parameters that describe the application itself, and the end user that interacts with the application. These fields assist your security operations teams to investigate and mitigate security incidents by providing a comprehensive approach to protecting your AI applications. [Learn more](https://aka.ms/TP4AI/Documentation/EndUserContext) about protecting AI applications using Microsoft Defender for Cloud.

Returns:

the userSecurityContext value.

setAgentReference

public AzureCreateResponseOptions setAgentReference(AgentReference agentReference)

Set the agentReference property: The agent to use for generating the response.

Parameters:

agentReference - the agentReference value to set.

Returns:

the AzureCreateResponseOptions object itself.

setRoutingConfig

public AzureCreateResponseOptions setRoutingConfig(RoutingConfiguration routingConfig)

Set the routingConfig property: Per-request configuration for Model Router inference calls. Supported on Model Router endpoints (deployed or instant if supported). Returns a 400 (Bad Request) error when the target is not a Model Router endpoint.

Parameters:

routingConfig - the routingConfig value to set.

Returns:

the AzureCreateResponseOptions object itself.

setStructuredInputs

public AzureCreateResponseOptions setStructuredInputs(Map<String,BinaryData> structuredInputs)

Set the structuredInputs property: The structured inputs to the response that can participate in prompt template substitution or tool argument bindings.

Parameters:

structuredInputs - the structuredInputs value to set.

Returns:

the AzureCreateResponseOptions object itself.

setUserSecurityContext

public AzureCreateResponseOptions setUserSecurityContext(AzureUserSecurityContext userSecurityContext)

Set the userSecurityContext property: User security context contains several parameters that describe the application itself, and the end user that interacts with the application. These fields assist your security operations teams to investigate and mitigate security incidents by providing a comprehensive approach to protecting your AI applications. [Learn more](https://aka.ms/TP4AI/Documentation/EndUserContext) about protecting AI applications using Microsoft Defender for Cloud.

Parameters:

userSecurityContext - the userSecurityContext value to set.

Returns:

the AzureCreateResponseOptions object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to