Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
9 changes: 6 additions & 3 deletions english/net/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,24 @@ is_root: true
| [Aspose.Pdf](./aspose.pdf/) | The **Aspose.Pdf** is a root namespace for all classes of Aspose.Pdf library which are either directly in it like **Document** or indirectly through several subnamespaces. |
| [Aspose.Pdf.AI](./aspose.pdf.ai/) | The **Aspose.Pdf.AI** namespace provides classes for AI functionalities, including API clients and intelligent assistants. |
| [Aspose.Pdf.Annotations](./aspose.pdf.annotations/) | The **Aspose.Pdf.Annotations** namespace provides classes for working with various types of actions, destinations and other features of document which traditionally called as interactive providing means user can intercommunicate with it. |
| [Aspose.Pdf.Comparison](./aspose.pdf.comparison/) | The **Aspose.Pdf.Comparison** namespace provides classes which are used for document comparison. |
| [Aspose.Pdf.Comparison](./aspose.pdf.comparison/) | The **Aspose.Pdf.Comparison** namespace provides classes for the PDF comparison functionalities. |
| [Aspose.Pdf.DataEditor](./aspose.pdf.dataeditor/) | The **Aspose.Pdf.DataEditor** contains tools for editing data within a document. |
| [Aspose.Pdf.Devices](./aspose.pdf.devices/) | The **Aspose.Pdf.Devices** namespace provides classes which are used for representing document as image(s) or a plain text. So document can be sent on to textual or various graphic devices which means we want to get it textual or graphic representation. |
| [Aspose.Pdf.Drawing](./aspose.pdf.drawing/) | The **Aspose.Pdf.Drawing** namespace provides classes describing graphic primitives like arc, line, circle etc. Corresponding objects can be used for creating new documents. |
| [Aspose.Pdf.Facades](./aspose.pdf.facades/) | The **Aspose.Pdf.Facades** namespace provides classes originaly came from Aspose.Pdf.Kit. These classes are used for manipulating documents perfoming operations like concatenating, stamping, signing, annotating etc. but on the high level without access to a document's inner structure. |
| [Aspose.Pdf.Flow](./aspose.pdf.flow/) | Contains classes and interfaces for recognizing and analyzing the structural composition of PDF documents. This includes components such as [`StructureRecognitionVisitor`](aspose.pdf.flow/structurerecognitionvisitor/), which traverses the layout tree to identify elements like paragraphs, tables, sections, and figures, and to build a structured representation of the document. |
| [Aspose.Pdf.Forms](./aspose.pdf.forms/) | The **Aspose.Pdf.Forms** namespace has classes which describes forms (standard, static, dynamic) and various types of fields like text box, list box, radio button etc. |
| [Aspose.Pdf.LogicalStructure](./aspose.pdf.logicalstructure/) | The **Aspose.Pdf.Tagged.LogicalStructure** is a namespace for PDF Logical Structure classes. |
| [Aspose.Pdf.LowCode](./aspose.pdf.lowcode/) | The **Aspose.Pdf.LowCode** is a root namespace for all classes of Aspose.Pdf.LowCode classes which are either directly in it like **PdfOrganizer** or indirectly through several subnamespaces. |
| [Aspose.Pdf.Multithreading](./aspose.pdf.multithreading/) | The **Aspose.Pdf.Multithreading** namespace provides classes that are meant to be used in multi-threaded scenarios. |
| [Aspose.Pdf.Ocr](./aspose.pdf.ocr/) | The **Aspose.Pdf.Ocr** namespace provides classes for extracting plain text from PDF pages using OCR. |
| [Aspose.Pdf.Operators](./aspose.pdf.operators/) | The **Aspose.Pdf.Operators** is a namespace for Operator implementations. These classes describes operators used in PDF page contents. |
| [Aspose.Pdf.Optimization](./aspose.pdf.optimization/) | The **Aspose.Pdf.Optimization** is a namespace for classes for managing of document optimization process. |
| [Aspose.Pdf.Plugins](./aspose.pdf.plugins/) | The **Aspose.Pdf.Plugins** is a root namespace for all classes of Aspose.Pdf.Plugins classes which are either directly in it like **PdfOrganizer** or indirectly through several subnamespaces. |
| [Aspose.Pdf.Printing](./aspose.pdf.printing/) | The **Aspose.Pdf.Printing** namespace provides classes and functionalities for handling PDF printing operations, including printer settings, page settings, and extensions for managing print-related configurations. |
| [Aspose.Pdf.Sanitization](./aspose.pdf.sanitization/) | The **Aspose.Pdf.Sanitization** is a namespace for sanitization operations. |
| [Aspose.Pdf.Security](./aspose.pdf.security/) | The **Aspose.Pdf.Security** namespace contains classes used for encryption and digital signing. |
| [Aspose.Pdf.Signatures](./aspose.pdf.signatures/) | The **Aspose.Pdf.Signatures** namespace contains classes used for detecting compromised signatures. |
| [Aspose.Pdf.Security.HiddenDataSanitization](./aspose.pdf.security.hiddendatasanitization/) | |
| [Aspose.Pdf.Signatures](./aspose.pdf.signatures/) | The **Aspose.Pdf.Signatures** namespace provides classes for signatures functionalities. |
| [Aspose.Pdf.Structure](./aspose.pdf.structure/) | The **Aspose.Pdf.Structure** namespace provides classes which help to work with a logical structure of a document which presents the organization of the document into chapters and sections or the identification of special elements such as figures, tables, and footnotes. |
| [Aspose.Pdf.Tagged](./aspose.pdf.tagged/) | The **Aspose.Pdf.Tagged** is a namespace for classes for support of Tagged PDF documents. |
| [Aspose.Pdf.Text](./aspose.pdf.text/) | The **Aspose.Pdf.Text** namespace provides classes that allow to extract text, add text, manipulate existing text of a document. It also contain classes that allow to extract, replace, substitute fonts of a document. |
Expand Down
5 changes: 4 additions & 1 deletion english/net/aspose.pdf.ai/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Aspose.Pdf.AI
second_title: Aspose.PDF for .NET API Reference
description: The Aspose.Pdf.AI namespace provides classes for AI functionalities including API clients and intelligent assistants
type: docs
weight: 40
weight: 20
url: /net/aspose.pdf.ai/
---
The **Aspose.Pdf.AI** namespace provides classes for AI functionalities, including API clients and intelligent assistants.
Expand All @@ -29,6 +29,7 @@ The **Aspose.Pdf.AI** namespace provides classes for AI functionalities, includi
| [ChatMessage](./chatmessage/) | A chat completion message generated by the model. |
| [ChatMessageResponse](./chatmessageresponse/) | A chat completion message generated by the model. |
| [Choice](./choice/) | Represents a choice in a chat completion response. |
| [ChunkingOptions](./chunkingoptions/) | Configuration options for document chunking operations. |
| [CodeInterpreter](./codeinterpreter/) | Represents the code interpreter tool resources. |
| [CompletionCreateRequest](./completioncreaterequest/) | Represents a request for the Create Chat Completion endpoint. |
| [CompletionFunction](./completionfunction/) | Represents the function object. |
Expand All @@ -40,7 +41,9 @@ The **Aspose.Pdf.AI** namespace provides classes for AI functionalities, includi
| [CreateFineTuningJobResponse](./createfinetuningjobresponse/) | Represents a response from the Create Fine-Tuning Job endpoint. |
| [DataResponse<T>](./dataresponse-1/) | Represents a data response containing the specified data. |
| [DeleteStatusResponse](./deletestatusresponse/) | Represents the status of an object deletion. |
| [DocumentChunk](./documentchunk/) | Represents a single chunk of content extracted from a document. |
| [DocumentCollection](./documentcollection/) | Represents a collection of documents to be processed. |
| [DocumentExtensions](./documentextensions/) | Extension methods for [`Document`](../aspose.pdf/document/) to support AI ingestion and chunking. |
| [Embedding](./embedding/) | Represents an embedding vector returned by embedding endpoint. |
| [Error](./error/) | Represents an error in the API response. |
| [ExpiresAfter](./expiresafter/) | Represents the expiration policy for a vector store. |
Expand Down
2 changes: 1 addition & 1 deletion english/net/aspose.pdf.ai/aiclientbase/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class AIClientBase
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.AIClientBase class. Represents client to access AI API
type: docs
weight: 50
weight: 20
url: /net/aspose.pdf.ai/aiclientbase/
---
## AIClientBase class
Expand Down
2 changes: 1 addition & 1 deletion english/net/aspose.pdf.ai/aiclientexception/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class AIClientException
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.AIClientException class. Represents an exception specific to the AI Client operations
type: docs
weight: 60
weight: 30
url: /net/aspose.pdf.ai/aiclientexception/
---
## AIClientException class
Expand Down
2 changes: 1 addition & 1 deletion english/net/aspose.pdf.ai/aicopilotexception/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class AICopilotException
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.AICopilotException class. Represents an exception specific to Copilots operations
type: docs
weight: 70
weight: 40
url: /net/aspose.pdf.ai/aicopilotexception/
---
## AICopilotException class
Expand Down
2 changes: 1 addition & 1 deletion english/net/aspose.pdf.ai/aicopilotfactory/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class AICopilotFactory
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.AICopilotFactory class. Factory class for creating different types of copilots
type: docs
weight: 80
weight: 50
url: /net/aspose.pdf.ai/aicopilotfactory/
---
## AICopilotFactory class
Expand Down
2 changes: 1 addition & 1 deletion english/net/aspose.pdf.ai/annotation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class Annotation
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.Annotation class. Represents the text content that is part of a message
type: docs
weight: 90
weight: 60
url: /net/aspose.pdf.ai/annotation/
---
## Annotation class
Expand Down
2 changes: 1 addition & 1 deletion english/net/aspose.pdf.ai/assistantcreaterequest/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class AssistantCreateRequest
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.AssistantCreateRequest class. Request object for creating an assistant
type: docs
weight: 100
weight: 70
url: /net/aspose.pdf.ai/assistantcreaterequest/
---
## AssistantCreateRequest class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class AssistantListQueryParameters
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.AssistantListQueryParameters class. Represents the query parameters object for listing assistants
type: docs
weight: 110
weight: 80
url: /net/aspose.pdf.ai/assistantlistqueryparameters/
---
## AssistantListQueryParameters class
Expand Down
2 changes: 1 addition & 1 deletion english/net/aspose.pdf.ai/assistantlistresponse/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class AssistantListResponse
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.AssistantListResponse class. Represents the response containing a list of assistant responses
type: docs
weight: 120
weight: 90
url: /net/aspose.pdf.ai/assistantlistresponse/
---
## AssistantListResponse class
Expand Down
2 changes: 1 addition & 1 deletion english/net/aspose.pdf.ai/assistantmodifyrequest/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class AssistantModifyRequest
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.AssistantModifyRequest class. Request object for modifying an assistant
type: docs
weight: 130
weight: 100
url: /net/aspose.pdf.ai/assistantmodifyrequest/
---
## AssistantModifyRequest class
Expand Down
2 changes: 1 addition & 1 deletion english/net/aspose.pdf.ai/assistantresponse/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class AssistantResponse
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.AssistantResponse class. Represents an assistant that can call the model and use tools
type: docs
weight: 140
weight: 110
url: /net/aspose.pdf.ai/assistantresponse/
---
## AssistantResponse class
Expand Down
2 changes: 1 addition & 1 deletion english/net/aspose.pdf.ai/attachment/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class Attachment
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.Attachment class. Represents a list of files attached to the message and the tools they should be added to
type: docs
weight: 150
weight: 120
url: /net/aspose.pdf.ai/attachment/
---
## Attachment class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class BaseListQueryParameters
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.BaseListQueryParameters class. Base query parameters for listing objects
type: docs
weight: 160
weight: 130
url: /net/aspose.pdf.ai/baselistqueryparameters/
---
## BaseListQueryParameters class
Expand Down
2 changes: 1 addition & 1 deletion english/net/aspose.pdf.ai/baseresponse/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class BaseResponse
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.BaseResponse class. Base class for API responses
type: docs
weight: 170
weight: 140
url: /net/aspose.pdf.ai/baseresponse/
---
## BaseResponse class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class CancellationTokenExtensions
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.CancellationTokenExtensions class. Provides extension methods for CancellationToken
type: docs
weight: 180
weight: 150
url: /net/aspose.pdf.ai/cancellationtokenextensions/
---
## CancellationTokenExtensions class
Expand Down
2 changes: 1 addition & 1 deletion english/net/aspose.pdf.ai/chatmessage/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class ChatMessage
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.ChatMessage class. A chat completion message generated by the model
type: docs
weight: 190
weight: 160
url: /net/aspose.pdf.ai/chatmessage/
---
## ChatMessage class
Expand Down
2 changes: 1 addition & 1 deletion english/net/aspose.pdf.ai/chatmessageresponse/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class ChatMessageResponse
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.ChatMessageResponse class. A chat completion message generated by the model
type: docs
weight: 200
weight: 170
url: /net/aspose.pdf.ai/chatmessageresponse/
---
## ChatMessageResponse class
Expand Down
2 changes: 1 addition & 1 deletion english/net/aspose.pdf.ai/choice/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class Choice
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.Choice class. Represents a choice in a chat completion response
type: docs
weight: 210
weight: 180
url: /net/aspose.pdf.ai/choice/
---
## Choice class
Expand Down
54 changes: 54 additions & 0 deletions english/net/aspose.pdf.ai/chunkingoptions/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Class ChunkingOptions
second_title: Aspose.PDF for .NET API Reference
description: Aspose.Pdf.AI.ChunkingOptions class. Configuration options for document chunking operations
type: docs
weight: 190
url: /net/aspose.pdf.ai/chunkingoptions/
---
## ChunkingOptions class

