# AgentEntityInfo

- Kind: `record`
- Package: [Aspire.Hosting.AgentFramework.DevUI](/reference/api/csharp/aspire.hosting.agentframework.devui.md)
- Version: `1.8.0-preview.260528.1`
- Namespace: `Aspire.Hosting.AgentFramework`
- Target framework: `net10.0`
- Source: [GitHub](https://github.com/microsoft/agent-framework/tree/e9a606344adbe5e41d9376b1f8508da593ea6c3b)
- Implements: `IEquatable<AgentEntityInfo>`

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

## Definition

```csharp
namespace Aspire.Hosting.AgentFramework;

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

## Remarks

When added via [AgentFrameworkBuilderExtensions.WithAgentService(IResourceBuilder<DevUIResource>, IResourceBuilder<TSource>, IReadOnlyList<AgentEntityInfo>, string?)](/reference/api/csharp/aspire.hosting.agentframework.devui/agentframeworkbuilderextensions/methods.md#withagentservice-iresourcebuilder-devuiresource-iresourcebuilder-tsource-ireadonlylist-agententityinfo-string), 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.

## Constructors

- [AgentEntityInfo(string, string?)](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/constructors.md#constructor-string-string) -- Describes an AI agent exposed by an agent service backend, used for entity discovery in DevUI.

## Properties

- [Description](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/properties.md#description) : `string?` `get; init` -- A short description of the agent's capabilities.
- [Framework](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/properties.md#framework) : `string` `get; init` -- Gets the framework identifier. Defaults to `"agent_framework"`.
- [Id](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/properties.md#id) : `string` `get; init` -- The unique identifier for the agent, typically matching the name passed to `AddAIAgent`.
- [Name](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/properties.md#name) : `string` `get; init` -- Gets the display name for the agent. Defaults to [AgentEntityInfo.Id](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/properties.md#id) if not specified.
- [Type](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/properties.md#type) : `string` `get; init` -- Gets the entity type. Defaults to `"agent"`.

## Methods

- [<Clone>$](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/methods.md#clone) : [AgentEntityInfo](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo.md) `virtual`
- [Deconstruct(string, string?)](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/methods.md#deconstruct-string-string)
- [Equals(object?)](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/methods.md#equals-object) : `bool` -- Determines whether the specified object is equal to the current object.
- [Equals(AgentEntityInfo?)](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/methods.md#equals-agententityinfo) : `bool` `virtual` -- Indicates whether the current object is equal to another object of the same type.
- [GetHashCode](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/methods.md#gethashcode) : `int` -- Serves as the default hash function.
- [op_Equality(AgentEntityInfo?, AgentEntityInfo?)](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/methods.md#op-equality-agententityinfo-agententityinfo) : `bool` `static`
- [op_Inequality(AgentEntityInfo?, AgentEntityInfo?)](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/methods.md#op-inequality-agententityinfo-agententityinfo) : `bool` `static`
- [ToString](/reference/api/csharp/aspire.hosting.agentframework.devui/agententityinfo/methods.md#tostring) : `string` -- Returns a string that represents the current object.