-
Notifications
You must be signed in to change notification settings - Fork 228
DOCS-409 - Query Assist (preview 1) #4563
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
Merged
Changes from 29 commits
Commits
Show all changes
35 commits
Select commit
Hold shift + click to select a range
7633db4
Intellisense docs/release note
kimsauce 97f5456
Merge branch 'main' into DOCS-409
kimsauce e46524f
typo
kimsauce 625cb99
Merge branch 'main' into DOCS-409
kimsauce 6c456a4
fixes
kimsauce fa4fbbc
Merge branch 'main' into DOCS-409
kimsauce 067c9fb
more edits
kimsauce ec2c49d
more edits
kimsauce a58fcac
Merge branch 'main' into DOCS-409
kimsauce 3ffea9a
link fix
kimsauce 71c0bca
Merge branch 'main' into DOCS-409
kimsauce ec99bfe
Update docs/search/intellisense.md
kimsauce 654f144
Merge branch 'main' into DOCS-409
kimsauce 72e622b
Merge branch 'DOCS-409' of github.com:SumoLogic/sumologic-documentati…
kimsauce d22ea99
Merge branch 'main' into DOCS-409
kimsauce 5222cb1
more edits
kimsauce ea922e8
add noindex code
kimsauce aaed992
Update docs/search/copilot.md
kimsauce 48599f1
Merge branch 'main' into DOCS-409
kimsauce dc6b63a
Merge branch 'main' into DOCS-409
kimsauce 85516db
Merge branch 'DOCS-409' of github.com:SumoLogic/sumologic-documentati…
kimsauce 7161f46
more edits based on meeting
kimsauce 1e14b76
Merge branch 'main' into DOCS-409
kimsauce 52c5acb
Merge branch 'main' into DOCS-409
kimsauce c86ebe3
Merge branch 'main' into DOCS-409
kimsauce ab48afd
updates
kimsauce 387e197
Merge branch 'DOCS-409' of github.com:SumoLogic/sumologic-documentati…
kimsauce e840187
fixes
kimsauce 67ae91a
fixes
kimsauce 8d3fc54
Merge branch 'main' into DOCS-409
kimsauce eec19c7
add vid
kimsauce 1d978c5
Update docs/search/query-assist.md
kimsauce 30a3501
Merge branch 'DOCS-409' of github.com:SumoLogic/sumologic-documentati…
kimsauce 480f648
edits per MS
kimsauce ced1ba3
edits per MS
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 |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| title: Logs Query Assist - Preview (Search) | ||
| image: https://help.sumologic.com/img/sumo-square.png | ||
| keywords: | ||
| - query | ||
| - ai | ||
| - copilot | ||
| - search | ||
| - log-search | ||
| hide_table_of_contents: true | ||
| --- | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <a href="https://help.sumologic.com/release-notes-service/rss.xml"><img src={useBaseUrl('img/release-notes/rss-orange2.png')} alt="icon" width="50"/></a> | ||
|
|
||
| This feature is in Preview. To participate, contact your Sumo Logic account representative. | ||
|
|
||
| We’re excited to announce the preview release of **Query Assist**, designed to simplify query building by reducing complexity, enabling easier field discovery, minimizing errors, and providing intelligent query-writing assistance. These enhancements deliver real-time syntax suggestions, schema-based recommendations, and a frictionless query experience. | ||
|
|
||
| ### Key features | ||
|
|
||
| * **Real-time syntax suggestions**. Get instant recommendations for syntax and operators to accelerate query creation and reduce errors. | ||
| * **Schema-based field suggestions**. Automatically discover relevant keys and fields for structured data like JSON logs. | ||
| * **Partial and full query predictions**. Anticipate the next operator or receive complete query suggestions based on your input. | ||
| * **Enhanced user experience**. Real-time error highlighting and intelligent suggestions provide a smooth and seamless query-building process. | ||
|
|
||
| These updates make it easier for both beginners and advanced users to craft accurate queries and analyze data efficiently. [Learn more](/docs/search/query-assist). | ||
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,87 @@ | ||
| --- | ||
| id: query-assist | ||
| title: Logs Query Assist - Preview | ||
| description: Logs Query Assist improvements reduce the complexity of Sumo Logic’s query language, making it easier to discover relevant fields, minimize errors, and benefit from intelligent query-building assistance. | ||
| --- | ||
|
|
||
| <head> | ||
| <meta name="robots" content="noindex" /> | ||
| </head> | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| :::sumo Preview release | ||
| This is a Preview release. To learn more, contact your Sumo Logic account executive. [Register here](https://docs.google.com/forms/d/e/1FAIpQLSdtmzRn1NyAdk1rXGZrJrpQQwR2i9FKOYd3uKLwEzrkZGVrwQ/viewform). | ||
| ::: | ||
|
|
||
| Query Assist simplifies query-building in Sumo Logic by offering real-time syntax suggestions, schema prompts, and partial/full query predictions. These enhancements streamline the process for users at all skill levels, making it easier to write accurate and efficient queries. | ||
|
|
||
| This feature reduces the complexity of query building, enabling easier discovery of relevant fields, minimizing errors, and providing intelligent assistance for query creation. | ||
|
|
||
| <img src={useBaseUrl('img/search/get-started-search/query-assist-preview1.gif')} alt="query assist demo gif" width="700"/> | ||
|
|
||
| ## Key enhancements | ||
|
|
||
| * **Simplified learning curve**. Syntax suggestions and schema prompts make it easy to write queries without extensive knowledge of query syntax. | ||
| * **Enhanced auto-complete**. Context-aware suggestions improve accuracy and efficiency, adapting to your queries and organizational patterns. | ||
| * **Streamlined field discovery**. Relevant fields are automatically suggested, especially for structured data like JSON, eliminating manual searching. | ||
|
|
||
| ## How to get started | ||
|
|
||
| 1. **Start a log search**. From the [**Classic UI**](/docs/get-started/sumo-logic-ui-classic) or the [**New UI**](/docs/get-started/sumo-logic-ui), go to **Log Search** to start typing your query. | ||
| 2. **Leverage syntax and schema suggestions**. As you type, watch for real-time suggestions for fields and operators. Select options using your arrow keys and press `Tab` to auto-complete. | ||
| 3. **Take advantage of predictions**. Use partial and full query predictions to build queries faster and more accurately. | ||
| 4. **Review and correct errors**. Correct flagged errors before running your query. | ||
|
|
||
kimsauce marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Features | ||
|
|
||
kimsauce marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Token-by-token prediction and auto-complete | ||
|
|
||
| Get real-time suggestions for query completion as you type, with token-by-token predictions helping to quickly finish your queries. | ||
|
|
||
| As you start typing a query, such as `_sourceCategory=`, the system provides **token-by-token predictions** and auto-completes your query with relevant metadata options. Simply use the `Tab` key to accept the suggestion. For example, after typing `status=`, you will be prompted with likely values such as `success`, `error`, or other status codes based on your previous queries or log data. | ||
|
|
||
| ## Schema discovery and field suggestions | ||
|
|
||
| Automatically receive suggestions for relevant fields in structured data like JSON logs, making field discovery much easier. | ||
|
|
||
| For structured logs like JSON, the system automatically suggests relevant fields such as `userID`, `eventType`, or `timestamp` as you type. This eliminates the need for manual inspection of logs, making it easier to filter and aggregate data. | ||
|
|
||
| ## Next operator and full query predictions | ||
kimsauce marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
kimsauce marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| The system intelligently predicts the next operator or offers full query suggestions based on your input, reducing manual effort. | ||
|
|
||
| When you type a query such as `source=logs | where status="error"`, the system predicts the **next operator** and offers suggestions like `count by employeeID` or other common fields. This minimizes manual input and ensures your queries are accurate and aligned with standard query patterns. | ||
|
|
||
| ## Real-time error highlighting and feedback | ||
|
|
||
| Errors are flagged as you type, with immediate suggestions for corrections, ensuring a seamless query-writing experience. | ||
|
|
||
| As you write queries, the system highlights any syntax errors in real-time. For example, if you forget to close parentheses or misspell an operator, the system will flag it and provide suggestions to fix the issue immediately, preventing unnecessary troubleshooting. | ||
|
|
||
| ## Contextual auto-complete and field discovery | ||
|
|
||
| Suggestions are ranked based on your organization’s common queries, making query completion smarter and more relevant. | ||
|
|
||
| The system ranks suggestions based on common queries from your organization or your own previous queries. This ensures that your auto-complete options are not only relevant but also contextually accurate, speeding up the query-writing process. | ||
|
|
||
|
|
||
| ### Need more help? | ||
|
|
||
| Try [Sumo Logic Copilot](/docs/search/copilot), our AI-powered assistant that helps you write and execute natural language log search queries. | ||
kimsauce marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Feedback | ||
|
|
||
| We want your input on Query Assist! Share your thoughts on its usage, relevance, accuracy, UX, and suggestions ranking (syntax, schema, single phrase). | ||
|
|
||
| :::note | ||
| Query Assist is a working name. Final naming and branding may change before release. All feature updates and release dates are subject to change. | ||
| ::: | ||
|
|
||
| <!-- | ||
| Phased Availability: | ||
|
|
||
| * **Phase 1**. Token-by-token prediction, metadata auto-complete, and basic schema suggestions. | ||
| * **Phase 2**. Enhanced operator predictions, full query suggestions, and advanced schema discovery. | ||
| * **Phase 3**. Real-time error feedback, more contextual suggestions, and query pattern-based improvements. | ||
| --> | ||
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.
Uh oh!
There was an error while loading. Please reload this page.