Skip to content

Addressed the feed backs in UG documentation for AI Agent Tools to support dual‑mode support #2646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ramaraj-Marimuthu merged 9 commits into from
Apr 21, 2026
Merged

Addressed the feed backs in UG documentation for AI Agent Tools to support dual‑mode support #2646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
52543ea
Modified the hyperlink
AtchayaSekar28 Apr 20, 2026
91e813e
Merge branch 'AI-AgentTool-DualMode' of https://github.com/syncfusion…
AtchayaSekar28 Apr 20, 2026
e502c39
Merge branch 'development' of https://github.com/syncfusion-content/d…
AtchayaSekar28 Apr 21, 2026
7429f18
Addressed the new feed backs
AtchayaSekar28 Apr 21, 2026
ecae156
Updated the system prompts in both modes
AtchayaSekar28 Apr 21, 2026
1b4630a
Updated the application structure with hyperlinks
AtchayaSekar28 Apr 21, 2026
f614364
Merge branch 'development' of https://github.com/syncfusion-content/d…
AtchayaSekar28 Apr 21, 2026
d0422c4
Resolved the CI failures
AtchayaSekar28 Apr 21, 2026
0db8608
Removed the staging links
AtchayaSekar28 Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions Document-Processing-toc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,33 @@
</li>
</ul>
</li>
<li>AI Agent Tools
<ul>
<li>
<a href="/document-processing/ai-agent-tools/overview">Overview</a>
</li>
<li>
<a href="/document-processing/ai-agent-tools/tools">Tools</a>
</li>
<li>
<a href="/document-processing/ai-agent-tools/getting-started">Getting Started</a>
<ul>
<li>
<a href="/document-processing/ai-agent-tools/getting-started-in-memory-mode">In-Memory Mode</a>
</li>
<li>
<a href="/document-processing/ai-agent-tools/getting-started-storage-mode">Storage Mode</a>
</li>
</ul>
</li>
<li>
<a href="/document-processing/ai-agent-tools/customization">Customization</a>
</li>
<li>
<a href="/document-processing/ai-agent-tools/example-prompts">Example Prompts</a>
</li>
</ul>
</li>
<li>AI Coding Assistant
<ul>
<li>
Expand Down
4 changes: 2 additions & 2 deletions Document-Processing/ai-agent-tools/customization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Syncfusion Document SDK Agent Tool library is designed to be extensible. Thi

## Creating a Custom Agent Tool Class

Follow these steps to expose new document operations to the AI agent.
Follow these steps to enable new document operations to the AI agent tool library.

**Step 1: Create a Custom Agent Tool by Inheriting AgentToolBase**

Expand Down Expand Up @@ -195,7 +195,7 @@ namespace Syncfusion.AI.AgentTools.Word

Once your custom tool class is created, register it alongside the built-in tools in your host application.

Documents can be handled using either In‑memory Mode or Storage Mode during AI agent execution. In In‑memory Mode, documents are loaded into memory and shared across tool calls. In Storage Mode, documents are loaded per tool call from external storage and must be explicitly saved to persist changes.
Documents can be handled using either in‑memory Mode or Storage Mode during AI agent execution. In in‑memory Mode, documents are loaded into memory and shared across tool calls. In Storage Mode, documents are loaded per tool call from external storage and must be explicitly saved to persist changes.

**Step 1: Registering a Custom Tool with the Syncfusion Agent Tools**

Expand Down
28 changes: 8 additions & 20 deletions Document-Processing/ai-agent-tools/example-prompts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,12 @@ documentation: ug

# Example Prompts - AI Agent Tools

Speed up your document automation using these example prompts for Syncfusion Document SDK AI Agent Tools. Each prompt demonstrates real-world scenarios—like document creation, data extraction, conversion, and manipulation.
Speed up your document automation using these example prompts for Syncfusion Document SDK AI Agent Tools. Each prompt demonstrates real-world scenarios-like document operation, data extraction, conversion, and manipulation.

## Document Processing Prompts

### PDF

Create, manipulate, secure, extract content from, and perform OCR on PDF documents using AI Agent Tools.

