Skip to content

Commit 02b209f

Browse files
Merge pull request #6664 from syncfusion-content/982891-Blazor-UG-Updation-1
982891: Updated the Blazor UG contents for Ai Assistview
2 parents 3a9f3c6 + 17b3ed8 commit 02b209f

File tree

3 files changed

+21
-20
lines changed

3 files changed

+21
-20
lines changed

blazor/ai-assistview/ai-integrations/gemini-integration.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,19 @@ documentation: ug
99

1010
# Integration of Gemini AI With Blazor AI AssistView component
1111

12-
The Syncfusion AI AssistView supports integration with [Gemini](https://ai.google.dev/gemini-api/docs/quickstart), enabling advanced conversational AI features in your applications.
12+
The Syncfusion AI AssistView supports integration with [Gemini](https://ai.google.dev/gemini-api/docs/quickstart), enabling advanced conversational AI features in applications.
1313

1414
## Prerequisites
1515

16-
* Google account to generate API key on accessing `Gemini AI`
17-
* Syncfusion AI AssistView for Blazor `Syncfusion.Blazor.InteractiveChat` installed in your project.
16+
* Google account to generate an API key for accessing Gemini AI
17+
* Syncfusion AI AssistView for Blazor package (Syncfusion.Blazor.InteractiveChat) installed in the project
18+
* Markdig package available in the project for Markdown-to-HTML conversion (required by the sample code)
1819

1920
## Getting Started with the AI AssistView Component
2021

21-
Before integrating Gemini AI, ensure that the Syncfusion AI AssistView is correctly rendered in your application:
22+
Before integrating Gemini AI, ensure that the Syncfusion AI AssistView renders correctly in the application and that prerequisites are met:
2223

23-
[ Blazor Getting Started Guide](../getting-started)
24+
[Blazor Getting Started Guide](../getting-started)
2425

2526
## Install Dependencies
2627

@@ -42,19 +43,19 @@ Install-Package Mscc.GenerativeAI
4243

4344
## Generate API Key
4445

45-
1. Go to [Google AI Studio](https://aistudio.google.com/app/apikey) and sign in with your Google account. If you don’t have one, create a new account.
46+
1. Go to [Google AI Studio](https://aistudio.google.com/app/apikey) and sign in with a Google account. Create a new account if needed.
4647

47-
2. Once logged in, click on `Get API Key` from the left-hand menu or the top-right corner of the dashboard.
48+
2. Select Get API Key from the left menu or the top-right of the dashboard.
4849

49-
3. Click the `Create API Key` button. You’ll be prompted to either select an existing Google Cloud project or create a new one. Choose the appropriate option and proceed.
50+
3. Choose Create API Key. Select an existing Google Cloud project or create a new one, then proceed.
5051

51-
4. After selecting or creating a project, your API key will be generated and displayed. Copy the key and store it securely, as it will only be shown once.
52+
4. After creating or selecting a project, an API key is generated and displayed. Copy the key and store it securely, as it may be shown only once.
5253

53-
> `Security Note`: Never commit the API key to version control. Use environment variables or a secret manager for production.
54+
> Security note: Do not commit API keys to version control. Use environment variables, a secret manager, or a server-side proxy in production.
5455
5556
## Integration Gemini AI with AI AssistView
5657

57-
* Add your generated `API Key` at the line
58+
* Add the generated API key in the following line.
5859

5960
```bash
6061

@@ -128,4 +129,4 @@ const string GeminiApiKey = 'Place your API key here';
128129
{% endhighlight %}
129130
{% endtabs %}
130131

131-
![Blazor AI AssistView Gemini Integration](./images/gemini-integration.png)
132+
![Blazor AI AssistView Gemini Integration](../images/gemini-integration.png)

blazor/ai-assistview/ai-integrations/openai-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,4 +240,4 @@ var deploymentName = "gpt-4o-mini";
240240
{% endhighlight %}
241241
{% endtabs %}
242242

243-
![Blazor AI AssistView Azure Open AI Integration](./images/openai-integration.png)
243+
![Blazor AI AssistView Azure Open AI Integration](../images/openai-integration.png)

blazor/ai-assistview/how-to/integration-with-ai.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@ documentation: ug
1111

1212
The Syncfusion<sup style="font-size:70%">&reg;</sup> AI AssistView component supports integration with the `Microsoft.Extensions.AI` framework, enabling seamless communication with various large language models (LLMs) such as `Azure OpenAI`, `OpenAI`, and more.
1313

14-
`The Microsoft.Extensions.AI` simplifies integration with different models, requiring minimal configuration changes depending on the provider. The following example demonstrates integration using `Azure OpenAI`.
14+
`Microsoft.Extensions.AI` simplifies integration with different providers and typically requires only minimal configuration changes based on the selected model. The following example demonstrates integration using `Azure OpenAI`.
1515

16-
N> The Microsoft AI extension libraries are currently in preview, and breaking changes may occur. Ensure that you use compatible versions to avoid integration issues.
16+
N> The Microsoft AI extension libraries are currently in preview and may include breaking changes. Use compatible versions of all referenced packages to prevent integration issues.
1717

1818
### Getting started with AI AssistView
1919

20-
Before integrating `AI AssistView` with `Microsoft.Extensions.AI`, ensure the SfAIAssistView component is rendered by following the appropriate project guideline:
20+
Before integrating `AI AssistView` with `Microsoft.Extensions.AI`, ensure the `SfAIAssistView` component is rendered by following the appropriate project guidelines:
2121

2222
* [Blazor Web App](../getting-started-webapp)
2323
* [Blazor WASM App](../getting-started)
2424

2525
### Prerequisites for Microsoft.Extensions.AI integration
2626

27-
To add the required NuGet packages, use the NuGet package manager in Visual Studio (*Tools → NuGet Package Manager → Manage NuGet Packages for Solution*) search and install the following:
27+
To add the required NuGet packages, use the NuGet Package Manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), then search for and install the following packages:
2828

2929
* `Azure.AI.OpenAI`
3030
* `Azure.Identity`
@@ -48,7 +48,7 @@ dotnet add package Markdig
4848

4949
### Configure services in Program.cs
5050

51-
Register the `Azure OpenAI` client and Syncfusion<sup style="font-size:70%">&reg;</sup> AI AssistView component within the Blazor application.
51+
Register the `Azure OpenAI` client and the Syncfusion<sup style="font-size:70%">&reg;</sup> AI AssistView component within the Blazor application.
5252

5353
{% tabs %}
5454
{% highlight c# tabtitle="~/_Program.cs" hl_lines="2 9" %}
@@ -88,9 +88,9 @@ var app = builder.Build();
8888

8989
### AI AssistView with IChatClient
9090

91-
The Syncfusion<sup style="font-size:70%">&reg;</sup> `AI AssistView` component is built to seamlessly integrate with external AI services. When the `IChatClient` is registered via `Microsoft.Extensions.AI`, the component automatically uses it to handle user prompts without any additional configuration.
91+
The Syncfusion<sup style="font-size:70%">&reg;</sup> AI AssistView component is designed to integrate seamlessly with external AI services. When an `IChatClient` is registered via Microsoft.Extensions.AI, the component automatically uses it to process user prompts without additional component configuration.
9292

93-
In the following example, the user input is processed using the injected `IChatClient`. The AI model's response is returned in Markdown format which is converted to HTML using the `Markdig` library before rendering in the AI AssistView component.
93+
In the following example, user input is sent to the injected `IChatClient`. The AI models response is returned in Markdown, converted to HTML using the `Markdig` library, and rendered in the AI AssistView component.
9494

9595
{% tabs %}
9696
{% highlight razor %}

0 commit comments

Comments
 (0)