# UploadDocumentChunk

> 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.uploaddocumentchunk/
> Summary: UploadDocumentChunk: A single ready-made chunk in an upload request.

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

A single ready-made chunk in an upload request.

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

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

```csharp
public UploadDocumentChunk()
```

## Properties

### <a id="Tracon_UploadDocumentChunk_Content"></a> Content

The chunk's text.

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

#### Property Value

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

### <a id="Tracon_UploadDocumentChunk_Embedding"></a> Embedding

The chunk's embedding. If empty, the server embeds it; if filled in, it
is written as is and returns 400 if it does not match the store's dimension.

```csharp
public float[]? Embedding { get; init; }
```

#### Property Value

 [float](https://learn.microsoft.com/dotnet/api/system.single)\[\]?

### <a id="Tracon_UploadDocumentChunk_Index"></a> Index

Sequence number within the source.

```csharp
public required int Index { get; init; }
```

#### Property Value

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

### <a id="Tracon_UploadDocumentChunk_Metadata"></a> Metadata

Optional metadata.

```csharp
public IReadOnlyDictionary<string, string>? Metadata { get; init; }
```

#### Property Value

 [IReadOnlyDictionary](https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlydictionary\-2)<[string](https://learn.microsoft.com/dotnet/api/system.string), [string](https://learn.microsoft.com/dotnet/api/system.string)\>?

## Methods

### <a id="Tracon_UploadDocumentChunk_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_UploadDocumentChunk_Equals_Tracon_UploadDocumentChunk_"></a> Equals\(UploadDocumentChunk?\)

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

#### Parameters

`other` [UploadDocumentChunk](/api/tracon.uploaddocumentchunk/)?

#### Returns

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

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

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

#### Returns

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

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

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

#### Returns

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

## Operators

### <a id="Tracon_UploadDocumentChunk_op_Equality_Tracon_UploadDocumentChunk_Tracon_UploadDocumentChunk_"></a> operator ==\(UploadDocumentChunk?, UploadDocumentChunk?\)

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

#### Parameters

`left` [UploadDocumentChunk](/api/tracon.uploaddocumentchunk/)?

`right` [UploadDocumentChunk](/api/tracon.uploaddocumentchunk/)?

#### Returns

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

### <a id="Tracon_UploadDocumentChunk_op_Inequality_Tracon_UploadDocumentChunk_Tracon_UploadDocumentChunk_"></a> operator \!=\(UploadDocumentChunk?, UploadDocumentChunk?\)

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

#### Parameters

`left` [UploadDocumentChunk](/api/tracon.uploaddocumentchunk/)?

`right` [UploadDocumentChunk](/api/tracon.uploaddocumentchunk/)?

#### Returns

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