# ToolUsage

> 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.toolusage/
> Summary: ToolUsage: A tool's usage summary. Shown by the UI's Tools screen.

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

A tool's usage summary. Shown by the UI's Tools screen.

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

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

## Constructors

### <a id="Tracon_ToolUsage__ctor"></a> ToolUsage\(\)

```csharp
public ToolUsage()
```

## Properties

### <a id="Tracon_ToolUsage_AverageDurationMs"></a> AverageDurationMs

The average duration (milliseconds). [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) if no call carries a duration.

```csharp
public double? AverageDurationMs { get; init; }
```

#### Property Value

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

### <a id="Tracon_ToolUsage_ErrorRate"></a> ErrorRate

The error rate among settled calls (0–1). [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) if there is no call.

```csharp
public double? ErrorRate { get; }
```

#### Property Value

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

### <a id="Tracon_ToolUsage_FailedCalls"></a> FailedCalls

The number of calls that errored.

```csharp
public required long FailedCalls { get; init; }
```

#### Property Value

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

### <a id="Tracon_ToolUsage_LastCalledAt"></a> LastCalledAt

The moment it was last called (UTC).

```csharp
public DateTimeOffset? LastCalledAt { get; init; }
```

#### Property Value

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

### <a id="Tracon_ToolUsage_ToolName"></a> ToolName

The tool name.

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

#### Property Value

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

### <a id="Tracon_ToolUsage_TotalCalls"></a> TotalCalls

The total number of calls.

```csharp
public required long TotalCalls { get; init; }
```

#### Property Value

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

## Methods

### <a id="Tracon_ToolUsage_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_ToolUsage_Equals_Tracon_ToolUsage_"></a> Equals\(ToolUsage?\)

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

#### Parameters

`other` [ToolUsage](/api/tracon.toolusage/)?

#### Returns

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

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

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

#### Returns

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

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

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

#### Returns

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

## Operators

### <a id="Tracon_ToolUsage_op_Equality_Tracon_ToolUsage_Tracon_ToolUsage_"></a> operator ==\(ToolUsage?, ToolUsage?\)

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

#### Parameters

`left` [ToolUsage](/api/tracon.toolusage/)?

`right` [ToolUsage](/api/tracon.toolusage/)?

#### Returns

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

### <a id="Tracon_ToolUsage_op_Inequality_Tracon_ToolUsage_Tracon_ToolUsage_"></a> operator \!=\(ToolUsage?, ToolUsage?\)

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

#### Parameters

`left` [ToolUsage](/api/tracon.toolusage/)?

`right` [ToolUsage](/api/tracon.toolusage/)?

#### Returns

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