Aspose.Pdf.AI

The Aspose.Pdf.AI namespace provides classes for AI functionalities, including API clients and intelligent assistants.

Classes

ClassDescription
AIClientBaseRepresents client to access AI API.
AIClientExceptionRepresents an exception specific to the AI Client operations.
AICopilotExceptionRepresents an exception specific to Copilots operations.
AICopilotFactoryFactory class for creating different types of copilots.
AnnotationRepresents the text content that is part of a message.
AssistantCreateRequestRequest object for creating an assistant.
AssistantListQueryParametersRepresents the query parameters object for listing assistants.
AssistantListResponseRepresents the response containing a list of assistant responses.
AssistantModifyRequestRequest object for modifying an assistant.
AssistantResponseRepresents an assistant that can call the model and use tools.
AttachmentRepresents a list of files attached to the message, and the tools they should be added to.
BaseListQueryParametersBase query parameters for listing objects.
BaseResponseBase class for API responses.
CancellationTokenExtensionsProvides extension methods for CancellationToken.
ChatMessageA chat completion message generated by the model.
ChatMessageResponseA chat completion message generated by the model.
ChoiceRepresents a choice in a chat completion response.
CodeInterpreterRepresents the code interpreter tool resources.
CompletionCreateRequestRepresents a request for the Create Chat Completion endpoint.
CompletionFunctionRepresents the function object.
CompletionResponseRepresents a chat completion response returned by model, based on the provided input.
CreateChatCompletionChunkResponseRepresents a streamed chunk of a chat completion response returned by model, based on the provided input.
CreateEmbeddingRequestRepresents a request for the Create Embeddings endpoint.
CreateEmbeddingResponseRepresents a response from the Create Embeddings endpoint.
CreateFineTuningJobRequestRepresents a request for the Create Fine-Tuning Job endpoint.
CreateFineTuningJobResponseRepresents a response from the Create Fine-Tuning Job endpoint.
DataResponse<T>Represents a data response containing the specified data.
DeleteStatusResponseRepresents the status of an object deletion.
DocumentCollectionRepresents a collection of documents to be processed.
EmbeddingRepresents an embedding vector returned by embedding endpoint.
ErrorRepresents an error in the API response.
ExpiresAfterRepresents the expiration policy for a vector store.
FileCitationRepresents the file citation.
FileContentResponse<T>
FileCounts
FileListResponseRepresents a file list response containing a list of file responses.
FileResponseThe FileResponse object represents a document that has been uploaded to OpenAI.
FileSearchRepresents the file search tool resources.
FunctionRepresents a function that can be called by the model.
HyperparametersRepresents the hyperparameters used for a fine-tuning job.
ImageDescriptionRepresents an image description.
ImageDescriptionResultRepresents the response containing image descriptions.
ImageFileRepresents an image File in the content of a message.
ImageUrlRepresents an image URL in the content of a message.
IncompleteDetailsDetails on why the run is incomplete. Will be null if the run is not incomplete.
LastErrorThe last error associated with this run. Will be null if there are no errors.
ListDataResponse<T>Represents a list data response containing additional information such as first and last IDs and whether there are more items.
LlamaChatCompletionRequestRepresents the request body for the ChatGPT API requests.
LlamaChatCompletionResponseRepresents a chat completion response returned by model, based on the provided input.
LlamaClientRepresents a client for interacting with the Llama API.
LlamaCopilotOptionsBaseRepresents the base options for configuring the LlamaCopilot.
LlamaModelsContains constants related to different Llama models.
LlamaSummaryCopilotProvides functionality for getting document summaries using AI models. Example usage of creating an Llama client, configuring options, and using the summary copilot. Note: This copilot uses completion API, so the total amount of text that can be sent is limited by the model context window.
LlamaSummaryCopilotOptionsRepresents the options for configuring the OpenAICopilot.
LogprobsRepresents log probability information for a choice.
MessageContentBaseThe content of the message in array of text and/or images.
MessageContentRequestThe content of the message in array of text and/or images.
MessageContentResponseThe content of the response message in array of text and/or images.
MessageCreationRepresents the creation of a message with its unique identifier.
OcrDetailRepresents the OCR result for a single page of a document or a single image file.
OpenAIAssistantCopilotOptionsBaseRepresents the base options for configuring the OpenAICopilots based on Assistants API.
OpenAIChatCopilotRepresents a chat copilot for interacting with documents via AI models. Example usage of creating an OpenAI client, configuring options, and using the ChatCopilot to interact with user queries and manage conversation context.
OpenAIChatCopilotOptionsRepresents the options for configuring the OpenAICopilot.
OpenAIClientProvides methods to interact with the OpenAI API for managing vector store file batches.
OpenAIContextRepresents the entity IDs related to an assistant.
OpenAICopilotOptionsBaseRepresents the base options for configuring the OpenAICopilot.
OpenAIImageDescriptionCopilotProvides image processing functionality for OpenAICopilot class. Example usage of creating an OpenAI client, configuration of ImageDescriptionCopilot options, and usage of the copilot to generate image descriptions and add descriptions to attached documents.
OpenAIImageDescriptionCopilotExtensionsProvides extension methods for OpenAIImageDescriptionCopilot class.
OpenAIImageDescriptionCopilotOptionsRepresents the options for configuring the OpenAICopilot.
OpenAIModelsContains the available OpenAI model identifiers.
OpenAIOcrCopilotProvides OCR capabilities to extract text from PDF documents and images. The supported image types: PNG (.png), JPEG (.jpeg and .jpg), WEBP (.webp), non-animated GIF (.gif). Example usage of creating an OpenAI client, configuring options, and using the OCR copilot.
OpenAIOcrCopilotOptionsRepresents the options for configuring the OpenAIOcrCopilot.
OpenAISummaryCopilotProvides functionality for getting document summaries using AI models. Example usage of creating an OpenAI client, configuring options, and using the summary copilot.
OpenAISummaryCopilotOptionsRepresents the options for configuring the OpenAICopilot.
PdfDocumentRepresents a PDF document with a name.
RequiredActionDetails on the action required to continue the run. Will be null if no action is required.
ResponseFormatRepresents the format of a response, which can be either a string value or an object value.
RunCreateRequestRepresents a request to create a run.
RunListQueryParametersQuery parameters object for listing runs.
RunListResponseRepresents a list response containing run data.
RunModifyRequestRepresents a request to modify a run.
RunResponseRepresents an execution run on a thread.
RunStepDetailsThe details of the run step.
RunStepListQueryParametersQuery parameters object for listing run steps.
RunStepListResponseRepresents a list response containing run step data.
RunStepResponseRepresents a step in execution of a run.
RunThreadCreateRequestRepresents a request to create a thread and run it in one request.
SubmitToolOutputsRepresents details on the tool outputs needed for the run to continue.
TextDocumentRepresents a text document with a name and content.
TextRecognitionResultRepresents the aggregated OCR results for a single source document.
TextResponseRepresents the text content that is part of a message.
ThreadCreateRequestRepresents a request to create a thread.
ThreadMessageCreateRequestRepresents a request to create a message within a thread.
ThreadMessageListQueryParametersQuery parameters object for listing thread messages.
ThreadMessageListResponseRepresents a list response containing thread message data.
ThreadMessageModifyRequestRepresents a request to modify a message within a thread.
ThreadMessageResponseRepresents a message within a thread.
ThreadModifyRequestRepresents a request to modify a thread.
ThreadResponseRepresents a thread that contains messages.
ToolRepresents a tool that can be called by the model.
ToolCallRepresents a tool call within a message.
ToolChoiceRepresents the ToolChoice, which can be either a string value or an object value.
ToolResourcesRepresents a set of resources that are used by the assistant’s tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.
TruncationStrategyRepresents the truncation strategy that controls for how a thread will be truncated prior to the run.
UsageRepresents usage statistics for a request.
VectorStoreA helper to create a vector store with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread.
VectorStoreCreateRequestCreate a vector store request.
VectorStoreFileBatchCreateRequestCreate a vector store file batch request.
VectorStoreFileBatchFileListQueryParametersQuery parameters object for listing vector store file batch files.
VectorStoreFileBatchFileListResponseRepresents a list response containing vector store file batch data.
VectorStoreFileBatchResponseThe vector store files batch response object.
VectorStoreFileCreateRequestCreate a vector store file request.
VectorStoreFileListQueryParametersQuery parameters object for listing vector store files.
VectorStoreFileListResponseRepresents a list response containing vector store file data.
VectorStoreFileResponseA vector store file response.
VectorStoreListQueryParametersQuery parameters object for listing vector stores.
VectorStoreListResponseRepresents a list response containing vector store data.
VectorStoreModifyRequestModify a vector store request.
VectorStoreResponseThe vector store object.

