You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/search/query-assist.md
+17-22Lines changed: 17 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,61 +14,56 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
14
14
This is a Preview release. [Register here](https://docs.google.com/forms/d/e/1FAIpQLSdtmzRn1NyAdk1rXGZrJrpQQwR2i9FKOYd3uKLwEzrkZGVrwQ/viewform). To learn more, contact your Sumo Logic account executive.
15
15
:::
16
16
17
-
Query Assist simplifies query-building in Sumo Logic by offering real-time syntax suggestions, schema prompts, and partial query prediction. These enhancements streamline the process for users at all skill levels, making it easier to write accurate and efficient queries.
18
-
19
-
This feature reduces the complexity of query building, enabling easier discovery of relevant fields, minimizing errors, and providing intelligent assistance for query creation.
17
+
Query Assist enhances the query-building experience in Sumo Logic by providing real-time syntax suggestions, schema prompts, and partial query predictions. These enhancements simplify the process for users at all skill levels, making it easier to write accurate and efficient queries, enabling easier discovery of relevant fields, minimizing errors, and providing intelligent assistance for query creation.
***Simplified learning curve**. Syntax suggestions and schema prompts make it easy to write queries without extensive knowledge of query syntax.
26
-
***Enhanced auto-complete**. Context-aware suggestions improve accuracy and efficiency, adapting to your queries and organizational patterns.
27
-
***Streamlined field discovery**. Relevant fields are automatically suggested, especially for structured data like JSON, eliminating manual searching.
23
+
***Simplified learning curve**. Receive syntax suggestions and schema prompts to write queries without extensive knowledge of query syntax.
24
+
***Enhanced autocomplete**. Benefit from context-aware suggestions improve accuracy and efficiency, adapting to your queries and organizational patterns.
25
+
***Streamlined field discovery**. Automatically receive suggestions for relevant fields, especially in structured data like JSON, reducing the need for manual searches.
28
26
29
27
## How to get started
30
28
31
29
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** and begin typing your query.
32
-
2.**Leverage syntax and schema suggestions**. As you type, watch for real-time suggestions for fields and operators. Use the arrow keys to navigate suggestions and press `Tab` to auto-complete.
30
+
2.**Leverage syntax and schema suggestions**. As you type, watch for real-time suggestions for fields and operators. Use the arrow keys to navigate suggestions and press `Tab` to autocomplete.
33
31
3.**Take advantage of predictions**. Use partial query predictions to build queries faster and more accurately.
34
32
4.**Review and correct errors**. Address flagged errors before running your query to ensure it executes as intended.
35
-
5.**Use the Copilot code editor field**. If you’re using Copilot, edit or update your query directly in the [code editor field](/docs/search/copilot/#edit-query-code) and take advantage of autocomplete suggestions for further refinement.
33
+
5.**Edit queries with the Copilot**. If you’re using Copilot, modify your query directly in the [code editor field](/docs/search/copilot/#edit-query-code) and utilize autocomplete suggestions for further refinement.
36
34
37
35
## Features
38
36
39
-
### Token-by-token prediction and auto-complete
40
-
41
-
Get real-time suggestions for query completion as you type, with token-by-token predictions helping to quickly finish your queries.
42
-
43
-
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.
37
+
### Token-by-token prediction and autocomplete
44
38
45
-
When typing the first letters of an operator, the system displays all matching operators related to those letters, helping you quickly find and select the appropriate one. For example, typing `st` might suggest `status`, `startsWith`, or other related operators.
39
+
Get real-time suggestions for query completion as you type, with token-by-token predictions that help you quickly finish your queries. For example, as you start typing `_sourceCategory=`, the system provides relevant metadata options and autocompletes your query. Simply press the `Tab` key to accept a suggestion.
46
40
47
-
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.
41
+
***Operator suggestions**. When typing the first letters of an operator, the system displays all matching operators related to those letters, helping you quickly find and select the appropriate one. For example, typing `st` might suggest `status`, `startsWith`, or other related operators.
42
+
***Value suggestions**. 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.
48
43
49
44
### Schema discovery and field suggestions
50
45
51
46
Automatically receive suggestions for relevant fields in structured data like JSON logs, making field discovery much easier.
52
47
53
-
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.
48
+
***Field suggestions**. For structured logs, 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.
54
49
55
50
### Next operator prediction
56
51
57
52
The system intelligently predicts the next search operator or offers partial query suggestions based on your input, reducing manual effort.
58
53
59
-
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.
54
+
***Operator predictions**. 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, aligning your queries with standard patterns.
60
55
61
56
### Real-time error highlighting and feedback
62
57
63
58
Errors are flagged as you type, with immediate suggestions for corrections, ensuring a seamless query-writing experience.
64
59
65
-
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.
60
+
***Error detection**. As you write queries, the system highlights syntax errors in real-time, such as unclosed parentheses or misspelled operators, and provides instant suggestions to fix the issue, preventing unnecessary troubleshooting.
66
61
67
-
### Contextual auto-complete and field discovery
62
+
### Contextual autocomplete and field discovery
68
63
69
64
Suggestions are ranked based on your organization’s common queries, making query completion smarter and more relevant.
70
65
71
-
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.
66
+
***Contextual suggestions**. The system ranks suggestions based on common queries from your organization or your own previous queries. This ensures that your autocomplete options are not only relevant but also contextually accurate, speeding up the query-writing process.
72
67
73
68
<!-- hold off
74
69
### Need more help?
@@ -77,7 +72,7 @@ Copilot with Query Assist video: https://docs.google.com/presentation/d/1HCaXROM
77
72
78
73
## Feedback
79
74
80
-
We want your input on Query Assist! Share your thoughts on its usage, relevance, accuracy, UX, and suggestions ranking (syntax, schema, single phrase).
75
+
We value your input on Query Assist! Share your thoughts on its usability, relevance, accuracy, user experience, and the ranking of suggestions (syntax, schema, single phrase).
81
76
82
77
:::note
83
78
Query Assist is a working name. Final naming and branding may change before release. All feature updates and release dates are subject to change.
@@ -86,7 +81,7 @@ Query Assist is a working name. Final naming and branding may change before rele
0 commit comments