# UploadDocumentRequest

> 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.uploaddocumentrequest/
> Summary: UploadDocumentRequest: Request to upload a document.

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

Request to upload a document.

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

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

Either `Text` or [UploadDocumentRequest.Chunks](/api/tracon.uploaddocumentrequest/#Tracon_UploadDocumentRequest_Chunks) is given; both or neither
cannot be given (see [KnowledgeIngestionService.IngestAsync](/api/tracon/)).

## Constructors

### <a id="Tracon_UploadDocumentRequest__ctor"></a> UploadDocumentRequest\(\)

```csharp
public UploadDocumentRequest()
```

## Properties

### <a id="Tracon_UploadDocumentRequest_Chunks"></a> Chunks

Ready-made chunks. If `UploadDocumentChunk.Embedding` is
left empty, the server embeds it; if it is filled in, it is written as is.

```csharp
public IReadOnlyList<UploadDocumentChunk>? Chunks { get; init; }
```

#### Property Value

 [IReadOnlyList](https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist\-1)<[UploadDocumentChunk](/api/tracon.uploaddocumentchunk/)\>?

### <a id="Tracon_UploadDocumentRequest_SourceId"></a> SourceId

Source identifier. Uploading again with the same identifier replaces the old one.

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

#### Property Value

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

### <a id="Tracon_UploadDocumentRequest_Text"></a> Text

Raw text. If given, the server chunks and embeds it.

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

#### Property Value

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

## Methods

### <a id="Tracon_UploadDocumentRequest_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_UploadDocumentRequest_Equals_Tracon_UploadDocumentRequest_"></a> Equals\(UploadDocumentRequest?\)

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

#### Parameters

`other` [UploadDocumentRequest](/api/tracon.uploaddocumentrequest/)?

#### Returns

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

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

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

#### Returns

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

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

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

#### Returns

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

## Operators

### <a id="Tracon_UploadDocumentRequest_op_Equality_Tracon_UploadDocumentRequest_Tracon_UploadDocumentRequest_"></a> operator ==\(UploadDocumentRequest?, UploadDocumentRequest?\)

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

#### Parameters

`left` [UploadDocumentRequest](/api/tracon.uploaddocumentrequest/)?

`right` [UploadDocumentRequest](/api/tracon.uploaddocumentrequest/)?

#### Returns

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

### <a id="Tracon_UploadDocumentRequest_op_Inequality_Tracon_UploadDocumentRequest_Tracon_UploadDocumentRequest_"></a> operator \!=\(UploadDocumentRequest?, UploadDocumentRequest?\)

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

#### Parameters

`left` [UploadDocumentRequest](/api/tracon.uploaddocumentrequest/)?

`right` [UploadDocumentRequest](/api/tracon.uploaddocumentrequest/)?

#### Returns

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