AgentOptimizationCostEstimate Class

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

Implements

public final class AgentOptimizationCostEstimate
implements JsonSerializable<AgentOptimizationCostEstimate>

Estimated monetary cost. Present only when at least one contributing model has pricing data.

Method Summary

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

Reads an instance of AgentOptimizationCostEstimate from the JsonReader.

AgentOptimizationStageEstimate getByStage()

Get the byStage property: Estimated cost grouped by optimization stage.

String getCurrency()

Get the currency property: ISO 4217 currency code for all monetary values in this estimate.

AgentOptimizationEstimateBand getTotal()

Get the total property: Total estimated cost across all priced stages.

List<AgentOptimizationStage> getUnpricedStages()

Get the unpricedStages property: Stages excluded from the total because pricing was unavailable.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Method Details

fromJson

public static AgentOptimizationCostEstimate fromJson(JsonReader jsonReader)

Reads an instance of AgentOptimizationCostEstimate from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getByStage

public AgentOptimizationStageEstimate getByStage()

Get the byStage property: Estimated cost grouped by optimization stage.

Returns:

the byStage value.

getCurrency

public String getCurrency()

Get the currency property: ISO 4217 currency code for all monetary values in this estimate.

Returns:

the currency value.

getTotal

public AgentOptimizationEstimateBand getTotal()

Get the total property: Total estimated cost across all priced stages.

Returns:

the total value.

getUnpricedStages

public List<AgentOptimizationStage> getUnpricedStages()

Get the unpricedStages property: Stages excluded from the total because pricing was unavailable.

Returns:

the unpricedStages value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to