HostedAgentDefinition interface

Package:

@azure/ai-projects

The hosted agent definition.

Extends

AgentDefinition

Properties

code_configuration	Code-based deployment configuration. Provide this for code-based deployments. Mutually exclusive with container_configuration — the service validates that exactly one is set.
container_configuration	Container-based deployment configuration. Provide this for image-based deployments. Mutually exclusive with code_configuration — the service validates that exactly one is set.
cpu	The CPU configuration for the hosted agent.
environment_variables	Environment variables to set in the hosted agent container.
kind	The kind of agent definition. Always hosted for an agent deployed to the hosted runtime.
memory	The memory configuration for the hosted agent.
protocol_versions	The protocols that the agent supports for ingress communication.
session_configuration	Optional session defaults (for example, the idle timeout) applied to sessions created for this agent version.
telemetry_config	Optional customer-supplied telemetry configuration for exporting container logs, traces, and metrics.

Inherited Properties

rai_config

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

Property Details

code_configuration

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

code_configuration?: CodeConfiguration

Property Value

CodeConfiguration

container_configuration

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

container_configuration?: ContainerConfiguration

Property Value

ContainerConfiguration

cpu

The CPU configuration for the hosted agent.

cpu: string

Property Value

string

environment_variables

Environment variables to set in the hosted agent container.

environment_variables?: Record<string, string>

Property Value

Record<string, string>

kind

The kind of agent definition. Always hosted for an agent deployed to the hosted runtime.

kind: "hosted"

Property Value

"hosted"

memory

The memory configuration for the hosted agent.

memory: string

Property Value

string

protocol_versions

The protocols that the agent supports for ingress communication.

protocol_versions?: ProtocolVersionRecord[]

Property Value

ProtocolVersionRecord[]

session_configuration

Optional session defaults (for example, the idle timeout) applied to sessions created for this agent version.

session_configuration?: SessionConfiguration

Property Value

SessionConfiguration

telemetry_config

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

telemetry_config?: TelemetryConfig

Property Value

TelemetryConfig

Inherited Property Details

rai_config

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

rai_config?: RaiConfig

Property Value

RaiConfig

Inherited From AgentDefinition.rai_config