ProjectsAgentsModelFactory.ExternalAgentDefinition Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
public static Azure.AI.Projects.Agents.ExternalAgentDefinition ExternalAgentDefinition(Azure.AI.Projects.Agents.ContentFilterConfiguration contentFilterConfiguration = default, string otelAgentId = default);static member ExternalAgentDefinition : Azure.AI.Projects.Agents.ContentFilterConfiguration * string -> Azure.AI.Projects.Agents.ExternalAgentDefinitionPublic Shared Function ExternalAgentDefinition (Optional contentFilterConfiguration As ContentFilterConfiguration = Nothing, Optional otelAgentId As String = Nothing) As ExternalAgentDefinitionParameters
- contentFilterConfiguration
- ContentFilterConfiguration
Configuration for Responsible AI (RAI) content filtering and safety features.
- otelAgentId
- String
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.
Returns
A new ExternalAgentDefinition instance for mocking.
