ExternalAgentDefinition Class

Definition

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 class ExternalAgentDefinition : Azure.AI.Projects.Agents.ProjectsAgentDefinition, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.ExternalAgentDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.ExternalAgentDefinition>
type ExternalAgentDefinition = class
    inherit ProjectsAgentDefinition
    interface IJsonModel<ExternalAgentDefinition>
    interface IPersistableModel<ExternalAgentDefinition>
Public Class ExternalAgentDefinition
Inherits ProjectsAgentDefinition
Implements IJsonModel(Of ExternalAgentDefinition), IPersistableModel(Of ExternalAgentDefinition)
Inheritance
ExternalAgentDefinition
Implements

Constructors

Name Description
ExternalAgentDefinition()

Initializes a new instance of ExternalAgentDefinition.

Properties

Name Description
ContentFilterConfiguration

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

(Inherited from ProjectsAgentDefinition)
OtelAgentId

The OpenTelemetry agent identifier used to attribute customer-emitted spans to this Foundry agent. Spans must include the attribute gen_ai.agent.id = &lt;otel_agent_id&gt; 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.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<ExternalAgentDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ExternalAgentDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<ProjectsAgentDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ProjectsAgentDefinition)
IJsonModel<ProjectsAgentDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ProjectsAgentDefinition)
IPersistableModel<ExternalAgentDefinition>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ExternalAgentDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ExternalAgentDefinition>.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