AgentEntityInfo

Record net10.0

📦 Aspire.Hosting.AgentFramework.DevUI v1.8.0-preview.260528.1

Describes an AI agent exposed by an agent service backend, used for entity discovery in DevUI.

namespace Aspire.Hosting.AgentFramework;

public record AgentEntityInfo
    : System.IEquatable<Aspire.Hosting.AgentFramework.AgentEntityInfo>
{
    // ...
}

IEquatable<AgentEntityInfo>

14 members

Remarks

When added via AgentFrameworkBuilderExtensions.WithAgentService, agent metadata is declared at the AppHost level so that the DevUI aggregator can build the entity listing without querying each backend's /v1/entities endpoint.

Agent services only need to expose the standard OpenAI Responses and Conversations API endpoints ( MapOpenAIResponses and MapOpenAIConversations), not a custom discovery endpoint.

Constructors1

AgentEntityInfo(string, string?)

Describes an AI agent exposed by an agent service backend, used for entity discovery in DevUI.

View all constructors

Properties5

Descriptionget; init

string?

A short description of the agent's capabilities.

Frameworkget; init

string

Gets the framework identifier. Defaults to "agent_framework".

Idget; init

string

The unique identifier for the agent, typically matching the name passed to AddAIAgent.

Nameget; init

string

Gets the display name for the agent. Defaults to AgentEntityInfo.Id if not specified.

Typeget; init

string

Gets the entity type. Defaults to "agent".

View all properties

Methods8

<Clone>$virtual

AgentEntityInfo

Deconstruct(string, string?)

Equals(object?)

bool

Determines whether the specified object is equal to the current object.

Equals(AgentEntityInfo?)virtual

bool

Indicates whether the current object is equal to another object of the same type.

GetHashCode

int

Serves as the default hash function.

op_Equality(AgentEntityInfo?, AgentEntityInfo?)static

bool

op_Inequality(AgentEntityInfo?, AgentEntityInfo?)static

bool

ToString

string

Returns a string that represents the current object.

View all methods