# EvalSuite

> Tracon documentation. Tracon is a .NET package family that adds a control
> plane on Microsoft Agent Framework, published as NuGet packages that run
> inside your own ASP.NET Core application.
>
> Page: https://tracon.dev/api/tracon.evalsuite/
> Summary: EvalSuite: An evaluation (eval) suite defined for an agent: carries which agent is measured, with which checks.

<div class="api-provenance">Namespace Tracon · Assembly <code>Tracon.Abstractions.dll</code></div>

An evaluation (eval) suite defined for an agent: carries which agent is
measured, with which checks.

```csharp
public sealed record EvalSuite : IEquatable<EvalSuite>
```

<dl class="api-relations"><dt>Inheritance</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ← <a href="/api/tracon.evalsuite/">EvalSuite</a></dd><dt>Implements</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable&lt;EvalSuite&gt;</a></dd><dt>Inherited Members</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a></dd></dl>

## Remarks

`Checks` is declarative: it runs no free-form code, it is
only a JSON array that `EvalCheckFactory` maps to recognized kind
names. A custom check is registered on the code side with `AddEvalCheck`.

## Constructors

### <a id="Tracon_EvalSuite__ctor"></a> EvalSuite\(\)

```csharp
public EvalSuite()
```

## Properties

### <a id="Tracon_EvalSuite_AgentName"></a> AgentName

The name of the agent this suite measures.

```csharp
public required string AgentName { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="Tracon_EvalSuite_Checks"></a> Checks

The check definitions. Example: `[{"kind":"nonEmpty","minLength":10}]`.

```csharp
public JsonElement Checks { get; init; }
```

#### Property Value

 [JsonElement](https://learn.microsoft.com/dotnet/api/system.text.json.jsonelement)

#### Remarks

An unset value is stored as the empty JSON array, never as
`JsonValueKind.Undefined` - see [Tracon.FreeFormJson](/api/tracon/).

### <a id="Tracon_EvalSuite_CreatedAt"></a> CreatedAt

The creation time (UTC).

```csharp
public DateTimeOffset CreatedAt { get; init; }
```

#### Property Value

 [DateTimeOffset](https://learn.microsoft.com/dotnet/api/system.datetimeoffset)

### <a id="Tracon_EvalSuite_Description"></a> Description

A short description.

```csharp
public string? Description { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)?

### <a id="Tracon_EvalSuite_Id"></a> Id

The suite identifier.

```csharp
public Guid Id { get; init; }
```

#### Property Value

 [Guid](https://learn.microsoft.com/dotnet/api/system.guid)

### <a id="Tracon_EvalSuite_Name"></a> Name

The suite name. Unique within the tenant.

```csharp
public required string Name { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="Tracon_EvalSuite_TenantId"></a> TenantId

The tenant the suite belongs to.

```csharp
public required string TenantId { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="Tracon_EvalSuite_UpdatedAt"></a> UpdatedAt

The last-updated time (UTC).

```csharp
public DateTimeOffset UpdatedAt { get; init; }
```

#### Property Value

 [DateTimeOffset](https://learn.microsoft.com/dotnet/api/system.datetimeoffset)

## Methods

### <a id="Tracon_EvalSuite_Equals_System_Object_"></a> Equals\(object?\)

```csharp
public override bool Equals(object? obj)
```

#### Parameters

`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_EvalSuite_Equals_Tracon_EvalSuite_"></a> Equals\(EvalSuite?\)

```csharp
public bool Equals(EvalSuite? other)
```

#### Parameters

`other` [EvalSuite](/api/tracon.evalsuite/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_EvalSuite_GetHashCode"></a> GetHashCode\(\)

```csharp
public override int GetHashCode()
```

#### Returns

 [int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="Tracon_EvalSuite_ToString"></a> ToString\(\)

```csharp
public override string ToString()
```

#### Returns

 [string](https://learn.microsoft.com/dotnet/api/system.string)

## Operators

### <a id="Tracon_EvalSuite_op_Equality_Tracon_EvalSuite_Tracon_EvalSuite_"></a> operator ==\(EvalSuite?, EvalSuite?\)

```csharp
public static bool operator ==(EvalSuite? left, EvalSuite? right)
```

#### Parameters

`left` [EvalSuite](/api/tracon.evalsuite/)?

`right` [EvalSuite](/api/tracon.evalsuite/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_EvalSuite_op_Inequality_Tracon_EvalSuite_Tracon_EvalSuite_"></a> operator \!=\(EvalSuite?, EvalSuite?\)

```csharp
public static bool operator !=(EvalSuite? left, EvalSuite? right)
```

#### Parameters

`left` [EvalSuite](/api/tracon.evalsuite/)?

`right` [EvalSuite](/api/tracon.evalsuite/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)