Skip to content

Commit 44418b2

Browse files
committed
docs(AIPrompt): Fix broken link, clarify AI dependency
1 parent d8fae76 commit 44418b2

File tree

3 files changed

+6
-1
lines changed

3 files changed

+6
-1
lines changed

common-features/microsoft-extensions-ai-integration.md

+4
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ Other components will support similar integration in future versions of UI for B
1818

1919
To integrate the **Microsoft.Extensions.AI** library with your AIPrompt component, register an [`IChatClient`](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.ai.ichatclient?view=net-9.0-pp) service and configure it according to the model you are using. The AIPrompt is designed to automatically use the registered `IChatClient`.
2020

21+
> The Microsoft AI library is still in preview, so breaking changes may occur. Telerik UI for Blazor references `Microsoft.Extensions.AI.Abstractions` version `9.1.0-preview.1.25064.3`. Do not register a newer version of this package explicitly in your app, as this may cause integration issues or exceptions.
22+
>
23+
> When using the Telerik AIPrompt component with the Microsoft AI library, do not subscribe to the `OnPromptRequest` event.
24+
2125
**Microsoft.Extensions.AI provides** a simple integration with various models where the configuration slightly differs depending on the model. The example below shows usage of [Azure OpenAI](https://www.nuget.org/packages/Azure.AI.OpenAI) and you may [explore some other examples with different models in this post](https://devblogs.microsoft.com/dotnet/introducing-microsoft-extensions-ai-preview/#chat).
2226

2327
>caption Startup.cs:

components/aiprompt/events.md

+1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ The event handler receives an argument of type [`AIPromptPromptRequestEventArgs`
3232
| `IsCancelled` | `bool` | Whether the event is cancelled and the built-in action is prevented. |
3333
| `OutputItem` | `AIPromptOutputItemDescriptor` | The output item. This property will be populated only when the user retries an existing output. See [`AIPromptOutputItemDescriptor`](slug:Telerik.Blazor.Components.AIPromptOutputItemDescriptor). |
3434

35+
> Do not use the `OnPromptRequest` event when [integrating the AIPrompt component with `Microsoft.Extensions.AI`](slug:common-features-microsoft-extensions-ai-integration). The `OnPromptRequest` event disables such integration.
3536
3637
## OnCommandExecute
3738

components/aiprompt/overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ The table below lists the AIPrompt parameters. For a full list of the AIPrompt A
103103
| `PromptSuggestions` | `List<string>` | The prompt suggestions displayed within the Prompt view. |
104104
| `PromptSuggestionItemTemplate` | `RenderFragment<string>` | The Prompt Suggestion Item template of the AIPrompt. |
105105
| `ShowOutputRating` | `bool` <br /> (`false`) | Controls the visibility of the rating buttons within the output card. |
106-
| `SystemPrompt` | `string` <br/> (See "Description" column) | Defines the system prompt that is passed to the [`IChatClient.CompleteAsync`](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.ai.ichatclient.completeasync?view=net-9.0-pp), when such is used. The default value is: `"You are a helpful assistant designed to assist users. Your goal is to provide helpful, accurate, and contextually appropriate information in a clear and concise manner. Avoid discussing harmful, illegal, or inappropriate topics"`.
106+
| `SystemPrompt` | `string` <br /> (See "Description" column) | Defines the system prompt that is passed to `IChatClient.CompleteAsync()`. This method exists in `Microsoft.Extensions.AI.Abstractions` package version `9.1.0-preview.1.25064.3`, but not in newer versions. Referencing a newer version explicitly in your app will cause a runtime exception. <br /><br /> The default `SystemPrompt` value is: `"You are a helpful assistant designed to assist users. Your goal is to provide helpful, accurate, and contextually appropriate information in a clear and concise manner. Avoid discussing harmful, illegal, or inappropriate topics"`.
107107
| `Width` | `string` | The `width` style of the component in any [supported CSS unit](slug:common-features/dimensions). The default AIPrompt dimensions depend on the CSS theme. |
108108

109109
## AIPrompt Reference and Methods

0 commit comments

Comments
 (0)