# TraconHealthOptions

> 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.traconhealthoptions/
> Summary: TraconHealthOptions: Defines model-provider health-check options.

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

Defines model-provider health-check options.

```csharp
public sealed class TraconHealthOptions
```

<dl class="api-relations"><dt>Inheritance</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ← <a href="/api/tracon.traconhealthoptions/">TraconHealthOptions</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

The check calls `GET {endpoint}/models` and does not incur cost. Results
are cached, so `/api/models/health` does not call a provider on every request.

## Constructors

### <a id="Tracon_TraconHealthOptions__ctor"></a> TraconHealthOptions\(\)

```csharp
public TraconHealthOptions()
```

## Properties

### <a id="Tracon_TraconHealthOptions_BackgroundInterval"></a> BackgroundInterval

Gets or sets the automatic background health-check interval. When
[null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null), the default, no background timer runs. The check
is triggered only from the UI's "check now" action or `/api/models/health`.

```csharp
public TimeSpan? BackgroundInterval { get; set; }
```

#### Property Value

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

#### Remarks

This is intentionally empty because regular requests from an idle
installation are an undesirable default.

### <a id="Tracon_TraconHealthOptions_CacheTtl"></a> CacheTtl

Gets or sets how long a health-check result remains fresh in cache.

```csharp
public TimeSpan CacheTtl { get; set; }
```

#### Property Value

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