Interfaces

InterfaceDescription
IAIClientRepresents an interface for an AI client.
IAICopilotRepresents a copilot for AI interactions.
IChatClient<TOptions>Represents an interface for a chat client with specific options.
IChatCopilotRepresents a chat copilot for interacting with documents via AI models.
IChatCopilotOptions<TOptions>Represents an interface for chat copilot options with a specific type.
IEntityIdRepresents an entity with an ID.
IImageDescriptionClient<TOptions>Represents an interface for an image description client with specific options.
IImageDescriptionCopilotRepresents an image description copilot for extracting image descriptions using AI models.
IImageDescriptionCopilotOptions<TOptions>Represents an interface for image description copilot options with a specific type.
ILlamaClientRepresents a client interface for interacting with the Llama API.
IOcrClient<TOptions>Represents an interface for a OCR client with specific options.
IOcrCopilotRepresents an OCR copilot for processing scanned PDFs and images via AI models.
IOcrCopilotOptions<TOptions>Represents an interface for chat copilot options with a specific type.
IOpenAIClientRepresents a client interface for interacting with the OpenAI API, extending basic AI client functionalities.
IQueryParametersRepresents query parameters for API requests.
IStatusRepresents the status of an operation.
IStringOrObject<T>Represents an object that can be either a string value or an object value.
ISummaryClient<TOptions>Represents an interface for a summary client with specific options.
ISummaryCopilotRepresents a summary copilot for generating summaries for documents using AI models.
ISummaryCopilotOptions<TOptions>Represents an interface for summary copilot options with a specific type.

Enumeration

EnumerationDescription
DetailSpecifies the level of detail for image analysis.