diff --git a/Document-Processing-toc.html b/Document-Processing-toc.html index 93557ebfd..837e87565 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/example-prompts.md b/Document-Processing/ai-agent-tools/example-prompts.md index b3533ce2d..7d9c42407 100644 --- a/Document-Processing/ai-agent-tools/example-prompts.md +++ b/Document-Processing/ai-agent-tools/example-prompts.md @@ -17,18 +17,18 @@ 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 %} -{% 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. +{% promptcards columns=1 %} +{% 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}. {% 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}. @@ -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 %} @@ -53,7 +53,7 @@ Load the legal service agreement template 'service_agreement_template.docx' from 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 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}. @@ -64,9 +64,9 @@ 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 %} -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}. +{% promptcards columns=1 %} +{% 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}. @@ -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 %} 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..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 | @@ -81,3 +87,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..cdf71ce83 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: + | 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. | @@ -105,6 +106,7 @@ Provides tools for watermarking, digitally signing, and adding or removing annot **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`. | @@ -114,6 +116,7 @@ Provides tools to convert image, HTML to Pdf **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.| @@ -260,10 +263,7 @@ 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). | @@ -282,19 +282,6 @@ Provides encryption, decryption, and protection management for Excel workbooks a -**ExcelFormulaAgentTools** - -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. | - - - **ExcelChartAgentTools** Provides tools to create modify and remove charts in excel workbooks @@ -304,14 +291,7 @@ Provides tools to create modify and remove charts in excel workbooks | 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`. | +| 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** @@ -321,8 +301,6 @@ 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. | **ExcelConversionAgentTools** @@ -331,23 +309,13 @@ 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. | +| 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. | -| 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. | +| 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. | -| 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. | **ExcelDataValidationAgentTools** @@ -356,15 +324,12 @@ 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. | +| 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** @@ -373,21 +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 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. | +| 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 @@ -470,6 +421,7 @@ 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) | 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. | @@ -478,3 +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)