Skip to content

Commit 00b7bc3

Browse files
Merge pull request #3649 from syncfusion-content/1040554_Update_API_Reference-HF
1040554-Update API Reference Links in AI Agent Tools Documentation (Document SDK UG)-HF
2 parents 279e3ec + 203294f commit 00b7bc3

4 files changed

Lines changed: 58 additions & 58 deletions

File tree

Document-Processing/ai-agent-tools/customization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ cd Document-SDK-AI-Agent-Tools
2525

2626
**Step 2: Create the tool class**
2727

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:
2929

3030
```csharp
3131
using Syncfusion.AI.AgentTools.Core;

Document-Processing/ai-agent-tools/example-use-cases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ At runtime the application performs the following steps:
106106
2. **Generate title and outline.** The agent drafts a title and 6–10 section outline for user confirmation (`[Y/n/r]`).
107107
3. **Draft blog content as HTML.** For each section the agent generates structured HTML with consistent styling.
108108
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).
110110
6. **Save output.** Both the assembled HTML and the converted Word document are saved to the output folder.
111111

112112
### Syncfusion setup

Document-Processing/ai-agent-tools/getting-started.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Refer to the table below to choose the appropriate mode for your application and
5454

5555
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).
5656

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).
5858

5959
### Prerequisites
6060

@@ -80,7 +80,7 @@ if (!string.IsNullOrEmpty(licenseKey))
8080

8181
**Step 2: Create Managers and Collection**
8282

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:
8484

8585
```csharp
8686
using Syncfusion.AI.AgentTools.Core;
@@ -102,11 +102,11 @@ repoCollection.AddManager(DocumentType.PDF, pdfManager);
102102
repoCollection.AddManager(DocumentType.PowerPoint, presentationManager);
103103
```
104104

105-
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).
106106

107107
**Step 3: Instantiate Tools**
108108

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:
110110

111111
```csharp
112112
using Syncfusion.AI.AgentTools.DataExtraction;
@@ -194,7 +194,7 @@ You can download a complete working sample from [GitHub](https://github.com/sync
194194

195195
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.
196196

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.
198198

199199
### Prerequisites
200200

@@ -221,7 +221,7 @@ if (!string.IsNullOrEmpty(licenseKey))
221221

222222
**Step 2: Implement Storage**
223223

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/).
225225

226226
```csharp
227227
using Azure.Storage.Blobs;
@@ -255,11 +255,11 @@ string containerName = Environment.GetEnvironmentVariable("AZURE_BLOB_CONTAIN
255255
IDocumentStorage storage = new AzureBlobStorage(connectionString, containerName);
256256
```
257257

258-
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.
259259

260260
**Step 3: Create DocumentStorageManager**
261261

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:
263263

264264
```csharp
265265
using Syncfusion.AI.AgentTools.DocumentManagers;
@@ -269,7 +269,7 @@ var storageManager = new DocumentStorageManager(storage);
269269

270270
**Step 4: Instantiate Tools**
271271

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:
273273

274274
```csharp
275275
using Syncfusion.AI.AgentTools.Word;
@@ -309,16 +309,16 @@ allTools.AddRange(new DataExtractionAgentTools().GetTools());
309309
```
310310

311311
N> 1. The following tool classes are not supported in Storage mode:
312-
N> * WordDocumentAgentTools
313-
N> * ExcelWorkbookAgentTools
314-
N> * PdfDocumentAgentTools
315-
N> * PresentationDocumentAgentTools
312+
N> * [WordDocumentAgentTools](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Word.WordDocumentAgentTools.html)
313+
N> * [ExcelWorkbookAgentTools](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.Excel.ExcelWorkbookAgentTools.html)
314+
N> * [PdfDocumentAgentTools](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.PDF.PdfDocumentAgentTools.html)
315+
N> * [PresentationDocumentAgentTools](https://help.syncfusion.com/cr/document-processing/Syncfusion.AI.AgentTools.PowerPoint.PresentationDocumentAgentTools.html)
316316
N> 2. All other tool classes work identically in both modes.
317317
N> 3. Register only the tool classes your app needs. See the full list in the [Tools Reference](./tools).
318318

319319
**Step 5: Convert and Register Tools**
320320

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):
322322

323323
```csharp
324324
using Microsoft.Extensions.AI;

0 commit comments

Comments
 (0)