From 8889f7538252c5bfcca0659b5ab68548b5983910 Mon Sep 17 00:00:00 2001 From: AtchayaSekar28 Date: Thu, 2 Apr 2026 23:54:34 +0530 Subject: [PATCH 1/8] Updated the changes in AI agent tools --- Document-Processing-toc.html | 2 +- .../ai-agent-tools/customization.md | 1 + .../ai-agent-tools/getting-started.md | 1 + .../ai-agent-tools/overview.md | 1 + Document-Processing/ai-agent-tools/tools.md | 1104 +++++++++++++---- 5 files changed, 875 insertions(+), 234 deletions(-) diff --git a/Document-Processing-toc.html b/Document-Processing-toc.html index 467bc0619..dae53bd42 100644 --- a/Document-Processing-toc.html +++ b/Document-Processing-toc.html @@ -40,7 +40,7 @@ Customization
  • - Example prompts + Example Prompts
  • diff --git a/Document-Processing/ai-agent-tools/customization.md b/Document-Processing/ai-agent-tools/customization.md index 4d9f93843..3a6f92014 100644 --- a/Document-Processing/ai-agent-tools/customization.md +++ b/Document-Processing/ai-agent-tools/customization.md @@ -220,3 +220,4 @@ string systemPrompt = "You are an expert document-processing assistant with acce - [Overview](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/overview) - [Tools](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/tools) - [Getting Started](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/getting-started) +- [Example Prompts](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/example-prompts) diff --git a/Document-Processing/ai-agent-tools/getting-started.md b/Document-Processing/ai-agent-tools/getting-started.md index 62b06ab99..1a9581f2d 100644 --- a/Document-Processing/ai-agent-tools/getting-started.md +++ b/Document-Processing/ai-agent-tools/getting-started.md @@ -253,3 +253,4 @@ Any other provider that exposes an `IChatClient` (Ollama, Anthropic via adapters - [Overview](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/overview) - [Tools](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/tools) - [Customization](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/customization) +- [Example Prompts](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/example-prompts) diff --git a/Document-Processing/ai-agent-tools/overview.md b/Document-Processing/ai-agent-tools/overview.md index 7d894ac9e..4d135820c 100644 --- a/Document-Processing/ai-agent-tools/overview.md +++ b/Document-Processing/ai-agent-tools/overview.md @@ -81,3 +81,4 @@ The following NuGet packages are used in the application. - [Syncfusion Excel Library](https://help.syncfusion.com/document-processing/excel/excel-library/overview) - [Syncfusion PowerPoint Library](https://help.syncfusion.com/document-processing/powerpoint/powerpoint-library/overview) - [Data Extraction](https://help.syncfusion.com/document-processing/data-extraction/overview) +- [Example Prompts](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/example-prompts) diff --git a/Document-Processing/ai-agent-tools/tools.md b/Document-Processing/ai-agent-tools/tools.md index 122282999..ffea264cc 100644 --- a/Document-Processing/ai-agent-tools/tools.md +++ b/Document-Processing/ai-agent-tools/tools.md @@ -12,14 +12,43 @@ documentation: ug Agent Tools are the callable functions exposed to the AI agent. Each tool class is initialized with the appropriate manager. Tools are organized into the following categories: -| Category | Tool Classes | Description | -|---|---|---| -| **PDF** | PdfDocumentAgentTools,
    PdfOperationsAgentTools,
    PdfSecurityAgentTools,
    PdfContentExtractionAgentTools,
    PdfAnnotationAgentTools,
    PdfConverterAgentTools,
    PdfOcrAgentTools | Create, manipulate, secure, extract content from, annotate, convert, and perform OCR on PDF documents. | -| **Word** | WordDocumentAgentTools,
    WordOperationsAgentTools,
    WordSecurityAgentTools,
    WordMailMergeAgentTools,
    WordFindAndReplaceAgentTools,
    WordRevisionAgentTools,
    WordImportExportAgentTools,
    WordFormFieldAgentTools,
    WordBookmarkAgentTools | Create, edit, protect, mail-merge, find/replace, track changes, import/export, and manage form fields and bookmarks in Word documents. | -| **Excel** | ExcelWorkbookAgentTools,
    ExcelWorksheetAgentTools,
    ExcelSecurityAgentTools,
    ExcelFormulaAgentTools,
    ExcelChartAgentTools,
    ExcelConditionalFormattingAgentTools,
    ExcelConversionAgentTools,
    ExcelDataValidationAgentTools,
    ExcelPivotTableAgentTools | Create and manage workbooks and worksheets, set cell values, formulas, and number formats, apply security, create and configure charts and sparklines, add conditional formatting, convert to image/HTML/ODS/JSON, manage data validation, and create and manipulate pivot tables. | -| **PowerPoint** | PresentationDocumentAgentTools,
    PresentationOperationsAgentTools,
    PresentationSecurityAgentTools,
    PresentationContentAgentTools,
    PresentationFindAndReplaceAgentTools | Load, merge, split, secure, and extract content from PowerPoint presentations. | -| **Conversion** | OfficeToPdfAgentTools | Convert Word, Excel, and PowerPoint documents to PDF. | -| **Data Extraction** | DataExtractionAgentTools | Extract structured data (text, tables, forms) from PDF and image files as JSON. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CategoryTool ClassesDescription
    PDFPdfDocumentAgentTools,
    PdfOperationsAgentTools,
    PdfSecurityAgentTools,
    PdfContentExtractionAgentTools,
    PdfAnnotationAgentTools,
    PdfConverterAgentTools,
    PdfOcrAgentTools
    Create, manipulate, secure, extract content from, annotate, convert, and perform OCR on PDF documents.
    WordWordDocumentAgentTools,
    WordOperationsAgentTools,
    WordSecurityAgentTools,
    WordMailMergeAgentTools,
    WordFindAndReplaceAgentTools,
    WordRevisionAgentTools,
    WordImportExportAgentTools,
    WordFormFieldAgentTools,
    WordBookmarkAgentTools
    Create, edit, protect, mail-merge, find/replace, track changes, import/export, and manage form fields and bookmarks in Word documents.
    ExcelExcelWorkbookAgentTools,
    ExcelWorksheetAgentTools,
    ExcelSecurityAgentTools,
    ExcelFormulaAgentTools,
    ExcelChartAgentTools,
    ExcelConditionalFormattingAgentTools,
    ExcelConversionAgentTools,
    ExcelDataValidationAgentTools,
    ExcelPivotTableAgentTools
    Create and manage workbooks and worksheets, set cell values, formulas, and number formats, apply security, create and configure charts and sparklines, add conditional formatting, convert to image/HTML/JSON, manage data validation, and create and manipulate pivot tables.
    PowerPointPresentationDocumentAgentTools,
    PresentationOperationsAgentTools,
    PresentationSecurityAgentTools,
    PresentationContentAgentTools,
    PresentationFindAndReplaceAgentTools
    Load, merge, split, secure, and extract content from PowerPoint presentations.
    ConversionOfficeToPdfAgentToolsConvert Word, Excel, and PowerPoint documents to PDF.
    Data ExtractionDataExtractionAgentToolsExtract structured data (text, tables, forms) from PDF and image files as JSON.
    ## Document Managers @@ -28,12 +57,28 @@ Document Managers are in-memory containers that manage document life cycles duri **Available Document Managers** -| Document Manager | Description | -|---|---| -| WordDocumentManager | Manages Word documents in memory. Supports `.docx`, `.doc`, `.rtf`, `.html`, and `.txt` formats with auto-detection on import. | -| ExcelWorkbookManager | Manages Excel workbooks in memory. Owns an `ExcelEngine` instance and implements `IDisposable` for proper resource cleanup. Supports `.xlsx`, `.xls`, `.xlsm`, and `.csv` on export. | -| PdfDocumentManager | Manages PDF documents in memory. Supports both new `PdfDocument` instances and loaded `PdfLoadedDocument` instances, including password-protected files. | -| PresentationManager | Manages PowerPoint presentations in memory. Supports creating new empty presentations and loading existing `.pptx` files, including password-protected ones. | + + + + + + + + + + + + + + + + + + + + + +
    Document ManagerDescription
    WordDocumentManagerManages Word documents in memory. Supports .docx, .doc, .rtf, .html, and .txt formats with auto-detection on import.
    ExcelWorkbookManagerManages Excel workbooks in memory. Owns an ExcelEngine instance and implements IDisposable for proper resource cleanup. Supports .xlsx, .xls, .xlsm, and .csv on export.
    PdfDocumentManagerManages PDF documents in memory. Supports both new PdfDocument instances and loaded PdfLoadedDocument instances, including password-protected files.
    PresentationManagerManages PowerPoint presentations in memory. Supports creating new empty presentations and loading existing .pptx files, including password-protected ones.
    **DocumentManagerCollection** @@ -49,74 +94,203 @@ Document Managers are in-memory containers that manage document life cycles duri Provides core life cycle operations for PDF documents — creating, loading, exporting, and managing PDF documents in memory. -| Tool | Syntax | Description | -|---|---|---| -| CreatePdfDocument | CreatePdfDocument(
    string? filePath = null,
    string? password = null) | Creates a new PDF document in memory or loads an existing one from a file path. Returns the documentId. | -| GetAllPDFDocuments | GetAllPDFDocuments() | Returns all PDF document IDs currently available in memory. | -| ExportPDFDocument | ExportPDFDocument(
    string documentId,
    string filePath) | Exports a PDF document from memory to the specified file path on the file system. | -| RemovePdfDocument | RemovePdfDocument(
    string documentId) | Removes a specific PDF document from memory by its ID. | -| SetActivePdfDocument | SetActivePdfDocument(
    string documentId) | Changes the active PDF document context to the specified document ID. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    CreatePdfDocumentCreatePdfDocument(
    string? filePath = null,
    string? password = null)
    Creates a new PDF document in memory or loads an existing one from a file path. Returns the documentId.
    GetAllPDFDocumentsGetAllPDFDocuments()Returns all PDF document IDs currently available in memory.
    ExportPDFDocumentExportPDFDocument(
    string documentId,
    string filePath)
    Exports a PDF document from memory to the specified file path on the file system.
    RemovePdfDocumentRemovePdfDocument(
    string documentId)
    Removes a specific PDF document from memory by its ID.
    SetActivePdfDocumentSetActivePdfDocument(
    string documentId)
    Changes the active PDF document context to the specified document ID.
    **PdfOperationsAgentTools** Provides merge, split, and compression operations for PDF documents. -| Tool | Syntax | Description | -|---|---|---| -| MergePdfs | MergePdfs(
    string[] filePaths,
    string[]? passwords = null,
    bool mergeAccessibilityTags = false) | Concatenates multiple PDF files into a single PDF document. Returns the merged document ID. | -| SplitPdfs | SplitPdfs(
    string filePath,
    int[,]? pageRanges = null,
    bool splitTags = false) | Splits a single PDF into multiple PDFs by page ranges. Returns the output folder path. | -| CompressPdf | CompressPdf(
    string documentId,
    bool compressImage = true,
    bool optimizePageContent = true,
    bool optimizeFont = true,
    bool removeMetadata = true,
    int imageQuality = 50) | Optimizes a PDF by compressing images, reducing content stream size, and optionally removing metadata. | + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    MergePdfsMergePdfs(
    string[] filePaths,
    string[]? passwords = null,
    bool mergeAccessibilityTags = false)
    Concatenates multiple PDF files into a single PDF document. Returns the merged documentId.
    SplitPdfsSplitPdfs(
    string filePath,
    int[,]? pageRanges = null,
    bool splitTags = false)
    Splits a single PDF into multiple PDFs by page ranges. Returns the output folder path.
    CompressPdfCompressPdf(
    string documentId,
    bool compressImage = true,
    bool optimizePageContent = true,
    bool optimizeFont = true,
    bool removeMetadata = true,
    int imageQuality = 50)
    Optimizes a PDF by compressing images, reducing content stream size, and optionally removing metadata.
    **PdfSecurityAgentTools** Provides encryption, decryption, and permissions management for PDF documents. -| Tool | Syntax | Description | -|---|---|---| -| EncryptPdf | EncryptPdf(
    string documentId,
    string password,
    string encryptionAlgorithm = "AES",
    string keySize = "256") | Protects a PDF document with a password using the specified encryption algorithm and key size. | -| DecryptPdf | DecryptPdf(
    string documentId) | Removes encryption from a protected PDF document. | -| SetPermissions | SetPermissions(
    string documentId,
    string permissions) | Sets document permissions (e.g., Print, CopyContent, EditContent). | -| RemovePermissions | RemovePermissions(
    string documentId) | Removes all document-level permissions from a PDF. | + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    EncryptPdfEncryptPdf(
    string documentId,
    string password,
    string encryptionAlgorithm = "AES",
    string keySize = "256")
    Protects a PDF document with a password using the specified encryption algorithm and key size.
    DecryptPdfDecryptPdf(
    string documentId)
    Removes encryption from a protected PDF document.
    SetPermissionsSetPermissions(
    string documentId,
    string permissions)
    Sets document permissions (e.g., Print, CopyContent, EditContent).
    RemovePermissionsRemovePermissions(
    string documentId)
    Removes all document-level permissions from a PDF.
    **PdfContentExtractionAgentTools** Provides tools for extracting text, images, and tables from PDF documents. -| Tool | Syntax | Description | -|---|---|---| -| ExtractText | ExtractText(
    string documentId,
    int startPageIndex = -1,
    int endPageIndex = -1) | Extracts text content from a PDF document across a specified page range, or from all pages if no range is given. | -| ExtractImages | ExtractImages(
    string documentId,
    int startPageIndex = -1,
    int endPageIndex = -1) | Extracts embedded images from a PDF document across a specified page range. | -| ExtractTables | ExtractTables(
    string documentId,
    int startPageIndex = -1,
    int endPageIndex = -1) | Extracts tables from a PDF document across a specified page range and returns the result as JSON. | + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    ExtractTextExtractText(
    string documentId,
    int startPageIndex = -1,
    int endPageIndex = -1)
    Extracts text content from a PDF document across a specified page range, or from all pages if no range is given.
    ExtractImagesExtractImages(
    string documentId,
    int startPageIndex = -1,
    int endPageIndex = -1)
    Extracts embedded images from a PDF document across a specified page range.
    ExtractTablesExtractTables(
    string documentId,
    int startPageIndex = -1,
    int endPageIndex = -1)
    Extracts tables from a PDF document across a specified page range and returns the result as JSON.
    **PdfAnnotationAgentTools** Provides tools for watermarking, digitally signing, and adding or removing annotations in PDF documents. -| Tool | Syntax | Description | -|---|---|---| -| WatermarkPdf | WatermarkPdf(
    string documentId,
    string watermarkText,
    int rotation = 45,
    float locationX = -1,
    float locationY = -1) | Applies a text watermark to all pages of a PDF document. | -| SignPdf | SignPdf(
    string documentId,
    string certificateFilePath,
    string certificatePassword,
    float boundsX,
    float boundsY,
    float boundsWidth,
    float boundsHeight,
    string? appearanceImagePath = null) | Digitally signs a PDF document using a PFX/certificate file. | -| AddAnnotation | AddAnnotation(
    string documentId,
    int pageIndex,
    string annotationType,
    float boundsX,
    float boundsY,
    float boundsWidth,
    float boundsHeight,
    string text) | Adds a `Text`, `Rectangle`, or `Circle` annotation to a PDF page at the specified position. | -| RemoveAnnotation | RemoveAnnotation(
    string documentId,
    int pageIndex,
    int annotationIndex) | Removes an annotation from a PDF page by its 0-based index. | + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    WatermarkPdfWatermarkPdf(
    string documentId,
    string watermarkText,
    int rotation = 45,
    float locationX = -1,
    float locationY = -1)
    Applies a text watermark to all pages of a PDF document.
    SignPdfSignPdf(
    string documentId,
    string certificateFilePath,
    string certificatePassword,
    float boundsX,
    float boundsY,
    float boundsWidth,
    float boundsHeight,
    string? appearanceImagePath = null)
    Digitally signs a PDF document using a PFX/certificate file.
    AddAnnotationAddAnnotation(
    string documentId,
    int pageIndex,
    string annotationType,
    float boundsX,
    float boundsY,
    float boundsWidth,
    float boundsHeight,
    string text)
    Adds a Text, Rectangle, or Circle annotation to a PDF page at the specified position.
    RemoveAnnotationRemoveAnnotation(
    string documentId,
    int pageIndex,
    int annotationIndex)
    Removes an annotation from a PDF page by its 0-based index.
    **PdfConverterAgentTools** Provides tools to convert image, HTML to Pdf -| Tool | Syntax | Description | -|---|---|---| -| ConvertPdfToPdfA | ConvertPdfToPdfA(
    string documentId,
    PdfConformanceLevel conformanceLevel) | Converts a loaded PDF document to a PDF/A-compliant format. Supported conformance levels: `PdfA1B`, `PdfA2B`, `PdfA3B`, `Pdf_A4`, `Pdf_A4F`, `Pdf_A4E`. | -| ConvertHtmlToPdf | ConvertHtmlToPdf(
    string urlOrFilePath,
    int pageWidth = 825,
    int pageHeight = 1100) | Converts a webpage URL or a local HTML file to a PDF document with the specified page dimensions. Returns the new document ID. | -| ImageToPdf | ImageToPdf(
    string[] imageFiles,
    string imagePosition = "FitToPage",
    int pageWidth = 612,
    int pageHeight = 792) | Creates a PDF document from one or more image files. `imagePosition` values: `Stretch`, `Center`, `FitToPage`. Returns the new document ID. | + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    ConvertPdfToPdfAConvertPdfToPdfA(
    string documentId,
    PdfConformanceLevel conformanceLevel)
    Converts a loaded PDF document to a PDF/A-compliant format. Supported conformance levels: PdfA1B, PdfA2B, PdfA3B, Pdf_A4, Pdf_A4F, Pdf_A4E.
    ConvertHtmlToPdfConvertHtmlToPdf(
    string urlOrFilePath,
    int pageWidth = 825,
    int pageHeight = 1100)
    Converts a webpage URL or a local HTML file to a PDF document with the specified page dimensions. Returns the new document ID.
    ImageToPdfImageToPdf(
    string[] imageFiles,
    string imagePosition = "FitToPage",
    int pageWidth = 612,
    int pageHeight = 792)
    Creates a PDF document from one or more image files. imagePosition values: Stretch, Center, FitToPage. Returns the new documentId.
    **PdfOcrAgentTools** Provides tools to perform OCR on PDF -| Tool | Syntax | Description | -|---|---|---| -| OcrPdf | OcrPdf(
    string documentId,
    string language = "eng") | Performs Optical Character Recognition (OCR) on a scanned or image-based PDF document to make its content text-searchable. Supported language codes: `eng` (English), etc.| + + + + + + + + + + + + +
    ToolSyntaxDescription
    OcrPdfOcrPdf(
    string documentId,
    string language = "eng")
    Performs Optical Character Recognition (OCR) on a scanned or image-based PDF document to make its content text-searchable. Supported language codes: eng (English), etc.
    ## Word Tools @@ -125,14 +299,43 @@ Provides tools to perform OCR on PDF Provides core life cycle operations for Word documents — creating, loading, exporting, and managing Word documents in memory. -| Tool | Syntax | Description | -|---|---|---| -| CreateDocument | CreateDocument(
    string? filePath = null,
    string? password = null) | Creates a new Word document in memory or loads an existing one from a file path. Returns the `documentId`. | -| GetAllDocuments | GetAllDocuments() | Returns all Word document IDs currently available in memory. | -| ExportDocument | ExportDocument(
    string documentId,
    string filePath,
    string? formatType = "Docx") | Exports a Word document to the file system. Supported formats: `Docx`, `Doc`, `Rtf`, `Html`, `Txt`. | -| RemoveDocument | RemoveDocument(
    string documentId) | Removes a specific Word document from memory by its ID. | -| SetActiveDocument | SetActiveDocument(
    string documentId) | Changes the active Word document context to the specified document ID. | -| ExportAsImage | ExportAsImage(
    string documentId,
    string? imageFormat = "Png",
    int? startPageIndex = null,
    int? endPageIndex = null) | Exports Word document pages as PNG or JPEG images to the output directory. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    CreateDocumentCreateDocument(
    string? filePath = null,
    string? password = null)
    Creates a new Word document in memory or loads an existing one from a file path. Returns the documentId.
    GetAllDocumentsGetAllDocuments()Returns all Word document IDs currently available in memory.
    ExportDocumentExportDocument(
    string documentId,
    string filePath,
    string? formatType = "Docx")
    Exports a Word document to the file system. Supported formats: Docx, Doc, Rtf, Html, Txt.
    RemoveDocumentRemoveDocument(
    string documentId)
    Removes a specific Word document from memory by its ID.
    SetActiveDocumentSetActiveDocument(
    string documentId)
    Changes the active Word document context to the specified document ID.
    ExportAsImageExportAsImage(
    string documentId,
    string? imageFormat = "Png",
    int? startPageIndex = null,
    int? endPageIndex = null)
    Exports Word document pages as PNG or JPEG images to the output directory.
    @@ -140,11 +343,28 @@ Provides core life cycle operations for Word documents — creating, loading, ex Provides merge, split, and compare operations for Word documents. -| Tool | Syntax | Description | -|---|---|---| -| MergeDocuments | MergeDocuments(
    string destinationDocumentId,
    string[] documentIdsOrFilePaths) | Merges multiple Word documents into a single destination document. | -| SplitDocument | SplitDocument(
    string documentId,
    string splitRules) | Splits a Word document into multiple documents based on split rules (e.g., sections, headings, bookmarks). | -| CompareDocuments | CompareDocuments(
    string originalDocumentId,
    string revisedDocumentId,
    string author,
    DateTime dateTime) | Compares two Word documents and marks differences as tracked changes in the original document. | + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    MergeDocumentsMergeDocuments(
    string destinationDocumentId,
    string[] documentIdsOrFilePaths)
    Merges multiple Word documents into a single destination document.
    SplitDocumentSplitDocument(
    string documentId,
    string splitRules)
    Splits a Word document into multiple documents based on split rules (e.g., sections, headings, bookmarks).
    CompareDocumentsCompareDocuments(
    string originalDocumentId,
    string revisedDocumentId,
    string author,
    DateTime dateTime)
    Compares two Word documents and marks differences as tracked changes in the original document.
    @@ -152,12 +372,33 @@ Provides merge, split, and compare operations for Word documents. Provides password protection, encryption, and decryption for Word documents. -| Tool | Syntax | Description | -|---|---|---| -| ProtectDocument | ProtectDocument(
    string documentId,
    string password,
    string protectionType) | Protects a Word document with a password and protection type (e.g., `AllowOnlyReading`). | -| EncryptDocument | EncryptDocument(
    string documentId,
    string password) | Encrypts a Word document with a password. | -| UnprotectDocument | UnprotectDocument(
    string documentId,
    string password) | Removes protection from a Word document using the provided password. | -| DecryptDocument | DecryptDocument(
    string documentId) | Removes encryption from a Word document. | + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    ProtectDocumentProtectDocument(
    string documentId,
    string password,
    string protectionType)
    Protects a Word document with a password and protection type (e.g., AllowOnlyReading).
    EncryptDocumentEncryptDocument(
    string documentId,
    string password)
    Encrypts a Word document with a password.
    UnprotectDocumentUnprotectDocument(
    string documentId,
    string password)
    Removes protection from a Word document using the provided password.
    DecryptDocumentDecryptDocument(
    string documentId)
    Removes encryption from a Word document.
    @@ -165,10 +406,23 @@ Provides password protection, encryption, and decryption for Word documents. Provides mail merge operations for populating Word document templates with structured data. -| Tool | Syntax | Description | -|---|---|---| -| MailMerge | MailMerge(
    string documentId,
    string dataTableJson,
    bool removeEmptyFields = true,
    bool removeEmptyGroup = true) | Executes a mail merge on a Word document using a JSON-represented DataTable. | -| ExecuteMailMerge | ExecuteMailMerge(
    string documentId,
    string dataSourceJson,
    bool generateSeparateDocuments = false,
    bool removeEmptyFields = true) | Extended mail merge with an option to generate one output document per data record. Returns document IDs. | + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    MailMergeMailMerge(
    string documentId,
    string dataTableJson,
    bool removeEmptyFields = true,
    bool removeEmptyGroup = true)
    Executes a mail merge on a Word document using a JSON-represented DataTable.
    ExecuteMailMergeExecuteMailMerge(
    string documentId,
    string dataSourceJson,
    bool generateSeparateDocuments = false,
    bool removeEmptyFields = true)
    Extended mail merge with an option to generate one output document per data record. Returns document IDs.
    @@ -176,25 +430,71 @@ Provides mail merge operations for populating Word document templates with struc Provides text search and replacement operations within Word documents. -| Tool | Syntax | Description | -|---|---|---| -| Find | Find(
    string documentId,
    string findWhat,
    bool matchCase = false,
    bool wholeWord = false) | Finds the first occurrence of the specified text in a Word document. | -| FindAll | FindAll(
    string documentId,
    string findWhat,
    bool matchCase = false,
    bool wholeWord = false) | Finds all occurrences of the specified text in a Word document. | -| Replace | Replace(
    string documentId,
    string findWhat,
    string replaceText,
    bool matchCase = false,
    bool wholeWord = false) | Replaces the first occurrence of the specified text in a Word document. | -| ReplaceAll | ReplaceAll(
    string documentId,
    string findWhat,
    string replaceText,
    bool matchCase = false,
    bool wholeWord = false) | Replaces all occurrences of the specified text in a Word document. Returns the count of replacements made. | + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    FindFind(
    string documentId,
    string findWhat,
    bool matchCase = false,
    bool wholeWord = false)
    Finds the first occurrence of the specified text in a Word document.
    FindAllFindAll(
    string documentId,
    string findWhat,
    bool matchCase = false,
    bool wholeWord = false)
    Finds all occurrences of the specified text in a Word document.
    ReplaceReplace(
    string documentId,
    string findWhat,
    string replaceText,
    bool matchCase = false,
    bool wholeWord = false)
    Replaces the first occurrence of the specified text in a Word document.
    ReplaceAllReplaceAll(
    string documentId,
    string findWhat,
    string replaceText,
    bool matchCase = false,
    bool wholeWord = false)
    Replaces all occurrences of the specified text in a Word document. Returns the count of replacements made.
    **WordRevisionAgentTools** Provides tools to inspect and manage tracked changes (revisions) in Word documents. -| Tool | Syntax | Description | -|---|---|---| -| GetRevisions | GetRevisions(
    string documentId) | Gets all tracked change revisions from a Word document. | -| AcceptRevision | AcceptRevision(
    string documentId,
    int revisionIndex) | Accepts a specific tracked change by its 0-based index. | -| RejectRevision | RejectRevision(
    string documentId,
    int revisionIndex) | Rejects a specific tracked change by its 0-based index. | -| AcceptAllRevisions | AcceptAllRevisions(
    string documentId) | Accepts all tracked changes in the document and returns the count accepted. | -| RejectAllRevisions | RejectAllRevisions(
    string documentId) | Rejects all tracked changes in the document and returns the count rejected. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    GetRevisionsGetRevisions(
    string documentId)
    Gets all tracked change revisions from a Word document.
    AcceptRevisionAcceptRevision(
    string documentId,
    int revisionIndex)
    Accepts a specific tracked change by its 0-based index.
    RejectRevisionRejectRevision(
    string documentId,
    int revisionIndex)
    Rejects a specific tracked change by its 0-based index.
    AcceptAllRevisionsAcceptAllRevisions(
    string documentId)
    Accepts all tracked changes in the document and returns the count accepted.
    RejectAllRevisionsRejectAllRevisions(
    string documentId)
    Rejects all tracked changes in the document and returns the count rejected.
    @@ -202,13 +502,38 @@ Provides tools to inspect and manage tracked changes (revisions) in Word documen Provides tools to import from and export Word documents to HTML and Markdown formats. -| Tool | Syntax | Description | -|---|---|---| -| ImportHtml | ImportHtml(
    string htmlContentOrFilePath,
    string? documentId = null) | Imports HTML content or an HTML file into a (new or existing) Word document. | -| ImportMarkdown | ImportMarkdown(
    string markdownContentOrFilePath,
    string? documentId = null) | Imports Markdown content or a Markdown file into a (new or existing) Word document. | -| GetHtml | GetHtml(
    string documentIdOrFilePath) | Returns the Word document content as an HTML string. | -| GetMarkdown | GetMarkdown(
    string documentIdOrFilePath) | Returns the Word document content as a Markdown string. | -| GetText | GetText(
    string documentIdOrFilePath) | Returns the Word document content as plain text. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    ImportHtmlImportHtml(
    string htmlContentOrFilePath,
    string? documentId = null)
    Imports HTML content or an HTML file into a (new or existing) Word document.
    ImportMarkdownImportMarkdown(
    string markdownContentOrFilePath,
    string? documentId = null)
    Imports Markdown content or a Markdown file into a (new or existing) Word document.
    GetHtmlGetHtml(
    string documentIdOrFilePath)
    Returns the Word document content as an HTML string.
    GetMarkdownGetMarkdown(
    string documentIdOrFilePath)
    Returns the Word document content as a Markdown string.
    GetTextGetText(
    string documentIdOrFilePath)
    Returns the Word document content as plain text.
    @@ -216,12 +541,33 @@ Provides tools to import from and export Word documents to HTML and Markdown for Provides tools to read and write form field values in Word documents. -| Tool | Syntax | Description | -|---|---|---| -| GetFormData | GetFormData(
    string documentId) | Retrieves all form field data from a Word document as a key-value dictionary. | -| SetFormData | SetFormData(
    string documentId,
    Dictionary data) | Sets multiple form field values in a Word document from a dictionary. | -| GetFormField | GetFormField(
    string documentId,
    string fieldName) | Gets the value of a specific form field by name. | -| SetFormField | SetFormField(
    string documentId,
    string fieldName,
    object fieldValue) | Sets the value of a specific form field by name. | + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    GetFormDataGetFormData(
    string documentId)
    Retrieves all form field data from a Word document as a key-value dictionary.
    SetFormDataSetFormData(
    string documentId,
    Dictionary<string, object> data)
    Sets multiple form field values in a Word document from a dictionary.
    GetFormFieldGetFormField(
    string documentId,
    string fieldName)
    Gets the value of a specific form field by name.
    SetFormFieldSetFormField(
    string documentId,
    string fieldName,
    object fieldValue)
    Sets the value of a specific form field by name.
    @@ -229,13 +575,38 @@ Provides tools to read and write form field values in Word documents. Provides tools to manage bookmarks and bookmark content within Word documents. -| Tool | Syntax | Description | -|---|---|---| -| GetBookmarks | GetBookmarks(
    string documentId) | Gets all bookmark names from a Word document. | -| GetContent | GetContent(
    string documentId,
    string bookmarkName) | Extracts the content inside a bookmark into a new document. Returns the new document ID. | -| ReplaceContent | ReplaceContent(
    string documentId,
    string bookmarkName,
    string replaceDocumentId) | Replaces bookmark content with content sourced from another document. | -| RemoveContent | RemoveContent(
    string documentId,
    string bookmarkName) | Removes the content inside a specific bookmark, leaving the bookmark itself intact. | -| RemoveBookmark | RemoveBookmark(
    string documentId,
    string bookmarkName) | Removes a named bookmark from a Word document. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    GetBookmarksGetBookmarks(
    string documentId)
    Gets all bookmark names from a Word document.
    GetContentGetContent(
    string documentId,
    string bookmarkName)
    Extracts the content inside a bookmark into a new document. Returns the new document ID.
    ReplaceContentReplaceContent(
    string documentId,
    string bookmarkName,
    string replaceDocumentId)
    Replaces bookmark content with content sourced from another document.
    RemoveContentRemoveContent(
    string documentId,
    string bookmarkName)
    Removes the content inside a specific bookmark, leaving the bookmark itself intact.
    RemoveBookmarkRemoveBookmark(
    string documentId,
    string bookmarkName)
    Removes a named bookmark from a Word document.
    ## Excel Tools @@ -244,26 +615,61 @@ Provides tools to manage bookmarks and bookmark content within Word documents. Provides core life cycle operations for Excel workbooks — creating, loading, exporting, and managing workbooks in memory. -| Tool | Syntax | Description | -|---|---|---| -| CreateWorkbook | CreateWorkbook(
    string? filePath = null,
    string? password = null) | Creates a new Excel workbook in memory or loads an existing one from a file path. Returns the `workbookId`. | -| GetAllWorkbooks | GetAllWorkbooks() | Returns all Excel workbook IDs currently available in memory. | -| ExportWorkbook | ExportWorkbook(
    string workbookId,
    string filePath,
    string version = "XLSX") | Exports an Excel workbook to the file system. Supported formats: `XLS`, `XLSX`, `XLSM`, `CSV`. | -| RemoveWorkbook | RemoveWorkbook(
    string workbookId) | Removes a specific workbook from memory by its ID. | -| SetActiveWorkbook | SetActiveWorkbook(
    string workbookId) | Changes the active workbook context to the specified workbook ID. | + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    CreateWorkbookCreateWorkbook(
    string? filePath = null,
    string? password = null)
    Creates a new Excel workbook in memory or loads an existing one from a file path. Returns the workbookId.
    ExportWorkbookExportWorkbook(
    string workbookId,
    string filePath,
    string version = "XLSX")
    Exports an Excel workbook to the file system. Supported formats: XLS, XLSX, XLSM, CSV.
    **ExcelWorksheetAgentTools** Provides tools to create, manage, and populate worksheets within Excel workbooks. -| Tool | Syntax | Description | -|---|---|---| -| CreateWorksheet | CreateWorksheet(
    string workbookId,
    string? sheetName = null) | Creates a new worksheet inside the specified workbook. | -| GetWorksheets | GetWorksheets(
    string workbookId) | Returns all worksheet names in a workbook. | -| RenameWorksheet | RenameWorksheet(
    string workbookId,
    string oldName,
    string newName) | Renames a worksheet in the workbook. | -| DeleteWorksheet | DeleteWorksheet(
    string workbookId,
    string worksheetName) | Deletes a worksheet from the workbook. | -| SetValue | SetValue(
    string workbookId,
    string worksheetName,
    string cellAddress,
    string data) | Assigns a data value to a cell (supports text, numbers, dates, and booleans). | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    CreateWorksheetCreateWorksheet(
    string workbookId,
    string? sheetName = null)
    Creates a new worksheet inside the specified workbook.
    RenameWorksheetRenameWorksheet(
    string workbookId,
    string oldName,
    string newName)
    Renames a worksheet in the workbook.
    DeleteWorksheetDeleteWorksheet(
    string workbookId,
    string worksheetName)
    Deletes a worksheet from the workbook.
    SetValueSetValue(
    string workbookId,
    string worksheetName,
    string cellAddress,
    string data)
    Assigns a data value to a cell (supports text, numbers, dates, and booleans).
    SetNumberFormatSetNumberFormat(
    string workbookId,
    string worksheetName,
    string cellAddress,
    string numberFormat)
    Assigns a number format to a cell in a worksheet (e.g., mm/dd/yyyy).
    @@ -271,14 +677,43 @@ Provides tools to create, manage, and populate worksheets within Excel workbooks Provides encryption, decryption, and protection management for Excel workbooks and worksheets. -| Tool | Syntax | Description | -|---|---|---| -| EncryptWorkbook | EncryptWorkbook(
    string workbookId,
    string password) | Encrypts an Excel workbook with a password. | -| DecryptWorkbook | DecryptWorkbook(
    string workbookId,
    string password) | Removes encryption from an Excel workbook using the provided password. | -| ProtectWorkbook | ProtectWorkbook(
    string workbookId,
    string password) | Protects the workbook structure (sheets) with a password. | -| UnprotectWorkbook | UnprotectWorkbook(
    string workbookId,
    string password) | Removes workbook structure protection. | -| ProtectWorksheet | ProtectWorksheet(
    string workbookId,
    string worksheetName,
    string password) | Protects a specific worksheet from editing using a password. | -| UnprotectWorksheet | UnprotectWorksheet(
    string workbookId,
    string worksheetName,
    string password) | Removes protection from a specific worksheet. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    EncryptWorkbookEncryptWorkbook(
    string workbookId,
    string password)
    Encrypts an Excel workbook with a password.
    DecryptWorkbookDecryptWorkbook(
    string workbookId,
    string password)
    Removes encryption from an Excel workbook using the provided password.
    ProtectWorkbookProtectWorkbook(
    string workbookId,
    string password)
    Protects the workbook structure (sheets) with a password.
    UnprotectWorkbookUnprotectWorkbook(
    string workbookId,
    string password)
    Removes workbook structure protection.
    ProtectWorksheetProtectWorksheet(
    string workbookId,
    string worksheetName,
    string password)
    Protects a specific worksheet from editing using a password.
    UnprotectWorksheetUnprotectWorksheet(
    string workbookId,
    string worksheetName,
    string password)
    Removes protection from a specific worksheet.
    @@ -286,12 +721,28 @@ Provides encryption, decryption, and protection management for Excel workbooks a Provides tools to set, retrieve, calculate and validate cell formulas in Excel workbooks. -| Tool | Syntax | Description | -|---|---|---| -| SetFormula | SetFormula(
    string workbookId,
    string worksheetName,
    string cellAddress,
    string formula) | Assigns a formula to a cell in the worksheet (e.g., `=SUM(A1:A10)`). | -| GetFormula | GetFormula(
    string workbookId,
    int worksheetIndex,
    string cellAddress) | Retrieves the formula string from a specific cell. | -| CalculateFormulas | CalculateFormulas(
    string workbookId) | Forces recalculation of all formulas in the workbook. | -| ValidateFormulas | ValidateFormulas(
    string workbookId) | Validates all formulas in the workbook and returns any errors as JSON. | + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    SetFormulaSetFormula(
    string workbookId,
    string worksheetName,
    string cellAddress,
    string formula)
    Assigns a formula to a cell in the worksheet (e.g., =SUM(A1:A10)).
    GetFormulaGetFormula(
    string workbookId,
    int worksheetIndex,
    string cellAddress)
    Retrieves the formula string from a specific cell.
    CalculateFormulasCalculateFormulas(
    string workbookId)
    Forces recalculation of all formulas in the workbook.
    @@ -299,95 +750,165 @@ Provides tools to set, retrieve, calculate and validate cell formulas in Excel w Provides tools to create modify and remove charts in excel workbooks -| Tool | Syntax | Description | -|---|---|---| -| CreateChart | CreateChart(
    string workbookId,
    string worksheetName,
    string chartType,
    string dataRange,
    bool isSeriesInRows = false,
    int topRow = 8,
    int leftColumn = 1,
    int bottomRow = 23,
    int rightColumn = 8) | Creates a chart from a data range in the worksheet. Supports many chart types (e.g., `Column_Clustered`, `Line`, `Pie`, `Bar_Clustered`). Returns the chart index. | -| CreateChartWithSeries | CreateChartWithSeries(
    string workbookId,
    string worksheetName,
    string chartType,
    string seriesName,
    string valuesRange,
    string categoryLabelsRange,
    int topRow = 8,
    int leftColumn = 1,
    int bottomRow = 23,
    int rightColumn = 8) | Creates a chart and adds a named series with values and category labels. Returns the chart index. | -| AddSeriesToChart | AddSeriesToChart(
    string workbookId,
    string worksheetName,
    int chartIndex,
    string seriesName,
    string valuesRange,
    string categoryLabelsRange) | Adds a new series to an existing chart. | -| SetChartTitle | SetChartTitle(
    string workbookId,
    string worksheetName,
    int chartIndex,
    string title) | Sets the title text of a chart. | -| SetChartLegend | SetChartLegend(
    string workbookId,
    string worksheetName,
    int chartIndex,
    bool hasLegend,
    string position = "Bottom") | Configures the chart legend visibility and position (`Bottom`, `Top`, `Left`, `Right`, `Corner`). | -| SetDataLabels | SetDataLabels(
    string workbookId,
    string worksheetName,
    int chartIndex,
    int seriesIndex,
    bool showValue = true,
    bool showCategoryName = false,
    bool showSeriesName = false,
    string position = "Outside") | Configures data labels for a chart series. | -| SetChartPosition | SetChartPosition(
    string workbookId,
    string worksheetName,
    int chartIndex,
    int topRow,
    int leftColumn,
    int bottomRow,
    int rightColumn) | Sets the position and size of a chart in the worksheet. | -| SetAxisTitles | SetAxisTitles(
    string workbookId,
    string worksheetName,
    int chartIndex,
    string? categoryAxisTitle = null,
    string? valueAxisTitle = null) | Sets titles for the category (horizontal) and value (vertical) axes. | -| RemoveChart | RemoveChart(
    string workbookId,
    string worksheetName,
    int chartIndex) | Removes a chart from the worksheet by its 0-based index. | -| GetChartCount | GetChartCount(
    string workbookId,
    string worksheetName) | Returns the number of charts in a worksheet. | -| CreateSparkline | CreateSparkline(
    string workbookId,
    string worksheetName,
    string sparklineType,
    string dataRange,
    string referenceRange) | Creates sparkline charts in worksheet cells. Types: `Line`, `Column`, `WinLoss`. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    CreateChartCreateChart(
    string workbookId,
    string worksheetName,
    string chartType,
    string dataRange,
    bool isSeriesInRows = false,
    int topRow = 8,
    int leftColumn = 1,
    int bottomRow = 23,
    int rightColumn = 8)
    Creates a chart from a data range in the worksheet. Supports many chart types (e.g., Column_Clustered, Line, Pie, Bar_Clustered). Returns the chart index.
    CreateChartWithSeriesCreateChartWithSeries(
    string workbookId,
    string worksheetName,
    string chartType,
    string seriesName,
    string valuesRange,
    string categoryLabelsRange,
    int topRow = 8,
    int leftColumn = 1,
    int bottomRow = 23,
    int rightColumn = 8)
    Creates a chart and adds a named series with values and category labels. Returns the chart index.
    AddSeriesToChartAddSeriesToChart(
    string workbookId,
    string worksheetName,
    int chartIndex,
    string seriesName,
    string valuesRange,
    string categoryLabelsRange)
    Adds a new series to an existing chart.
    SetChartElementSetChartElement(
    string workbookId,
    string worksheetName,
    int chartIndex,
    int seriesIndex,
    string title,
    bool hasLegend,
    string position = "Bottom",
    bool showValue = true,
    bool showCategoryName = false,
    bool showSeriesName = false,
    string dataLabelPosition = "Outside",
    string? categoryAxisTitle = null,
    string? valueAxisTitle = null)
    Sets chart elements including title, legend, data labels, and axis titles. position (legend): Bottom, Top, Left, Right, Corner. dataLabelPosition: Outside, Inside, Center, etc.
    SetChartPositionSetChartPosition(
    string workbookId,
    string worksheetName,
    int chartIndex,
    int topRow,
    int leftColumn,
    int bottomRow,
    int rightColumn)
    Sets the position and size of a chart in the worksheet.
    CreateSparklineCreateSparkline(
    string workbookId,
    string worksheetName,
    string sparklineType,
    string dataRange,
    string referenceRange)
    Creates sparkline charts. Sparklines are small charts in worksheet cells that provide visual representation of data. Types: Line, Column, WinLoss.
    **ExcelConditionalFormattingAgentTools** Provides tools to add or remove conditional formatting in workbook -| Tool | Syntax | Description | -|---|---|---| -| AddConditionalFormat | AddConditionalFormat(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string formatType,
    string? operatorType = null,
    string? firstFormula = null,
    string? secondFormula = null,
    string? backColor = null,
    bool? isBold = null,
    bool? isItalic = null) | Adds conditional formatting to a cell or range. `formatType` values: `CellValue`, `Formula`, `DataBar`, `ColorScale`, `IconSet`. | -| RemoveConditionalFormat | RemoveConditionalFormat(
    string workbookId,
    string worksheetName,
    string rangeAddress) | Removes all conditional formatting from a specified cell or range. | -| RemoveConditionalFormatAtIndex | RemoveConditionalFormatAtIndex(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    int index) | Removes the conditional format at a specific 0-based index from a range. | + + + + + + + + + + + +
    ToolSyntaxDescription
    AddConditionalFormatAddConditionalFormat(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string formatType,
    string? operatorType = null,
    string? firstFormula = null,
    string? secondFormula = null,
    string? backColor = null,
    bool? isBold = null,
    bool? isItalic = null)
    Adds conditional formatting to a cell or range. formatType values: CellValue, Formula, DataBar, ColorScale, IconSet.
    **ExcelConversionAgentTools** Provides tools to convert worksheet to image, HTML, ODS, JSON file formats -| Tool | Syntax | Description | -|---|---|---| -| ConvertWorksheetToImage | ConvertWorksheetToImage(
    string workbookId,
    string worksheetName,
    string outputPath,
    string imageFormat = "PNG",
    string scalingMode = "Best") | Converts an entire worksheet to an image file (PNG, JPEG, BMP, GIF, TIFF). | -| ConvertRangeToImage | ConvertRangeToImage(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string outputPath,
    string imageFormat = "PNG",
    string scalingMode = "Best") | Converts a specific cell range to an image file. | -| ConvertRowColumnRangeToImage | ConvertRowColumnRangeToImage(
    string workbookId,
    string worksheetName,
    int startRow,
    int startColumn,
    int endRow,
    int endColumn,
    string outputPath,
    string imageFormat = "PNG",
    string scalingMode = "Best") | Converts a row/column range to an image using 1-based row and column numbers. | -| ConvertChartToImage | ConvertChartToImage(
    string workbookId,
    string worksheetName,
    int chartIndex,
    string outputPath,
    string imageFormat = "PNG",
    string scalingMode = "Best") | Converts a chart to an image file (PNG or JPEG). | -| ConvertAllChartsToImages | ConvertAllChartsToImages(
    string workbookId,
    string worksheetName,
    string outputDirectory,
    string imageFormat = "PNG",
    string scalingMode = "Best",
    string fileNamePrefix = "Chart") | Converts all charts in a worksheet to separate image files. | -| ConvertWorkbookToHtml | ConvertWorkbookToHtml(
    string workbookId,
    string outputPath,
    string textMode = "DisplayText") | Converts an entire workbook to an HTML file preserving styles, hyperlinks, images, and charts. | -| ConvertWorksheetToHtml | ConvertWorksheetToHtml(
    string workbookId,
    string worksheetName,
    string outputPath,
    string textMode = "DisplayText") | Converts a specific worksheet to an HTML file. | -| ConvertUsedRangeToHtml | ConvertUsedRangeToHtml(
    string workbookId,
    string worksheetName,
    string outputPath,
    string textMode = "DisplayText",
    bool autofitColumns = true) | Converts the used range of a worksheet to an HTML file with optional column auto-fitting. | -| ConvertAllWorksheetsToHtml | ConvertAllWorksheetsToHtml(
    string workbookId,
    string outputDirectory,
    string textMode = "DisplayText",
    string fileNamePrefix = "Sheet") | Converts all worksheets in a workbook to separate HTML files. | -| ConvertWorkbookToOds | ConvertWorkbookToOds(
    string workbookId,
    string outputPath) | Converts an entire workbook to OpenDocument Spreadsheet (ODS) format. | -| ConvertWorkbookToOdsStream | ConvertWorkbookToOdsStream(
    string workbookId,
    string outputPath) | Converts an entire workbook to ODS format using stream-based output. | -| ConvertWorkbookToJson | ConvertWorkbookToJson(
    string workbookId,
    string outputPath,
    bool includeSchema = true) | Converts an entire workbook to JSON format with optional schema. | -| ConvertWorkbookToJsonStream | ConvertWorkbookToJsonStream(
    string workbookId,
    string outputPath,
    bool includeSchema = true) | Converts an entire workbook to JSON format using stream-based output. | -| ConvertWorksheetToJson | ConvertWorksheetToJson(
    string workbookId,
    string worksheetName,
    string outputPath,
    bool includeSchema = true) | Converts a specific worksheet to JSON format. | -| ConvertWorksheetToJsonStream | ConvertWorksheetToJsonStream(
    string workbookId,
    string worksheetName,
    string outputPath,
    bool includeSchema = true) | Converts a specific worksheet to JSON format using stream-based output. | -| ConvertRangeToJson | ConvertRangeToJson(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string outputPath,
    bool includeSchema = true) | Converts a specific cell range to JSON format. | -| ConvertRangeToJsonStream | ConvertRangeToJsonStream(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string outputPath,
    bool includeSchema = true) | Converts a specific cell range to JSON format using stream-based output. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    ConvertWorksheetToImageConvertWorksheetToImage(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string outputPath,
    string imageFormat = "PNG",
    string scalingMode = "Best")
    Converts an entire worksheet to an image file. Supports PNG, JPEG, BMP, GIF, and TIFF formats.
    ConvertChartToImageConvertChartToImage(
    string workbookId,
    string worksheetName,
    int chartIndex,
    string outputPath,
    string imageFormat = "PNG",
    string scalingMode = "Best")
    Converts an Excel chart to an image file. Supports PNG and JPEG formats.
    ConvertWorkbookToHtmlConvertWorkbookToHtml(
    string workbookId,
    string outputPath,
    string textMode = "DisplayText")
    Converts an entire Excel workbook to an HTML file with styles, hyperlinks, images, and charts preserved.
    ConvertWorksheetToHtmlConvertWorksheetToHtml(
    string workbookId,
    string worksheetName,
    string outputPath,
    string textMode = "DisplayText")
    Converts a specific Excel worksheet to an HTML file with styles, hyperlinks, images, and charts preserved.
    ConvertWorkbookToJsonConvertWorkbookToJson(
    string workbookId,
    string outputPath,
    bool includeSchema = true)
    Converts an entire workbook to JSON format with optional schema.
    ConvertWorksheetToJsonConvertWorksheetToJson(
    string workbookId,
    string worksheetName,
    string outputPath,
    bool includeSchema = true)
    Converts a specific worksheet to JSON format with optional schema.
    **ExcelDataValidationAgentTools** Provides tools to add data validation to workbook -| Tool | Syntax | Description | -|---|---|---| -| AddDropdownListValidation | AddDropdownListValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string listValues,
    bool showErrorBox = true,
    string? errorTitle = null,
    string? errorMessage = null,
    bool showPromptBox = false,
    string? promptMessage = null) | Adds a dropdown list data validation to a cell or range. `listValues` is comma-separated (max 255 chars). | -| AddDropdownFromRange | AddDropdownFromRange(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string sourceRange,
    bool showErrorBox = true,
    string? errorTitle = null,
    string? errorMessage = null,
    bool showPromptBox = false,
    string? promptMessage = null) | Adds a dropdown list validation using a reference range as the data source (e.g., `=Sheet1!$A$1:$A$10`). | -| AddNumberValidation | AddNumberValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string numberType,
    string comparisonOperator,
    string firstValue,
    string? secondValue = null,
    ...) | Adds number validation (`Integer` or `Decimal`) with a comparison operator and value(s). | -| AddDateValidation | AddDateValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string comparisonOperator,
    string firstDate,
    string? secondDate = null,
    ...) | Adds date validation using dates in `yyyy-MM-dd` format. | -| AddTimeValidation | AddTimeValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string comparisonOperator,
    string firstTime,
    string? secondTime = null,
    ...) | Adds time validation using 24-hour `HH:mm` format. | -| AddTextLengthValidation | AddTextLengthValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string comparisonOperator,
    string firstLength,
    string? secondLength = null,
    ...) | Adds text length validation with a comparison operator and length value(s). | -| AddCustomValidation | AddCustomValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string formula,
    ...) | Adds custom formula-based validation (e.g., `=A1>10`). | -| RemoveValidation | RemoveValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress) | Removes data validation from a cell or range. | -| RemoveAllValidations | RemoveAllValidations(
    string workbookId,
    string worksheetName) | Removes all data validations from a worksheet. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    AddDropdownValidationAddDropdownValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string listValues,
    bool showErrorBox = true,
    string? errorTitle = null,
    string? errorMessage = null,
    bool showPromptBox = false,
    string? promptMessage = null)
    Adds a dropdown list data validation to a cell or range. List values are limited to 255 characters including separators.
    AddNumberValidationAddNumberValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string numberType,
    string comparisonOperator,
    string firstValue,
    string? secondValue = null,
    ...)
    Adds number validation to a cell or range with specified comparison operator and values.
    AddDateValidationAddDateValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string comparisonOperator,
    string firstDate,
    string? secondDate = null,
    ...)
    Adds date validation to a cell or range with specified comparison operator and dates.
    AddTimeValidationAddTimeValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string comparisonOperator,
    string firstTime,
    string? secondTime = null,
    ...)
    Adds time validation to a cell or range with specified comparison operator and time values. Use 24-hour format like 10:00 or 18:30.
    AddTextLengthValidationAddTextLengthValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string comparisonOperator,
    string firstLength,
    string? secondLength = null,
    ...)
    Adds text length validation to a cell or range with specified comparison operator and length values.
    AddCustomValidationAddCustomValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string formula,
    ...)
    Adds custom formula-based validation to a cell or range.
    **ExcelPivotTableAgentTools** Provides tools to create, edit pivot table in workbook -| Tool | Syntax | Description | -|---|---|---| -| CreatePivotTable | CreatePivotTable(
    string workbookId,
    string dataWorksheetName,
    string dataRange,
    string pivotWorksheetName,
    string pivotTableName,
    string pivotLocation,
    string rowFieldIndices,
    string columnFieldIndices,
    int dataFieldIndex,
    string dataFieldCaption,
    string subtotalType = "Sum") | Creates a pivot table from a data range. Row/column field indices are comma-separated 0-based values. `subtotalType`: `Sum`, `Count`, `Average`, `Max`, `Min`, etc. XLSX only. | -| EditPivotTableCell | EditPivotTableCell(
    string workbookId,
    string worksheetName,
    int pivotTableIndex,
    string cellAddress,
    string newValue) | Lays out a pivot table and edits a specific cell value within the pivot area. | -| RemovePivotTable | RemovePivotTable(
    string workbookId,
    string worksheetName,
    string pivotTableName) | Removes a pivot table from a worksheet by name. | -| RemovePivotTableByIndex | RemovePivotTableByIndex(
    string workbookId,
    string worksheetName,
    int pivotTableIndex) | Removes a pivot table from a worksheet by its 0-based index. | -| GetPivotTables | GetPivotTables(
    string workbookId,
    string worksheetName) | Returns all pivot table names and their indices in the specified worksheet. | -| LayoutPivotTable | LayoutPivotTable(
    string workbookId,
    string worksheetName,
    int pivotTableIndex,
    bool setRefreshOnLoad = true) | Materializes pivot table values into worksheet cells, enabling reading and editing of pivot data. | -| RefreshPivotTable | RefreshPivotTable(
    string workbookId,
    string worksheetName,
    int pivotTableIndex) | Marks the pivot table cache to refresh when the file is opened in Excel. | -| ApplyPivotTableStyle | ApplyPivotTableStyle(
    string workbookId,
    string worksheetName,
    int pivotTableIndex,
    string builtInStyle) | Applies a built-in Excel style to a pivot table (e.g., `PivotStyleLight1`, `PivotStyleMedium2`, `PivotStyleDark12`, `None`). | -| FormatPivotTableCells | FormatPivotTableCells(
    string workbookId,
    string worksheetName,
    int pivotTableIndex,
    string rangeAddress,
    string backColor) | Applies a background color to a cell range within a pivot table area. | -| SortPivotTableTopToBottom | SortPivotTableTopToBottom(
    string workbookId,
    string worksheetName,
    int pivotTableIndex,
    int rowFieldIndex,
    string sortType,
    int dataFieldIndex = 1) | Sorts a pivot table row field top-to-bottom (`Ascending` or `Descending`) by data field values. | -| SortPivotTableLeftToRight | SortPivotTableLeftToRight(
    string workbookId,
    string worksheetName,
    int pivotTableIndex,
    int columnFieldIndex,
    string sortType,
    int dataFieldIndex = 1) | Sorts a pivot table column field left-to-right (`Ascending` or `Descending`) by data field values. | -| ApplyPivotPageFilter | ApplyPivotPageFilter(
    string workbookId,
    string worksheetName,
    int pivotTableIndex,
    int pageFieldIndex,
    string hiddenItemIndices) | Sets a pivot field as a page/report filter and hides specified items (comma-separated 0-based indices). | -| ApplyPivotLabelFilter | ApplyPivotLabelFilter(
    string workbookId,
    string worksheetName,
    int pivotTableIndex,
    int fieldIndex,
    string filterType,
    string filterValue) | Applies a caption/label filter to a pivot field (e.g., `CaptionEqual`, `CaptionBeginsWith`, `CaptionContains`). | -| ApplyPivotValueFilter | ApplyPivotValueFilter(
    string workbookId,
    string worksheetName,
    int pivotTableIndex,
    int fieldIndex,
    string filterType,
    string filterValue) | Applies a value-based filter to a pivot field (e.g., `ValueGreaterThan`, `ValueLessThan`, `ValueBetween`). | -| HidePivotFieldItems | HidePivotFieldItems(
    string workbookId,
    string worksheetName,
    int pivotTableIndex,
    int fieldIndex,
    string hiddenItemIndices) | Hides specified items within a pivot table row or column field by comma-separated 0-based indices. | + + + + + + + + + + + +
    ToolSyntaxDescription
    CreatePivotTableCreatePivotTable(
    string workbookId,
    string dataWorksheetName,
    string dataRange,
    string pivotWorksheetName,
    string pivotTableName,
    string pivotLocation,
    string rowFieldIndices,
    string columnFieldIndices,
    int dataFieldIndex,
    string dataFieldCaption,
    string builtInStyle = "None",
    string subtotalType = "Sum")
    Creates a pivot table in the specified worksheet using a data range from a source worksheet. Supports row, column, and data (values) fields with a chosen aggregation function. builtInStyle options: PivotStyleLight1-28, PivotStyleMedium1-28, PivotStyleDark1-28, or None. subtotalType options: Sum, Count, Average, Max, Min, Product, CountNums, StdDev, StdDevP, Var, VarP. Only supported in XLSX format.
    ## PowerPoint Tools @@ -396,14 +917,43 @@ Provides tools to create, edit pivot table in workbook Provides core life cycle operations for PowerPoint presentations — creating, loading, exporting, and managing presentations in memory. -| Tool | Syntax | Description | -|---|---|---| -| LoadPresentation | LoadPresentation(
    string? filePath = null,
    string? password = null) | Creates an empty presentation in memory or loads an existing one from a file path. Returns the `documentId`. | -| GetAllPresentations | GetAllPresentations() | Returns all presentation IDs currently available in memory. | -| ExportPresentation | ExportPresentation(
    string documentId,
    string filePath,
    string format = "PPTX") | Exports a PowerPoint presentation to the file system. | -| ExportAsImage | ExportAsImage(
    string documentId,
    string? imageFormat = "Png",
    int? startSlideIndex = null,
    int? endSlideIndex = null) | Exports presentation slides as PNG or JPEG images to the output directory. | -| RemovePresentation | RemovePresentation(
    string documentId) | Removes a specific presentation from memory by its ID. | -| SetActivePresentation | SetActivePresentation(
    string documentId) | Changes the active presentation context to the specified document ID. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    LoadPresentationLoadPresentation(
    string? filePath = null,
    string? password = null)
    Creates an empty presentation in memory or loads an existing one from a file path. Returns the documentId.
    GetAllPresentationsGetAllPresentations()Returns all presentation IDs currently available in memory.
    ExportPresentationExportPresentation(
    string documentId,
    string filePath,
    string format = "PPTX")
    Exports a PowerPoint presentation to the file system.
    ExportAsImageExportAsImage(
    string documentId,
    string? imageFormat = "Png",
    int? startSlideIndex = null,
    int? endSlideIndex = null)
    Exports presentation slides as PNG or JPEG images to the output directory.
    RemovePresentationRemovePresentation(
    string documentId)
    Removes a specific presentation from memory by its ID.
    SetActivePresentationSetActivePresentation(
    string documentId)
    Changes the active presentation context to the specified document ID.
    @@ -411,42 +961,102 @@ Provides core life cycle operations for PowerPoint presentations — creating, l Provides merge and split operations for PowerPoint presentations. -| Tool | Syntax | Description | -|---|---|---| -| MergePresentations | MergePresentations(
    string destinationDocumentId,
    string sourceDocumentIds,
    string pasteOption = "SourceFormatting") | Merges multiple presentations into a destination presentation. Accepts comma-separated source document IDs or file paths. | -| SplitPresentation | SplitPresentation(
    string documentId,
    string splitRules,
    string pasteOption = "SourceFormatting") | Splits a presentation by sections, layout type, or slide numbers (e.g., `"1,3,5"`). Returns the resulting document IDs. | + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    MergePresentationsMergePresentations(
    string destinationDocumentId,
    string sourceDocumentIds,
    string pasteOption = "SourceFormatting")
    Merges multiple presentations into a destination presentation. Accepts comma-separated source document IDs or file paths.
    SplitPresentationSplitPresentation(
    string documentId,
    string splitRules,
    string pasteOption = "SourceFormatting")
    Splits a presentation by sections, layout type, or slide numbers (e.g., "1,3,5"). Returns the resulting document IDs.
    **PresentationSecurityAgentTools** Provides password protection and encryption management for PowerPoint presentations. -| Tool | Syntax | Description | -|---|---|---| -| ProtectPresentation | ProtectPresentation(
    string documentId,
    string password) | Write-protects a PowerPoint presentation with a password. | -| EncryptPresentation | EncryptPresentation(
    string documentId,
    string password) | Encrypts a PowerPoint presentation with a password. | -| UnprotectPresentation | UnprotectPresentation(
    string documentId) | Removes write protection from a presentation. | -| DecryptPresentation | DecryptPresentation(
    string documentId) | Removes encryption from a presentation. | + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    ProtectPresentationProtectPresentation(
    string documentId,
    string password)
    Write-protects a PowerPoint presentation with a password.
    EncryptPresentationEncryptPresentation(
    string documentId,
    string password)
    Encrypts a PowerPoint presentation with a password.
    UnprotectPresentationUnprotectPresentation(
    string documentId)
    Removes write protection from a presentation.
    DecryptPresentationDecryptPresentation(
    string documentId)
    Removes encryption from a presentation.
    **PresentationContentAgentTools** Provides tools for reading content and metadata from PowerPoint presentations. -| Tool | Syntax | Description | -|---|---|---| -| GetText | GetText(
    string? documentId = null,
    string? filePath = null) | Extracts all text content from a presentation by document ID or file path. | -| GetSlideCount | GetSlideCount(
    string documentId) | Returns the number of slides in the presentation. | + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    GetTextGetText(
    string? documentId = null,
    string? filePath = null)
    Extracts all text content from a presentation by document ID or file path.
    GetSlideCountGetSlideCount(
    string documentId)
    Returns the number of slides in the presentation.
    **PresentationFindAndReplaceAgentTools** Provides text search and replacement across all slides in a PowerPoint presentation. -| Tool | Syntax | Description | -|---|---|---| -| FindAndReplace | FindAndReplace(
    string documentId,
    string findWhat,
    string replaceText,
    bool matchCase = false,
    bool wholeWord = false) | Finds and replaces all occurrences of the specified text across all slides in the presentation. | -| FindAndReplaceByPattern | FindAndReplaceByPattern(
    string documentId,
    string regexPattern,
    string replaceText) | Finds and replaces text that matches a regex pattern across all slides (e.g., `{[A-Za-z]+}`). | + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    FindAndReplaceFindAndReplace(
    string documentId,
    string findWhat,
    string replaceText,
    bool matchCase = false,
    bool wholeWord = false)
    Finds and replaces all occurrences of the specified text across all slides in the presentation.
    FindAndReplaceByPatternFindAndReplaceByPattern(
    string documentId,
    string regexPattern,
    string replaceText)
    Finds and replaces text that matches a regex pattern across all slides (e.g., {[A-Za-z]+}).
    ## PDF Conversion Tools @@ -455,9 +1065,18 @@ Provides text search and replacement across all slides in a PowerPoint presentat Provides conversion of Word, Excel, and PowerPoint documents to PDF format. -| Tool | Syntax | Description | -|---|---|---| -| ConvertToPDF | ConvertToPDF(
    string sourceDocumentId,
    string sourceType) | Converts a Word, Excel, or PowerPoint document to PDF. `sourceType` must be `Word`, `Excel`, or `PowerPoint`. Returns the PDF document ID. | + + + + + + + + + + + +
    ToolSyntaxDescription
    ConvertToPDFConvertToPDF(
    string sourceDocumentId,
    string sourceType)
    Converts a Word, Excel, or PowerPoint document to PDF. sourceType must be Word, Excel, or PowerPoint. Returns the PDF document ID.
    ## Data Extraction Tools @@ -466,10 +1085,28 @@ Provides conversion of Word, Excel, and PowerPoint documents to PDF format. Provides AI-powered structured data extraction from PDF documents and images, returning results as JSON. -| Tool | Syntax | Description | -|---|---|---| -| ExtractDataAsJSON | ExtractDataAsJSON(
    string inputFilePath,
    bool enableFormDetection = true,
    bool enableTableDetection = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    bool detectSignatures = true,
    bool detectTextboxes = true,
    bool detectCheckboxes = true,
    bool detectRadioButtons = true,
    bool detect_Border_less_Tables = true,
    string? outputFilePath = null) | Extracts structured data (text, forms, tables, checkboxes, signatures) from a PDF or image file and returns the result as JSON. | -| ExtractTableAsJSON | ExtractTableAsJSON(
    string inputFilePath,
    bool detect_Border_less_Tables = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    string? outputFilePath = null) | Extracts only table data from a PDF document and returns the result as JSON. Optimized for table-focused extraction. | + + + + + + + + + + + + + + + + + + + + + +
    ToolSyntaxDescription
    ExtractDataAsJSONExtractDataAsJSON(
    string inputFilePath,
    bool enableFormDetection = true,
    bool enableTableDetection = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    bool detectSignatures = true,
    bool detectTextboxes = true,
    bool detectCheckboxes = true,
    bool detectRadioButtons = true,
    bool detect_Border_less_Tables = true,
    string? outputFilePath = null)
    Extracts structured data (text, forms, tables, checkboxes, signatures) from a PDF or image file and returns the result as JSON.
    ExtractTableAsJSONExtractTableAsJSON(
    string inputFilePath,
    bool detect_Border_less_Tables = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    string? outputFilePath = null)
    Extracts only table data from a PDF document and returns the result as JSON. Optimized for table-focused extraction.
    RecognizeFormAsJsonRecognizeFormAsJson(
    string inputFilePath,
    bool detectSignatures = true,
    bool detectTextboxes = true,
    bool detectCheckboxes = true,
    bool detectRadioButtons = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    string? outputFilePath = null)
    Extracts only form field data from a PDF document and returns as JSON. Optimized for form-focused recognition.
    @@ -478,3 +1115,4 @@ Provides AI-powered structured data extraction from PDF documents and images, re - [Overview](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/overview) - [Getting Started](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/getting-started) - [Customization](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/customization) +- [Example Prompts](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/example-prompts) \ No newline at end of file From 40b0bee91e216a639eacfef3f46074806cb3ed21 Mon Sep 17 00:00:00 2001 From: AtchayaSekar28 Date: Mon, 6 Apr 2026 11:11:25 +0530 Subject: [PATCH 2/8] addressed the new feed backs --- .../ai-agent-tools/example-prompts.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/Document-Processing/ai-agent-tools/example-prompts.md b/Document-Processing/ai-agent-tools/example-prompts.md index b3533ce2d..8dd94923c 100644 --- a/Document-Processing/ai-agent-tools/example-prompts.md +++ b/Document-Processing/ai-agent-tools/example-prompts.md @@ -17,7 +17,7 @@ Speed up your document automation using these example prompts for Syncfusion Doc Create, manipulate, secure, extract content from, and perform OCR on PDF documents using AI Agent Tools. -{% promptcards %} +{% promptcards columns=1 %} {% promptcard CreatePdfDocument, ExtractText, FindTextInPdf, ExportPDFDocument %} Load the insurance policy document 'policy_document.pdf' from {InputDir}. Extract all text content from the document. Then search for all occurrences of the term 'exclusion' and return their exact page locations and bounding rectangle positions so our legal team can quickly audit every exclusion clause in the policy. {% endpromptcard %} @@ -39,7 +39,7 @@ Load the sensitive HR performance review document 'performance_review_Q4.pdf' fr Create, edit, protect, mail-merge, track changes, and manage form fields in Word documents. -{% promptcards %} +{% promptcards columns=1 %} {% promptcard CreateDocument, MergeDocuments, ExportDocument %} Assemble the annual company report by merging the following department Word documents from {InputDir} in order: 'cover_page.docx', 'executive_summary.docx', 'finance_report.docx', 'hr_report.docx', 'operations_report.docx', and 'appendix.docx'. Merge them all into 'cover_page.docx' using destination styles to maintain a consistent look. Export the final assembled report as 'annual_report_2025.docx' to {OutputDir}. {% endpromptcard %} @@ -64,8 +64,8 @@ Load the comprehensive legal contract bundle 'master_contracts_2026.docx' from { Create and manage workbooks, worksheets, apply formulas, charts, conditional formatting, and data validation. -{% promptcards %} -{% promptcard CreateWorkbook, CreateWorksheet, SetValue, SetFormula, CreateChart, SetChartTitle, SetAxisTitles, ExportWorkbook %} +{% promptcards columns=1 %} +{% promptcard CreateWorkbook, CreateWorksheet, SetValue, SetFormula, CreateChart, SetChartElements, ExportWorkbook %} Create a sales performance dashboard workbook 'sales_dashboard_Q1_2026.xlsx'. Add a worksheet named 'Sales_Data' and populate it with the following Q1 data — headers: (Region, January, February, March, Q1_Total); rows: North (42000, 45000, 51000), South (38000, 40000, 44000), East (55000, 58000, 63000), West (29000, 31000, 35000) — and add Q1_Total formulas summing January through March for each region. Then create a clustered bar chart from the data range A1:D5, positioning it in rows 8–23 and columns 1–8. Set the chart title to 'Q1 2026 Regional Sales Performance', set the category axis title to 'Region', and the value axis title to 'Revenue (USD)'. Enable the chart legend at the bottom. Export the workbook to {OutputDir}. {% endpromptcard %} {% promptcard CreateWorkbook, CreateWorksheet, SetValue, AddConditionalFormat, SetFormula, ExportWorkbook %} @@ -77,8 +77,8 @@ Create a confidential board-level financial model workbook 'board_financial_mode {% promptcard CreateWorkbook, CreateWorksheet, SetValue, SetFormula, CalculateFormulas, ExportWorkbook %} Create a new Excel workbook 'budget_tracker_2026.xlsx' with two worksheets named 'Revenue' and 'Expenses'. In the Revenue sheet, add headers (Month, Product_A, Product_B, Product_C, Total) and populate data for January through June with realistic monthly revenue figures. Add a SUM formula in the Total column for each row. In the Expenses sheet, add headers (Month, Salaries, Marketing, Operations, Total) and populate similar monthly data with SUM formulas in the Total column. Force a full formula recalculation to verify all totals. Export the workbook to {OutputDir}. {% endpromptcard %} -{% promptcard CreateWorkbook, CreateWorksheet, SetValue, SetFormula, CreatePivotTable, ApplyPivotTableStyle, LayoutPivotTable, ExportWorkbook %} -Create a sales analysis workbook 'sales_pivot_analysis.xlsx'. In a worksheet named 'Raw_Data', add the following headers: (SaleDate, Region, Salesperson, Product, Units, Revenue) and populate it with at least 12 rows of realistic Q1 2026 sales transactions spanning 3 regions, 4 salespersons, and 3 products. Then create a pivot table in a new worksheet named 'Pivot_Summary' at cell A3 named 'RegionalSummary' — use Region as the row field (index 1), Product as the column field (index 3), and Revenue as the data field (index 5) with a Sum subtotal. Apply the built-in style 'PivotStyleMedium2' to the pivot table and layout the pivot to materialize the values. Export the workbook to {OutputDir}. +{% promptcard CreateWorkbook, CreateWorksheet, SetValue, SetFormula, CreatePivotTable, ExportWorkbook %} +Create a sales analysis workbook 'sales_pivot_analysis.xlsx'. In a worksheet named 'Raw_Data', add the following headers: (SaleDate, Region, Salesperson, Product, Units, Revenue) and populate it with at least 12 rows of realistic Q1 2026 sales transactions spanning 3 regions, 4 salespersons, and 3 products. Then create a pivot table in a new worksheet named 'Pivot_Summary' at cell A3 named 'RegionalSummary' — use Region as the row field (index 1), Product as the column field (index 3), and Revenue as the data field (index 5) with a Sum subtotal. Export the workbook to {OutputDir}. {% endpromptcard %} {% endpromptcards %} @@ -86,7 +86,7 @@ Create a sales analysis workbook 'sales_pivot_analysis.xlsx'. In a worksheet nam Load, merge, split, secure, and extract content from PowerPoint presentations. -{% promptcards %} +{% promptcards columns=1 %} {% promptcard LoadPresentation, FindAndReplace, ExportPresentation %} Load the product launch presentation 'product_launch_template.pptx' from {InputDir}. The presentation is a reusable template — replace all occurrences of '[PRODUCT_NAME]' with 'Orion Pro X1', '[LAUNCH_DATE]' with 'May 15, 2026', '[PRICE]' with '$299', and '[TARGET_MARKET]' with 'Enterprise Customers'. Export the customized presentation as 'product_launch_orion_pro_x1.pptx' to {OutputDir}. {% endpromptcard %} @@ -108,7 +108,7 @@ Load the investor pitch deck 'investor_pitch_Q1_2026.pptx' from {InputDir}. Get Convert documents between different formats including Word, Excel, and PowerPoint to PDF. -{% promptcards %} +{% promptcards columns=1 %} {% promptcard CreateDocument (Word), ConvertToPDF, WatermarkPdf, ExportPDFDocument %} Load the signed vendor contract 'vendor_contract_final.docx' from {InputDir}, convert it to PDF for archiving purposes, and then apply a 'ARCHIVED' watermark with 30% opacity across all pages of the resulting PDF. Export the archived PDF as 'vendor_contract_final_archived.pdf' to {OutputDir}. {% endpromptcard %} @@ -124,7 +124,7 @@ Convert the sales conference presentation 'sales_conference_2026.pptx' from {Inp Extract structured data including text, tables, forms, and checkboxes from PDFs and images as JSON. -{% promptcards %} +{% promptcards columns=1 %} {% promptcard ExtractDataAsJSON %} Extract all structured data from the vendor invoice 'invoice_APR2026_00142.pdf' located at {InputDir}. Enable both form and table detection to capture invoice header fields (vendor name, invoice number, date, due date) and the line-item table (description, quantity, unit price, total). Use a confidence threshold of 0.7 for reliable results. Save the extracted JSON to 'invoice_APR2026_00142_data.json' in {OutputDir}. {% endpromptcard %} From 0aa655afa56200b2a159b80418948dbd223de7e6 Mon Sep 17 00:00:00 2001 From: AtchayaSekar28 Date: Mon, 6 Apr 2026 11:49:20 +0530 Subject: [PATCH 3/8] Added the additional Nuget package references --- Document-Processing/ai-agent-tools/overview.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Document-Processing/ai-agent-tools/overview.md b/Document-Processing/ai-agent-tools/overview.md index 4d135820c..cf2133120 100644 --- a/Document-Processing/ai-agent-tools/overview.md +++ b/Document-Processing/ai-agent-tools/overview.md @@ -58,6 +58,12 @@ The following NuGet packages are required dependencies for the agent tool librar |[Syncfusion.PDF.OCR.Net.Core](https://www.nuget.org/packages/Syncfusion.PDF.OCR.Net.Core)|OCR Processor| |[Syncfusion.HtmlToPdfConverter.Net.Windows](https://www.nuget.org/packages/Syncfusion.HtmlToPdfConverter.Net.Windows)| HTML to PDF conversion| +The following functionalities required additional NuGet packages in non-Windows platforms. + +- [Office to PDF in Linux platform](https://help.syncfusion.com/document-processing/word/word-library/net/nuget-packages-required#additional-nuget-packages-required-for-linux) + +- [HTML to PDF in Cross-Platform](https://help.syncfusion.com/document-processing/pdf/conversions/html-to-pdf/net/nuget-packages-required) + The following NuGet packages are used in the application. | Package | Purpose | From 3258e4484181988db7e00b64ae9f82665a08beb4 Mon Sep 17 00:00:00 2001 From: AtchayaSekar28 Date: Mon, 6 Apr 2026 17:23:34 +0530 Subject: [PATCH 4/8] resolved the CI issues --- Document-Processing/ai-agent-tools/tools.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/Document-Processing/ai-agent-tools/tools.md b/Document-Processing/ai-agent-tools/tools.md index ffea264cc..250999f2e 100644 --- a/Document-Processing/ai-agent-tools/tools.md +++ b/Document-Processing/ai-agent-tools/tools.md @@ -12,6 +12,7 @@ documentation: ug Agent Tools are the callable functions exposed to the AI agent. Each tool class is initialized with the appropriate manager. Tools are organized into the following categories: + @@ -50,7 +51,6 @@ Tools are organized into the following categories:
    Category
    - ## Document Managers Document Managers are in-memory containers that manage document life cycles during AI agent operations. They provide common functionality including document creation, import/export, active document tracking, and automatic expiration-based cleanup. @@ -64,7 +64,8 @@ Document Managers are in-memory containers that manage document life cycles duri WordDocumentManager -Manages Word documents in memory. Supports .docx, .doc, .rtf, .html, and .txt formats with auto-detection on import. +Manages Word documents in memory. Supports: .docx, .doc, .rtf, .html, and .txt formats with auto-detection on import. + ExcelWorkbookManager @@ -802,7 +803,7 @@ Provides tools to add or remove conditional formatting in workbook AddConditionalFormat AddConditionalFormat(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string formatType,
    string? operatorType = null,
    string? firstFormula = null,
    string? secondFormula = null,
    string? backColor = null,
    bool? isBold = null,
    bool? isItalic = null) -Adds conditional formatting to a cell or range. formatType values: CellValue, Formula, DataBar, ColorScale, IconSet. +Adds conditional formatting to a cell or range. formatType values: CellValue, Formula, DataBar, ColorScale, IconSet. @@ -1093,12 +1094,12 @@ Provides AI-powered structured data extraction from PDF documents and images, re ExtractDataAsJSON -ExtractDataAsJSON(
    string inputFilePath,
    bool enableFormDetection = true,
    bool enableTableDetection = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    bool detectSignatures = true,
    bool detectTextboxes = true,
    bool detectCheckboxes = true,
    bool detectRadioButtons = true,
    bool detect_Border_less_Tables = true,
    string? outputFilePath = null) +ExtractDataAsJSON(
    string inputFilePath,
    bool enableFormDetection = true,
    bool enableTableDetection = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    bool detectSignatures = true,
    bool detectTextboxes = true,
    bool detectCheckboxes = true,
    bool detectRadioButtons = true,
    bool detect_Border_less_Tables = true,
    string? outputFilePath = null) Extracts structured data (text, forms, tables, checkboxes, signatures) from a PDF or image file and returns the result as JSON. ExtractTableAsJSON -ExtractTableAsJSON(
    string inputFilePath,
    bool detect_Border_less_Tables = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    string? outputFilePath = null) +ExtractTableAsJSON(
    string inputFilePath,
    bool detect_Border_less_Tables = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    string? outputFilePath = null) Extracts only table data from a PDF document and returns the result as JSON. Optimized for table-focused extraction. From bb012160eda58bef88a20667d9f4e14c36b6dc63 Mon Sep 17 00:00:00 2001 From: AtchayaSekar28 Date: Mon, 6 Apr 2026 17:27:10 +0530 Subject: [PATCH 5/8] resolved the CI issues --- Document-Processing/ai-agent-tools/tools.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Document-Processing/ai-agent-tools/tools.md b/Document-Processing/ai-agent-tools/tools.md index 250999f2e..1708764be 100644 --- a/Document-Processing/ai-agent-tools/tools.md +++ b/Document-Processing/ai-agent-tools/tools.md @@ -1094,12 +1094,12 @@ Provides AI-powered structured data extraction from PDF documents and images, re ExtractDataAsJSON -ExtractDataAsJSON(
    string inputFilePath,
    bool enableFormDetection = true,
    bool enableTableDetection = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    bool detectSignatures = true,
    bool detectTextboxes = true,
    bool detectCheckboxes = true,
    bool detectRadioButtons = true,
    bool detect_Border_less_Tables = true,
    string? outputFilePath = null) +ExtractDataAsJSON(
    string inputFilePath,
    bool enableFormDetection = true,
    bool enableTableDetection = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    bool detectSignatures = true,
    bool detectTextboxes = true,
    bool detectCheckboxes = true,
    bool detectRadioButtons = true,
    bool detect_Border_less_Tables = true,
    string? outputFilePath = null) Extracts structured data (text, forms, tables, checkboxes, signatures) from a PDF or image file and returns the result as JSON. ExtractTableAsJSON -ExtractTableAsJSON(
    string inputFilePath,
    bool detect_Border_less_Tables = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    string? outputFilePath = null) +ExtractTableAsJSON(
    string inputFilePath,
    bool detect_Border_less_Tables = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    string? outputFilePath = null) Extracts only table data from a PDF document and returns the result as JSON. Optimized for table-focused extraction. From ca35d0ae6d301717eeb10e91a97cbd07652e9349 Mon Sep 17 00:00:00 2001 From: AtchayaSekar28 Date: Mon, 6 Apr 2026 18:57:57 +0530 Subject: [PATCH 6/8] Updated the prompt changes --- Document-Processing/ai-agent-tools/example-prompts.md | 10 +++++----- Document-Processing/ai-agent-tools/tools.md | 3 +-- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/Document-Processing/ai-agent-tools/example-prompts.md b/Document-Processing/ai-agent-tools/example-prompts.md index 8dd94923c..c469dcea2 100644 --- a/Document-Processing/ai-agent-tools/example-prompts.md +++ b/Document-Processing/ai-agent-tools/example-prompts.md @@ -18,11 +18,11 @@ Speed up your document automation using these example prompts for Syncfusion Doc Create, manipulate, secure, extract content from, and perform OCR on PDF documents using AI Agent Tools. {% promptcards columns=1 %} -{% promptcard CreatePdfDocument, ExtractText, FindTextInPdf, ExportPDFDocument %} -Load the insurance policy document 'policy_document.pdf' from {InputDir}. Extract all text content from the document. Then search for all occurrences of the term 'exclusion' and return their exact page locations and bounding rectangle positions so our legal team can quickly audit every exclusion clause in the policy. +{% promptcard CreatePdfDocument, FindTextInPdf, ExportPDFDocument %} +Load the insurance policy document ‘policy_document.pdf’ from {InputDir}. Then search for all occurrences of the term ‘exclusion’ and return their exact page locations and bounding rectangle positions so our legal team can quickly audit every exclusion clause in the policy. {% endpromptcard %} {% promptcard CreatePdfDocument, FindTextInPdf, RedactPdf, ExportPDFDocument %} -Load the court filing document 'case_filing.pdf' from {InputDir}. Permanently redact all personally identifiable information: on page 1, redact the name 'John Michael' and the address '4821 Ellwood Drive, Austin, TX 78701'; on page 3, redact the social security number '472-90-1835'. Use black highlight color for all redactions. Export the redacted document as 'case_filing_redacted.pdf' to {OutputDir}. +Load the court filing document ‘case_filing.pdf’ from {InputDir} and Find the Text ‘John Michael’ and ‘Ellwood Drive, Austin, TX 78701’ and ‘472-90-1835’. Permanently redact all identifiable information. Use black highlight color for all redactions. Export the redacted document as ‘case_filing_redacted.pdf’ to {OutputDir}. {% endpromptcard %} {% promptcard CreatePdfDocument, SignPdf, ExportPDFDocument %} Load the vendor contract 'vendor_agreement_draft.pdf' from {InputDir} and apply a digital signature using the company certificate 'certificate.pfx' (located at {InputDir}) with the password 'password123'. Place the signature in the bottom-right corner of the last page and use the company logo 'signature_logo.png' from {InputDir} as the signature appearance image. Export the signed contract as 'vendor_agreement_signed.pdf' to {OutputDir}. @@ -50,10 +50,10 @@ Load the employee Onboarding letter template 'Onboarding_template.docx' from {In Load the legal service agreement template 'service_agreement_template.docx' from {InputDir}. Replace the placeholder '[CLIENT_NAME]' with 'Apex Innovations Ltd.', '[SERVICE_FEE]' with '$18,500', and '[CONTRACT_DATE]' with 'April 1, 2026'. Additionally, use a regex pattern to find all date placeholders matching the pattern '\[DATE_[A-Z]+\]' and replace them with 'TBD'. Return the total count of all replacements made. Export the finalized agreement as 'service_agreement_apex.docx' to {OutputDir}. {% endpromptcard %} {% promptcard CreateDocument, ImportMarkdown, ExportDocument %} -Our developer wrote the API release notes in Markdown format — load the file 'release_notes_v3.2.mdx' from {InputDir}, import it into a new Word document to convert it into a properly formatted .docx file suitable for distribution to non-technical stakeholders. Export the document as 'release_notes_v3.2.docx' to {OutputDir}. +Our developer wrote the API release notes in Markdown format — load the file 'release_notes_v3.2.md' from {InputDir}, import it into a new Word document to convert it into a properly formatted .docx file suitable for distribution to non-technical stakeholders. Export the document as 'release_notes_v3.2.docx' to {OutputDir}. {% endpromptcard %} {% promptcard CreateDocument, GetFormData, SetFormFields, ExportDocument %} -Load the patient intake form 'patient_intake_form.docx' from {InputDir}. First, read all current form field values to see what fields are available. Then populate the form with the following patient information: PatientName='Robert Hayes', DateOfBirth='03/12/1978', InsuranceID='INS-4892-XY', PrimaryPhysician='Dr. Amanda Foster', EmergencyContact='Laura Hayes', Allergies='Penicillin'. Export the completed form as 'Intake_Form_Robert_Hayes.docx' to {OutputDir}. +Load the patient intake form 'patient_intake_form.docx' from {InputDir}. First, read all current form field values to see what fields are available. Then set the form with the following patient information: PatientName='Robert Hayes', DateOfBirth='03/12/1978', Gender='Male', ContactNumber='+1 (214) 555-7834', EmailAddress='robert.hayes@example.com', Address='4567 Elm Street, Apt 210, Dallas, TX 75201, United States', InsuranceProvider='Blue Cross Blue Shield', InsuranceID='INS-4892-XY', InsuranceGroupNumber='GRP-10293', Diabetes = "true", EmergencyContact='Laura Hayes', EmergencyRelation='Spouse', EmergencyPhone='+1 (214) 555-4466', Declaration = 'true', PatientSignature='Robert Hayes', FormDate='04/02/2026'. Export the completed form as 'Intake_Form_Robert_Hayes.docx' to {OutputDir}. {% endpromptcard %} {% promptcard CreateDocument, GetBookmarks, SplitDocument, ExportDocument %} Load the comprehensive legal contract bundle 'master_contracts_2026.docx' from {InputDir}. List all bookmarks in the document to identify the section boundaries. Split the document by bookmarks so that each bookmarked region — such as 'VendorAgreement', 'NDASection', and 'SLATerms' — becomes a standalone contract file. Export each split document to {OutputDir}. diff --git a/Document-Processing/ai-agent-tools/tools.md b/Document-Processing/ai-agent-tools/tools.md index 1708764be..33b9e3ae3 100644 --- a/Document-Processing/ai-agent-tools/tools.md +++ b/Document-Processing/ai-agent-tools/tools.md @@ -64,8 +64,7 @@ Document Managers are in-memory containers that manage document life cycles duri WordDocumentManager -Manages Word documents in memory. Supports: .docx, .doc, .rtf, .html, and .txt formats with auto-detection on import. - +Manages Word documents in memory. Supports: .docx, .doc, .rtf, .html, and .txt formats with auto-detection on import. ExcelWorkbookManager From 1669b7790e2f994ea86983474de1facb84d76c90 Mon Sep 17 00:00:00 2001 From: AtchayaSekar28 Date: Mon, 6 Apr 2026 22:05:38 +0530 Subject: [PATCH 7/8] Resolved the table issues --- .../ai-agent-tools/example-prompts.md | 2 +- Document-Processing/ai-agent-tools/tools.md | 1067 +++-------------- 2 files changed, 192 insertions(+), 877 deletions(-) diff --git a/Document-Processing/ai-agent-tools/example-prompts.md b/Document-Processing/ai-agent-tools/example-prompts.md index c469dcea2..050283d3a 100644 --- a/Document-Processing/ai-agent-tools/example-prompts.md +++ b/Document-Processing/ai-agent-tools/example-prompts.md @@ -28,7 +28,7 @@ Load the court filing document ‘case_filing.pdf’ from {InputDir} and Find th Load the vendor contract 'vendor_agreement_draft.pdf' from {InputDir} and apply a digital signature using the company certificate 'certificate.pfx' (located at {InputDir}) with the password 'password123'. Place the signature in the bottom-right corner of the last page and use the company logo 'signature_logo.png' from {InputDir} as the signature appearance image. Export the signed contract as 'vendor_agreement_signed.pdf' to {OutputDir}. {% endpromptcard %} {% promptcard MergePdfs, ReorderPdfPages, ExportPDFDocument %} -Merge the following monthly financial reports into a single consolidated annual report: 'Jan_report.pdf', 'Feb_report.pdf', 'Mar_report.pdf', 'Apr_report.pdf', 'May_report.pdf', 'Jun_report.pdf' — all located at {InputDir}. After merging, reorder the pages so the executive summary (currently the last page) appears first, followed by the monthly reports in chronological order. Export the final document as 'annual_report_2025.pdf' to {OutputDir}. +Merge the following monthly financial reports into a single consolidated annual report: ‘Jan_report.pdf’, ‘Feb_report.pdf’, ‘Mar_report.pdf’, ‘Apr_report.pdf’, ‘May_report.pdf’, ‘Jun_report.pdf’ — all located at {InputDir}. Each PDF has 3 pages, with the last page being the executive summary. After merging, reorder pages so each month’s summary page appears first, followed by the other two pages, while keeping January–June chronological order. Save the final file as annual_report_2025.pdf in {OutputDir}. {% endpromptcard %} {% promptcard CreatePdfDocument, EncryptPdf, SetPermissions, ExportPDFDocument %} Load the sensitive HR performance review document 'performance_review_Q4.pdf' from {InputDir}. Encrypt it using AES-256 encryption with the password 'HR@Secure2025'. Restrict permissions so that only reading and accessibility copy operations are allowed — disable printing, editing, and annotation. Export the secured document as 'performance_review_Q4_secured.pdf' to {OutputDir}. diff --git a/Document-Processing/ai-agent-tools/tools.md b/Document-Processing/ai-agent-tools/tools.md index 33b9e3ae3..3804dc7be 100644 --- a/Document-Processing/ai-agent-tools/tools.md +++ b/Document-Processing/ai-agent-tools/tools.md @@ -13,43 +13,15 @@ Agent Tools are the callable functions exposed to the AI agent. Each tool class Tools are organized into the following categories: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    CategoryTool ClassesDescription
    PDFPdfDocumentAgentTools,
    PdfOperationsAgentTools,
    PdfSecurityAgentTools,
    PdfContentExtractionAgentTools,
    PdfAnnotationAgentTools,
    PdfConverterAgentTools,
    PdfOcrAgentTools
    Create, manipulate, secure, extract content from, annotate, convert, and perform OCR on PDF documents.
    WordWordDocumentAgentTools,
    WordOperationsAgentTools,
    WordSecurityAgentTools,
    WordMailMergeAgentTools,
    WordFindAndReplaceAgentTools,
    WordRevisionAgentTools,
    WordImportExportAgentTools,
    WordFormFieldAgentTools,
    WordBookmarkAgentTools
    Create, edit, protect, mail-merge, find/replace, track changes, import/export, and manage form fields and bookmarks in Word documents.
    ExcelExcelWorkbookAgentTools,
    ExcelWorksheetAgentTools,
    ExcelSecurityAgentTools,
    ExcelFormulaAgentTools,
    ExcelChartAgentTools,
    ExcelConditionalFormattingAgentTools,
    ExcelConversionAgentTools,
    ExcelDataValidationAgentTools,
    ExcelPivotTableAgentTools
    Create and manage workbooks and worksheets, set cell values, formulas, and number formats, apply security, create and configure charts and sparklines, add conditional formatting, convert to image/HTML/JSON, manage data validation, and create and manipulate pivot tables.
    PowerPointPresentationDocumentAgentTools,
    PresentationOperationsAgentTools,
    PresentationSecurityAgentTools,
    PresentationContentAgentTools,
    PresentationFindAndReplaceAgentTools
    Load, merge, split, secure, and extract content from PowerPoint presentations.
    ConversionOfficeToPdfAgentToolsConvert Word, Excel, and PowerPoint documents to PDF.
    Data ExtractionDataExtractionAgentToolsExtract structured data (text, tables, forms) from PDF and image files as JSON.
    +| Category | Tool Classes | Description | +|---|---|---| +| **PDF** | PdfDocumentAgentTools,
    PdfOperationsAgentTools,
    PdfSecurityAgentTools,
    PdfContentExtractionAgentTools,
    PdfAnnotationAgentTools,
    PdfConverterAgentTools,
    PdfOcrAgentTools | Create, manipulate, secure, extract content from, annotate, convert, and perform OCR on PDF documents. | +| **Word** | WordDocumentAgentTools,
    WordOperationsAgentTools,
    WordSecurityAgentTools,
    WordMailMergeAgentTools,
    WordFindAndReplaceAgentTools,
    WordRevisionAgentTools,
    WordImportExportAgentTools,
    WordFormFieldAgentTools,
    WordBookmarkAgentTools | Create, edit, protect, mail-merge, find/replace, track changes, import/export, and manage form fields and bookmarks in Word documents. | +| **Excel** | ExcelWorkbookAgentTools,
    ExcelWorksheetAgentTools,
    ExcelSecurityAgentTools,
    ExcelFormulaAgentTools,
    ExcelChartAgentTools,
    ExcelConditionalFormattingAgentTools,
    ExcelConversionAgentTools,
    ExcelDataValidationAgentTools,
    ExcelPivotTableAgentTools | Create and manage workbooks and worksheets, set cell values, formulas, and number formats, apply security, create and configure charts and sparklines, add conditional formatting, convert to image/HTML/ODS/JSON, manage data validation, and create and manipulate pivot tables. | +| **PowerPoint** | PresentationDocumentAgentTools,
    PresentationOperationsAgentTools,
    PresentationSecurityAgentTools,
    PresentationContentAgentTools,
    PresentationFindAndReplaceAgentTools | Load, merge, split, secure, and extract content from PowerPoint presentations. | +| **Conversion** | OfficeToPdfAgentTools | Convert Word, Excel, and PowerPoint documents to PDF. | +| **Data Extraction** | DataExtractionAgentTools | Extract structured data (text, tables, forms) from PDF and image files as JSON. | + ## Document Managers @@ -57,28 +29,12 @@ Document Managers are in-memory containers that manage document life cycles duri **Available Document Managers** - - - - - - - - - - - - - - - - - - - - - -
    Document ManagerDescription
    WordDocumentManagerManages Word documents in memory. Supports: .docx, .doc, .rtf, .html, and .txt formats with auto-detection on import.
    ExcelWorkbookManagerManages Excel workbooks in memory. Owns an ExcelEngine instance and implements IDisposable for proper resource cleanup. Supports .xlsx, .xls, .xlsm, and .csv on export.
    PdfDocumentManagerManages PDF documents in memory. Supports both new PdfDocument instances and loaded PdfLoadedDocument instances, including password-protected files.
    PresentationManagerManages PowerPoint presentations in memory. Supports creating new empty presentations and loading existing .pptx files, including password-protected ones.
    +| Document Manager | Description | +|---|---| +| WordDocumentManager | Manages Word documents in memory. Supports `.docx`, `.doc`, `.rtf`, `.html`, and `.txt` formats with auto-detection on import. | +| ExcelWorkbookManager | Manages Excel workbooks in memory. Owns an `ExcelEngine` instance and implements `IDisposable` for proper resource cleanup. Supports `.xlsx`, `.xls`, `.xlsm`, and `.csv` on export. | +| PdfDocumentManager | Manages PDF documents in memory. Supports both new `PdfDocument` instances and loaded `PdfLoadedDocument` instances, including password-protected files. | +| PresentationManager | Manages PowerPoint presentations in memory. Supports creating new empty presentations and loading existing `.pptx` files, including password-protected ones. | **DocumentManagerCollection** @@ -94,203 +50,76 @@ Document Managers are in-memory containers that manage document life cycles duri Provides core life cycle operations for PDF documents — creating, loading, exporting, and managing PDF documents in memory. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    CreatePdfDocumentCreatePdfDocument(
    string? filePath = null,
    string? password = null)
    Creates a new PDF document in memory or loads an existing one from a file path. Returns the documentId.
    GetAllPDFDocumentsGetAllPDFDocuments()Returns all PDF document IDs currently available in memory.
    ExportPDFDocumentExportPDFDocument(
    string documentId,
    string filePath)
    Exports a PDF document from memory to the specified file path on the file system.
    RemovePdfDocumentRemovePdfDocument(
    string documentId)
    Removes a specific PDF document from memory by its ID.
    SetActivePdfDocumentSetActivePdfDocument(
    string documentId)
    Changes the active PDF document context to the specified document ID.
    +| Tool | Syntax | Description | +|---|---|---| +| CreatePdfDocument | CreatePdfDocument(
    string? filePath = null,
    string? password = null) | Creates a new PDF document in memory or loads an existing one from a file path. Returns the documentId. | +| GetAllPDFDocuments | GetAllPDFDocuments() | Returns all PDF document IDs currently available in memory. | +| ExportPDFDocument | ExportPDFDocument(
    string documentId,
    string filePath) | Exports a PDF document from memory to the specified file path on the file system. | +| RemovePdfDocument | RemovePdfDocument(
    string documentId) | Removes a specific PDF document from memory by its ID. | +| SetActivePdfDocument | SetActivePdfDocument(
    string documentId) | Changes the active PDF document context to the specified document ID. | **PdfOperationsAgentTools** Provides merge, split, and compression operations for PDF documents. - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    MergePdfsMergePdfs(
    string[] filePaths,
    string[]? passwords = null,
    bool mergeAccessibilityTags = false)
    Concatenates multiple PDF files into a single PDF document. Returns the merged documentId.
    SplitPdfsSplitPdfs(
    string filePath,
    int[,]? pageRanges = null,
    bool splitTags = false)
    Splits a single PDF into multiple PDFs by page ranges. Returns the output folder path.
    CompressPdfCompressPdf(
    string documentId,
    bool compressImage = true,
    bool optimizePageContent = true,
    bool optimizeFont = true,
    bool removeMetadata = true,
    int imageQuality = 50)
    Optimizes a PDF by compressing images, reducing content stream size, and optionally removing metadata.
    +| Tool | Syntax | Description | +|---|---|---| +| MergePdfs | MergePdfs(
    string[] filePaths,
    string[]? passwords = null,
    bool mergeAccessibilityTags = false) | Concatenates multiple PDF files into a single PDF document. Returns the merged document ID. | +| SplitPdfs | SplitPdfs(
    string filePath,
    int[,]? pageRanges = null,
    bool splitTags = false) | Splits a single PDF into multiple PDFs by page ranges. Returns the output folder path. | +| CompressPdf | CompressPdf(
    string documentId,
    bool compressImage = true,
    bool optimizePageContent = true,
    bool optimizeFont = true,
    bool removeMetadata = true,
    int imageQuality = 50) | Optimizes a PDF by compressing images, reducing content stream size, and optionally removing metadata. | **PdfSecurityAgentTools** Provides encryption, decryption, and permissions management for PDF documents. - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    EncryptPdfEncryptPdf(
    string documentId,
    string password,
    string encryptionAlgorithm = "AES",
    string keySize = "256")
    Protects a PDF document with a password using the specified encryption algorithm and key size.
    DecryptPdfDecryptPdf(
    string documentId)
    Removes encryption from a protected PDF document.
    SetPermissionsSetPermissions(
    string documentId,
    string permissions)
    Sets document permissions (e.g., Print, CopyContent, EditContent).
    RemovePermissionsRemovePermissions(
    string documentId)
    Removes all document-level permissions from a PDF.
    +| Tool | Syntax | Description | +|---|---|---| +| EncryptPdf | EncryptPdf(
    string documentId,
    string password,
    string encryptionAlgorithm = "AES",
    string keySize = "256") | Protects a PDF document with a password using the specified encryption algorithm and key size. | +| DecryptPdf | DecryptPdf(
    string documentId) | Removes encryption from a protected PDF document. | +| SetPermissions | SetPermissions(
    string documentId,
    string permissions) | Sets document permissions (e.g., Print, CopyContent, EditContent). | +| RemovePermissions | RemovePermissions(
    string documentId) | Removes all document-level permissions from a PDF. | **PdfContentExtractionAgentTools** Provides tools for extracting text, images, and tables from PDF documents. - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    ExtractTextExtractText(
    string documentId,
    int startPageIndex = -1,
    int endPageIndex = -1)
    Extracts text content from a PDF document across a specified page range, or from all pages if no range is given.
    ExtractImagesExtractImages(
    string documentId,
    int startPageIndex = -1,
    int endPageIndex = -1)
    Extracts embedded images from a PDF document across a specified page range.
    ExtractTablesExtractTables(
    string documentId,
    int startPageIndex = -1,
    int endPageIndex = -1)
    Extracts tables from a PDF document across a specified page range and returns the result as JSON.
    +| Tool | Syntax | Description | +|---|---|---| +| ExtractText | ExtractText(
    string documentId,
    int startPageIndex = -1,
    int endPageIndex = -1) | Extracts text content from a PDF document across a specified page range, or from all pages if no range is given. | +| ExtractImages | ExtractImages(
    string documentId,
    int startPageIndex = -1,
    int endPageIndex = -1) | Extracts embedded images from a PDF document across a specified page range. | +| ExtractTables | ExtractTables(
    string documentId,
    int startPageIndex = -1,
    int endPageIndex = -1) | Extracts tables from a PDF document across a specified page range and returns the result as JSON. | **PdfAnnotationAgentTools** Provides tools for watermarking, digitally signing, and adding or removing annotations in PDF documents. - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    WatermarkPdfWatermarkPdf(
    string documentId,
    string watermarkText,
    int rotation = 45,
    float locationX = -1,
    float locationY = -1)
    Applies a text watermark to all pages of a PDF document.
    SignPdfSignPdf(
    string documentId,
    string certificateFilePath,
    string certificatePassword,
    float boundsX,
    float boundsY,
    float boundsWidth,
    float boundsHeight,
    string? appearanceImagePath = null)
    Digitally signs a PDF document using a PFX/certificate file.
    AddAnnotationAddAnnotation(
    string documentId,
    int pageIndex,
    string annotationType,
    float boundsX,
    float boundsY,
    float boundsWidth,
    float boundsHeight,
    string text)
    Adds a Text, Rectangle, or Circle annotation to a PDF page at the specified position.
    RemoveAnnotationRemoveAnnotation(
    string documentId,
    int pageIndex,
    int annotationIndex)
    Removes an annotation from a PDF page by its 0-based index.
    +| Tool | Syntax | Description | +|---|---|---| +| WatermarkPdf | WatermarkPdf(
    string documentId,
    string watermarkText,
    int rotation = 45,
    float locationX = -1,
    float locationY = -1) | Applies a text watermark to all pages of a PDF document. | +| SignPdf | SignPdf(
    string documentId,
    string certificateFilePath,
    string certificatePassword,
    float boundsX,
    float boundsY,
    float boundsWidth,
    float boundsHeight,
    string? appearanceImagePath = null) | Digitally signs a PDF document using a PFX/certificate file. | +| AddAnnotation | AddAnnotation(
    string documentId,
    int pageIndex,
    string annotationType,
    float boundsX,
    float boundsY,
    float boundsWidth,
    float boundsHeight,
    string text) | Adds a `Text`, `Rectangle`, or `Circle` annotation to a PDF page at the specified position. | +| RemoveAnnotation | RemoveAnnotation(
    string documentId,
    int pageIndex,
    int annotationIndex) | Removes an annotation from a PDF page by its 0-based index. | **PdfConverterAgentTools** Provides tools to convert image, HTML to Pdf - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    ConvertPdfToPdfAConvertPdfToPdfA(
    string documentId,
    PdfConformanceLevel conformanceLevel)
    Converts a loaded PDF document to a PDF/A-compliant format. Supported conformance levels: PdfA1B, PdfA2B, PdfA3B, Pdf_A4, Pdf_A4F, Pdf_A4E.
    ConvertHtmlToPdfConvertHtmlToPdf(
    string urlOrFilePath,
    int pageWidth = 825,
    int pageHeight = 1100)
    Converts a webpage URL or a local HTML file to a PDF document with the specified page dimensions. Returns the new document ID.
    ImageToPdfImageToPdf(
    string[] imageFiles,
    string imagePosition = "FitToPage",
    int pageWidth = 612,
    int pageHeight = 792)
    Creates a PDF document from one or more image files. imagePosition values: Stretch, Center, FitToPage. Returns the new documentId.
    +| Tool | Syntax | Description | +|---|---|---| +| ConvertPdfToPdfA | ConvertPdfToPdfA(
    string documentId,
    PdfConformanceLevel conformanceLevel) | Converts a loaded PDF document to a PDF/A-compliant format. Supported conformance levels: `PdfA1B`, `PdfA2B`, `PdfA3B`, `Pdf_A4`, `Pdf_A4F`, `Pdf_A4E`. | +| ConvertHtmlToPdf | ConvertHtmlToPdf(
    string urlOrFilePath,
    int pageWidth = 825,
    int pageHeight = 1100) | Converts a webpage URL or a local HTML file to a PDF document with the specified page dimensions. Returns the new document ID. | +| ImageToPdf | ImageToPdf(
    string[] imageFiles,
    string imagePosition = "FitToPage",
    int pageWidth = 612,
    int pageHeight = 792) | Creates a PDF document from one or more image files. `imagePosition` values: `Stretch`, `Center`, `FitToPage`. Returns the new document ID. | **PdfOcrAgentTools** Provides tools to perform OCR on PDF - - - - - - - - - - - -
    ToolSyntaxDescription
    OcrPdfOcrPdf(
    string documentId,
    string language = "eng")
    Performs Optical Character Recognition (OCR) on a scanned or image-based PDF document to make its content text-searchable. Supported language codes: eng (English), etc.
    +| Tool | Syntax | Description | +|---|---|---| +| OcrPdf | OcrPdf(
    string documentId,
    string language = "eng") | Performs Optical Character Recognition (OCR) on a scanned or image-based PDF document to make its content text-searchable. Supported language codes: `eng` (English), etc.| ## Word Tools @@ -299,43 +128,14 @@ Provides tools to perform OCR on PDF Provides core life cycle operations for Word documents — creating, loading, exporting, and managing Word documents in memory. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    CreateDocumentCreateDocument(
    string? filePath = null,
    string? password = null)
    Creates a new Word document in memory or loads an existing one from a file path. Returns the documentId.
    GetAllDocumentsGetAllDocuments()Returns all Word document IDs currently available in memory.
    ExportDocumentExportDocument(
    string documentId,
    string filePath,
    string? formatType = "Docx")
    Exports a Word document to the file system. Supported formats: Docx, Doc, Rtf, Html, Txt.
    RemoveDocumentRemoveDocument(
    string documentId)
    Removes a specific Word document from memory by its ID.
    SetActiveDocumentSetActiveDocument(
    string documentId)
    Changes the active Word document context to the specified document ID.
    ExportAsImageExportAsImage(
    string documentId,
    string? imageFormat = "Png",
    int? startPageIndex = null,
    int? endPageIndex = null)
    Exports Word document pages as PNG or JPEG images to the output directory.
    +| Tool | Syntax | Description | +|---|---|---| +| CreateDocument | CreateDocument(
    string? filePath = null,
    string? password = null) | Creates a new Word document in memory or loads an existing one from a file path. Returns the `documentId`. | +| GetAllDocuments | GetAllDocuments() | Returns all Word document IDs currently available in memory. | +| ExportDocument | ExportDocument(
    string documentId,
    string filePath,
    string? formatType = "Docx") | Exports a Word document to the file system. Supported formats: `Docx`, `Doc`, `Rtf`, `Html`, `Txt`. | +| RemoveDocument | RemoveDocument(
    string documentId) | Removes a specific Word document from memory by its ID. | +| SetActiveDocument | SetActiveDocument(
    string documentId) | Changes the active Word document context to the specified document ID. | +| ExportAsImage | ExportAsImage(
    string documentId,
    string? imageFormat = "Png",
    int? startPageIndex = null,
    int? endPageIndex = null) | Exports Word document pages as PNG or JPEG images to the output directory. | @@ -343,28 +143,11 @@ Provides core life cycle operations for Word documents — creating, loading, ex Provides merge, split, and compare operations for Word documents. - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    MergeDocumentsMergeDocuments(
    string destinationDocumentId,
    string[] documentIdsOrFilePaths)
    Merges multiple Word documents into a single destination document.
    SplitDocumentSplitDocument(
    string documentId,
    string splitRules)
    Splits a Word document into multiple documents based on split rules (e.g., sections, headings, bookmarks).
    CompareDocumentsCompareDocuments(
    string originalDocumentId,
    string revisedDocumentId,
    string author,
    DateTime dateTime)
    Compares two Word documents and marks differences as tracked changes in the original document.
    +| Tool | Syntax | Description | +|---|---|---| +| MergeDocuments | MergeDocuments(
    string destinationDocumentId,
    string[] documentIdsOrFilePaths) | Merges multiple Word documents into a single destination document. | +| SplitDocument | SplitDocument(
    string documentId,
    string splitRules) | Splits a Word document into multiple documents based on split rules (e.g., sections, headings, bookmarks). | +| CompareDocuments | CompareDocuments(
    string originalDocumentId,
    string revisedDocumentId,
    string author,
    DateTime dateTime) | Compares two Word documents and marks differences as tracked changes in the original document. | @@ -372,33 +155,12 @@ Provides merge, split, and compare operations for Word documents. Provides password protection, encryption, and decryption for Word documents. - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    ProtectDocumentProtectDocument(
    string documentId,
    string password,
    string protectionType)
    Protects a Word document with a password and protection type (e.g., AllowOnlyReading).
    EncryptDocumentEncryptDocument(
    string documentId,
    string password)
    Encrypts a Word document with a password.
    UnprotectDocumentUnprotectDocument(
    string documentId,
    string password)
    Removes protection from a Word document using the provided password.
    DecryptDocumentDecryptDocument(
    string documentId)
    Removes encryption from a Word document.
    +| Tool | Syntax | Description | +|---|---|---| +| ProtectDocument | ProtectDocument(
    string documentId,
    string password,
    string protectionType) | Protects a Word document with a password and protection type (e.g., `AllowOnlyReading`). | +| EncryptDocument | EncryptDocument(
    string documentId,
    string password) | Encrypts a Word document with a password. | +| UnprotectDocument | UnprotectDocument(
    string documentId,
    string password) | Removes protection from a Word document using the provided password. | +| DecryptDocument | DecryptDocument(
    string documentId) | Removes encryption from a Word document. | @@ -406,23 +168,10 @@ Provides password protection, encryption, and decryption for Word documents. Provides mail merge operations for populating Word document templates with structured data. - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    MailMergeMailMerge(
    string documentId,
    string dataTableJson,
    bool removeEmptyFields = true,
    bool removeEmptyGroup = true)
    Executes a mail merge on a Word document using a JSON-represented DataTable.
    ExecuteMailMergeExecuteMailMerge(
    string documentId,
    string dataSourceJson,
    bool generateSeparateDocuments = false,
    bool removeEmptyFields = true)
    Extended mail merge with an option to generate one output document per data record. Returns document IDs.
    +| Tool | Syntax | Description | +|---|---|---| +| MailMerge | MailMerge(
    string documentId,
    string dataTableJson,
    bool removeEmptyFields = true,
    bool removeEmptyGroup = true) | Executes a mail merge on a Word document using a JSON-represented DataTable. | +| ExecuteMailMerge | ExecuteMailMerge(
    string documentId,
    string dataSourceJson,
    bool generateSeparateDocuments = false,
    bool removeEmptyFields = true) | Extended mail merge with an option to generate one output document per data record. Returns document IDs. | @@ -430,71 +179,25 @@ Provides mail merge operations for populating Word document templates with struc Provides text search and replacement operations within Word documents. - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    FindFind(
    string documentId,
    string findWhat,
    bool matchCase = false,
    bool wholeWord = false)
    Finds the first occurrence of the specified text in a Word document.
    FindAllFindAll(
    string documentId,
    string findWhat,
    bool matchCase = false,
    bool wholeWord = false)
    Finds all occurrences of the specified text in a Word document.
    ReplaceReplace(
    string documentId,
    string findWhat,
    string replaceText,
    bool matchCase = false,
    bool wholeWord = false)
    Replaces the first occurrence of the specified text in a Word document.
    ReplaceAllReplaceAll(
    string documentId,
    string findWhat,
    string replaceText,
    bool matchCase = false,
    bool wholeWord = false)
    Replaces all occurrences of the specified text in a Word document. Returns the count of replacements made.
    +| Tool | Syntax | Description | +|---|---|---| +| Find | Find(
    string documentId,
    string findWhat,
    bool matchCase = false,
    bool wholeWord = false) | Finds the first occurrence of the specified text in a Word document. | +| FindAll | FindAll(
    string documentId,
    string findWhat,
    bool matchCase = false,
    bool wholeWord = false) | Finds all occurrences of the specified text in a Word document. | +| Replace | Replace(
    string documentId,
    string findWhat,
    string replaceText,
    bool matchCase = false,
    bool wholeWord = false) | Replaces the first occurrence of the specified text in a Word document. | +| ReplaceAll | ReplaceAll(
    string documentId,
    string findWhat,
    string replaceText,
    bool matchCase = false,
    bool wholeWord = false) | Replaces all occurrences of the specified text in a Word document. Returns the count of replacements made. | **WordRevisionAgentTools** Provides tools to inspect and manage tracked changes (revisions) in Word documents. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    GetRevisionsGetRevisions(
    string documentId)
    Gets all tracked change revisions from a Word document.
    AcceptRevisionAcceptRevision(
    string documentId,
    int revisionIndex)
    Accepts a specific tracked change by its 0-based index.
    RejectRevisionRejectRevision(
    string documentId,
    int revisionIndex)
    Rejects a specific tracked change by its 0-based index.
    AcceptAllRevisionsAcceptAllRevisions(
    string documentId)
    Accepts all tracked changes in the document and returns the count accepted.
    RejectAllRevisionsRejectAllRevisions(
    string documentId)
    Rejects all tracked changes in the document and returns the count rejected.
    +| Tool | Syntax | Description | +|---|---|---| +| GetRevisions | GetRevisions(
    string documentId) | Gets all tracked change revisions from a Word document. | +| AcceptRevision | AcceptRevision(
    string documentId,
    int revisionIndex) | Accepts a specific tracked change by its 0-based index. | +| RejectRevision | RejectRevision(
    string documentId,
    int revisionIndex) | Rejects a specific tracked change by its 0-based index. | +| AcceptAllRevisions | AcceptAllRevisions(
    string documentId) | Accepts all tracked changes in the document and returns the count accepted. | +| RejectAllRevisions | RejectAllRevisions(
    string documentId) | Rejects all tracked changes in the document and returns the count rejected. | @@ -502,38 +205,13 @@ Provides tools to inspect and manage tracked changes (revisions) in Word documen Provides tools to import from and export Word documents to HTML and Markdown formats. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    ImportHtmlImportHtml(
    string htmlContentOrFilePath,
    string? documentId = null)
    Imports HTML content or an HTML file into a (new or existing) Word document.
    ImportMarkdownImportMarkdown(
    string markdownContentOrFilePath,
    string? documentId = null)
    Imports Markdown content or a Markdown file into a (new or existing) Word document.
    GetHtmlGetHtml(
    string documentIdOrFilePath)
    Returns the Word document content as an HTML string.
    GetMarkdownGetMarkdown(
    string documentIdOrFilePath)
    Returns the Word document content as a Markdown string.
    GetTextGetText(
    string documentIdOrFilePath)
    Returns the Word document content as plain text.
    +| Tool | Syntax | Description | +|---|---|---| +| ImportHtml | ImportHtml(
    string htmlContentOrFilePath,
    string? documentId = null) | Imports HTML content or an HTML file into a (new or existing) Word document. | +| ImportMarkdown | ImportMarkdown(
    string markdownContentOrFilePath,
    string? documentId = null) | Imports Markdown content or a Markdown file into a (new or existing) Word document. | +| GetHtml | GetHtml(
    string documentIdOrFilePath) | Returns the Word document content as an HTML string. | +| GetMarkdown | GetMarkdown(
    string documentIdOrFilePath) | Returns the Word document content as a Markdown string. | +| GetText | GetText(
    string documentIdOrFilePath) | Returns the Word document content as plain text. | @@ -541,33 +219,12 @@ Provides tools to import from and export Word documents to HTML and Markdown for Provides tools to read and write form field values in Word documents. - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    GetFormDataGetFormData(
    string documentId)
    Retrieves all form field data from a Word document as a key-value dictionary.
    SetFormDataSetFormData(
    string documentId,
    Dictionary<string, object> data)
    Sets multiple form field values in a Word document from a dictionary.
    GetFormFieldGetFormField(
    string documentId,
    string fieldName)
    Gets the value of a specific form field by name.
    SetFormFieldSetFormField(
    string documentId,
    string fieldName,
    object fieldValue)
    Sets the value of a specific form field by name.
    +| Tool | Syntax | Description | +|---|---|---| +| GetFormData | GetFormData(
    string documentId) | Retrieves all form field data from a Word document as a key-value dictionary. | +| SetFormData | SetFormData(
    string documentId,
    Dictionary data) | Sets multiple form field values in a Word document from a dictionary. | +| GetFormField | GetFormField(
    string documentId,
    string fieldName) | Gets the value of a specific form field by name. | +| SetFormField | SetFormField(
    string documentId,
    string fieldName,
    object fieldValue) | Sets the value of a specific form field by name. | @@ -575,38 +232,13 @@ Provides tools to read and write form field values in Word documents. Provides tools to manage bookmarks and bookmark content within Word documents. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    GetBookmarksGetBookmarks(
    string documentId)
    Gets all bookmark names from a Word document.
    GetContentGetContent(
    string documentId,
    string bookmarkName)
    Extracts the content inside a bookmark into a new document. Returns the new document ID.
    ReplaceContentReplaceContent(
    string documentId,
    string bookmarkName,
    string replaceDocumentId)
    Replaces bookmark content with content sourced from another document.
    RemoveContentRemoveContent(
    string documentId,
    string bookmarkName)
    Removes the content inside a specific bookmark, leaving the bookmark itself intact.
    RemoveBookmarkRemoveBookmark(
    string documentId,
    string bookmarkName)
    Removes a named bookmark from a Word document.
    +| Tool | Syntax | Description | +|---|---|---| +| GetBookmarks | GetBookmarks(
    string documentId) | Gets all bookmark names from a Word document. | +| GetContent | GetContent(
    string documentId,
    string bookmarkName) | Extracts the content inside a bookmark into a new document. Returns the new document ID. | +| ReplaceContent | ReplaceContent(
    string documentId,
    string bookmarkName,
    string replaceDocumentId) | Replaces bookmark content with content sourced from another document. | +| RemoveContent | RemoveContent(
    string documentId,
    string bookmarkName) | Removes the content inside a specific bookmark, leaving the bookmark itself intact. | +| RemoveBookmark | RemoveBookmark(
    string documentId,
    string bookmarkName) | Removes a named bookmark from a Word document. | ## Excel Tools @@ -615,61 +247,23 @@ Provides tools to manage bookmarks and bookmark content within Word documents. Provides core life cycle operations for Excel workbooks — creating, loading, exporting, and managing workbooks in memory. - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    CreateWorkbookCreateWorkbook(
    string? filePath = null,
    string? password = null)
    Creates a new Excel workbook in memory or loads an existing one from a file path. Returns the workbookId.
    ExportWorkbookExportWorkbook(
    string workbookId,
    string filePath,
    string version = "XLSX")
    Exports an Excel workbook to the file system. Supported formats: XLS, XLSX, XLSM, CSV.
    +| Tool | Syntax | Description | +|---|---|---| +| CreateWorkbook | CreateWorkbook(
    string? filePath = null,
    string? password = null) | Creates a new Excel workbook in memory or loads an existing one from a file path. Returns the `workbookId`. | +| GetAllWorkbooks | GetAllWorkbooks() | Returns all Excel workbook IDs currently available in memory. | +| ExportWorkbook | ExportWorkbook(
    string workbookId,
    string filePath,
    string version = "XLSX") | Exports an Excel workbook to the file system. Supported formats: `XLS`, `XLSX`, `XLSM`, `CSV`. | +| RemoveWorkbook | RemoveWorkbook(
    string workbookId) | Removes a specific workbook from memory by its ID. | +| SetActiveWorkbook | SetActiveWorkbook(
    string workbookId) | Changes the active workbook context to the specified workbook ID. | **ExcelWorksheetAgentTools** Provides tools to create, manage, and populate worksheets within Excel workbooks. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    CreateWorksheetCreateWorksheet(
    string workbookId,
    string? sheetName = null)
    Creates a new worksheet inside the specified workbook.
    RenameWorksheetRenameWorksheet(
    string workbookId,
    string oldName,
    string newName)
    Renames a worksheet in the workbook.
    DeleteWorksheetDeleteWorksheet(
    string workbookId,
    string worksheetName)
    Deletes a worksheet from the workbook.
    SetValueSetValue(
    string workbookId,
    string worksheetName,
    string cellAddress,
    string data)
    Assigns a data value to a cell (supports text, numbers, dates, and booleans).
    SetNumberFormatSetNumberFormat(
    string workbookId,
    string worksheetName,
    string cellAddress,
    string numberFormat)
    Assigns a number format to a cell in a worksheet (e.g., mm/dd/yyyy).
    +| Tool | Syntax | Description | +|---|---|---| +| CreateWorksheet | CreateWorksheet(
    string workbookId,
    string? sheetName = null) | Creates a new worksheet inside the specified workbook. | +| DeleteWorksheet | DeleteWorksheet(
    string workbookId,
    string worksheetName) | Deletes a worksheet from the workbook. | @@ -677,72 +271,14 @@ Provides tools to create, manage, and populate worksheets within Excel workbooks Provides encryption, decryption, and protection management for Excel workbooks and worksheets. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    EncryptWorkbookEncryptWorkbook(
    string workbookId,
    string password)
    Encrypts an Excel workbook with a password.
    DecryptWorkbookDecryptWorkbook(
    string workbookId,
    string password)
    Removes encryption from an Excel workbook using the provided password.
    ProtectWorkbookProtectWorkbook(
    string workbookId,
    string password)
    Protects the workbook structure (sheets) with a password.
    UnprotectWorkbookUnprotectWorkbook(
    string workbookId,
    string password)
    Removes workbook structure protection.
    ProtectWorksheetProtectWorksheet(
    string workbookId,
    string worksheetName,
    string password)
    Protects a specific worksheet from editing using a password.
    UnprotectWorksheetUnprotectWorksheet(
    string workbookId,
    string worksheetName,
    string password)
    Removes protection from a specific worksheet.
    - - - -**ExcelFormulaAgentTools** - -Provides tools to set, retrieve, calculate and validate cell formulas in Excel workbooks. - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    SetFormulaSetFormula(
    string workbookId,
    string worksheetName,
    string cellAddress,
    string formula)
    Assigns a formula to a cell in the worksheet (e.g., =SUM(A1:A10)).
    GetFormulaGetFormula(
    string workbookId,
    int worksheetIndex,
    string cellAddress)
    Retrieves the formula string from a specific cell.
    CalculateFormulasCalculateFormulas(
    string workbookId)
    Forces recalculation of all formulas in the workbook.
    +| Tool | Syntax | Description | +|---|---|---| +| EncryptWorkbook | EncryptWorkbook(
    string workbookId,
    string password) | Encrypts an Excel workbook with a password. | +| DecryptWorkbook | DecryptWorkbook(
    string workbookId,
    string password) | Removes encryption from an Excel workbook using the provided password. | +| ProtectWorkbook | ProtectWorkbook(
    string workbookId,
    string password) | Protects the workbook structure (sheets) with a password. | +| UnprotectWorkbook | UnprotectWorkbook(
    string workbookId,
    string password) | Removes workbook structure protection. | +| ProtectWorksheet | ProtectWorksheet(
    string workbookId,
    string worksheetName,
    string password) | Protects a specific worksheet from editing using a password. | +| UnprotectWorksheet | UnprotectWorksheet(
    string workbookId,
    string worksheetName,
    string password) | Removes protection from a specific worksheet. | @@ -750,165 +286,59 @@ Provides tools to set, retrieve, calculate and validate cell formulas in Excel w Provides tools to create modify and remove charts in excel workbooks - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    CreateChartCreateChart(
    string workbookId,
    string worksheetName,
    string chartType,
    string dataRange,
    bool isSeriesInRows = false,
    int topRow = 8,
    int leftColumn = 1,
    int bottomRow = 23,
    int rightColumn = 8)
    Creates a chart from a data range in the worksheet. Supports many chart types (e.g., Column_Clustered, Line, Pie, Bar_Clustered). Returns the chart index.
    CreateChartWithSeriesCreateChartWithSeries(
    string workbookId,
    string worksheetName,
    string chartType,
    string seriesName,
    string valuesRange,
    string categoryLabelsRange,
    int topRow = 8,
    int leftColumn = 1,
    int bottomRow = 23,
    int rightColumn = 8)
    Creates a chart and adds a named series with values and category labels. Returns the chart index.
    AddSeriesToChartAddSeriesToChart(
    string workbookId,
    string worksheetName,
    int chartIndex,
    string seriesName,
    string valuesRange,
    string categoryLabelsRange)
    Adds a new series to an existing chart.
    SetChartElementSetChartElement(
    string workbookId,
    string worksheetName,
    int chartIndex,
    int seriesIndex,
    string title,
    bool hasLegend,
    string position = "Bottom",
    bool showValue = true,
    bool showCategoryName = false,
    bool showSeriesName = false,
    string dataLabelPosition = "Outside",
    string? categoryAxisTitle = null,
    string? valueAxisTitle = null)
    Sets chart elements including title, legend, data labels, and axis titles. position (legend): Bottom, Top, Left, Right, Corner. dataLabelPosition: Outside, Inside, Center, etc.
    SetChartPositionSetChartPosition(
    string workbookId,
    string worksheetName,
    int chartIndex,
    int topRow,
    int leftColumn,
    int bottomRow,
    int rightColumn)
    Sets the position and size of a chart in the worksheet.
    CreateSparklineCreateSparkline(
    string workbookId,
    string worksheetName,
    string sparklineType,
    string dataRange,
    string referenceRange)
    Creates sparkline charts. Sparklines are small charts in worksheet cells that provide visual representation of data. Types: Line, Column, WinLoss.
    +| Tool | Syntax | Description | +|---|---|---| +| CreateChart | CreateChart(
    string workbookId,
    string worksheetName,
    string chartType,
    string dataRange,
    bool isSeriesInRows = false,
    int topRow = 8,
    int leftColumn = 1,
    int bottomRow = 23,
    int rightColumn = 8) | Creates a chart from a data range in the worksheet. Supports many chart types (e.g., `Column_Clustered`, `Line`, `Pie`, `Bar_Clustered`). Returns the chart index. | +| CreateChartWithSeries | CreateChartWithSeries(
    string workbookId,
    string worksheetName,
    string chartType,
    string seriesName,
    string valuesRange,
    string categoryLabelsRange,
    int topRow = 8,
    int leftColumn = 1,
    int bottomRow = 23,
    int rightColumn = 8) | Creates a chart and adds a named series with values and category labels. Returns the chart index. | +| AddSeriesToChart | AddSeriesToChart(
    string workbookId,
    string worksheetName,
    int chartIndex,
    string seriesName,
    string valuesRange,
    string categoryLabelsRange) | Adds a new series to an existing chart. | +| SetChartElement | SetChartElement(
    string workbookId,
    string worksheetName,
    int chartIndex,
    int seriesIndex,
    string title,
    bool hasLegend,
    string position = "Bottom",
    bool showValue = true,
    bool showCategoryName = false,
    bool showSeriesName = false,
    string dataLabelPosition = "Outside",
    string? categoryAxisTitle = null,
    string? valueAxisTitle = null) | Sets chart elements including title, legend, data labels, and axis titles. `position` (legend): `Bottom`, `Top`, `Left`, `Right`, `Corner`. `dataLabelPosition`: `Outside`, `Inside`, `Center`, etc. | **ExcelConditionalFormattingAgentTools** Provides tools to add or remove conditional formatting in workbook - - - - - - - - - - - -
    ToolSyntaxDescription
    AddConditionalFormatAddConditionalFormat(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string formatType,
    string? operatorType = null,
    string? firstFormula = null,
    string? secondFormula = null,
    string? backColor = null,
    bool? isBold = null,
    bool? isItalic = null)
    Adds conditional formatting to a cell or range. formatType values: CellValue, Formula, DataBar, ColorScale, IconSet.
    +| Tool | Syntax | Description | +|---|---|---| +| AddConditionalFormat | AddConditionalFormat(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string formatType,
    string? operatorType = null,
    string? firstFormula = null,
    string? secondFormula = null,
    string? backColor = null,
    bool? isBold = null,
    bool? isItalic = null) | Adds conditional formatting to a cell or range. `formatType` values: `CellValue`, `Formula`, `DataBar`, `ColorScale`, `IconSet`. | **ExcelConversionAgentTools** Provides tools to convert worksheet to image, HTML, ODS, JSON file formats - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    ConvertWorksheetToImageConvertWorksheetToImage(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string outputPath,
    string imageFormat = "PNG",
    string scalingMode = "Best")
    Converts an entire worksheet to an image file. Supports PNG, JPEG, BMP, GIF, and TIFF formats.
    ConvertChartToImageConvertChartToImage(
    string workbookId,
    string worksheetName,
    int chartIndex,
    string outputPath,
    string imageFormat = "PNG",
    string scalingMode = "Best")
    Converts an Excel chart to an image file. Supports PNG and JPEG formats.
    ConvertWorkbookToHtmlConvertWorkbookToHtml(
    string workbookId,
    string outputPath,
    string textMode = "DisplayText")
    Converts an entire Excel workbook to an HTML file with styles, hyperlinks, images, and charts preserved.
    ConvertWorksheetToHtmlConvertWorksheetToHtml(
    string workbookId,
    string worksheetName,
    string outputPath,
    string textMode = "DisplayText")
    Converts a specific Excel worksheet to an HTML file with styles, hyperlinks, images, and charts preserved.
    ConvertWorkbookToJsonConvertWorkbookToJson(
    string workbookId,
    string outputPath,
    bool includeSchema = true)
    Converts an entire workbook to JSON format with optional schema.
    ConvertWorksheetToJsonConvertWorksheetToJson(
    string workbookId,
    string worksheetName,
    string outputPath,
    bool includeSchema = true)
    Converts a specific worksheet to JSON format with optional schema.
    +| Tool | Syntax | Description | +|---|---|---| +| ConvertWorksheetToImage | ConvertWorksheetToImage(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string outputPath,
    string imageFormat = "PNG",
    string scalingMode = "Best") | Converts an entire worksheet to an image file. Supports PNG, JPEG, BMP, GIF, and TIFF formats. | +| ConvertChartToImage | ConvertChartToImage(
    string workbookId,
    string worksheetName,
    int chartIndex,
    string outputPath,
    string imageFormat = "PNG",
    string scalingMode = "Best") | Converts an Excel chart to an image file. Supports PNG and JPEG formats. | +| ConvertWorkbookToHtml | ConvertWorkbookToHtml(
    string workbookId,
    string outputPath,
    string textMode = "DisplayText") | Converts an entire Excel workbook to an HTML file with styles, hyperlinks, images, and charts preserved. | +| ConvertWorksheetToHtml | ConvertWorksheetToHtml(
    string workbookId,
    string worksheetName,
    string outputPath,
    string textMode = "DisplayText") | Converts a specific Excel worksheet to an HTML file with styles, hyperlinks, images, and charts preserved. | +| ConvertWorkbookToJson | ConvertWorkbookToJson(
    string workbookId,
    string outputPath,
    bool includeSchema = true) | Converts an entire workbook to JSON format with optional schema. | +| ConvertWorksheetToJson | ConvertWorksheetToJson(
    string workbookId,
    string worksheetName,
    string outputPath,
    bool includeSchema = true) | Converts a specific worksheet to JSON format with optional schema. | +| ConvertRangeToJson | ConvertRangeToJson(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string outputPath,
    bool includeSchema = true) | Converts a specific cell range to JSON format. | **ExcelDataValidationAgentTools** Provides tools to add data validation to workbook - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    AddDropdownValidationAddDropdownValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string listValues,
    bool showErrorBox = true,
    string? errorTitle = null,
    string? errorMessage = null,
    bool showPromptBox = false,
    string? promptMessage = null)
    Adds a dropdown list data validation to a cell or range. List values are limited to 255 characters including separators.
    AddNumberValidationAddNumberValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string numberType,
    string comparisonOperator,
    string firstValue,
    string? secondValue = null,
    ...)
    Adds number validation to a cell or range with specified comparison operator and values.
    AddDateValidationAddDateValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string comparisonOperator,
    string firstDate,
    string? secondDate = null,
    ...)
    Adds date validation to a cell or range with specified comparison operator and dates.
    AddTimeValidationAddTimeValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string comparisonOperator,
    string firstTime,
    string? secondTime = null,
    ...)
    Adds time validation to a cell or range with specified comparison operator and time values. Use 24-hour format like 10:00 or 18:30.
    AddTextLengthValidationAddTextLengthValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string comparisonOperator,
    string firstLength,
    string? secondLength = null,
    ...)
    Adds text length validation to a cell or range with specified comparison operator and length values.
    AddCustomValidationAddCustomValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string formula,
    ...)
    Adds custom formula-based validation to a cell or range.
    +| Tool | Syntax | Description | +|---|---|---| +| AddDropdownValidation | AddDropdownValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string listValues,
    bool showErrorBox = true,
    string? errorTitle = null,
    string? errorMessage = null,
    bool showPromptBox = false,
    string? promptMessage = null) | Adds a dropdown list data validation to a cell or range. List values are limited to 255 characters including separators. | +| AddNumberValidation | AddNumberValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string numberType,
    string comparisonOperator,
    string firstValue,
    string? secondValue = null,
    ...) | Adds number validation to a cell or range with specified comparison operator and values. | +| AddDateValidation | AddDateValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string comparisonOperator,
    string firstDate,
    string? secondDate = null,
    ...) | Adds date validation to a cell or range with specified comparison operator and dates. | +| AddTimeValidation | AddTimeValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string comparisonOperator,
    string firstTime,
    string? secondTime = null,
    ...) | Adds time validation to a cell or range with specified comparison operator and time values. Use 24-hour format like 10:00 or 18:30. | +| AddTextLengthValidation | AddTextLengthValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string comparisonOperator,
    string firstLength,
    string? secondLength = null,
    ...) | Adds text length validation to a cell or range with specified comparison operator and length values. | +| AddCustomValidation | AddCustomValidation(
    string workbookId,
    string worksheetName,
    string rangeAddress,
    string formula,
    ...) | Adds custom formula-based validation to a cell or range. | **ExcelPivotTableAgentTools** Provides tools to create, edit pivot table in workbook - - - - - - - - - - - -
    ToolSyntaxDescription
    CreatePivotTableCreatePivotTable(
    string workbookId,
    string dataWorksheetName,
    string dataRange,
    string pivotWorksheetName,
    string pivotTableName,
    string pivotLocation,
    string rowFieldIndices,
    string columnFieldIndices,
    int dataFieldIndex,
    string dataFieldCaption,
    string builtInStyle = "None",
    string subtotalType = "Sum")
    Creates a pivot table in the specified worksheet using a data range from a source worksheet. Supports row, column, and data (values) fields with a chosen aggregation function. builtInStyle options: PivotStyleLight1-28, PivotStyleMedium1-28, PivotStyleDark1-28, or None. subtotalType options: Sum, Count, Average, Max, Min, Product, CountNums, StdDev, StdDevP, Var, VarP. Only supported in XLSX format.
    +| Tool | Syntax | Description | +|---|---|---| +| CreatePivotTable | CreatePivotTable(
    string workbookId,
    string dataWorksheetName,
    string dataRange,
    string pivotWorksheetName,
    string pivotTableName,
    string pivotLocation,
    string rowFieldIndices,
    string columnFieldIndices,
    int dataFieldIndex,
    string dataFieldCaption,
    string builtInStyle = "None",
    string subtotalType = "Sum") | Creates a pivot table in the specified worksheet using a data range from a source worksheet. Supports row, column, and data (values) fields with a chosen aggregation function. `builtInStyle` options: `PivotStyleLight1-28`, `PivotStyleMedium1-28`, `PivotStyleDark1-28`, or `None`. `subtotalType` options: `Sum`, `Count`, `Average`, `Max`, `Min`, `Product`, `CountNums`, `StdDev`, `StdDevP`, `Var`, `VarP`. Only supported in XLSX format. | ## PowerPoint Tools @@ -917,43 +347,14 @@ Provides tools to create, edit pivot table in workbook Provides core life cycle operations for PowerPoint presentations — creating, loading, exporting, and managing presentations in memory. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    LoadPresentationLoadPresentation(
    string? filePath = null,
    string? password = null)
    Creates an empty presentation in memory or loads an existing one from a file path. Returns the documentId.
    GetAllPresentationsGetAllPresentations()Returns all presentation IDs currently available in memory.
    ExportPresentationExportPresentation(
    string documentId,
    string filePath,
    string format = "PPTX")
    Exports a PowerPoint presentation to the file system.
    ExportAsImageExportAsImage(
    string documentId,
    string? imageFormat = "Png",
    int? startSlideIndex = null,
    int? endSlideIndex = null)
    Exports presentation slides as PNG or JPEG images to the output directory.
    RemovePresentationRemovePresentation(
    string documentId)
    Removes a specific presentation from memory by its ID.
    SetActivePresentationSetActivePresentation(
    string documentId)
    Changes the active presentation context to the specified document ID.
    +| Tool | Syntax | Description | +|---|---|---| +| LoadPresentation | LoadPresentation(
    string? filePath = null,
    string? password = null) | Creates an empty presentation in memory or loads an existing one from a file path. Returns the `documentId`. | +| GetAllPresentations | GetAllPresentations() | Returns all presentation IDs currently available in memory. | +| ExportPresentation | ExportPresentation(
    string documentId,
    string filePath,
    string format = "PPTX") | Exports a PowerPoint presentation to the file system. | +| ExportAsImage | ExportAsImage(
    string documentId,
    string? imageFormat = "Png",
    int? startSlideIndex = null,
    int? endSlideIndex = null) | Exports presentation slides as PNG or JPEG images to the output directory. | +| RemovePresentation | RemovePresentation(
    string documentId) | Removes a specific presentation from memory by its ID. | +| SetActivePresentation | SetActivePresentation(
    string documentId) | Changes the active presentation context to the specified document ID. | @@ -961,102 +362,42 @@ Provides core life cycle operations for PowerPoint presentations — creating, l Provides merge and split operations for PowerPoint presentations. - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    MergePresentationsMergePresentations(
    string destinationDocumentId,
    string sourceDocumentIds,
    string pasteOption = "SourceFormatting")
    Merges multiple presentations into a destination presentation. Accepts comma-separated source document IDs or file paths.
    SplitPresentationSplitPresentation(
    string documentId,
    string splitRules,
    string pasteOption = "SourceFormatting")
    Splits a presentation by sections, layout type, or slide numbers (e.g., "1,3,5"). Returns the resulting document IDs.
    +| Tool | Syntax | Description | +|---|---|---| +| MergePresentations | MergePresentations(
    string destinationDocumentId,
    string sourceDocumentIds,
    string pasteOption = "SourceFormatting") | Merges multiple presentations into a destination presentation. Accepts comma-separated source document IDs or file paths. | +| SplitPresentation | SplitPresentation(
    string documentId,
    string splitRules,
    string pasteOption = "SourceFormatting") | Splits a presentation by sections, layout type, or slide numbers (e.g., `"1,3,5"`). Returns the resulting document IDs. | **PresentationSecurityAgentTools** Provides password protection and encryption management for PowerPoint presentations. - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    ProtectPresentationProtectPresentation(
    string documentId,
    string password)
    Write-protects a PowerPoint presentation with a password.
    EncryptPresentationEncryptPresentation(
    string documentId,
    string password)
    Encrypts a PowerPoint presentation with a password.
    UnprotectPresentationUnprotectPresentation(
    string documentId)
    Removes write protection from a presentation.
    DecryptPresentationDecryptPresentation(
    string documentId)
    Removes encryption from a presentation.
    +| Tool | Syntax | Description | +|---|---|---| +| ProtectPresentation | ProtectPresentation(
    string documentId,
    string password) | Write-protects a PowerPoint presentation with a password. | +| EncryptPresentation | EncryptPresentation(
    string documentId,
    string password) | Encrypts a PowerPoint presentation with a password. | +| UnprotectPresentation | UnprotectPresentation(
    string documentId) | Removes write protection from a presentation. | +| DecryptPresentation | DecryptPresentation(
    string documentId) | Removes encryption from a presentation. | **PresentationContentAgentTools** Provides tools for reading content and metadata from PowerPoint presentations. - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    GetTextGetText(
    string? documentId = null,
    string? filePath = null)
    Extracts all text content from a presentation by document ID or file path.
    GetSlideCountGetSlideCount(
    string documentId)
    Returns the number of slides in the presentation.
    +| Tool | Syntax | Description | +|---|---|---| +| GetText | GetText(
    string? documentId = null,
    string? filePath = null) | Extracts all text content from a presentation by document ID or file path. | +| GetSlideCount | GetSlideCount(
    string documentId) | Returns the number of slides in the presentation. | **PresentationFindAndReplaceAgentTools** Provides text search and replacement across all slides in a PowerPoint presentation. - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    FindAndReplaceFindAndReplace(
    string documentId,
    string findWhat,
    string replaceText,
    bool matchCase = false,
    bool wholeWord = false)
    Finds and replaces all occurrences of the specified text across all slides in the presentation.
    FindAndReplaceByPatternFindAndReplaceByPattern(
    string documentId,
    string regexPattern,
    string replaceText)
    Finds and replaces text that matches a regex pattern across all slides (e.g., {[A-Za-z]+}).
    +| Tool | Syntax | Description | +|---|---|---| +| FindAndReplace | FindAndReplace(
    string documentId,
    string findWhat,
    string replaceText,
    bool matchCase = false,
    bool wholeWord = false) | Finds and replaces all occurrences of the specified text across all slides in the presentation. | +| FindAndReplaceByPattern | FindAndReplaceByPattern(
    string documentId,
    string regexPattern,
    string replaceText) | Finds and replaces text that matches a regex pattern across all slides (e.g., `{[A-Za-z]+}`). | ## PDF Conversion Tools @@ -1065,18 +406,9 @@ Provides text search and replacement across all slides in a PowerPoint presentat Provides conversion of Word, Excel, and PowerPoint documents to PDF format. - - - - - - - - - - - -
    ToolSyntaxDescription
    ConvertToPDFConvertToPDF(
    string sourceDocumentId,
    string sourceType)
    Converts a Word, Excel, or PowerPoint document to PDF. sourceType must be Word, Excel, or PowerPoint. Returns the PDF document ID.
    +| Tool | Syntax | Description | +|---|---|---| +| ConvertToPDF | ConvertToPDF(
    string sourceDocumentId,
    string sourceType) | Converts a Word, Excel, or PowerPoint document to PDF. `sourceType` must be `Word`, `Excel`, or `PowerPoint`. Returns the PDF document ID. | ## Data Extraction Tools @@ -1085,28 +417,11 @@ Provides conversion of Word, Excel, and PowerPoint documents to PDF format. Provides AI-powered structured data extraction from PDF documents and images, returning results as JSON. - - - - - - - - - - - - - - - - - - - - - -
    ToolSyntaxDescription
    ExtractDataAsJSONExtractDataAsJSON(
    string inputFilePath,
    bool enableFormDetection = true,
    bool enableTableDetection = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    bool detectSignatures = true,
    bool detectTextboxes = true,
    bool detectCheckboxes = true,
    bool detectRadioButtons = true,
    bool detect_Border_less_Tables = true,
    string? outputFilePath = null)
    Extracts structured data (text, forms, tables, checkboxes, signatures) from a PDF or image file and returns the result as JSON.
    ExtractTableAsJSONExtractTableAsJSON(
    string inputFilePath,
    bool detect_Border_less_Tables = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    string? outputFilePath = null)
    Extracts only table data from a PDF document and returns the result as JSON. Optimized for table-focused extraction.
    RecognizeFormAsJsonRecognizeFormAsJson(
    string inputFilePath,
    bool detectSignatures = true,
    bool detectTextboxes = true,
    bool detectCheckboxes = true,
    bool detectRadioButtons = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    string? outputFilePath = null)
    Extracts only form field data from a PDF document and returns as JSON. Optimized for form-focused recognition.
    +| Tool | Syntax | Description | +|---|---|---| +| ExtractDataAsJSON | ExtractDataAsJSON(
    string inputFilePath,
    bool enableFormDetection = true,
    bool enableTableDetection = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    bool detectSignatures = true,
    bool detectTextboxes = true,
    bool detectCheckboxes = true,
    bool detectRadioButtons = true,
    bool detect_Border_less_Tables = true,
    string? outputFilePath = null) | Extracts structured data (text, forms, tables, checkboxes, signatures) from a PDF or image file and returns the result as JSON. | +| ExtractTableAsJSON | ExtractTableAsJSON(
    string inputFilePath,
    bool detect_Border_less_Tables = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    string? outputFilePath = null) | Extracts only table data from a PDF document and returns the result as JSON. Optimized for table-focused extraction. | +| RecognizeFormAsJson | RecognizeFormAsJson(
    string inputFilePath,
    bool detectSignatures = true,
    bool detectTextboxes = true,
    bool detectCheckboxes = true,
    bool detectRadioButtons = true,
    double confidenceThreshold = 0.6,
    int startPage = -1,
    int endPage = -1,
    string? outputFilePath = null) | Extracts only form field data from a PDF document and returns as JSON. Optimized for form-focused recognition. | @@ -1115,4 +430,4 @@ Provides AI-powered structured data extraction from PDF documents and images, re - [Overview](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/overview) - [Getting Started](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/getting-started) - [Customization](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/customization) -- [Example Prompts](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/example-prompts) \ No newline at end of file +- [Example Prompts](https://helpstaging.syncfusion.com/document-processing/ai-agent-tools/example-prompts) From 410953ec4c4cdde145e60b9fa43aff296b34fa0c Mon Sep 17 00:00:00 2001 From: AtchayaSekar28 Date: Mon, 6 Apr 2026 22:30:01 +0530 Subject: [PATCH 8/8] changed the words for spell error --- Document-Processing/ai-agent-tools/example-prompts.md | 8 ++++---- Document-Processing/ai-agent-tools/tools.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Document-Processing/ai-agent-tools/example-prompts.md b/Document-Processing/ai-agent-tools/example-prompts.md index 050283d3a..7d9c42407 100644 --- a/Document-Processing/ai-agent-tools/example-prompts.md +++ b/Document-Processing/ai-agent-tools/example-prompts.md @@ -50,10 +50,10 @@ Load the employee Onboarding letter template 'Onboarding_template.docx' from {In Load the legal service agreement template 'service_agreement_template.docx' from {InputDir}. Replace the placeholder '[CLIENT_NAME]' with 'Apex Innovations Ltd.', '[SERVICE_FEE]' with '$18,500', and '[CONTRACT_DATE]' with 'April 1, 2026'. Additionally, use a regex pattern to find all date placeholders matching the pattern '\[DATE_[A-Z]+\]' and replace them with 'TBD'. Return the total count of all replacements made. Export the finalized agreement as 'service_agreement_apex.docx' to {OutputDir}. {% endpromptcard %} {% promptcard CreateDocument, ImportMarkdown, ExportDocument %} -Our developer wrote the API release notes in Markdown format — load the file 'release_notes_v3.2.md' from {InputDir}, import it into a new Word document to convert it into a properly formatted .docx file suitable for distribution to non-technical stakeholders. Export the document as 'release_notes_v3.2.docx' to {OutputDir}. +Our developer wrote the API release notes in Markdown format — load the file 'release_notes_v3.2.mdx' from {InputDir}, import it into a new Word document to convert it into a properly formatted .docx file suitable for distribution to non-technical stakeholders. Export the document as 'release_notes_v3.2.docx' to {OutputDir}. {% endpromptcard %} {% promptcard CreateDocument, GetFormData, SetFormFields, ExportDocument %} -Load the patient intake form 'patient_intake_form.docx' from {InputDir}. First, read all current form field values to see what fields are available. Then set the form with the following patient information: PatientName='Robert Hayes', DateOfBirth='03/12/1978', Gender='Male', ContactNumber='+1 (214) 555-7834', EmailAddress='robert.hayes@example.com', Address='4567 Elm Street, Apt 210, Dallas, TX 75201, United States', InsuranceProvider='Blue Cross Blue Shield', InsuranceID='INS-4892-XY', InsuranceGroupNumber='GRP-10293', Diabetes = "true", EmergencyContact='Laura Hayes', EmergencyRelation='Spouse', EmergencyPhone='+1 (214) 555-4466', Declaration = 'true', PatientSignature='Robert Hayes', FormDate='04/02/2026'. Export the completed form as 'Intake_Form_Robert_Hayes.docx' to {OutputDir}. +Load the patient intake form 'patient_intake_form.docx' from {InputDir}. First, read all current form field values to see what fields are available. Then set the form with the following patient information: PatientName='Robert Hayes', DateOfBirth='03/12/1978', Gender='Male', ContactNumber='+1 (214) 555-7834', EmailAddress='Robert.Hayes@example.com', Address='4567 Elm Street, Apt 210, Dallas, TX 75201, United States', InsuranceProvider='Blue Cross Blue Shield', InsuranceID='INS-4892-XY', InsuranceGroupNumber='GRP-10293', Diabetes = "true", EmergencyContact='Laura Hayes', EmergencyRelation='Spouse', EmergencyPhone='+1 (214) 555-4466', Declaration = 'true', PatientSignature='Robert Hayes', FormDate='04/02/2026'. Export the completed form as 'Intake_Form_Robert_Hayes.docx' to {OutputDir}. {% endpromptcard %} {% promptcard CreateDocument, GetBookmarks, SplitDocument, ExportDocument %} Load the comprehensive legal contract bundle 'master_contracts_2026.docx' from {InputDir}. List all bookmarks in the document to identify the section boundaries. Split the document by bookmarks so that each bookmarked region — such as 'VendorAgreement', 'NDASection', and 'SLATerms' — becomes a standalone contract file. Export each split document to {OutputDir}. @@ -65,8 +65,8 @@ Load the comprehensive legal contract bundle 'master_contracts_2026.docx' from { Create and manage workbooks, worksheets, apply formulas, charts, conditional formatting, and data validation. {% promptcards columns=1 %} -{% promptcard CreateWorkbook, CreateWorksheet, SetValue, SetFormula, CreateChart, SetChartElements, ExportWorkbook %} -Create a sales performance dashboard workbook 'sales_dashboard_Q1_2026.xlsx'. Add a worksheet named 'Sales_Data' and populate it with the following Q1 data — headers: (Region, January, February, March, Q1_Total); rows: North (42000, 45000, 51000), South (38000, 40000, 44000), East (55000, 58000, 63000), West (29000, 31000, 35000) — and add Q1_Total formulas summing January through March for each region. Then create a clustered bar chart from the data range A1:D5, positioning it in rows 8–23 and columns 1–8. Set the chart title to 'Q1 2026 Regional Sales Performance', set the category axis title to 'Region', and the value axis title to 'Revenue (USD)'. Enable the chart legend at the bottom. Export the workbook to {OutputDir}. +{% CreateWorkbook, CreateWorksheet, AddDropdownListValidation, CreateChart, SetChartElement, ExportWorkbook %} +Load a sales performance dashboard workbook ‘sales_dashboard_Q1_2026.xlsx’ from {InputDir}. Add a worksheet named ‘DataValidation’ and create the List validation in the A1:B3 range and the list names "Excel", "Presentation", "Word", "PDF". Then create a clustered bar chart from the `Sales data’ sheet data range A1:D5, positioning it in rows 8–23 and columns 1–8. Set the chart title to ‘Q1 2026 Regional Sales Performance’, set the category axis title to ‘Region’, and the value axis title to ‘Revenue (USD)’. Enable the chart legend at the bottom. Export the workbook to {OutputDir}. {% endpromptcard %} {% promptcard CreateWorkbook, CreateWorksheet, SetValue, AddConditionalFormat, SetFormula, ExportWorkbook %} Create an inventory management workbook 'inventory_status.xlsx' with a worksheet named 'Stock_Levels'. Add headers (SKU, Product_Name, Category, In_Stock, Reorder_Point, Status) and populate it with 10 product rows across Electronics, Furniture, and Stationery categories with realistic stock and reorder data. Add a formula in the Status column that returns 'Reorder' when In_Stock is less than Reorder_Point and 'OK' otherwise. Apply conditional formatting to the In_Stock column (D2:D11): highlight cells in red where the value is less than the reorder threshold (use 10 as the formula threshold for the conditional format). Export the workbook to {OutputDir}. diff --git a/Document-Processing/ai-agent-tools/tools.md b/Document-Processing/ai-agent-tools/tools.md index 3804dc7be..cdf71ce83 100644 --- a/Document-Processing/ai-agent-tools/tools.md +++ b/Document-Processing/ai-agent-tools/tools.md @@ -338,7 +338,7 @@ Provides tools to create, edit pivot table in workbook | Tool | Syntax | Description | |---|---|---| -| CreatePivotTable | CreatePivotTable(
    string workbookId,
    string dataWorksheetName,
    string dataRange,
    string pivotWorksheetName,
    string pivotTableName,
    string pivotLocation,
    string rowFieldIndices,
    string columnFieldIndices,
    int dataFieldIndex,
    string dataFieldCaption,
    string builtInStyle = "None",
    string subtotalType = "Sum") | Creates a pivot table in the specified worksheet using a data range from a source worksheet. Supports row, column, and data (values) fields with a chosen aggregation function. `builtInStyle` options: `PivotStyleLight1-28`, `PivotStyleMedium1-28`, `PivotStyleDark1-28`, or `None`. `subtotalType` options: `Sum`, `Count`, `Average`, `Max`, `Min`, `Product`, `CountNums`, `StdDev`, `StdDevP`, `Var`, `VarP`. Only supported in XLSX format. | +| CreatePivotTable | CreatePivotTable(
    string workbookId,
    string dataWorksheetName,
    string dataRange,
    string pivotWorksheetName,
    string pivotTableName,
    string pivotLocation,
    string rowFieldIndices,
    string columnFieldIndices,
    int dataFieldIndex,
    string dataFieldCaption,
    string builtInStyle = "None",
    string subtotalType = "Sum") | Creates a pivot table in the specified worksheet using a data range from a source worksheet. Supports row, column, and data (values) fields with a chosen aggregation function. `builtInStyle` options: `PivotStyleLight1-28`, `PivotStyleMedium1-28`, `PivotStyleDark1-28`, or `None`. `subtotalType` options: `Sum`, `Count`, `Average`, `Max`, `Min`, `Product`, `CountNumbs`, `StdDev`, `StdDevP`, `Var`, `VarP`. Only supported in XLSX format. | ## PowerPoint Tools