# VoiceHealth

> 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.voicehealth/
> Summary: VoiceHealth: The voice provider's reachability status.

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

The voice provider's reachability status.

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

<dl class="api-relations"><dt>Inheritance</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ← <a href="/api/tracon.voicehealth/">VoiceHealth</a></dd><dt>Implements</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable&lt;VoiceHealth&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

`ModelProviderHealth` is deliberately not reused: a voice provider is
not an `IModelProvider` and must not appear in the
`/api/models/health` output. If the two sources were combined into
one list, the circuit breaker and model catalog would behave incorrectly.

## Constructors

### <a id="Tracon_VoiceHealth__ctor"></a> VoiceHealth\(\)

```csharp
public VoiceHealth()
```

## Properties

### <a id="Tracon_VoiceHealth_CheckedAt"></a> CheckedAt

The moment the check was performed (UTC).

```csharp
public required DateTimeOffset CheckedAt { get; init; }
```

#### Property Value

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

### <a id="Tracon_VoiceHealth_Detail"></a> Detail

The reason, if failed. The text carries neither an API key nor an address.

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

#### Property Value

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

### <a id="Tracon_VoiceHealth_IsHealthy"></a> IsHealthy

Whether the provider is reachable.

```csharp
public required bool IsHealthy { get; init; }
```

#### Property Value

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

### <a id="Tracon_VoiceHealth_Latency"></a> Latency

The check's duration.

```csharp
public required TimeSpan Latency { get; init; }
```

#### Property Value

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

### <a id="Tracon_VoiceHealth_ProviderName"></a> ProviderName

The provider name.

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

#### Property Value

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

### <a id="Tracon_VoiceHealth_VoiceCount"></a> VoiceCount

The number of voices seen during the check.

```csharp
public int? VoiceCount { get; init; }
```

#### Property Value

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

## Methods

### <a id="Tracon_VoiceHealth_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_VoiceHealth_Equals_Tracon_VoiceHealth_"></a> Equals\(VoiceHealth?\)

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

#### Parameters

`other` [VoiceHealth](/api/tracon.voicehealth/)?

#### Returns

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

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

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

#### Returns

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

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

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

#### Returns

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

## Operators

### <a id="Tracon_VoiceHealth_op_Equality_Tracon_VoiceHealth_Tracon_VoiceHealth_"></a> operator ==\(VoiceHealth?, VoiceHealth?\)

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

#### Parameters

`left` [VoiceHealth](/api/tracon.voicehealth/)?

`right` [VoiceHealth](/api/tracon.voicehealth/)?

#### Returns

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

### <a id="Tracon_VoiceHealth_op_Inequality_Tracon_VoiceHealth_Tracon_VoiceHealth_"></a> operator \!=\(VoiceHealth?, VoiceHealth?\)

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

#### Parameters

`left` [VoiceHealth](/api/tracon.voicehealth/)?

`right` [VoiceHealth](/api/tracon.voicehealth/)?

#### Returns

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