You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Document-Processing/ai-agent-tools/customization.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ cd Document-SDK-AI-Agent-Tools
25
25
26
26
**Step 2: Create the tool class**
27
27
28
-
Open the `Syncfusion.DocumentSDK.AI.AgentTools` library project. Create a new class inside the `Tools` folder. The example below adds a watermark tool for Word documents:
28
+
Open the [Syncfusion.DocumentSDK.AI.AgentTools](https://github.com/syncfusion/document-sdk-ai-agent-tools/tree/master/Syncfusion.DocumentSDK.AI.AgentTools) library project. Create a new class inside the [Tools](https://github.com/syncfusion/document-sdk-ai-agent-tools/tree/master/Syncfusion.DocumentSDK.AI.AgentTools/Tools) folder. The example below adds a watermark tool for Word documents:
Copy file name to clipboardExpand all lines: Document-Processing/ai-agent-tools/example-use-cases.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -106,7 +106,7 @@ At runtime the application performs the following steps:
106
106
2.**Generate title and outline.** The agent drafts a title and 6–10 section outline for user confirmation (`[Y/n/r]`).
107
107
3.**Draft blog content as HTML.** For each section the agent generates structured HTML with consistent styling.
108
108
4.**Generate images.** For sections that need visuals, the **gpt-image-1.5** model generates PNG images embedded as Base64.
109
-
5.**Convert HTML to Word.** The AI agent autonomously chains `CreateDocument` → `ImportHtml` → `ExportDocument` using `WordDocumentAgentTools` and `WordImportExportAgentTools`.
109
+
5. **Convert HTML to Word.** The AI agent autonomously chains [CreateDocument](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Word.WordDocumentAgentTools.html#Syncfusion_AI_AgentTools_Word_WordDocumentAgentTools_CreateDocument_System_String_System_String_) → [ImportHtml](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Word.WordImportExportAgentTools.html#Syncfusion_AI_AgentTools_Word_WordImportExportAgentTools_ImportHtml_System_String_System_String_System_String_) → [ExportDocument](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Word.WordDocumentAgentTools.html#Syncfusion_AI_AgentTools_Word_WordDocumentAgentTools_ExportDocument_System_String_System_String_System_String_) using [WordDocumentAgentTools](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Word.WordDocumentAgentTools.html) and [WordImportExportAgentTools](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Word.WordImportExportAgentTools.html).
110
110
6.**Save output.** Both the assembled HTML and the converted Word document are saved to the output folder.
Copy file name to clipboardExpand all lines: Document-Processing/ai-agent-tools/getting-started.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ Refer to the table below to choose the appropriate mode for your application and
54
54
55
55
Documents are held as live objects in an in-memory dictionary. Each tool accesses and modifies the object directly without opening or saving files on each call. Unused documents are cleaned up automatically after a configurable timeout (default: 10 minutes).
56
56
57
-
The example below uses the Microsoft Agents Framework with OpenAI. The same steps apply to any [provider](https://learn.microsoft.com/en-us/agent-framework/agents/providers/?pivots=programming-language-csharp) that implements `IChatClient`.
57
+
The example below uses the Microsoft Agents Framework with OpenAI. The same steps apply to any [provider](https://learn.microsoft.com/en-us/agent-framework/agents/providers/?pivots=programming-language-csharp) that implements [IChatClient](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.ai.ichatclient?view=net-11.0-pp).
58
58
59
59
### Prerequisites
60
60
@@ -80,7 +80,7 @@ if (!string.IsNullOrEmpty(licenseKey))
80
80
81
81
**Step 2: Create Managers and Collection**
82
82
83
-
Create one document manager per document type. The `timeout` controls how long an unused document stays in memory. Register all managers in a `DocumentManagerCollection` so cross-format tools (such as `OfficeToPdfAgentTools`) can resolve the correct manager at runtime:
83
+
Create one document manager per document type. The `timeout` controls how long an unused document stays in memory. Register all managers in a [DocumentManagerCollection](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Core.DocumentManagerCollection.html) so cross-format tools (such as [OfficeToPdfAgentTools](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.OfficeToPDF.OfficeToPdfAgentTools.html)) can resolve the correct manager at runtime:
N> Tools that operate on a single document type are initialized directly with their own manager. Only cross-format tools like `OfficeToPdfAgentTools` require the `DocumentManagerCollection`.
105
+
N> Tools that operate on a single document type are initialized directly with their own manager. Only cross-format tools like [OfficeToPdfAgentTools](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.OfficeToPDF.OfficeToPdfAgentTools.html) require the [DocumentManagerCollection](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Core.DocumentManagerCollection.html).
106
106
107
107
**Step 3: Instantiate Tools**
108
108
109
-
Initialize each tool class with its manager and call `GetTools()` to collect `AITool` objects:
109
+
Initialize each tool class with its manager and call [GetTools()](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Core.AgentToolBase.html#Syncfusion_AI_AgentTools_Core_AgentToolBase_GetTools) to collect [AITool](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Core.AITool.html) objects:
110
110
111
111
```csharp
112
112
usingSyncfusion.AI.AgentTools.DataExtraction;
@@ -194,7 +194,7 @@ You can download a complete working sample from [GitHub](https://github.com/sync
194
194
195
195
Documents are read from and written to storage (Azure Blob, S3, local disk, etc.) on each tool invocation. No in-memory objects are maintained between tool calls - each operation opens the document from storage, processes it, and saves it back. This mode is ideal for distributed systems, serverless architectures, and scenarios where document persistence is required.
196
196
197
-
The example below uses Azure Blob Storage. The same pattern works with any storage back end by implementing the `IDocumentStorage` interface.
197
+
The example below uses Azure Blob Storage. The same pattern works with any storage back end by implementing the [IDocumentStorage](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Core.IDocumentStorage.html) interface.
198
198
199
199
### Prerequisites
200
200
@@ -221,7 +221,7 @@ if (!string.IsNullOrEmpty(licenseKey))
221
221
222
222
**Step 2: Implement Storage**
223
223
224
-
Implement `IDocumentStorage` for your storage back end. Below is the class signature and method placeholders for Azure Blob Storage - You can download a complete working sample from [GitHub](https://github.com/syncfusion/document-sdk-ai-agent-tools/blob/master/Examples/ASP.NET-Core/AgentChatWeb/).
224
+
Implement [IDocumentStorage](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Core.IDocumentStorage.html) for your storage back end. Below is the class signature and method placeholders for Azure Blob Storage - You can download a complete working sample from [GitHub](https://github.com/syncfusion/document-sdk-ai-agent-tools/blob/master/Examples/ASP.NET-Core/AgentChatWeb/).
N> For other storage providers (AWS S3, local disk, etc.), implement the same `IDocumentStorage` interface with the appropriate SDK or file system operations.
258
+
N> For other storage providers (AWS S3, local disk, etc.), implement the same [IDocumentStorage](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Core.IDocumentStorage.html) interface with the appropriate SDK or file system operations.
259
259
260
260
**Step 3: Create DocumentStorageManager**
261
261
262
-
Unlike In-Memory Mode which uses separate managers per document type, Storage Mode uses a single `DocumentStorageManager` for all document types:
262
+
Unlike In-Memory Mode which uses separate managers per document type, Storage Mode uses a single [DocumentStorageManager](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Core.DocumentStorageManager.html) for all document types:
263
263
264
264
```csharp
265
265
usingSyncfusion.AI.AgentTools.DocumentManagers;
@@ -269,7 +269,7 @@ var storageManager = new DocumentStorageManager(storage);
269
269
270
270
**Step 4: Instantiate Tools**
271
271
272
-
Initialize each tool class with the storage manager and collect [AITool](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.ai.aitool) objects:
272
+
Initialize each tool class with the storage manager and collect [AITool](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Core.AITool.html) objects:
N> 2. All other tool classes work identically in both modes.
317
317
N> 3. Register only the tool classes your app needs. See the full list in the [Tools Reference](./tools).
318
318
319
319
**Step 5: Convert and Register Tools**
320
320
321
-
Wrap each `AITool` into a framework-compatible function using `AIFunctionFactory.Create`:
321
+
Wrap each [AITool](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.ai.aitool?view=net-11.0-pp) into a framework-compatible function using [AIFunctionFactory.Create](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.ai.aifunctionfactory.create?view=net-11.0-pp):
0 commit comments