Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[NL-to-ESQL] improve generated documentation #192762

Closed
pgayvallet opened this issue Sep 12, 2024 · 1 comment · Fixed by #192378
Closed

[NL-to-ESQL] improve generated documentation #192762

pgayvallet opened this issue Sep 12, 2024 · 1 comment · Fixed by #192378
Assignees
@pgayvallet
Labels
enhancement New value added to drive a business result Team:AI Infra AppEx AI Infrastructure Team

Comments

@pgayvallet
Copy link
Contributor

pgayvallet commented Sep 12, 2024 •
edited
Loading

Part of https://github.com/elastic/kibana-team/issues/1264

We should try to improve the generated ES|QL documentation we're providing to the LLM, to see if we could

  1. reduce token count by cutting unnecessary content
  2. add missing informations (atm we're stripping the parameter list from the doc)
  3. improving efficiency by highlighting the most important info
@botelastic botelastic bot added the needs-team Issues missing a team label label Sep 12, 2024
@pgayvallet pgayvallet mentioned this issue Sep 12, 2024
Merged
pgayvallet added a commit that referenced this issue Sep 13, 2024
@pgayvallet @kibanamachine
[inference] NL-to-ESQL: improve doc generation (#192378)
3226eb6 
## Summary

Follow-up of #190433

Fix [#192762](#192762)

- Cleanup and refactor the documentation generation script
- Make some tweak to the documentation to improve efficiency and make a
better user of tokens
- Perform human review of the generated content to make sure everything
is accurate

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Sep 13, 2024
@pgayvallet
[inference] NL-to-ESQL: improve doc generation (elastic#192378)
fcc8d3b 
## Summary

Follow-up of elastic#190433

Fix [elastic#192762](elastic#192762)

- Cleanup and refactor the documentation generation script
- Make some tweak to the documentation to improve efficiency and make a
better user of tokens
- Perform human review of the generated content to make sure everything
is accurate

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 3226eb6)
kibanamachine added a commit that referenced this issue Sep 13, 2024
@kibanamachine @pgayvallet
[8.x] [inference] NL-to-ESQL: improve doc generation (#192378) (#192802)
8936983 
# Backport

This will backport the following commits from `main` to `8.x`:
- [[inference] NL-to-ESQL: improve doc generation
(#192378)](#192378)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Pierre
Gayvallet","email":"pierre.gayvallet@elastic.co"},"sourceCommit":{"committedDate":"2024-09-13T07:29:29Z","message":"[inference]
NL-to-ESQL: improve doc generation (#192378)\n\n##
Summary\r\n\r\nFollow-up of
https://github.com/elastic/kibana/pull/190433\r\n\r\nFix
[#192762](https://github.com/elastic/kibana/issues/192762)\r\n\r\n-
Cleanup and refactor the documentation generation script\r\n- Make some
tweak to the documentation to improve efficiency and make a\r\nbetter
user of tokens\r\n- Perform human review of the generated content to
make sure everything\r\nis
accurate\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"3226eb691af82882cdc89edd9ddff9abbcac1e5c","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:prev-minor","v8.16.0","Team:AI
Infra"],"title":"[inference] NL-to-ESQL: improve doc
generation","number":192378,"url":"https://github.com/elastic/kibana/pull/192378","mergeCommit":{"message":"[inference]
NL-to-ESQL: improve doc generation (#192378)\n\n##
Summary\r\n\r\nFollow-up of
https://github.com/elastic/kibana/pull/190433\r\n\r\nFix
[#192762](https://github.com/elastic/kibana/issues/192762)\r\n\r\n-
Cleanup and refactor the documentation generation script\r\n- Make some
tweak to the documentation to improve efficiency and make a\r\nbetter
user of tokens\r\n- Perform human review of the generated content to
make sure everything\r\nis
accurate\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"3226eb691af82882cdc89edd9ddff9abbcac1e5c"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/192378","number":192378,"mergeCommit":{"message":"[inference]
NL-to-ESQL: improve doc generation (#192378)\n\n##
Summary\r\n\r\nFollow-up of
https://github.com/elastic/kibana/pull/190433\r\n\r\nFix
[#192762](https://github.com/elastic/kibana/issues/192762)\r\n\r\n-
Cleanup and refactor the documentation generation script\r\n- Make some
tweak to the documentation to improve efficiency and make a\r\nbetter
user of tokens\r\n- Perform human review of the generated content to
make sure everything\r\nis
accurate\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"3226eb691af82882cdc89edd9ddff9abbcac1e5c"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Pierre Gayvallet <pierre.gayvallet@elastic.co>
@legrego legrego added the Team:AI Infra AppEx AI Infrastructure Team label Sep 17, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/appex-ai-infra (Team:AI Infra)

@botelastic botelastic bot removed the needs-team Issues missing a team label label Sep 17, 2024
@legrego legrego added the enhancement New value added to drive a business result label Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pgayvallet pgayvallet

Labels
enhancement New value added to drive a business result Team:AI Infra AppEx AI Infrastructure Team
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[inference] NL-to-ESQL: improve doc generation pgayvallet/kibana
3 participants
@pgayvallet @legrego @elasticmachine