Configuration options for document chunking operations.

```csharp
public sealed class ChunkingOptions
```

## Constructors

| Name | Description |
| --- | --- |
| [ChunkingOptions](chunkingoptions/)() | The default constructor. |

## Properties

| Name | Description |
| --- | --- |
| [MaxChunkSize](../../aspose.pdf.ai/chunkingoptions/maxchunksize/) { get; set; } | Gets or sets the maximum size of each chunk in tokens. |
| [OverlapSize](../../aspose.pdf.ai/chunkingoptions/overlapsize/) { get; set; } | Gets or sets the number of tokens to overlap between consecutive chunks. |

## Methods

| Name | Description |
| --- | --- |
| [Validate](../../aspose.pdf.ai/chunkingoptions/validate/)() | Validates the current options configuration. |

## Fields

| Name | Description |
| --- | --- |
| const [DefaultMaxChunkSize](../../aspose.pdf.ai/chunkingoptions/defaultmaxchunksize/) | The default maximum chunk size in tokens. |
| const [DefaultOverlapSize](../../aspose.pdf.ai/chunkingoptions/defaultoverlapsize/) | The default overlap size in tokens between consecutive chunks. |
| const [MaximumChunkSize](../../aspose.pdf.ai/chunkingoptions/maximumchunksize/) | The maximum allowed chunk size. |
| const [MinimumChunkSize](../../aspose.pdf.ai/chunkingoptions/minimumchunksize/) | The minimum allowed chunk size. |

