Skip to content

Commit

Permalink
Update API reference for Aspose.PDF for .NET 24.11
Browse files Browse the repository at this point in the history
  • Loading branch information
@AlexBiriukov
AlexBiriukov committed Nov 21, 2024
1 parent fdd3d70 commit b38c6d6
Show file tree
Hide file tree
Showing 1,795 changed files with 10,089 additions and 7,041 deletions.
2 changes: 2 additions & 0 deletions english/net/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ 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** 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.Artifacts.Pagination](./aspose.pdf.artifacts.pagination/) | The **Aspose.Pdf.Artifacts.Pagination** namespace provides classes which are used for adding pagenumbering artifacts. |
| [Aspose.Pdf.Comparison](./aspose.pdf.comparison/) | |
| [Aspose.Pdf.Comparison.Diff](./aspose.pdf.comparison.diff/) | |
| [Aspose.Pdf.Comparison.GraphicalComparison](./aspose.pdf.comparison.graphicalcomparison/) | |
Expand All @@ -36,6 +37,7 @@ is_root: true
| [Aspose.Pdf.Printing](./aspose.pdf.printing/) | |
| [Aspose.Pdf.Printing.Extensions](./aspose.pdf.printing.extensions/) | |
| [Aspose.Pdf.Sanitization](./aspose.pdf.sanitization/) | The **Aspose.Pdf.Sanitization** is a namespace for sanitization operations. |
| [Aspose.Pdf.Security](./aspose.pdf.security/) | |
| [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
264 changes: 132 additions & 132 deletions english/net/aspose.pdf.ai/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,140 +12,140 @@ url: /net/aspose.pdf.ai/

| 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) | |
| [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. |
| [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 -->
18 changes: 9 additions & 9 deletions english/net/aspose.pdf.ai/aiclientbase/_index.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: AIClientBase
title: Class AIClientBase
second_title: Aspose.PDF for .NET API Reference
description:
description: Aspose.Pdf.AI.AIClientBase class.
type: docs
weight: 50
url: /net/aspose.pdf.ai/aiclientbase/
Expand All @@ -16,20 +16,20 @@ public abstract class AIClientBase : IDisposable

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

## Methods

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

### See Also

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

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

10 changes: 5 additions & 5 deletions english/net/aspose.pdf.ai/aiclientbase/backoffdelayseconds/_index.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: BackoffDelaySeconds
title: AIClientBase.BackoffDelaySeconds
second_title: Aspose.PDF for .NET API Reference
description:
description: AIClientBase property.
type: docs
weight: 10
url: /net/aspose.pdf.ai/aiclientbase/backoffdelayseconds/
Expand All @@ -14,8 +14,8 @@ public int BackoffDelaySeconds { get; set; }

### See Also

* class [AIClientBase](../../aiclientbase)
* namespace [Aspose.Pdf.AI](../../aiclientbase)
* class [AIClientBase](../)
* 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 b38c6d6

Please sign in to comment.