diff --git a/blazor/ai-coding-assistant/mcp-server.md b/blazor/ai-coding-assistant/mcp-server.md index 5062680f78..81218249d1 100644 --- a/blazor/ai-coding-assistant/mcp-server.md +++ b/blazor/ai-coding-assistant/mcp-server.md @@ -1,19 +1,19 @@ --- layout: post -title: SyncfusionBlazorAssistant MCP Server | Syncfusion -description: Learn how to configure and use SyncfusionBlazorAssistant MCP server for intelligent code generation, documentation, and troubleshooting in Blazor apps. +title: SyncfusionBlazorAssistant MCP server | Syncfusion +description: Learn how to configure and use SyncfusionBlazorAssistant MCP server for intelligent code generation, documentation, and troubleshooting in Blazor applications. control: Getting started with SyncfusionBlazorAssistant MCP Server platform: Blazor documentation: ug --- -# SyncfusionBlazorAssistant MCP Server +# SyncfusionBlazorAssistant MCP server ## Overview -The [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor-assistant) is a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) server that provides intelligent assistance for developers using Syncfusion's Blazor component libraries. This tool seamlessly integrates with compatible [MCP clients](https://modelcontextprotocol.io/clients) to enhance your development workflow when building Blazor applications with Syncfusion® components. +The [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor-assistant) is a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) server that provides intelligent assistance for developers using Syncfusion Blazor component libraries. This tool seamlessly integrates with compatible [MCP clients](https://modelcontextprotocol.io/clients) to enhance your development workflow when building Blazor applications with Syncfusion® components. -### Key Benefits +### Key benefits * Intelligent code generation for Syncfusion® Blazor components. * Detailed component documentation and usage examples. @@ -23,15 +23,15 @@ The [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor Before using [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor-assistant), ensure you have: -* Required [node](https://nodejs.org/en/) version >= 18 -* A [compatible MCP client](https://modelcontextprotocol.io/clients) (Visual Studio Code with GitHub Copilot, [Syncfusion® CodeStudio](https://www.syncfusion.com/code-studio/), etc.) +* Required [Node.js](https://nodejs.org/en/) version >= 18 +* A [compatible MCP client](https://modelcontextprotocol.io/clients) (Visual Studio Code with GitHub Copilot, [Syncfusion® Code Studio](https://www.syncfusion.com/code-studio/), etc.) * An active Syncfusion® license (any of the following): - [Commercial License](https://www.syncfusion.com/sales/unlimitedlicense) - [Free Community License](https://www.syncfusion.com/products/communitylicense) - [Free Trial](https://www.syncfusion.com/account/manage-trials/start-trials) -* An active [API KEY](https://syncfusion.com/account/api-key) +* An active [API key](https://www.syncfusion.com/account/api-key) -## Unlimited Access +## Unlimited access Syncfusion® offers unlimited access to this MCP server. There are no restrictions on: @@ -46,7 +46,7 @@ This ensures users can fully leverage Syncfusion® Before you can invoke the `SyncfusionBlazorAssistant` MCP server, you need to configure your MCP client with these core settings. The **Generic MCP Server Settings** shown below are identical across all clients: -### Generic MCP Server Settings +### Generic MCP server settings - **npm package name**: `@syncfusion/blazor-assistant` - **Type**: stdio (standard input/output transport) @@ -54,7 +54,7 @@ Before you can invoke the `SyncfusionBlazorAssistant` MCP server, you need to co - **Arguments**: -y - **Server name**: syncfusionBlazorAssistant -You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key) as an env parameter in the configuration file: +You need to add your [Syncfusion API key](https://www.syncfusion.com/account/api-key) as an env parameter in the configuration file: ```json "env": { @@ -93,7 +93,7 @@ Below are setup instructions for popular MCP clients: } ``` -* After updating the configuration in settings.json, you'll notice a "Start" option at the top of the config. This allows you to easily start the [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor-assistant) server directly from the settings interface without additional commands. +* After updating the configuration in mcp.json, you'll notice a "Start" option at the top of the config. This allows you to easily start the [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor-assistant) server directly from the settings interface without additional commands. * Confirm the server is active by checking for a message like: `SyncfusionBlazorAssistant is running...` in the output. @@ -176,7 +176,7 @@ For more details, refer to the [Cursor documentation](https://cursor.com/docs/co For further assistance, see the [JetBrains documentation](https://www.jetbrains.com/help/ai-assistant/mcp.html#connect-to-an-mcp-server). -> For more detailed information about configuring MCP servers in various clients, refer to the official documentations, e.g., [Windsurf](https://docs.windsurf.com/windsurf/cascade/mcp#mcp-config-json) +> For more detailed information about configuring MCP servers in various clients, refer to the official documentation, e.g., [Windsurf](https://docs.windsurf.com/windsurf/cascade/mcp#mcp-config-json) ## Usage @@ -199,7 +199,7 @@ To activate the SyncfusionBlazorAssistant MCP server: Syncfusion® MCP Servers provide full access to all AI interaction modes — Ask/Chat, Edit, and Agent — across supported MCP clients. -### Best Practices for Effective Usage +### Best practices for effective usage 1. `Be specific`: Mention both platform and component (e.g., "How do I create a Syncfusion Blazor Grid with paging and filtering?"). 2. `Provide context`: Include details about your use case for more targeted solutions. @@ -225,7 +225,7 @@ If you encounter issues: ## Support -Product support is available through the following mediums. +Product support is available through the following channels. * [Support ticket](https://support.syncfusion.com/support/tickets/create) - Guaranteed Response in 24 hours \| Unlimited tickets \| Holiday support * [Community forum](https://www.syncfusion.com/forums/blazor-components) @@ -234,4 +234,4 @@ Product support is available through the following mediums. ## See also -* [Syncfusion Blazor Documentation](https://blazor.syncfusion.com/documentation) \ No newline at end of file +* [Syncfusion Blazor documentation](https://blazor.syncfusion.com/documentation) diff --git a/blazor/ai-coding-assistant/overview.md b/blazor/ai-coding-assistant/overview.md index cc9913fcb7..2dcc8fdc04 100644 --- a/blazor/ai-coding-assistant/overview.md +++ b/blazor/ai-coding-assistant/overview.md @@ -1,36 +1,36 @@ --- layout: post -title: Syncfusion AI Coding Assistant Overview | Syncfusion -description: Learn how Syncfusion AI Coding Assistant boost Blazor productivity by generating accurate code snippets, configuration examples, and contextual guidance. +title: Syncfusion AI Coding Assistant overview | Syncfusion +description: Learn how the Syncfusion AI Coding Assistant boosts Blazor productivity by generating accurate code snippets, configuration examples, and contextual guidance. control: Syncfusion AI Coding Assistant Overview platform: Blazor documentation: ug --- -# Syncfusion® AI Coding Assistant Overview +# Syncfusion® AI Coding Assistant overview -The **Syncfusion® AI Coding Assistant** are designed to streamline your development workflow when building Blazor applications with Syncfusion® components. It uses contextual knowledge of the Syncfusion® component library to generate accurate code snippets, configuration examples, and guided explanations—minimizing documentation searches and maximizing productivity. +The **Syncfusion® AI Coding Assistant** is designed to streamline development when building Blazor applications with Syncfusion® components. It uses contextual knowledge of the Syncfusion® component library to generate accurate code snippets, configuration examples, and guided explanations—minimizing documentation searches and maximizing productivity. -AI Coding Assistant: +AI Coding Assistants: -* **The SyncfusionBlazorAssistant MCP Server** - Processes advanced prompts and returns tailored code suggestions via [MCP-compatible clients](https://modelcontextprotocol.io/clients). +* **SyncfusionBlazorAssistant MCP server** + Processes prompts and returns tailored code suggestions through [MCP-compatible clients](https://modelcontextprotocol.io/clients). -## Getting Started +## Getting started -To use the AI Coding Assistant, you need: +To use the AI Coding Assistant, the following are required: * A [Syncfusion® user account](https://www.syncfusion.com/account) * An active Syncfusion® license (any of the following): - [Commercial License](https://www.syncfusion.com/sales/unlimitedlicense) - [Free Community License](https://www.syncfusion.com/products/communitylicense) - [Free Trial](https://www.syncfusion.com/account/manage-trials/start-trials) -* An active [API KEY](https://syncfusion.com/account/api-key) +* An active [API key](https://www.syncfusion.com/account/api-key) * A [Blazor application that includes SyncfusionBlazor](https://blazor.syncfusion.com/documentation/getting-started/blazor-web-app) -## Unlimited Access +## Unlimited access -Syncfusion® offers unlimited access to the AI Coding Assistant, with no limitations on: +Syncfusion® offers unlimited access to the AI Coding Assistant with no limitations on: * Number of requests * Components usage @@ -39,12 +39,14 @@ Syncfusion® offers unlimited access to the This ensures users can fully leverage Syncfusion® components to enhance their development experience without limitations. -## Best Practices +## Best practices * Initial Setup: Use the tools to quickly add and configure Syncfusion® components in your Blazor application. * Feature Tuning: Enable or disable component features through prompt-based configuration for tailored functionality. * Data Binding: Generate sample data for testing and prototyping. Avoid using sensitive or production data to ensure security. -* Step-by-step explanations: Use annotated code to understand component behavior. Note that the level of detail may vary depending on the tool, mode, and AI model used. Refer to the [Syncfusion® Blazor Documentation](https://blazor.syncfusion.com/documentation/getting-started/blazor-web-app) for in-depth information. +* Step-by-step explanations: Use annotated code to understand component behavior. The level of detail may vary based on the tool, mode, and AI model. Refer to the [Syncfusion® Blazor documentation](https://blazor.syncfusion.com/documentation/getting-started/blazor-web-app) for in-depth information. +* Troubleshooting: Resolve common issues with AI-generated suggestions. For complex problems, see the [documentation](https://blazor.syncfusion.com/documentation/getting-started/blazor-web-app) or contact [support](https://support.syncfusion.com/support/tickets/create). + * Troubleshooting: Resolve common issues with AI-generated suggestions. For complex problems, refer to [documentation](https://blazor.syncfusion.com/documentation/getting-started/blazor-web-app) or [support](https://support.syncfusion.com/support/tickets/create). > Always check AI-generated content and code for accuracy before using it. @@ -52,18 +54,18 @@ This ensures users can fully leverage Syncfusion® ## Recommendations * Session Management: Start new sessions when switching tasks to ensure prompt relevance and maintain content focus. -* Model Compatibility: For optimal performance, use the tools with advanced AI models such as GPT-5 or Claude Sonnet 4. +* Model compatibility: For optimal performance, use the tools with advanced AI models such as GPT-5 or Claude Sonnet 4. -## Privacy & Data Handling +## Privacy and data handling The Syncfusion® AI Coding Assistant is designed with privacy in mind: * The tools do not access your project files or workspace directly. * User prompts are not stored by any of the tools or used for any other purpose. * Prompts are not used to train Syncfusion® models. -* The assistant generates context, while the final output is handled by your selected AI model. +* The assistant provides context, while the final output is generated by the AI model selected in your client. ## See also -* Add the [SyncfusionBlazorAssistant MCP Server](https://blazor.syncfusion.com/documentation/ai-coding-assistant/mcp-server) to an MCP-enabled client -* [Syncfusion® Blazor Documentation](https://blazor.syncfusion.com/documentation) +* Add the [SyncfusionBlazorAssistant MCP server](https://blazor.syncfusion.com/documentation/ai-coding-assistant/mcp-server) to an MCP-enabled client +* [Syncfusion® Blazor documentation](https://blazor.syncfusion.com/documentation) diff --git a/blazor/getting-started/blazor-server-side-visual-studio.md b/blazor/getting-started/blazor-server-side-visual-studio.md index 55566d1bed..e7f9ed505c 100644 --- a/blazor/getting-started/blazor-server-side-visual-studio.md +++ b/blazor/getting-started/blazor-server-side-visual-studio.md @@ -227,7 +227,7 @@ N> If an Interactivity Location is set to `Global` and the **Render Mode** is se { OrderID = 1000 + x, CustomerID = (new string[] { "ALFKI", "ANANTR", "ANTON", "BLONP", "BOLID" })[new Random().Next(5)], - Freight = 2.1 * x, + Freight = 2 * x, OrderDate = DateTime.Now.AddDays(-x), }).ToList(); } diff --git a/blazor/getting-started/blazor-web-app.md b/blazor/getting-started/blazor-web-app.md index 53ecd33ff8..af05bdd5f9 100644 --- a/blazor/getting-started/blazor-web-app.md +++ b/blazor/getting-started/blazor-web-app.md @@ -293,7 +293,7 @@ N> If an **Interactivity Location** is set to `Global` and the **Render Mode** i { OrderID = 1000 + x, CustomerID = (new string[] { "ALFKI", "ANANTR", "ANTON", "BLONP", "BOLID" })[new Random().Next(5)], - Freight = 2.1 * x, + Freight = 2 * x, OrderDate = DateTime.Now.AddDays(-x), }).ToList(); } diff --git a/blazor/getting-started/blazor-webassembly-app.md b/blazor/getting-started/blazor-webassembly-app.md index 3036ff24d5..b166a81070 100644 --- a/blazor/getting-started/blazor-webassembly-app.md +++ b/blazor/getting-started/blazor-webassembly-app.md @@ -217,7 +217,7 @@ Add the Syncfusion® Blazor DataGrid compone { OrderID = 1000 + x, CustomerID = (new string[] { "ALFKI", "ANANTR", "ANTON", "BLONP", "BOLID" })[new Random().Next(5)], - Freight = 2.1 * x, + Freight = 2 * x, OrderDate = DateTime.Now.AddDays(-x), }).ToList(); } diff --git a/blazor/getting-started/images/blazor-datagrid-component.png b/blazor/getting-started/images/blazor-datagrid-component.png new file mode 100644 index 0000000000..ad8981d980 Binary files /dev/null and b/blazor/getting-started/images/blazor-datagrid-component.png differ diff --git a/blazor/smart-ai-solutions/ai-samples/treegrid/adaptive-structuring.md b/blazor/smart-ai-solutions/ai-samples/treegrid/adaptive-structuring.md index da9f429bf4..2dca167da5 100644 --- a/blazor/smart-ai-solutions/ai-samples/treegrid/adaptive-structuring.md +++ b/blazor/smart-ai-solutions/ai-samples/treegrid/adaptive-structuring.md @@ -1,33 +1,33 @@ --- layout: post -title: Data Restructuring with Blazor TreeGrid and AI Models | Syncfusion -description: Learn how to use Syncfusion Blazor TreeGrid with AI service to automatically organize hierarchical data. +title: Data restructuring with Blazor TreeGrid and AI models | Syncfusion +description: Learn how to use the Syncfusion Blazor TreeGrid with OpenAI, Azure OpenAI, or Ollama to automatically organize hierarchical data. Explore to more details. platform: Blazor control: AI Integration documentation: ug keywords: Blazor TreeGrid, AI data restructuring, Syncfusion Blazor AI --- -# Data Restructuring with Blazor TreeGrid and Ollama +# Data restructuring with Blazor TreeGrid and AI models -This guide demonstrates how to use the [**Syncfusion.Blazor.AI**](https://www.nuget.org/packages/Syncfusion.Blazor.AI) package to automatically organize hierarchical data in a Syncfusion Blazor TreeGrid component. The [**Syncfusion.Blazor.AI**](https://www.nuget.org/packages/Syncfusion.Blazor.AI) package enables integration with AI models to process and structure data, while Ollama provides self-hosted or cloud-based AI capabilities for analyzing relationships in datasets. In this example, the application assigns appropriate `ParentId` values based on `CategoryName` relationships, dynamically updating the TreeGrid to reflect the corrected hierarchical structure. +This guide demonstrates how to use the [Syncfusion.Blazor.AI](https://www.nuget.org/packages/Syncfusion.Blazor.AI) package to automatically organize hierarchical data in a Syncfusion Blazor TreeGrid component. The [Syncfusion.Blazor.AI](https://www.nuget.org/packages/Syncfusion.Blazor.AI) package enables integration with AI models to process and structure data, while Ollama provides self-hosted or cloud-based AI capabilities for analyzing relationships in datasets. In the example below, the application assigns appropriate `ParentId` values based on `CategoryName` relationships and dynamically updates the TreeGrid to reflect the corrected hierarchical structure. ## Prerequisites -Ensure the following NuGet packages are installed based on your chosen AI service: +Ensure the following NuGet packages are installed based on the selected AI service. ### For OpenAI -- **Microsoft.Extensions.AI** -- **Microsoft.Extensions.AI.OpenAI** +- Microsoft.Extensions.AI +- Microsoft.Extensions.AI.OpenAI ### For Azure OpenAI -- **Microsoft.Extensions.AI** -- **Microsoft.Extensions.AI.OpenAI** -- **Azure.AI.OpenAI** +- Microsoft.Extensions.AI +- Microsoft.Extensions.AI.OpenAI +- Azure.AI.OpenAI ### For Ollama -- **Microsoft.Extensions.AI** -- **OllamaSharp** +- Microsoft.Extensions.AI +- OllamaSharp {% tabs %} {% highlight C# tabtitle="Package Manager" %} @@ -43,9 +43,9 @@ Install-Package OllamaSharp # For Ollama {% endhighlight %} {% endtabs %} -## Add Stylesheet and Script Resources +## Add stylesheet and script resources -Include the theme stylesheet and script from NuGet via [Static Web Assets](https://blazor.syncfusion.com/documentation/appearance/themes#static-web-assets) in the `` of your main page: +Include the theme stylesheet and script from NuGet via [Static Web Assets](https://blazor.syncfusion.com/documentation/appearance/themes#static-web-assets) in the `` of the main page: - For **.NET 6** Blazor Server apps, add to **~/Pages/_Layout.cshtml**. - For **.NET 8 or .NET 9** Blazor Server apps, add to **~/Components/App.razor**. @@ -61,18 +61,18 @@ Include the theme stylesheet and script from NuGet via [Static Web Assets](https N> Explore the [Blazor Themes](https://blazor.syncfusion.com/documentation/appearance/themes) topic for methods to reference themes ([Static Web Assets](https://blazor.syncfusion.com/documentation/appearance/themes#static-web-assets), [CDN](https://blazor.syncfusion.com/documentation/appearance/themes#cdn-reference), or [CRG](https://blazor.syncfusion.com/documentation/common/custom-resource-generator)). Refer to the [Adding Script Reference](https://blazor.syncfusion.com/documentation/common/adding-script-references) topic for different approaches to adding script references in your Blazor application. -## Configure AI Service +## Configure AI service -Choose one of the following AI services (OpenAI, Azure OpenAI, or Ollama) based on your requirements: -- **OpenAI**: Best for cloud-based, general-purpose AI models with minimal setup. -- **Azure OpenAI**: Ideal for enterprise-grade deployments with enhanced security and scalability. -- **Ollama**: Suitable for self-hosted, privacy-focused AI models. +Choose one of the following AI services (OpenAI, Azure OpenAI, or Ollama) based on requirements: +- **OpenAI**: Cloud-based, general-purpose AI models with minimal setup. +- **Azure OpenAI**: Enterprise-grade deployment with enhanced security and scalability. +- **Ollama**: Self-hosted, privacy-focused AI models. -Follow the instructions for your selected service to register the AI model in your application. +Follow the instructions for the selected service to register the AI model in the application. ### OpenAI -Generate an API key from OpenAI and set `openAIApiKey`. Specify the desired model (e.g., `gpt-3.5-turbo`, `gpt-4`) in `openAIModel`. +Generate an API key from OpenAI and set `openAIApiKey`. Specify the desired model (for example, `gpt-3.5-turbo`, `gpt-4`) in `openAIModel`. - Install the required NuGet packages: @@ -85,7 +85,7 @@ Install-Package Microsoft.Extensions.AI.OpenAI {% endhighlight %} {% endtabs %} -- Add the following to the **~/Program.cs** file in your Blazor WebApp: +- Add the following to the **~/Program.cs** file in the Blazor Web App: {% tabs %} {% highlight C# tabtitle="Blazor WebApp" hl_lines="7 8 9 11 12 13" %} @@ -110,7 +110,7 @@ var app = builder.Build(); ### Azure OpenAI -Deploy an Azure OpenAI Service resource and model as described in [Microsoft's documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource). Obtain values for `azureOpenAIKey`, `azureOpenAIEndpoint`, and `azureOpenAIModel`. +Deploy an Azure OpenAI Service resource and model as described in [Microsoft’s documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource). Obtain values for `azureOpenAIKey`, `azureOpenAIEndpoint`, and `azureOpenAIModel`. - Install the required NuGet packages: @@ -124,7 +124,7 @@ Install-Package Azure.AI.OpenAI {% endhighlight %} {% endtabs %} -- Add the following to the **~/Program.cs** file in your Blazor WebApp: +- Add the following to the **~/Program.cs** file in the Blazor Web App: {% tabs %} {% highlight C# tabtitle="Blazor WebApp" hl_lines="7 8 9 11 12 13" %} @@ -156,9 +156,9 @@ var app = builder.Build(); To use Ollama for self-hosted AI models: -1. **Download and install Ollama**: Visit [Ollama's official website](https://ollama.com) and install the application for your operating system. -2. **Install a model**: Choose a model from the [Ollama Library](https://ollama.com/library) (e.g., `llama2:13b`, `mistral:7b`). -3. **Configure the application**: Provide the `Endpoint` URL (e.g., `http://localhost:11434`) and `ModelName` (e.g., `llama2:13b`). +1. **Download and install Ollama**: Visit [Ollama's official website](https://ollama.com) and install the application for the operating system. +2. **Install a model**: Choose a model from the [Ollama Library](https://ollama.com/library) (for example, `llama2:13b`, `mistral:7b`). +3. **Configure the application**: Provide the `Endpoint` URL (for example, `http://localhost:11434`) and `ModelName` (for example, `llama2:13b`). - Install the required NuGet packages: @@ -171,7 +171,7 @@ Install-Package OllamaSharp {% endhighlight %} {% endtabs %} -- Add the following to the **~/Program.cs** file in your Blazor WebApp: +- Add the following to the **~/Program.cs** file in the Blazor Web App: {% tabs %} {% highlight C# tabtitle="Blazor WebApp" hl_lines="7 8 9 11 12 13" %} @@ -192,14 +192,14 @@ var app = builder.Build(); {% endhighlight %} {% endtabs %} -- **Verify connectivity**: Ensure the Ollama server is running and accessible at the specified endpoint (e.g., `http://localhost:11434`) before starting the application. +- **Verify connectivity**: Ensure the Ollama server is running and accessible at the specified endpoint (for example, `http://localhost:11434`) before starting the application. -## Register Syncfusion Blazor Service +## Register Syncfusion Blazor service -Add the Syncfusion Blazor service to your **~/Program.cs** file. The configuration depends on your app's **Interactive Render Mode**: +Add the Syncfusion Blazor service to the **~/Program.cs** file. The configuration depends on the app’s **Interactive Render Mode**: -- **Server Mode**: Register the service in the single **~/Program.cs** file. -- **WebAssembly or Auto Mode**: Register the service in both the server-side **~/Program.cs** and client-side **~/Program.cs** files. +- **Server mode**: Register the service in the single **~/Program.cs** file. +- **WebAssembly or Auto mode**: Register the service in both the server-side **~/Program.cs** and client-side **~/Program.cs** files. {% tabs %} {% highlight C# tabtitle="Server (~/_Program.cs)" hl_lines="3 11" %} @@ -228,9 +228,9 @@ await builder.Build().RunAsync(); {% endhighlight %} {% endtabs %} -## Razor Component (`Home.razor`) +## Razor component (`Home.razor`) -This section implements the Syncfusion Blazor TreeGrid with AI-driven data restructuring using the AI model to assign `ParentId` values based on `CategoryName` relationships. +This section implements the Syncfusion Blazor TreeGrid with AI-driven data restructuring, using the AI model to assign `ParentId` values based on `CategoryName` relationships. ```csharp @page "/" @@ -362,20 +362,20 @@ namespace AISamples.Components.Pages } ``` -## Error Handling and Troubleshooting +## Error handling and troubleshooting -If the AI service fails to return a valid response, the TreeGrid will display an error message ("Oops! Please try again!"). Common issues include: +If the AI service fails to return a valid response, the TreeGrid displays an error message (“Oops! Please try again!”). Common issues include: -- **Invalid API Key or Endpoint**: Verify that the `openAIApiKey`, `azureOpenAIKey`, or Ollama `Endpoint` is correct and the service is accessible. -- **Model Unavailable**: Ensure the specified `openAIModel`, `azureOpenAIModel`, or `ModelName` is deployed and supported. -- **Network Issues**: Check connectivity to the AI service endpoint, especially for self-hosted Ollama instances. -- **Large Datasets**: Processing large datasets may cause timeouts. Consider batching data or optimizing the prompt for efficiency. +- **Invalid API key or endpoint**: Verify that `openAIApiKey`, `azureOpenAIKey`, or the Ollama `Endpoint` is correct and the service is accessible. +- **Model unavailable**: Ensure the specified `openAIModel`, `azureOpenAIModel`, or `ModelName` is deployed and supported. +- **Network issues**: Check connectivity to the AI service endpoint, especially for self-hosted Ollama instances. +- **Large datasets**: Processing large datasets may cause timeouts. Consider batching data or optimizing the prompt. -## Performance Considerations +## Performance considerations When handling large datasets, ensure the Ollama server has sufficient resources (CPU/GPU) to process requests efficiently. For datasets exceeding 10,000 records, consider splitting the data into smaller batches to avoid performance bottlenecks. Test the application with your specific dataset to determine optimal performance. -## Sample Code +## Sample code A complete working example is available in the [Syncfusion Blazor AI Samples GitHub repository](https://github.com/syncfusion/smart-ai-samples). diff --git a/blazor/visual-studio-code-integration/upgrade-project.md b/blazor/visual-studio-code-integration/upgrade-project.md index 70af54c052..60bb491d4b 100644 --- a/blazor/visual-studio-code-integration/upgrade-project.md +++ b/blazor/visual-studio-code-integration/upgrade-project.md @@ -1,36 +1,36 @@ --- layout: post -title: Upgrade Project to Latest Version in Blazor | Syncfusion -description: Learn here about how to upgrade the project to the latest version using the Syncfusion Blazor extension for Visual Studio Code. Explore to more details. +title: Upgrade a project to the latest version | Syncfusion +description: Learn here about how to upgrade a project to the latest version using the Syncfusion Blazor extension for Visual Studio Code. Explore to more details. platform: Blazor -component: Common +control: Common documentation: ug --- -# Upgrading Syncfusion® Blazor application to updated version +# Upgrading Syncfusion® Blazor application to new version -The Syncfusion® Blazor Migration is an add-in for Visual Studio Code allows you to migrate an existing Syncfusion® Blazor Web Application from one Essential Studio® version to another. +The Syncfusion® Blazor migration add-in for Visual Studio Code enables upgrading an existing Syncfusion® Blazor web application from one Essential Studio® version to another. - N> The Syncfusion® Blazor Web Application Project Migration utility is available from `v17.4.0.39`. +N> The Syncfusion Blazor Web Application project migration utility is available from version `v17.4.0.39`. -The steps below assist you to migrating existing Syncfusion® Blazor Web Application. +Use the following steps to migrate an existing Syncfusion® Blazor Web Application. -1. Open an existing Syncfusion® Blazor Web Application or create a new Syncfusion® Blazor Web Application in Visual Studio Code. +1. In Visual Studio Code, open an existing Syncfusion® Blazor Web Application or create a new one. -2. Select **Migrate Syncfusion® Blazor Application to another version...** from the context menu when you right-click on the **Project file** from Explorer (Workspace). Refer to the screenshot below. +2. In Explorer (Workspace), right-click the project file and select **Migrate Syncfusion® Blazor Application to another version...** from the context menu. Refer to the screenshot below. - ![Migration add-in](images/Migration.PNG) + ![Context menu showing Migrate Syncfusion Blazor Application command](images/Migration.PNG) - N> If you have a Syncfusion® Blazor reference in your application, the Migration option will be enabled. + N> The Migration option is available only when the application already references Syncfusion® Blazor packages. -3. **Select Blazor Version** (which published in `nuget.org`) from the palette appears. +3. From the Command Palette, choose **Select Blazor Version** and pick the required Syncfusion® Blazor package version published on `nuget.org`. - ![Select Blazor Version](images/VersionSelection.PNG) + ![Palette showing selection of Syncfusion Blazor version](images/VersionSelection.PNG) -4. The Syncfusion® NuGet packages references and themes are updated to the selected version in the application. +4. The Syncfusion® Blazor NuGet package references and theme links are updated to the selected version in the application. - ![NuGetPackage](images/NuGetPackage.png) + ![Project file updated with new Syncfusion NuGet package versions](images/NuGetPackage.png) - ![CDNLink](images/CDNLink.png) + ![Theme link updated to the selected version](images/CDNLink.png) 5. If you installed the trial setup or NuGet packages from nuget.org you must register the Syncfusion® license key to your application since Syncfusion® introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio® release. Navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key) to generate and register the Syncfusion® license key to your application. Refer to this [UG](https://blazor.syncfusion.com/documentation/getting-started/license-key/overview) topic for understanding the licensing details in Essential Studio® for Blazor. \ No newline at end of file diff --git a/blazor/visual-studio-integration/Syncfusion-Notifications.md b/blazor/visual-studio-integration/Syncfusion-Notifications.md index 01a74c23c9..e0d7d386d9 100644 --- a/blazor/visual-studio-integration/Syncfusion-Notifications.md +++ b/blazor/visual-studio-integration/Syncfusion-Notifications.md @@ -1,51 +1,51 @@ --- layout: post -title: Notifications | Blazor | Syncfusion -description: For displaying the notifications about trial and newer version update information for Syncfusion applications. +title: Syncfusion notifications in Blazor | Syncfusion +description: Configure and understand Syncfusion notifications in Blazor applications, including trial license alerts, newer NuGet package updates, ES build notifications. platform: Blazor control: Syncfusion Extensions documentation: ug --- -# Syncfusion® Notifications +# Syncfusion® notifications Syncfusion® enhances the user experience in Blazor applications through notification messages. These notifications cover various aspects, including alerts for trial applications when using Syncfusion® trial assemblies, updates about the availability of the latest Syncfusion® NuGet package, and notifications about newer releases of Essential Studio®. By keeping users informed, Syncfusion® ensures that developers stay up to date with the latest features and enhancements. -N> The Syncfusion® Notification feature is available from Essential Studio® v22.1.34. +N> The Syncfusion® notifications feature is available starting with Essential Studio® v22.1.34. -## Notification Configuration +## Notification configuration -The Syncfusion® Options page allows you to configure notification settings. Customise trial and newer version notifications with a simple true or false toggle. +Notification behavior is configured in Visual Studio on the Syncfusion® Options page. Use the toggles to true or false trial and newer version notifications. -It can be accessed by clicking **Tools -> Options -> Syncfusion -> Blazor** +To access the settings, go to **Tools -> Options -> Syncfusion -> Blazor**. - ![Option Page](images/blazor_optionPage.png) + ![Visual Studio Options page for Syncfusion Blazor notifications](images/blazor_optionPage.png) -## Notification Types +## Notification types -**1. Syncfusion® Trial Application Notification** +**1. Syncfusion® trial application notification** -When you utilize Syncfusion® trial assemblies in your Blazor application, you will receive a notification stating, **This application uses a trial Syncfusion® license.** This notification encourages you to obtain a valid license key, enabling you to fully explore and experience the extensive features and capabilities offered by Syncfusion®. +When trial licensing is detected in a Blazor application, a message is shown: **This application uses a trial Syncfusion® license.** This notification encourages you to obtain a valid license key, enabling you to fully explore and experience the extensive features and capabilities offered by Syncfusion®. - ![Trial Notification](images/blazor_trial.png) + ![In-app banner indicating the application uses a trial Syncfusion license](images/blazor_trial.png) -**2. Newer Syncfusion® NuGet Package Notification** +**2. Newer Syncfusion® NuGet package notification** -If you have installed lower versions of Syncfusion® NuGet packages in your application, you will be notified about the availability of higher versions of Syncfusion® NuGet packages on nuget.org. This empowers you to easily identify opportunities to upgrade and gain access to new features, performance enhancements, and bug fixes. +If older Syncfusion® NuGet packages are referenced, a notification indicates that newer versions are available on NuGet.org. Upgrading provides access to new features, performance improvements, and bug fixes. - ![NuGet Notification](images/blazor_nuget.png) + ![Notification indicating newer Syncfusion NuGet packages are available](images/blazor_nuget.png) -**3. Newer Essential Studio® Build Notification** +**3. Newer Essential Studio® build notification** -If you use older versions of Syncfusion® assemblies or NuGet packages from **Essential Studio® Blazor,** Syncfusion® will notify you about new releases for the latest Essential Studio® build. Updating to the newest version ensures access to recent features, enhancements, and important updates, maximizing the capabilities of Syncfusion® in your Blazor development projects. +When using older Essential Studio® assemblies or NuGet packages, a notification announces the availability of a newer Essential Studio® build for Blazor. Updating to the newest version ensures access to recent features, enhancements, and important updates, maximizing the capabilities of Syncfusion® in your Blazor development projects. - ![Build Notification](images/blazor_build.png) + ![Notification announcing a newer Essential Studio build is available](images/blazor_build.png) -**4. Invalid License Key Notification** +**4. Invalid license key notification** If you have mistakenly used an incorrect license key or a license from another version or platform in your Blazor application, Syncfusion® will display a notification message stating, **The provided Syncfusion® license key is invalid**. This message serves as a reminder to obtain a valid license key and ensure proper licensing for Syncfusion® components. - ![Invalid Notification](images/blazor_invalid.png) + ![Notification indicating the provided Syncfusion license key is invalid](images/blazor_invalid.png) diff --git a/blazor/visual-studio-integration/convert-project.md b/blazor/visual-studio-integration/convert-project.md index 146307ea28..1ef92b4d70 100644 --- a/blazor/visual-studio-integration/convert-project.md +++ b/blazor/visual-studio-integration/convert-project.md @@ -1,52 +1,52 @@ --- layout: post -title: Convert Project in Blazor | Syncfusion -description: Learn here about how to convert the blazor application to Syncfusion Blazor application using Syncfusion Blazor Extension for Visual Studio. +title: Convert a Blazor project to Syncfusion Blazor | Syncfusion +description: Learn how to convert an existing Blazor application to a Blazor application using the Blazor Extension for VS 2022, including NuGet package installation. platform: Blazor -component: Common +control: Common documentation: ug --- # Converting Blazor application to Syncfusion® Blazor application -The Syncfusion® Blazor conversion is a Visual Studio add-in that transforms an existing Blazor application into a Syncfusion® Blazor application by adding the necessary assemblies and theme files. +The Syncfusion® Blazor conversion is a Visual Studio add-in that transforms an existing Blazor application into a Syncfusion® Blazor application by installing the required NuGet packages and adding the corresponding theme styles to the layout. -The steps below help you to convert the **Blazor application** to the **Syncfusion® Blazor application** via the **Visual Studio 2022**: +The steps below describe how to convert a Blazor application to a Syncfusion® Blazor application using Visual Studio 2022. -N> Before use the Syncfusion® Blazor Project Conversion, check whether the Syncfusion® Blazor Template Studio Extension installed or not in Visual Studio Extension Manager by clicking on the Extensions -> Manage Extensions -> Installed. If this extension not installed, install the extension by follow the steps from the [download and installation](download-and-installation) help topic. +N> Before using the Syncfusion® Blazor Project Conversion, verify that the Syncfusion® Blazor Template Studio extension is installed in Visual Studio (Extensions -> Manage Extensions -> Installed). If the extension is not installed, install it by following the instructions in the [download and installation](download-and-installation) help topic. -1. Open your existing Blazor application or create a new Blazor application in Visual Studio 2022. +1. Open the existing Blazor application or create a new Blazor application in Visual Studio 2022. -2. To open the Syncfusion® Project Conversion Wizard, follow either one of the options below: +2. Open the Syncfusion® Project Conversion wizard using one of the following options: **Option 1:** - Choose **Extensions -> Syncfusion® -> Essential Studio® for Blazor -> Convert Project...** in the Visual Studio menu. + Choose **Extensions -> Syncfusion® -> Essential Studio® for Blazor -> Convert Project...** from the Visual Studio menu. - ![ConversionMenu](images/ConversionMenu.png) + ![Open Convert Project from the Extensions menu in Visual Studio](images/ConversionMenu.png) **Option 2:** - Right-click the application from the **Solution Explorer** and select the **Syncfusion® Blazor** and choose the **Convert to Syncfusion® Blazor application...** + In **Solution Explorer**, right-click the project, select **Syncfusion® Blazor**, and then choose **Convert to Syncfusion® Blazor application...** - ![ConversionAddin](images/ConversionAddin.png) + ![Open Convert Project from the Solution Explorer context menu](images/ConversionAddin.png) -3. The Syncfusion® Blazor Project Conversion window will appear. You can choose the required version of Syncfusion® Blazor and Themes to convert the application. +3. In the Syncfusion® Blazor Project Conversion window, select the required Syncfusion® Blazor version and theme to apply to the application. - ![ConversionWizard](images/Conversion.png) + ![Syncfusion Blazor Project Conversion wizard with version and theme selection](images/Conversion.png) - N> The versions are loaded from the Syncfusion® Blazor NuGet packages published in [`NuGet.org`](https://www.nuget.org/packages?q=Tags%3A%22blazor%22syncfusion) and it requires internet connectivity. + N> Versions are loaded from the Syncfusion® Blazor NuGet packages available on [`NuGet.org`](https://www.nuget.org/packages?q=Tags%3A%22blazor%22syncfusion) and require an active internet connection. -4. Check the **“Enable a backup before converting”** checkbox if you want to take the project backup and choose the location. +4. Select the **Enable a backup before converting** checkbox to create a project backup, and then choose the backup location. -5. Once the conversion process has been completed, you will get a successful message window. +5. After the conversion completes, a confirmation message is displayed. - ![ConversionSuccessMessage](images/ConversionSuccess.png) + ![Conversion succeeded message after completing the conversion](images/ConversionSuccess.png) - If you enabled project backup before converting, the old application was saved in the specified backup path location, as shown below once the conversion process completed. + If a backup was enabled, the original project is saved to the specified backup path after conversion, as shown below. - ![ConversionBackupLocation](images/Backuplocation.png) + ![Backup location for the original project created during conversion](images/Backuplocation.png) -6. The selected Blazor application is converted into a Syncfusion® Blazor application by installing the appropriate Syncfusion® Blazor NuGet packages with the selected version and adding the chosen styles to the corresponding layout file. +6. The selected Blazor application is converted to a Syncfusion® Blazor application by installing the appropriate Syncfusion® Blazor NuGet packages for the chosen version and adding the selected theme styles to the project’s layout file. -7. If you installed the trial setup or NuGet packages from nuget.org you must register the Syncfusion® license key to your application since Syncfusion® introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio® release. Navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key) to generate and register the Syncfusion® license key to your application. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2) post for understanding the licensing changes introduced in Essential Studio®. \ No newline at end of file +7. If using a trial setup or packages from NuGet.org, a Syncfusion® license key must be registered with the application. Syncfusion® introduced license registration starting with the 2018 Volume 2 (v16.2.0.41) Essential Studio® release. Refer to the [licensing overview and key generation guide](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key) to generate and register the Syncfusion® license key. For details about the licensing changes introduced in Essential Studio®, see the [2018 Volume 2 announcement](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2). \ No newline at end of file diff --git a/blazor/visual-studio-integration/images/MigrationAddin.png b/blazor/visual-studio-integration/images/MigrationAddin.png index 0ec7ac0395..9d729cf93d 100644 Binary files a/blazor/visual-studio-integration/images/MigrationAddin.png and b/blazor/visual-studio-integration/images/MigrationAddin.png differ diff --git a/blazor/visual-studio-integration/upgrade-project.md b/blazor/visual-studio-integration/upgrade-project.md index e90bf2fe4c..b63265eff4 100644 --- a/blazor/visual-studio-integration/upgrade-project.md +++ b/blazor/visual-studio-integration/upgrade-project.md @@ -1,52 +1,52 @@ --- layout: post -title: Upgrade Project in Blazor - Syncfusion -description: Learn here about how to upgrade the project in the Syncfusion Essential Blazor application to latest version. +title: Upgrade a Syncfusion Blazor project to the latest version | Syncfusion +description: Learn how to upgrade a Blazor application to latest version using Blazor Project Migration wizard in VS 2022, including NuGet package updates and backup option. platform: Blazor -component: Common +control: Common documentation: ug --- # Upgrading Syncfusion® Blazor application to latest version -The Syncfusion® Blazor migration add-in for Visual Studio allows you to migrate an existing Syncfusion® Blazor application from one version of Essential Studio® to another. This reduces the amount of manual work required during the migration process. +The Syncfusion® Blazor project migration wizard for Visual Studio updates an existing Syncfusion® Blazor application from one Essential Studio® version to another by upgrading the corresponding Syncfusion® Blazor NuGet packages. This reduces manual effort and helps keep projects current. -The steps below will assist you to upgrade the Syncfusion® version in the Syncfusion® Blazor application via Visual Studio 2022: +The steps below describe how to upgrade the Syncfusion® version in a Syncfusion® Blazor application using Visual Studio 2022. -N> Before use the Syncfusion® Blazor Project Migration, check whether the Syncfusion® Blazor Template Studio Extension installed or not in Visual Studio Extension Manager by clicking on the Extensions -> Manage Extensions -> Installed. If this extension not installed, install the extension by follow the steps from the [download and installation](download-and-installation) help topic. +N> Before using the Syncfusion® Blazor Project Migration, verify that the Syncfusion® Blazor Template Studio extension is installed in Visual Studio (Extensions -> Manage Extensions -> Installed). If the extension is not installed, install it by following the instructions in the [download and installation](download-and-installation) help topic. -1. Open the Syncfusion® Blazor application that uses the Syncfusion® component in the Visual Studio 2022. +1. Open the Syncfusion® Blazor application that uses Syncfusion® components in Visual Studio 2022. -2. To open the Migration Wizard, either one of the following options should be followed: +2. Open the Migration Wizard using one of the following options: **Option 1** - Choose **Extensions -> Syncfusion® -> Essential Studio® for Blazor -> Migrate Project…** from Visual Studio 2022 menu. + Choose **Extensions -> Syncfusion® -> Essential Studio® for Blazor -> Migrate Project…** from the Visual Studio 2022 menu. - ![MigrationMenu](images/MigrationMenu.PNG) + ![Open the Migrate Project wizard from the Extensions menu in Visual Studio](images/MigrationMenu.PNG) **Option 2** - Right-click the application from the **Solution Explorer** and select the **Syncfusion® Blazor** and choose the **Migrate Syncfusion® Blazor project from another version...** + In **Solution Explorer**, right-click the project, select **Syncfusion® Blazor**, and then choose **Migrate Syncfusion® Blazor project from another version...** - ![MigrationAddin](images/MigrationAddin.png) + ![Open the Migrate Project wizard from the Solution Explorer context menu](images/MigrationAddin.png) -3. The Syncfusion® Project Migration window will appear. You can choose the required version of Syncfusion® Blazor to migrate. +3. In the Syncfusion® Project Migration window, select the required Syncfusion® Blazor version to migrate to. - N> The versions are loaded from the Syncfusion® Blazor NuGet packages published in [`NuGet.org`](https://www.nuget.org/packages?q=Tags%3A%22blazor%22syncfusion) and it requires internet connectivity. + N> Versions are loaded from the Syncfusion® Blazor NuGet packages published on [NuGet.org](https://www.nuget.org/packages?q=Tags%3A%22blazor%22syncfusion) and require an active internet connection. - ![MigrationWizard](images/Migration.png) + ![Syncfusion Blazor Project Migration wizard with version selection](images/Migration.png) -4. Check the **“Enable a backup before migrating”** checkbox if you want to take the project backup and choose the location. +4. Select the **Enable a backup before migrating** checkbox to create a project backup, and then choose the backup location. -5. Once the migration process is completed, you will get a successful message window +5. After the migration completes, a confirmation message is displayed. - ![MigrationSuccessMessage](images/MigrationSuccess.png) + ![Migration succeeded message after completing the project migration](images/MigrationSuccess.png) - If you enabled project backup before migrating, the old application was saved in the specified backup path location, as shown below once the migration process completed. + If a backup was enabled, the original project is saved to the specified backup path after migration, as shown below. - ![MigrationBackupLocation](images/Backuplocation.png) + ![Backup location of the original project created during migration](images/Backuplocation.png) -6. The Syncfusion® Blazor NuGet packages are updated to the respective selected version in the Syncfusion® Blazor application. +6. The Syncfusion® Blazor NuGet packages are updated to the selected version in the Syncfusion® Blazor application. -7. If you installed the trial setup or NuGet packages from nuget.org you must register the Syncfusion® license key to your application since Syncfusion® introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio® release. Navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key) to generate and register the Syncfusion® license key to your application. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx) post for understanding the licensing changes introduced in Essential Studio®. \ No newline at end of file +7. If using a trial setup or packages from NuGet.org, a Syncfusion® license key must be registered with the application. Syncfusion® introduced license registration starting with the 2018 Volume 2 (v16.2.0.41) Essential Studio® release. Refer to the [licensing overview and key generation guide](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key) to generate and register the Syncfusion® license key. For details about the licensing changes introduced in Essential Studio®, see the [2018 Volume 2 announcement](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx). \ No newline at end of file