## Remarks

This class provides configuration for controlling how documents are split into chunks suitable for AI processing and embeddings.

### See Also

* namespace [Aspose.Pdf.AI](../../aspose.pdf.ai/)
* assembly [Aspose.PDF](../../)


Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: ChunkingOptions.ChunkingOptions
second_title: Aspose.PDF for .NET API Reference
description: ChunkingOptions constructor. The default constructor
type: docs
weight: 10
url: /net/aspose.pdf.ai/chunkingoptions/chunkingoptions/
---
## ChunkingOptions constructor

The default constructor.

```csharp
public ChunkingOptions()
```

### See Also

* class [ChunkingOptions](../)
* namespace [Aspose.Pdf.AI](../../../aspose.pdf.ai/)
* assembly [Aspose.PDF](../../../)


Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: ChunkingOptions.DefaultMaxChunkSize
second_title: Aspose.PDF for .NET API Reference
description: ChunkingOptions field. The default maximum chunk size in tokens
type: docs
weight: 50
url: /net/aspose.pdf.ai/chunkingoptions/defaultmaxchunksize/
---
## ChunkingOptions.DefaultMaxChunkSize field

The default maximum chunk size in tokens.

```csharp
public const int DefaultMaxChunkSize;
```

### See Also

* class [ChunkingOptions](../)
* namespace [Aspose.Pdf.AI](../../../aspose.pdf.ai/)
* assembly [Aspose.PDF](../../../)


Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: ChunkingOptions.DefaultOverlapSize
second_title: Aspose.PDF for .NET API Reference
description: ChunkingOptions field. The default overlap size in tokens between consecutive chunks
type: docs
weight: 60
url: /net/aspose.pdf.ai/chunkingoptions/defaultoverlapsize/
---
## ChunkingOptions.DefaultOverlapSize field

The default overlap size in tokens between consecutive chunks.

```csharp
public const int DefaultOverlapSize;
```

### See Also

* class [ChunkingOptions](../)
* namespace [Aspose.Pdf.AI](../../../aspose.pdf.ai/)
* assembly [Aspose.PDF](../../../)


33 changes: 33 additions & 0 deletions english/net/aspose.pdf.ai/chunkingoptions/maxchunksize/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: ChunkingOptions.MaxChunkSize
second_title: Aspose.PDF for .NET API Reference
description: ChunkingOptions property. Gets or sets the maximum size of each chunk in tokens
type: docs
weight: 20
url: /net/aspose.pdf.ai/chunkingoptions/maxchunksize/
---
## ChunkingOptions.MaxChunkSize property

Gets or sets the maximum size of each chunk in tokens.

```csharp
public int MaxChunkSize { get; set; }
```

### Property Value

The maximum chunk size in tokens. Must be between [`MinimumChunkSize`](../minimumchunksize/) and [`MaximumChunkSize`](../maximumchunksize/). Default is [`DefaultMaxChunkSize`](../defaultmaxchunksize/).

### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | Thrown when the value is less than [`MinimumChunkSize`](../minimumchunksize/) or greater than [`MaximumChunkSize`](../maximumchunksize/). |

### See Also

* class [ChunkingOptions](../)
* namespace [Aspose.Pdf.AI](../../../aspose.pdf.ai/)
* assembly [Aspose.PDF](../../../)


Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: ChunkingOptions.MaximumChunkSize
second_title: Aspose.PDF for .NET API Reference
description: ChunkingOptions field. The maximum allowed chunk size
type: docs
weight: 70
url: /net/aspose.pdf.ai/chunkingoptions/maximumchunksize/
---
## ChunkingOptions.MaximumChunkSize field

The maximum allowed chunk size.

```csharp
public const int MaximumChunkSize;
```

### See Also

* class [ChunkingOptions](../)
* namespace [Aspose.Pdf.AI](../../../aspose.pdf.ai/)
* assembly [Aspose.PDF](../../../)


Loading