# SpeechProviderDescriptor

> 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.speechproviderdescriptor/
> Summary: SpeechProviderDescriptor: A registered speech provider, as the speech provider list reports it.

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

A registered speech provider, as the speech provider list reports it.

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

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

Returned by [ISpeechProviderResolver.Providers](/api/tracon.ispeechproviderresolver/#Tracon_ISpeechProviderResolver_Providers) and `GET /api/voice/providers`.

## Constructors

### <a id="Tracon_SpeechProviderDescriptor__ctor"></a> SpeechProviderDescriptor\(\)

```csharp
public SpeechProviderDescriptor()
```

## Properties

### <a id="Tracon_SpeechProviderDescriptor_Dialogue"></a> Dialogue

Gets the limits of one dialogue request, or [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) when the provider
cannot voice a dialogue.

```csharp
public SpeechDialogueCapabilities? Dialogue { get; init; }
```

#### Property Value

 [SpeechDialogueCapabilities](/api/tracon.speechdialoguecapabilities/)?

#### Remarks

Read from the registered instance ([ISpeechDialogueSynthesizer.DialogueCapabilities](/api/tracon.ispeechdialoguesynthesizer/#Tracon_ISpeechDialogueSynthesizer_DialogueCapabilities)),
never from a tenant's wrapper, so every tenant sees the same value. Always
[null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) for a transcriber. A caller reads it to plan its requests, and to
choose a provider before [ISpeechProviderResolver.GetDialogueSynthesizerAsync](/api/tracon.ispeechproviderresolver/#Tracon_ISpeechProviderResolver_GetDialogueSynthesizerAsync_System_String_System_Threading_CancellationToken_)
fails for one that has none.

### <a id="Tracon_SpeechProviderDescriptor_Kind"></a> Kind

Gets whether the provider synthesizes or transcribes speech.

```csharp
public required SpeechProviderKind Kind { get; init; }
```

#### Property Value

 [SpeechProviderKind](/api/tracon.speechproviderkind/)

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

Gets the registration name, or [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) for the unnamed default.

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

#### Property Value

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

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

Gets the provider name the instance reports. A tenant's egress policy and
provider bindings name this value, not the registration name.

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

#### Property Value

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

### <a id="Tracon_SpeechProviderDescriptor_SupportsTenantCredentials"></a> SupportsTenantCredentials

Gets whether the provider can call the service with a tenant's own credential.

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

#### Property Value

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

## Methods

### <a id="Tracon_SpeechProviderDescriptor_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_SpeechProviderDescriptor_Equals_Tracon_SpeechProviderDescriptor_"></a> Equals\(SpeechProviderDescriptor?\)

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

#### Parameters

`other` [SpeechProviderDescriptor](/api/tracon.speechproviderdescriptor/)?

#### Returns

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

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

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

#### Returns

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

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

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

#### Returns

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

## Operators

### <a id="Tracon_SpeechProviderDescriptor_op_Equality_Tracon_SpeechProviderDescriptor_Tracon_SpeechProviderDescriptor_"></a> operator ==\(SpeechProviderDescriptor?, SpeechProviderDescriptor?\)

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

#### Parameters

`left` [SpeechProviderDescriptor](/api/tracon.speechproviderdescriptor/)?

`right` [SpeechProviderDescriptor](/api/tracon.speechproviderdescriptor/)?

#### Returns

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

### <a id="Tracon_SpeechProviderDescriptor_op_Inequality_Tracon_SpeechProviderDescriptor_Tracon_SpeechProviderDescriptor_"></a> operator \!=\(SpeechProviderDescriptor?, SpeechProviderDescriptor?\)

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

#### Parameters

`left` [SpeechProviderDescriptor](/api/tracon.speechproviderdescriptor/)?

`right` [SpeechProviderDescriptor](/api/tracon.speechproviderdescriptor/)?

#### Returns

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