-
Notifications
You must be signed in to change notification settings - Fork 226
DOCS-1210 - Add Knowledge Agent to Mobot beta (ETA: Nov 14) #5967
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’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jpipkin1
wants to merge
6
commits into
main
Choose a base branch
from
docs-1210-knowledge-agent-beta
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.
+32
−9
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
62f20f2
Add Knowledge Agent to Mobot beta article
jpipkin1 0708037
Minor tweaks
jpipkin1 1209216
Minor tweaks
jpipkin1 6368019
Fresh screenshots
jpipkin1 8aef4e1
Merge branch 'main' into docs-1210-knowledge-agent-beta
kimsauce 6917d24
add memory retention for KA
kimsauce 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,7 +19,16 @@ Our new conversational experience in Mobot (formerly known as Copilot) lets you | |
|
|
||
| As we transition the feature name from *Copilot* to *Mobot*, some UI labels and screenshots may still show **Copilot**. Functionality is unchanged. | ||
|
|
||
| ## What's new in Beta | ||
| <!-- What is Mobot? consists of query agent which does xxxx and knowledge agent which does xxx --> | ||
|
|
||
|
|
||
| ## Query Agent | ||
|
|
||
| Select **Query Agent** to get help with Sumo Logic queries. | ||
|
|
||
| <img src={useBaseUrl('img/search/mobot/mobot-logs-agent-button.png')} alt="Query Agent button selected in the Mobot UI" style={{border: '1px solid gray'}} width="600" /> | ||
|
|
||
| ### What's new in Beta | ||
|
|
||
| * **Conversational flow**. Refine queries through natural, conversational follow-up questions without losing context. A sequence of related instructions that retains context and incrementally updates the query and output. | ||
| * **Automatic source detection**. Have Mobot choose a data source automatically based on your question or enter one yourself. | ||
|
|
@@ -30,11 +39,11 @@ As we transition the feature name from *Copilot* to *Mobot*, some UI labels and | |
| * **Guided exploration**. Intent cards summarize your current goal, and suggestion cards offer refinements you can apply with a click. | ||
| * **Integrated workflow**. A conversation pane shows your prompts and refinements, with queries rendered directly in the editor, live results, and the ability to branch or revisit past conversations. | ||
|
|
||
| ## Typical workflow | ||
| ### Typical workflow | ||
|
|
||
| The steps below outline a common conversational interaction pattern. You can apply the same approach to different logs, events, or dimensions. | ||
|
|
||
| ### Step 1: Ask your initial question | ||
| #### Step 1: Ask your initial question | ||
|
|
||
| Use natural language to ask what you're looking for. You can start broad when you set a goal, or, for better results, include the name of the data source you're querying, and any related field names or values. | ||
|
|
||
|
|
@@ -47,7 +56,7 @@ We'll ask: `Show failed login attempts in the last 24 hours`. | |
| <img src={useBaseUrl('img/search/mobot/initial-question.png')} alt="Mobot conversational experience showing initial query for failed login attempts in the last 24 hours" style={{border: '1px solid gray'}} width="700"/> | ||
| --> | ||
|
|
||
| ### Step 2: Narrow the scope | ||
| #### Step 2: Narrow the scope | ||
|
|
||
| After clicking on a follow-up suggestion, Mobot refreshes the results and updates the intent card and query to reflect the new focus. With each subsequent refinement, Mobot adjusts the query, applies the refinements, and renders a visual chart. | ||
|
|
||
|
|
@@ -60,7 +69,7 @@ Now, refine further by typing: `Break down failed scheduling events by namespace | |
| <img src={useBaseUrl('img/search/mobot/narrow-scope-filter.png')} alt="Mobot conversational experience showing failed scheduling events broken down by namespace" style={{border: '1px solid gray'}} width="700"/> | ||
| --> | ||
|
|
||
| ### Step 3: Drill into causes | ||
| #### Step 3: Drill into causes | ||
|
|
||
| As you go, Mobot presents new suggestion cards to help you pivot into related questions, such as analyzing trends of event reasons or identifying top namespaces. | ||
|
|
||
|
|
@@ -72,7 +81,7 @@ Next, type `Add error messages`. Mobot translates this into: `Add error messages | |
| <img src={useBaseUrl('img/search/mobot/drill-causes.png')} alt="Mobot conversational experience showing error messages for failed scheduling events" style={{border: '1px solid gray'}} width="700"/> | ||
| --> | ||
|
|
||
| ### Step 4: Request a trend over time | ||
| #### Step 4: Request a trend over time | ||
|
|
||
| If you type a time period (for example, `Show the trend over 24 hours`), the query applies a timeslice (for example, one-hour buckets) to group results over time. | ||
|
|
||
|
|
@@ -87,11 +96,11 @@ Finally, type: `Show the trend over 24 hours`. Mobot translates this into: `Show | |
| where the results appear in a table view, you can change the visualization to a time-series chart (for example, line or area) to see the trend more clearly over time. | ||
| --> | ||
|
|
||
| ### Next steps | ||
| #### Next steps | ||
|
|
||
| As with legacy Mobot, you can adjust the [time range](/docs/search/mobot/#time-range), switch [chart types](/docs/search/mobot/#chart-type), [edit the query logic](/docs/search/mobot/#edit-query-code), [open in Log Search](/docs/search/mobot/#step-4-open-in-log-search), or start over with a [new chat](/docs/search/mobot/#new-conversation). | ||
|
|
||
| ## Best practices | ||
| ### Best practices | ||
|
|
||
| * **Talk to it like a conversation**. Layer refinements instead of rewriting the whole question. | ||
| * **Be specific**. Combine filters, units, and percentiles in clear language. | ||
|
|
@@ -101,7 +110,7 @@ As with legacy Mobot, you can adjust the [time range](/docs/search/mobot/#time-r | |
| * **Guide Mobot with feedback**. If the result isn't right, use natural language: `Don't do X, instead do Y`. | ||
| * **Fix broken queries**. Paste a syntactically invalid query. Mobot will correct it. | ||
|
|
||
| ## FAQ | ||
| ### FAQ | ||
|
|
||
| The questions below refer specifically to the conversational (Beta) experience. For general information about Mobot, see the [Mobot FAQ](/docs/search/mobot#faq). | ||
|
|
||
|
|
@@ -139,6 +148,20 @@ Here are some common cases: | |
| * Mobot cannot currently refer to the output of a log search directly in subsequent queries. Each follow-up must be expressed in terms of query refinements rather than referencing previous results. This is an important limitation to be aware of when constructing multi-turn conversations. | ||
| </details> | ||
|
|
||
| ## Knowledge Agent | ||
|
|
||
| Select **Knowledge Agent** to get help using Sumo Logic. | ||
|
|
||
| <img src={useBaseUrl('img/search/mobot/mobot-knowledge-agent-button.png')} alt="Knowledge Agent button selected in the Mobot UI" style={{border: '1px solid gray'}} width="600" /> | ||
|
Collaborator
Author
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. @kimsauce, here's another screenshot you need to update because "Logs Agent" has been changed to "Query Agent". |
||
|
|
||
| Enter a question about Sumo Logic, such as *"How do I add a collector for AWS CloudTrail?"*, *"What are the API endpoints for Sumo Logic?"*, or anything else you need help with. The Knowledge agent returns an answer, including steps if needed. | ||
|
|
||
| When you enter a question to the Knowledge Agent, it returns an answer using [Sumo Logic documentation](/docs/get-started). Click links in the response to see the help articles that served as the basis for the response. | ||
|
|
||
| Knowledge Agent retains your conversation context for 24 hours from the time you ask your first question. After 24 hours, the session resets and prior context is no longer available. However, any new question will begin a new 24-hour session with its own preserved context. For example, if you ask a question and follow up with a related question within 24 hours, Mobot will still remember and continue the conversation seamlessly. | ||
|
|
||
|
|
||
|
|
||
| ## Additional resources | ||
|
|
||
| * [Mobot (formerly known as *Copilot*)](/docs/search/mobot) | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
@kimsauce, you need to update the screenshot because "Logs Agent" has been changed to "Query Agent".