diff --git a/docs/search/index.md b/docs/search/index.md index c5831bbdfb..cb69034ddb 100644 --- a/docs/search/index.md +++ b/docs/search/index.md @@ -65,6 +65,12 @@ In this section, we'll introduce the following concepts:

Learn about Lookup tables and the search operators you can use with them.

+
+
+ icon

Logs Query Assist

 +

Learn how Logs Query Assist makes it easier to discover relevant fields and minimize errors.

+
+
icon

Optimize Search Performance

 diff --git a/docs/search/query-assist.md b/docs/search/query-assist.md index 1fab7d8ec5..728518b315 100644 --- a/docs/search/query-assist.md +++ b/docs/search/query-assist.md @@ -1,29 +1,19 @@ --- id: query-assist -title: Logs Query Assist - Preview +title: Logs Query Assist 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. --- - - - - import useBaseUrl from '@docusaurus/useBaseUrl'; - - -:::sumo Preview release -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. -::: - -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. +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. The suggestions that appear comply with the user's role-based access restrictions. query assist demo gif ## Key enhancements * **Simplified learning curve**. Receive syntax suggestions and schema prompts to write queries without extensive knowledge of query syntax. -* **Enhanced autocomplete**. Benefit from context-aware suggestions improve accuracy and efficiency, adapting to your queries and organizational patterns. +* **Enhanced autocomplete**. Benefit from context-aware suggestions to improve accuracy and efficiency, adapting to your queries and organizational patterns. * **Streamlined field discovery**. Automatically receive suggestions for relevant fields, especially in structured data like JSON, reducing the need for manual searches. ## How to get started @@ -40,8 +30,11 @@ Query Assist enhances the query-building experience in Sumo Logic by providing r Get real-time suggestions for query completion as you type, with token-by-token predictions that help you quickly finish your queries. +token-by-token-prediction-and-autocomplete + * **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 `co` might suggest `count`, `count_distinct`, `count_frequent`, `compare`, `compose`, or other related operators. -* **Value suggestions**. When you start typing a source expression (e.g. `_sourceCategory=`), you will be provided with relevant built-in metadata field options to help autocomplete your query. +* **Metadata Key-Value suggestions**. When you start typing a source expression (for example, `_sourceCategory=`), you will be provided with relevant metadata keys options to help autocomplete your query. And once you select a particular key, it displays the available values for the selected metadata. This not only displays the built-in metadata fields but also discovers the custom fields configured in your system. +* **Clause Suggestions**. When you start typing the operators, you will be provided with the entire clause to complete the remaining portion of the clause. Clause suggestions are currently restricted to the `where`, `count`, `min`, `max`, `count_distinct`, `avg`, `first`, `last`, `stddev`, `sum`, `if`, `sort`, `limit`, `timeslice`, and `fields` operators. For example, as you start typing, the system provides relevant metadata options and autocompletes your query. Simply press the `Tab` key to accept a suggestion. @@ -49,6 +42,8 @@ For example, as you start typing, the system provides relevant metadata options Automatically receive suggestions for relevant [fields](/docs/manage/fields) in structured data like JSON logs, making field discovery much easier. +schema-discovery-and-field-suggestion + * **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. * **Inline suggestions**. An inline suggestion is a real-time, context-aware recommendation within the search editor. By default, the first item in the dropdown is treated as an inline suggestion, but you can use the keyboard navigations to explore other suggestions, which will be shown inline. To apply an inline suggestion, press the Tab key. @@ -62,20 +57,34 @@ The system intelligently predicts the next search operator or offers partial que Suggestions are ranked based on your organization’s common queries, making query completion smarter and more relevant. -* **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. +* **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. However, if you occasionally find that no suggestions appear, this could be because there is no relevant data available to offer a contextual suggestion. + +## Limitations + +Suggestions are predictive in nature and may not be comprehensive or completely accurate in every circumstance. +## Turn off autocomplete + +1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select your username and then **Preferences**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu, select the person silhouette icon and then **Preferences**.
Account Preferences +1. Access your [Preferences](/docs/get-started/account-settings-preferences/#my-preferences). +1. Navigate to **My Preferences** and uncheck the **Show search autocomplete suggestions while typing** checkbox.
turn-off_autocomplete + ## Feedback 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). -:::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. -::: +Follow the below steps to provide your feedback: + +1. Enter the query typehead to view the suggestions dropdown. +1. Press the thumbs up or down button to share your feedback.
query-suggestion-feedback +1. When you press thumbs down, provide additional feedback in the dialog box. +1. Select the **Include query string and provided suggestions in the feedback automatically** checkbox. +1. Click **Submit**.
query-suggestion-thumbs-down-feedback