CandidateDeployConfig Class

Definition

Namespace:
Azure.AI.Projects.Agents
Assembly:
Azure.AI.Projects.Agents.dll
Package:
Azure.AI.Projects.Agents v2.1.0-beta.3
Source:
CandidateDeployConfig.cs

Deploy-config blob for a candidate. Suitable for setting OPTIMIZATION_CONFIG on a hosted-agent version.

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

Properties

Name Description
Instructions

System prompt / instructions.
Model

Foundry deployment name.
Skills

Optional skill overrides.

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" }.

Temperature

Optional sampling temperature.
Tools

Optional tool overrides.

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)

Operators

Name Description
Explicit(ClientResult to CandidateDeployConfig)

Explicit Interface Implementations

Name Description
IJsonModel<CandidateDeployConfig>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<CandidateDeployConfig>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<CandidateDeployConfig>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<CandidateDeployConfig>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<CandidateDeployConfig>.Write(ModelReaderWriterOptions)

Applies to