[ES|QL] Autocomplete suggestions improvements

[stratoula]

[Meta] list of possible autocomplete suggestion improvements for the ES|QL editor

Categorized by topic; prioritized within each group

Function helpers

Beta Give feedback

1. [ES|QL] respect existing parenthesis when renaming a function via autocomplete #180953
   Team:ESQL enhancement impact:medium usability +4
2. [ES|QL] suggest a missing command based on a function #180737
   Team:ESQL enhancement impact:low +3
3. [ES|QL] Autocomplete should help build expressions as first arg in case rather than simple boolean #177258
   >enhancement Feature:ES|QL Team:ESQL enhancement impact:low +5
4. Build argument suggestions based on all available call signatures - (Reference)
5. Constant-only parameter constraints should be inherited by nested functions - For example, if func1's first parameter is constant-only, any nested functions should inherit that constraint: func1(func2(shouldBeConstantOnly))
6. Improve 'Read more' for functions - This is contextually relevant and contains useful documentation; however, the order and readability of content could be improved At left: ES|QL ... right: analog example)
7. Excel-like experience for functions (see [ES|QL] show function signature while typing #180528) - Leverage the Parameter Info capabilities provided by Intellisense for a more Excel-like experience when adding functions to a query

Smarter suggest

Beta Give feedback

1. [ES|QL] Suggest field values #184679 - This is a known ES limitation at the moment (need issue link if one exists). It's worth capturing as it is a key, missing capability of the current editing experience. As seen below, the suggest lists simply contains a redundant field list.
2. [ES|QL] show suggestions on editor refocus #180839
   Team:ESQL enhancement impact:low +3
3. Redisplay autocomplete when editing/typing a data source - After adding a data source, backspace/delete some text, start typing again, autocomplete should redisplay (filtered). In the gif below, when re-typing auditbeat, I expect the suggestion menu to redisplay, filtered to what I have typed thus far.
4. [ES|QL] Prioritize fields based on ecs information on the editor #181036
   Feature:ES|QL Team:ESQL enhancement impact:high +4
5. Display ECS field info in the 'Read more', right-hand panel (see comment)
6. Add suggestions for built-in functions - For builtin functions like the comparison one, there are frequent literal values used (i.e. field > 0) which are currently not covered by the suggestion system.
7. Indicate when a value needs to be entered - In addition to suggesting fields, commands, and functions, it can be equally logical to enter a value such as a number. In the example below, I am desiring to enter a numerical value (bonus: a hint on the range or sampling of values would be extra delightful)
8. Disable suggestions when typing values - Today, when typing a field value between double quotes, the suggest list appears with recommendations filtered, by the string, for functions and variables. This could be an interim 'fix' as we await the availability of field values (see related recommendation).
9. Improve BY suggestion to include pipe - If you add a by then the +,- is suggested. We should at least suggest the pipe here
10. Improve Metadata suggestions with comma - Metadata autocomplete should use comma when suggesting the rest of the available meta fields, also should suggest the pipe
11. Consider suggesting functions with the right return for constant-only parameters ... but more thinking is needed on how to make this accurate.
12. Ignore casing when sorting (?) - When one data source uses camel case, those fields appear first. In the situation where sources use the same casing, the list appears to be combined and sorted as a single list. I sense lowercase is the best practice, but other casing does not seem to be prohibited. Upon further investigation, I don't see indices in obs or esql demo environments with camel case field names.
13. Revisit how we handle remote indices - Support for remote indices was recently added. Now that it is in place, we may want to consider some enhancements with regards to scalability and organizational hierarchy. For example, clusters appear alphabetically with local indices.

Environmental / Authoring helpers

Beta Give feedback

1. Indicate field type - When writing a query and doing calculations or bucketing with STATS and BUCKET, it would be helpful to know the field type (date, number, boolean, etc.)
2. Indicate data source for a field - Most relevant upon adding more than one data source, the suggest list combines/mixes fields making it difficult to know which source(s) the field is coming from. Fields may exist in both - appear as one entry - or be similar in name on more than one data source. Note that the 'Ability to view field names' recommendation would help here, too.
3. Remove not-very-useful 'Read more' on fields/variables - Currently, the same 'Read more' text is shown on every field/variable. It is both redundant and lacking useful information; therefore, we should consider disabling it.
4. Ability to view all fields - When working with a query, the current field list returns only what the query returns.
5. Ability to always view query results (Documents) - Allow users to view/request the underlying result set (Documents) even when the query returns an aggregated result. Seeing the underlying documents builds confidence and understanding of the result. Contrast how this works today in Discover vs Splunk and other competitors where Events and Stats are separate.

Syntactical papercuts

Beta Give feedback

1. [ES|QL] make autocomplete respect existing closing parenthesis #180975
   Team:ESQL enhancement impact:low +3
2. [ES|QL] correct double-commas when a suggestion is accepted #180840
   Team:ESQL enhancement impact:low +3
3. Fix suggestions after + - In the above, after clicking the + the aggregation is suggested which is wrong. If the user runs it, ES will error out
4. Make sure drop respects keep columns - Drop here suggests the avg(bytes) which is wrong as with the previous keep I am only keeping one column
5. A second comma loosens suggestion constraints - https://github.com/elastic/kibana/assets/315764/0e27577e-ea73-4a41-9b12-fe043fb4fd59
6. Autocomplete shouldn't suggest on = when it is part of <= or >= - https://github.com/elastic/kibana/assets/315764/4635d08f-5618-4091-b8fd-925baff95b77

Related, previously issues

• Support data_part as proposed in docs
  These date functions can be very tricky so we would like to help our users a bit with autocomplete. It would be great if we could suggest the date_part as proposed on our official documentation

[elasticmachine]

Pinging @elastic/kibana-visualizations (Team:Visualizations)

[dej611]

These date functions can be very tricky so we would like to help our users a bit with autocomplete. It would be great if we could suggest the date_part as proposed on our official documentation

This is done already in 8.13

[elasticmachine]

Pinging @elastic/kibana-esql (Team:ESQL)

[dej611]

Drop here suggests the avg(bytes) which is wrong as with the previous keep I am only keeping one column

this is by design right now.
All location information about variables are stored but the engine is not pruning variables after stats, keep, rename or drop. All column utility functions should take those into account (same apply for validation feature as well).