# VectorSearchRequest

> 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.vectorsearchrequest/
> Summary: VectorSearchRequest: A semantic search request.

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

A semantic search request.

```csharp
public sealed record VectorSearchRequest : IEquatable<VectorSearchRequest>
```

<dl class="api-relations"><dt>Inheritance</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ← <a href="/api/tracon.vectorsearchrequest/">VectorSearchRequest</a></dd><dt>Implements</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable&lt;VectorSearchRequest&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_VectorSearchRequest__ctor"></a> VectorSearchRequest\(\)

```csharp
public VectorSearchRequest()
```

## Properties

### <a id="Tracon_VectorSearchRequest_Collection"></a> Collection

The collection name.

```csharp
public required string Collection { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="Tracon_VectorSearchRequest_MaxDistance"></a> MaxDistance

The largest cosine distance accepted (0 = identical, 2 = opposite).
No distance filter is applied when [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null).

```csharp
public double? MaxDistance { get; init; }
```

#### Property Value

 [double](https://learn.microsoft.com/dotnet/api/system.double)?

### <a id="Tracon_VectorSearchRequest_QueryEmbedding"></a> QueryEmbedding

The embedding of the query text.

```csharp
public required ReadOnlyMemory<float> QueryEmbedding { get; init; }
```

#### Property Value

 [ReadOnlyMemory](https://learn.microsoft.com/dotnet/api/system.readonlymemory\-1)<[float](https://learn.microsoft.com/dotnet/api/system.single)\>

### <a id="Tracon_VectorSearchRequest_TenantId"></a> TenantId

The tenant identifier.

```csharp
public required string TenantId { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="Tracon_VectorSearchRequest_Top"></a> Top

The number of results to return.

```csharp
public int Top { get; init; }
```

#### Property Value

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

### <a id="Tracon_VectorSearchRequest_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_VectorSearchRequest_Equals_Tracon_VectorSearchRequest_"></a> Equals\(VectorSearchRequest?\)

```csharp
public bool Equals(VectorSearchRequest? other)
```

#### Parameters

`other` [VectorSearchRequest](/api/tracon.vectorsearchrequest/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_VectorSearchRequest_GetHashCode"></a> GetHashCode\(\)

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

 [int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="Tracon_VectorSearchRequest_ToString"></a> ToString\(\)

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

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

### <a id="Tracon_VectorSearchRequest_op_Equality_Tracon_VectorSearchRequest_Tracon_VectorSearchRequest_"></a> operator ==\(VectorSearchRequest?, VectorSearchRequest?\)

```csharp
public static bool operator ==(VectorSearchRequest? left, VectorSearchRequest? right)
```

#### Parameters

`left` [VectorSearchRequest](/api/tracon.vectorsearchrequest/)?

`right` [VectorSearchRequest](/api/tracon.vectorsearchrequest/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_VectorSearchRequest_op_Inequality_Tracon_VectorSearchRequest_Tracon_VectorSearchRequest_"></a> operator \!=\(VectorSearchRequest?, VectorSearchRequest?\)

```csharp
public static bool operator !=(VectorSearchRequest? left, VectorSearchRequest? right)
```

#### Parameters

`left` [VectorSearchRequest](/api/tracon.vectorsearchrequest/)?

`right` [VectorSearchRequest](/api/tracon.vectorsearchrequest/)?

#### Returns

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