Share via


HostedAgentDefinition Class

Definition

The hosted agent definition.

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

Constructors

Name Description
HostedAgentDefinition(IEnumerable<ProtocolVersionRecord>, String, String)

Initializes a new instance of HostedAgentDefinition.

HostedAgentDefinition(String, String)

Initializes a new instance of HostedAgentDefinition.

Properties

Name Description
CodeConfiguration

Code-based deployment configuration. Provide this for code-based deployments. Mutually exclusive with container_configuration — the service validates that exactly one is set.

ContainerConfiguration

Container-based deployment configuration. Provide this for image-based deployments. Mutually exclusive with code_configuration — the service validates that exactly one is set.

ContentFilterConfiguration

Configuration for Responsible AI (RAI) content filtering and safety features.

(Inherited from ProjectsAgentDefinition)
Cpu

The CPU configuration for the hosted agent.

EnvironmentVariables

Environment variables to set in the hosted agent container.

Image

The image ID for the agent, applicable to image-based hosted agents.

Memory

The memory configuration for the hosted agent.

ProtocolVersions

The protocols that the agent supports for ingress communication.

TelemetryConfig

Optional customer-supplied telemetry configuration for exporting container logs, traces, and metrics.

Tools

An array of tools the hosted agent's model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.

Versions

The protocols that the agent supports for ingress communication of the containers.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<HostedAgentDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<HostedAgentDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<ProjectsAgentDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ProjectsAgentDefinition)
IJsonModel<ProjectsAgentDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ProjectsAgentDefinition)
IPersistableModel<HostedAgentDefinition>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<HostedAgentDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<HostedAgentDefinition>.Write(ModelReaderWriterOptions)
IPersistableModel<ProjectsAgentDefinition>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from ProjectsAgentDefinition)
IPersistableModel<ProjectsAgentDefinition>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from ProjectsAgentDefinition)
IPersistableModel<ProjectsAgentDefinition>.Write(ModelReaderWriterOptions) (Inherited from ProjectsAgentDefinition)

Applies to