{% promptcards %}
{% promptcard FindTextInPdf %}
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.
Expand All @@ -28,17 +26,15 @@ 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 %}
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}.
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 EncryptPdf, SetPermissions %}
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}.
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}.
{% endpromptcard %}
{% endpromptcards %}

### Word

Create, edit, protect, mail-merge, track changes, and manage form fields in Word documents.

{% promptcards %}
{% promptcard MergeDocuments %}
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}.
Expand All @@ -50,20 +46,18 @@ 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 ImportMarkdown %}
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.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 GetFormData, SetFormFields %}
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 GetBookmarks, SplitDocument %}
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}.
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}.
{% endpromptcard %}
{% endpromptcards %}

### Excel

Create and manage workbooks, worksheets, charts, conditional formatting, and data validation.

{% promptcards %}
{% promptcard AddDropdownListValidation, CreateChart, SetChartElement %}
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}.
Expand All @@ -84,11 +78,9 @@ Load a sales performance dashboard workbook ‘car_brands.xlsx’ from {InputDir

### PowerPoint

Load, merge, split, secure, and extract content from PowerPoint presentations.

{% promptcards %}
{% promptcard FindAndReplace %}
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}.
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 %}
{% promptcard MergePresentations %}
Assemble the annual all-hands meeting presentation by merging the following department slide decks from {InputDir} into the master deck 'all_hands_master.pptx', preserving each department's source formatting: 'chief_executive_officer_intro.pptx', 'finance_update.pptx', 'product_road_map.pptx', 'hr_highlights.pptx', 'engineering_wins.pptx'. Export the complete merged presentation as 'all_hands_annual_2026.pptx' to {OutputDir}.
Expand All @@ -106,14 +98,12 @@ Load the investor pitch deck 'investor_pitch_Q1_2026.pptx' from {InputDir}. Get

### Conversions

Convert documents between different formats including Word, Excel, and PowerPoint to PDF.

{% promptcards %}
{% promptcard ConvertToPDF, WatermarkPdf %}
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 %}
{% promptcard ConvertToPDF, EncryptPdf %}
Load the annual financial summary workbook 'financial_summary_2025.xlsx' from {InputDir}, convert it to PDF for board distribution, then encrypt the resulting PDF with the password 'Board@Secure2025' and restrict permissions to read-only (no printing or editing). Export the secured financial report as 'financial_summary_2025_board.pdf' to {OutputDir}.
Load the annual financial summary workbook 'financial_summary_2025.xlsx' from {InputDir}, convert it to PDF for board distribution, then restrict permissions to read-only (no printing or editing) and encrypt the resulting PDF with the password ‘Board@Secure2025’. Export the secured financial report as 'financial_summary_2025_board.pdf' to {OutputDir}.
{% endpromptcard %}
{% promptcard ConvertToPDF, MergePdfs %}
Convert the sales conference presentation 'sales_conference_2026.pptx' from {InputDir} to PDF format. Save the converted PDF as 'sales_conference_2026.pdf' in {InputDir}. Then merge the converted presentation PDF with the existing supplementary materials PDF 'conference_appendix.pdf' (also located in {InputDir}) into a single unified conference package. Finally, export the combined merged document as 'sales_conference_package_2026.pdf' to {OutputDir}.
Expand All @@ -122,14 +112,12 @@ Convert the sales conference presentation 'sales_conference_2026.pptx' from {Inp

### Data Extraction

Extract structured data including text, tables, forms, and checkboxes from PDFs and images as JSON.

{% promptcards %}
{% 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 %}
{% promptcard ExtractTableAsJSON %}
Extract only the table data from the quarterly financial report 'financial_report_Q1_2026.pdf' located at {InputDir}. The report contains multiple financial tables across 15 pages — enable border less table detection to ensure all tables are captured even if they lack visible borders. Use a confidence threshold of 0.3. Save the extracted table data as 'financial_tables_Q1_2026.json' in {OutputDir}.
Extract only the table data from the quarterly financial report 'financial_report_Q1_2026.pdf' located at {InputDir}. The report contains multiple financial tables across 15 pages - enable border less table detection to ensure all tables are captured even if they lack visible borders. Use a confidence threshold of 0.3. Save the extracted table data as 'financial_tables_Q1_2026.json' in {OutputDir}.
{% endpromptcard %}
{% endpromptcards %}

Expand Down
Loading