AgentOptimizationJob Class
- java.
lang. Object - com.
azure. ai. agents. models. AgentOptimizationJob
- com.
Implements
public final class AgentOptimizationJob
implements JsonSerializable<AgentOptimizationJob>
Agent optimization job resource — a long-running job that produces candidate changes to a Foundry agent configuration.
Constructor Summary
| Constructor | Description |
|---|---|
| AgentOptimizationJob(AgentOptimizationModelConfiguration optimizationModelConfiguration, AgentOptimizationConfigurationBase optimizationConfiguration) |
Creates an instance of Agent |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
static
Agent |
fromJson(JsonReader jsonReader)
Reads an instance of Agent |
|
Offset |
getCreatedAt()
Get the created |
| String |
getDisplayName()
Get the display |
|
Api |
getError()
Get the error property: Error details — populated only on failure. |
| String |
getId()
Get the id property: Server-assigned unique identifier. |
|
Agent |
getOptimizationConfiguration()
Get the optimization |
|
Agent |
getOptimizationModelConfiguration()
Get the optimization |
|
Agent |
getResult()
Get the result property: Result produced on success. |
| Duration |
getRunDuration()
Get the run |
|
Job |
getStatus()
Get the status property: Current lifecycle status. |
|
Agent |
getTargetConfiguration()
Get the target |
|
Offset |
getUpdatedAt()
Get the updated |
| List<String> |
getWarnings()
Get the warnings property: Non-fatal warnings emitted during optimization. |
|
Agent |
setDisplayName(String displayName)
Set the display |
|
Agent |
setTargetConfiguration(AgentOptimizationTargetConfiguration targetConfiguration)
Set the target |
|
Json |
toJson(JsonWriter jsonWriter) |
Methods inherited from java.lang.Object
Constructor Details
AgentOptimizationJob
public AgentOptimizationJob(AgentOptimizationModelConfiguration optimizationModelConfiguration, AgentOptimizationConfigurationBase optimizationConfiguration)
Creates an instance of AgentOptimizationJob class.
Parameters:
Method Details
fromJson
public static AgentOptimizationJob fromJson(JsonReader jsonReader)
Reads an instance of AgentOptimizationJob from the JsonReader.
Parameters:
Returns:
Throws:
getCreatedAt
public OffsetDateTime getCreatedAt()
Get the createdAt property: The timestamp when the job was created, represented in Unix time.
Returns:
getDisplayName
public String getDisplayName()
Get the displayName property: Human-readable label. Omitted when no label is needed; it has no uniqueness, routing, or idempotency semantics.
Returns:
getError
public ApiError getError()
Get the error property: Error details — populated only on failure.
Returns:
getId
public String getId()
Get the id property: Server-assigned unique identifier.
Returns:
getOptimizationConfiguration
public AgentOptimizationConfigurationBase getOptimizationConfiguration()
Get the optimizationConfiguration property: Type-specific optimization configuration.
Returns:
getOptimizationModelConfiguration
public AgentOptimizationModelConfiguration getOptimizationModelConfiguration()
Get the optimizationModelConfiguration property: Model used to generate candidate changes. An existing deployment name is also accepted.
Returns:
getResult
public AgentOptimizationJobResult getResult()
Get the result property: Result produced on success.
Returns:
getRunDuration
public Duration getRunDuration()
Get the runDuration property: Duration for which the job has been running, in milliseconds.
Returns:
getStatus
public JobStatus getStatus()
Get the status property: Current lifecycle status.
Returns:
getTargetConfiguration
public AgentOptimizationTargetConfiguration getTargetConfiguration()
Get the targetConfiguration property: Foundry agent whose configuration is optimized. Omitted when the workflow does not target a registered Foundry agent.
Returns:
getUpdatedAt
public OffsetDateTime getUpdatedAt()
Get the updatedAt property: The timestamp when the job was last updated, represented in Unix time.
Returns:
getWarnings
public List<String> getWarnings()
Get the warnings property: Non-fatal warnings emitted during optimization. Omitted when no warnings were produced.
Returns:
setDisplayName
public AgentOptimizationJob setDisplayName(String displayName)
Set the displayName property: Human-readable label. Omitted when no label is needed; it has no uniqueness, routing, or idempotency semantics.
Parameters:
Returns:
setTargetConfiguration
public AgentOptimizationJob setTargetConfiguration(AgentOptimizationTargetConfiguration targetConfiguration)
Set the targetConfiguration property: Foundry agent whose configuration is optimized. Omitted when the workflow does not target a registered Foundry agent.
Parameters:
Returns: