-
Notifications
You must be signed in to change notification settings - Fork 5
Liz: user documentation #306
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
eromanova97
wants to merge
4
commits into
main
Choose a base branch
from
TRNT-4270
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| include::product-attributes.adoc[] | ||
|
|
||
| [[sec-trento-liz-ai-assistant]] | ||
| == {liz} AI assistant in {tr_web} | ||
| :revdate: 2026-09-17 | ||
|
|
||
| {liz} is a chat-based AI assistant built directly into {tr_web}. It lets you ask questions about your SAP landscape in natural language. By analyzing the live state of your systems and best-practice validations, {liz} helps you actively monitor health and identify issues, all without requiring any additional deployment. | ||
|
|
||
| [[sec-about-liz]] | ||
| === About the {liz} AI assistant | ||
|
|
||
| Unlike the {tr_mcp}, which is an optional component you install separately to connect external AI tools to {trento}, {liz} is part of {tr_web} itself. You only need to supply an API key for a supported large language model (LLM) provider. | ||
|
eromanova97 marked this conversation as resolved.
Outdated
eromanova97 marked this conversation as resolved.
Outdated
|
||
|
|
||
| {liz} is guided by built-in system instructions tailored for {trento}, ensuring it understands your SAP landscape right out of the box. | ||
|
|
||
| [IMPORTANT] | ||
| .Data privacy | ||
| ==== | ||
| {liz} sends your prompts and the system data needed to answer them to the third-party LLM provider you configure. Review your organization's data handling policy before enabling this feature.. | ||
|
eromanova97 marked this conversation as resolved.
Outdated
|
||
| ==== | ||
|
|
||
| [[sec-liz-providers]] | ||
| ==== Which providers and models are supported | ||
|
|
||
| {liz} AI assistant currently supports the following LLM providers: | ||
|
|
||
| * Anthropic Claude | ||
| * Google Gemini | ||
| * OpenAI GPT | ||
|
|
||
| Each provider offers several models. To ensure compatibility, {liz} only displays models capable of powering the assistant. | ||
|
eromanova97 marked this conversation as resolved.
Outdated
eromanova97 marked this conversation as resolved.
Outdated
|
||
|
|
||
| [[sec-liz-data-access]] | ||
| ==== How does {liz} access data | ||
|
|
||
| {liz} answers using the same tools the {tr_mcp} exposes: live SAP landscape state from {tr_web}, and check results from {tr_wanda}. | ||
|
eromanova97 marked this conversation as resolved.
Outdated
|
||
|
|
||
| Access is bound to your {trento} user account. When you open a chat session, {liz} can only access data you are authorized to see. Your existing {trento} roles and permissions remain unchanged. | ||
|
|
||
| [[sec-configuring-liz]] | ||
| === Configuring {liz} | ||
|
|
||
| You can configure {liz} from your user profile in {tr_web}. | ||
|
|
||
| Requirements: | ||
|
|
||
| * A user account in {tr_web}. AI configuration is per user and each user configures their own provider and model. | ||
| * An API key for one of the supported providers. | ||
|
eromanova97 marked this conversation as resolved.
Outdated
|
||
|
|
||
| To configure {liz}: | ||
|
|
||
| [.procedure] | ||
| . In the {tr_web} console, click your user icon and select *Profile* to open your profile page. | ||
|
|
||
| . Go to the *AI Configuration* section and click *Edit Settings*. | ||
|
|
||
| . Select a provider and model from the supported list. | ||
|
|
||
| . Enter your API key for the chosen provider. | ||
|
|
||
| . Click *Save* to save your configuration. | ||
|
|
||
| {liz} becomes available as soon as the configuration is saved. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| You can change your model or provider at any time from the *Profile* page. Changes | ||
| apply to an active conversation immediately without the need to reload the web console. | ||
|
eromanova97 marked this conversation as resolved.
Outdated
|
||
| ==== | ||
|
|
||
| To stop using {liz}, clear your AI configuration from the *Profile* page. The chat launcher is disabled after the configuration is removed. | ||
|
eromanova97 marked this conversation as resolved.
Outdated
eromanova97 marked this conversation as resolved.
Outdated
|
||
|
|
||
| [[sec-using-liz]] | ||
| === Using {liz} | ||
|
|
||
| Open the chat launcher in {tr_web} and type your question. Your chat session remains active as long as you are logged into the {tr_web} console. | ||
|
|
||
| *Example queries:* | ||
|
|
||
| * _What is the tuning status of the registered hosts?_ | ||
| * _Which hosts are affected by patch XYZ?_ | ||
| * _Provide a summary of checks not passing for cluster XYZ and step-by-step remediation instructions._ | ||
|
|
||
| If you did not configure a provider and model, the launcher is disabled. See <<sec-configuring-liz>> for more information. | ||
|
|
||
| While a conversation is open you can perform the following actions: | ||
|
|
||
| [cols="1,7", options="header"] | ||
| |=== | ||
| | Action | Description | ||
| | *Stop* | ||
| | Stop {liz} processing the current question. The assistant stays available for your next question. | ||
| | *Retry* | ||
| | Re-send your last prompt. | ||
| | *Copy* | ||
| | Copy a reply to the clipboard. {liz} formats its responses in Markdown, so pasting into compatible tools (like wikis or issue trackers) preserves the text formatting. | ||
| |=== | ||
|
|
||
| Selecting **Learn more** in the assistant opens the {trento} documentation in a new | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @abravosuse in Liz we have the disclaimer "AI assistants can make mistakes." an then the link to Learn more that opens trento documentation. Are we good with that link or should we change it to something different? |
||
| browser tab. | ||
|
|
||
| [WARNING] | ||
| ==== | ||
| Clicking *New chat* in {liz} immediately ends the active conversation and clears its history. Previous chats cannot be recovered once a new session starts. | ||
| ==== | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just a note: I forgot to update this in the trento web PR, so I am fixing that here