ExternalAgentDefinition interface

Package:

@azure/ai-projects

The external agent definition. Represents a third-party agent hosted outside Foundry (for example, on GCP or AWS). Registration is metadata-only: Foundry records the agent definition to light up observability experiences (traces, evaluations) over customer-emitted OpenTelemetry data.

Extends

AgentDefinition

Properties

kind

The kind of agent.

otel_agent_id

The OpenTelemetry agent identifier used to attribute customer-emitted spans to this Foundry agent. Spans must include the attribute gen_ai.agent.id = <otel_agent_id> to appear under this registration. Defaults to the top-level agent name when omitted. Provide an explicit value only for migration scenarios where the running external agent already emits a stable id that differs from the Foundry agent name. The resolved value is always echoed on read.

Inherited Properties

rai_config

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

Property Details

kind

The kind of agent.

kind: "external"

Property Value

"external"

otel_agent_id

The OpenTelemetry agent identifier used to attribute customer-emitted spans to this Foundry agent. Spans must include the attribute gen_ai.agent.id = <otel_agent_id> to appear under this registration. Defaults to the top-level agent name when omitted. Provide an explicit value only for migration scenarios where the running external agent already emits a stable id that differs from the Foundry agent name. The resolved value is always echoed on read.

otel_agent_id?: string

Property Value

string

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