OptimizationAgentDefinition Class

Definition

Agent definition returned in response payloads (includes resolved config).

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

Properties

Name Description
AgentName

Agent name.

AgentVersion

Agent version.

Model

Model deployment name.

Skills

Agent skills.

To assign an object to the element of 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" }.

SystemPrompt

System prompt / instructions.

Tools

Agent tools.

To assign an object to the element of 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<OptimizationAgentDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<OptimizationAgentDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<OptimizationAgentDefinition>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<OptimizationAgentDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<OptimizationAgentDefinition>.Write(ModelReaderWriterOptions)

Applies to