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.

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

[Obs AI Assistant] Write ES|QL docs with LLM #183173

Merged
merged 2 commits into from
Jun 9, 2024

Conversation

dgieselaar
Copy link
Member

@dgieselaar dgieselaar commented May 10, 2024

Uses the LLM to re-write docs from the built-docs repo, that have a lot of weird technical artifacts, to improve the output from the LLM.

@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@dgieselaar dgieselaar force-pushed the obs-ai-assistant-llm-esql-docs branch from 81b1dfb to 82212f8 Compare May 10, 2024 16:14
@dgieselaar dgieselaar force-pushed the obs-ai-assistant-llm-esql-docs branch from 82212f8 to 11cea40 Compare June 7, 2024 07:07
@dgieselaar dgieselaar changed the title Obs ai assistant llm esql docs [Obs AI Assistant] Write ES|QL docs with LLM Jun 7, 2024
@dgieselaar dgieselaar force-pushed the obs-ai-assistant-llm-esql-docs branch from 11cea40 to 45d6618 Compare June 7, 2024 12:27
@dgieselaar dgieselaar force-pushed the obs-ai-assistant-llm-esql-docs branch from 45d6618 to 1004e22 Compare June 7, 2024 13:01
@dgieselaar dgieselaar marked this pull request as ready for review June 7, 2024 13:02
@dgieselaar dgieselaar requested a review from a team as a code owner June 7, 2024 13:02
@dgieselaar dgieselaar added v8.15.0 v8.14.1 release_note:skip Skip the PR/issue when compiling release notes labels Jun 7, 2024
Copy link
Member

@sorenlouv sorenlouv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't reviewed in depth but lgtm from a very cursory look.
btw. what does "Uses the LLM to re-write docs" mean?

@dgieselaar
Copy link
Member Author

@sorenlouv We extract ES|QL documentation from the Elasticsearch docs, but it has a lot of technical artifacts because we are parsing HTML. So we now add another step where we ask the LLM to rewrite those docs, to remove technical artifacts and we ask it to add more examples.

@dgieselaar dgieselaar enabled auto-merge (squash) June 9, 2024 19:43
@kibana-ci
Copy link
Collaborator

kibana-ci commented Jun 9, 2024

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@dgieselaar dgieselaar merged commit 4fc13a4 into elastic:main Jun 9, 2024
21 checks passed
@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
8.14 Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 183173

Questions ?

Please refer to the Backport tool documentation

@dgieselaar
Copy link
Member Author

💚 All backports created successfully

Status Branch Result
8.14

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

dgieselaar added a commit to dgieselaar/kibana that referenced this pull request Jun 10, 2024
Uses the LLM to re-write docs from the `built-docs` repo, that have a
lot of weird technical artifacts, to improve the output from the LLM.

(cherry picked from commit 4fc13a4)

# Conflicts:
#	x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/kibana_client.ts
#	x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/index.ts
dgieselaar added a commit that referenced this pull request Jun 10, 2024
# Backport

This will backport the following commits from `main` to `8.14`:
- [[Obs AI Assistant] Write ES|QL docs with LLM
(#183173)](#183173)

<!--- Backport version: 7.3.2 -->

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

<!--BACKPORT {commits} BACKPORT-->
eokoneyo pushed a commit to eokoneyo/kibana that referenced this pull request Jun 13, 2024
Uses the LLM to re-write docs from the `built-docs` repo, that have a
lot of weird technical artifacts, to improve the output from the LLM.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:project-deploy-observability Create an Observability project release_note:skip Skip the PR/issue when compiling release notes Team:Obs AI Assistant v8.14.1 v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants