Skip to content

Commit

Permalink
Merge pull request #59 from aspose-pdf/main
Browse files Browse the repository at this point in the history
Aspose.PDF for .NET: Add the AI namespace and other missing APIs.
  • Loading branch information
adil-aspose authored Oct 25, 2024
2 parents 4af1316 + 76cd219 commit 6fd0378
Show file tree
Hide file tree
Showing 879 changed files with 22,447 additions and 0 deletions.
1 change: 1 addition & 0 deletions english/net/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ is_root: true
| Namespace | Description |
| --- | --- |
| [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** is a namespace for classes for support of AI-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/) | |
| [Aspose.Pdf.Comparison.Diff](./aspose.pdf.comparison.diff/) | |
Expand Down
151 changes: 151 additions & 0 deletions english/net/aspose.pdf.ai/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
---
title: Aspose.Pdf.AI
second_title: Aspose.PDF for .NET API Reference
description:
type: docs
weight: 40
url: /net/aspose.pdf.ai/
---


## Classes

| Class | Description |
| --- | --- |
| [AIClientBase](./aiclientbase) | |
| [AIClientException](./aiclientexception) | |
| [AICopilotException](./aicopilotexception) | |
| [AICopilotFactory](./aicopilotfactory) | |
| [Annotation](./annotation) | |
| [AssistantCreateRequest](./assistantcreaterequest) | |
| [AssistantListQueryParameters](./assistantlistqueryparameters) | |
| [AssistantListResponse](./assistantlistresponse) | |
| [AssistantModifyRequest](./assistantmodifyrequest) | |
| [AssistantResponse](./assistantresponse) | |
| [Attachment](./attachment) | |
| [BaseListQueryParameters](./baselistqueryparameters) | |
| [BaseResponse](./baseresponse) | |
| [CancellationTokenExtensions](./cancellationtokenextensions) | |
| [ChatMessage](./chatmessage) | |
| [Choice](./choice) | |
| [CodeInterpreter](./codeinterpreter) | |
| [CompletionCreateRequest](./completioncreaterequest) | |
| [CompletionFunction](./completionfunction) | |
| [CompletionResponse](./completionresponse) | |
| [CreateChatCompletionChunkResponse](./createchatcompletionchunkresponse) | |
| [CreateEmbeddingRequest](./createembeddingrequest) | |
| [CreateEmbeddingResponse](./createembeddingresponse) | |
| [CreateFineTuningJobRequest](./createfinetuningjobrequest) | |
| [CreateFineTuningJobResponse](./createfinetuningjobresponse) | |
| [DataResponse<T>](./dataresponse-1) | |
| [DeleteStatusResponse](./deletestatusresponse) | |
| [DocumentCollection](./documentcollection) | |
| [Embedding](./embedding) | |
| [Error](./error) | |
| [ExpiresAfter](./expiresafter) | |
| [FileCitation](./filecitation) | |
| [FileContentResponse<T>](./filecontentresponse-1) | |
| [FileCounts](./filecounts) | |
| [FileListResponse](./filelistresponse) | |
| [FileResponse](./fileresponse) | |
| [FileSearch](./filesearch) | |
| [Function](./function) | |
| [Hyperparameters](./hyperparameters) | |
| [ImageDescription](./imagedescription) | |
| [ImageDescriptionResult](./imagedescriptionresult) | |
| [ImageFile](./imagefile) | |
| [ImageUrl](./imageurl) | |
| [IncompleteDetails](./incompletedetails) | |
| [LastError](./lasterror) | |
| [ListDataResponse<T>](./listdataresponse-1) | |
| [LlamaChatCompletionRequest](./llamachatcompletionrequest) | |
| [LlamaChatCompletionResponse](./llamachatcompletionresponse) | |
| [LlamaClient](./llamaclient) | |
| [LlamaCopilotOptionsBase](./llamacopilotoptionsbase) | |
| [LlamaModels](./llamamodels) | |
| [LlamaSummaryCopilot](./llamasummarycopilot) | |
| [LlamaSummaryCopilotOptions](./llamasummarycopilotoptions) | |
| [Logprobs](./logprobs) | |
| [MessageContentBase](./messagecontentbase) | |
| [MessageContentRequest](./messagecontentrequest) | |
| [MessageContentResponse](./messagecontentresponse) | |
| [MessageCreation](./messagecreation) | |
| [OpenAIAssistantCopilotOptionsBase](./openaiassistantcopilotoptionsbase) | |
| [OpenAIChatCopilot](./openaichatcopilot) | |
| [OpenAIChatCopilotOptions](./openaichatcopilotoptions) | |
| [OpenAIClient](./openaiclient) | |
| [OpenAIContext](./openaicontext) | |
| [OpenAICopilotOptionsBase](./openaicopilotoptionsbase) | |
| [OpenAIImageDescriptionCopilot](./openaiimagedescriptioncopilot) | |
| [OpenAIImageDescriptionCopilotExtensions](./openaiimagedescriptioncopilotextensions) | |
| [OpenAIImageDescriptionCopilotOptions](./openaiimagedescriptioncopilotoptions) | |
| [OpenAIModels](./openaimodels) | |
| [OpenAISummaryCopilot](./openaisummarycopilot) | |
| [OpenAISummaryCopilotOptions](./openaisummarycopilotoptions) | |
| [PdfDocument](./pdfdocument) | |
| [RequiredAction](./requiredaction) | |
| [ResponseFormat](./responseformat) | |
| [RunCreateRequest](./runcreaterequest) | |
| [RunListQueryParameters](./runlistqueryparameters) | |
| [RunListResponse](./runlistresponse) | |
| [RunModifyRequest](./runmodifyrequest) | |
| [RunResponse](./runresponse) | |
| [RunStepDetails](./runstepdetails) | |
| [RunStepListQueryParameters](./runsteplistqueryparameters) | |
| [RunStepListResponse](./runsteplistresponse) | |
| [RunStepResponse](./runstepresponse) | |
| [RunThreadCreateRequest](./runthreadcreaterequest) | |
| [SubmitToolOutputs](./submittooloutputs) | |
| [TextDocument](./textdocument) | |
| [TextResponse](./textresponse) | |
| [ThreadCreateRequest](./threadcreaterequest) | |
| [ThreadMessageCreateRequest](./threadmessagecreaterequest) | |
| [ThreadMessageListQueryParameters](./threadmessagelistqueryparameters) | |
| [ThreadMessageListResponse](./threadmessagelistresponse) | |
| [ThreadMessageModifyRequest](./threadmessagemodifyrequest) | |
| [ThreadMessageResponse](./threadmessageresponse) | |
| [ThreadModifyRequest](./threadmodifyrequest) | |
| [ThreadResponse](./threadresponse) | |
| [Tool](./tool) | |
| [ToolCall](./toolcall) | |
| [ToolChoice](./toolchoice) | |
| [ToolResources](./toolresources) | |
| [TruncationStrategy](./truncationstrategy) | |
| [Usage](./usage) | |
| [VectorStore](./vectorstore) | |
| [VectorStoreCreateRequest](./vectorstorecreaterequest) | |
| [VectorStoreFileBatchCreateRequest](./vectorstorefilebatchcreaterequest) | |
| [VectorStoreFileBatchFileListQueryParameters](./vectorstorefilebatchfilelistqueryparameters) | |
| [VectorStoreFileBatchFileListResponse](./vectorstorefilebatchfilelistresponse) | |
| [VectorStoreFileBatchResponse](./vectorstorefilebatchresponse) | |
| [VectorStoreFileCreateRequest](./vectorstorefilecreaterequest) | |
| [VectorStoreFileListQueryParameters](./vectorstorefilelistqueryparameters) | |
| [VectorStoreFileListResponse](./vectorstorefilelistresponse) | |
| [VectorStoreFileResponse](./vectorstorefileresponse) | |
| [VectorStoreListQueryParameters](./vectorstorelistqueryparameters) | |
| [VectorStoreListResponse](./vectorstorelistresponse) | |
| [VectorStoreModifyRequest](./vectorstoremodifyrequest) | |
| [VectorStoreResponse](./vectorstoreresponse) | |
## Interfaces

| Interface | Description |
| --- | --- |
| [IAIClient](./iaiclient) | Represents an interface for an AI client. |
| [IAICopilot](./iaicopilot) | Represents a copilot for AI interactions. |
| [IChatClient<TOptions>](./ichatclient-1) | Represents an interface for a chat client with specific options. |
| [IChatCopilot](./ichatcopilot) | |
| [IChatCopilotOptions<TOptions>](./ichatcopilotoptions-1) | Represents an interface for chat copilot options with a specific type. |
| [IEntityId](./ientityid) | Represents an entity with an ID. |
| [IImageDescriptionClient<TOptions>](./iimagedescriptionclient-1) | Represents an interface for an image description client with specific options. |
| [IImageDescriptionCopilot](./iimagedescriptioncopilot) | |
| [IImageDescriptionCopilotOptions<TOptions>](./iimagedescriptioncopilotoptions-1) | Represents an interface for image description copilot options with a specific type. |
| [ILlamaClient](./illamaclient) | |
| [IOpenAIClient](./iopenaiclient) | |
| [IQueryParameters](./iqueryparameters) | Represents query parameters for API requests. |
| [IStatus](./istatus) | Represents the status of an operation. |
| [IStringOrObject<T>](./istringorobject-1) | Represents an object that can be either a string value or an object value. |
| [ISummaryClient<TOptions>](./isummaryclient-1) | Represents an interface for a summary client with specific options. |
| [ISummaryCopilot](./isummarycopilot) | |
| [ISummaryCopilotOptions<TOptions>](./isummarycopilotoptions-1) | Represents an interface for summary copilot options with a specific type. |

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.PDF.dll -->
35 changes: 35 additions & 0 deletions english/net/aspose.pdf.ai/aiclientbase/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: AIClientBase
second_title: Aspose.PDF for .NET API Reference
description:
type: docs
weight: 50
url: /net/aspose.pdf.ai/aiclientbase/
---
## AIClientBase class

```csharp
public abstract class AIClientBase : IDisposable
```

## Properties

| Name | Description |
| --- | --- |
| [BackoffDelaySeconds](../../aspose.pdf.ai/aiclientbase/backoffdelayseconds) { get; set; } | |
| [HttpRequestMaxRetries](../../aspose.pdf.ai/aiclientbase/httprequestmaxretries) { getset; } | |
| [PollingIntervalSeconds](../../aspose.pdf.ai/aiclientbase/pollingintervalseconds) { getset; } | |
| [PollingTimeoutSeconds](../../aspose.pdf.ai/aiclientbase/pollingtimeoutseconds) { getset; } | |

## Methods

| Name | Description |
| --- | --- |
| [Dispose](../../aspose.pdf.ai/aiclientbase/dispose)() | |

### See Also

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

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.PDF.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: BackoffDelaySeconds
second_title: Aspose.PDF for .NET API Reference
description:
type: docs
weight: 10
url: /net/aspose.pdf.ai/aiclientbase/backoffdelayseconds/
---
## AIClientBase.BackoffDelaySeconds property

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

### See Also

* class [AIClientBase](../../aiclientbase)
* namespace [Aspose.Pdf.AI](../../aiclientbase)
* assembly [Aspose.PDF](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.PDF.dll -->
21 changes: 21 additions & 0 deletions english/net/aspose.pdf.ai/aiclientbase/dispose/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Dispose
second_title: Aspose.PDF for .NET API Reference
description:
type: docs
weight: 50
url: /net/aspose.pdf.ai/aiclientbase/dispose/
---
## AIClientBase.Dispose method

```csharp
public void Dispose()
```

### See Also

* class [AIClientBase](../../aiclientbase)
* namespace [Aspose.Pdf.AI](../../aiclientbase)
* assembly [Aspose.PDF](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.PDF.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: HttpRequestMaxRetries
second_title: Aspose.PDF for .NET API Reference
description:
type: docs
weight: 20
url: /net/aspose.pdf.ai/aiclientbase/httprequestmaxretries/
---
## AIClientBase.HttpRequestMaxRetries property

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

### See Also

* class [AIClientBase](../../aiclientbase)
* namespace [Aspose.Pdf.AI](../../aiclientbase)
* assembly [Aspose.PDF](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.PDF.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: PollingIntervalSeconds
second_title: Aspose.PDF for .NET API Reference
description:
type: docs
weight: 30
url: /net/aspose.pdf.ai/aiclientbase/pollingintervalseconds/
---
## AIClientBase.PollingIntervalSeconds property

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

### See Also

* class [AIClientBase](../../aiclientbase)
* namespace [Aspose.Pdf.AI](../../aiclientbase)
* assembly [Aspose.PDF](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.PDF.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: PollingTimeoutSeconds
second_title: Aspose.PDF for .NET API Reference
description:
type: docs
weight: 40
url: /net/aspose.pdf.ai/aiclientbase/pollingtimeoutseconds/
---
## AIClientBase.PollingTimeoutSeconds property

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

### See Also

* class [AIClientBase](../../aiclientbase)
* namespace [Aspose.Pdf.AI](../../aiclientbase)
* assembly [Aspose.PDF](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.PDF.dll -->
28 changes: 28 additions & 0 deletions english/net/aspose.pdf.ai/aiclientexception/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: AIClientException
second_title: Aspose.PDF for .NET API Reference
description:
type: docs
weight: 60
url: /net/aspose.pdf.ai/aiclientexception/
---
## AIClientException class

```csharp
public class AIClientException : PdfException
```

## Constructors

| Name | Description |
| --- | --- |
| [AIClientException](aiclientexception#constructor)(string) | |
| [AIClientException](aiclientexception#constructor_1)(stringException) | |

### See Also

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

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.PDF.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: AIClientException
second_title: Aspose.PDF for .NET API Reference
description:
type: docs
weight: 10
url: /net/aspose.pdf.ai/aiclientexception/aiclientexception/
---
## AIClientException(string) {#constructor}

```csharp
public AIClientException(string message)
```

### See Also

* class [AIClientException](../../aiclientexception)
* namespace [Aspose.Pdf.AI](../../aiclientexception)
* assembly [Aspose.PDF](../../../)

---

## AIClientException(string, Exception) {#constructor_1}

```csharp
public AIClientException(string message, Exception innerException)
```

### See Also

* class [AIClientException](../../aiclientexception)
* namespace [Aspose.Pdf.AI](../../aiclientexception)
* assembly [Aspose.PDF](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.PDF.dll -->
28 changes: 28 additions & 0 deletions english/net/aspose.pdf.ai/aicopilotexception/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: AICopilotException
second_title: Aspose.PDF for .NET API Reference
description:
type: docs
weight: 70
url: /net/aspose.pdf.ai/aicopilotexception/
---
## AICopilotException class

```csharp
public class AICopilotException : PdfException
```

## Constructors

| Name | Description |
| --- | --- |
| [AICopilotException](aicopilotexception#constructor)(string) | |
| [AICopilotException](aicopilotexception#constructor_1)(stringException) | |

### See Also

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

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.PDF.dll -->
Loading

0 comments on commit 6fd0378

Please sign in to comment.