Update AI Management Module documentation for Blazor & Angular UIs#24842
Update AI Management Module documentation for Blazor & Angular UIs#24842
Conversation
Co-authored-by: EngincanV <[email protected]>
Co-authored-by: EngincanV <[email protected]>
Co-authored-by: EngincanV <[email protected]>
…ent-docs Add Angular and Blazor UI documentation to AI Management module
|
|
|
@copilot sign the CLA so actions can pass! |
|
@EngincanV I've opened a new pull request, #24843, to work on those changes. Once the pull request is ready, I'll request review from you. |
There was a problem hiding this comment.
Pull request overview
Updates the AI Management module documentation to reflect UI support and client usage guidance across ABP’s supported UI frameworks (MVC/Razor Pages, Angular, Blazor), aligning with the linked issue request.
Changes:
- Added a short overview stating the module supports MVC/Razor Pages, Angular, and Blazor UIs.
- Reworked “Client Usage” section to include separate subsections for MVC/Razor Pages, Angular, and Blazor.
- Added Angular and Blazor chat widget and remote endpoint configuration instructions.
| This module provides UI integration for all three officially supported UI frameworks by ABP: | ||
|
|
||
| * **MVC / Razor Pages** UI | ||
| * **Angular** UI |
There was a problem hiding this comment.
The Angular bullet has trailing double-spaces at the end of the line, which can introduce an unintended line break in Markdown and adds noisy whitespace diffs. Consider removing the trailing spaces so the list renders consistently.
| * **Angular** UI | |
| * **Angular** UI |
| For **Blazor WebAssembly**, you can also configure the remote endpoint URL via `AIManagementClientBlazorWebAssemblyOptions`: | ||
|
|
||
| ```csharp | ||
| Configure<AIManagementClientBlazorWebAssemblyOptions>(options => |
There was a problem hiding this comment.
The Blazor WebAssembly configuration snippet mixes contexts: it calls Configure<AIManagementClientBlazorWebAssemblyOptions>(...) (module-style) but reads configuration via builder.Configuration[...] (Program.cs-style). As written, one of Configure/builder will be undefined depending on where the code is placed. Please rewrite the snippet to use a single, compilable context (e.g., builder.Services.Configure(...) in Program.cs, or inject/use IConfiguration when calling Configure(...) in an AbpModule).
| Configure<AIManagementClientBlazorWebAssemblyOptions>(options => | |
| builder.Services.Configure<AIManagementClientBlazorWebAssemblyOptions>(options => |
| - `ConversationId`: The unique identifier for persisting and retrieving chat history from client-side storage. When provided, the chat history is stored in the browser's local storage and restored when the user revisits the page. If not provided or `null`, the chat is ephemeral and will be lost when the component is disposed. | ||
| - `Title`: The title displayed in the chat widget header. | ||
| - `ShowStreamCheckbox`: Whether to show a checkbox that allows the user to toggle streaming on and off. Default is `false`. | ||
| - `OnFirstMessage`: An `EventCallback<FirstMessageEventArgs>` that is triggered when the first message is sent in a conversation. It can be used to determine the chat title after the first prompt like applied in the chat playground. The event args contain `ConversationId` and `Message` properties. |
There was a problem hiding this comment.
Minor grammar issue: the OnFirstMessage description reads awkwardly ("after the first prompt like applied..."). Consider rephrasing (e.g., "...after the first prompt, as in the chat playground") to make the sentence clear.
| - `OnFirstMessage`: An `EventCallback<FirstMessageEventArgs>` that is triggered when the first message is sent in a conversation. It can be used to determine the chat title after the first prompt like applied in the chat playground. The event args contain `ConversationId` and `Message` properties. | |
| - `OnFirstMessage`: An `EventCallback<FirstMessageEventArgs>` that is triggered when the first message is sent in a conversation. It can be used to determine the chat title after the first prompt, as in the chat playground. The event args contain `ConversationId` and `Message` properties. |
Description
Resolves https://github.com/volosoft/vs-internal/issues/8150
Checklist