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

[Request][Serverless & ESS] Update docs to convey release state of AI Assistant's ES|QL-query-generating functionality #5098

Closed
nastasha-solomon opened this issue Apr 17, 2024 · 3 comments
Assignees
Labels
Effort: Small Issues that can be resolved quickly Feature: ES|QL Priority: High Issues that are time-sensitive and/or are of high customer importance Team: GenAI Generative AI team v8.14.0

Comments

@nastasha-solomon
Copy link
Contributor

Description

ES|QL is going GA in 8.14, but the functionality that generates ES|QL queries is still in tech preview, so the following warning that's in the docs needs to be tweaked.
Screenshot 2024-04-16 at 1 55 51 PM

The following revision was suggested by @dhru42:

ES|QL queries generated by the AI Assistant may not be 100% accurate, so please refer to the ES|QL documentation (link) to ensure accuracy.

Background & resources

  • PRs: N/A
  • Issues/metas: N/A
  • Point of contact: @dhru42
  • Test environments: N/A

Which documentation set does this change impact?

ESS only

ESS release

8.14

Serverless release

N/A

Feature differences

N/A

API docs impact

N/A

Prerequisites, privileges, feature flags

N/A

@nastasha-solomon nastasha-solomon added Priority: High Issues that are time-sensitive and/or are of high customer importance Team: GenAI Generative AI team Effort: Small Issues that can be resolved quickly v8.14.0 Feature: ES|QL labels Apr 17, 2024
@nastasha-solomon nastasha-solomon self-assigned this Apr 17, 2024
@dhru42
Copy link
Collaborator

dhru42 commented Apr 17, 2024

@nastasha-solomon could we wordsmith this to sound more confident?

ES|QL queries generated by the AI Assistant may not be 100% accurate, so please refer to the ES|QL documentation (link) to ensure accuracy.

I proposed the above on chat just as a guide 😄

@nastasha-solomon
Copy link
Contributor Author

nastasha-solomon commented Apr 22, 2024

Hey, @dhru42 - sorry for not getting back to you sooner. If the entire Knowledge Base feature is still in tech preview (i.e., the functionality that generates ES|QL queries and the functionality that answers questions about alerts), we should keep the tech preview warning in the docs but remove the line that says "Do not use ES|QL on production environments."

Then, in the Knowledge base for ES|QL section, we can add a note or warning that encourages users to double-check ES|QL queries generated by AI Assistant. Placing the note here targets users who are reading about that functionality and increases the information's visibility.

Let me know if you're ok with that approach, and the following revision of the language you provided:

ES|QL queries generated by AI Assistant might require additional validation. To ensure they're correct, refer to the ES|QL documentation.

Also if it helps to visualize the changes I'm proposing, here's an example of what they'd look like in the docs:

Image

@nastasha-solomon nastasha-solomon changed the title [Request] Revise tech preview note for the Knowledge Base feature [Request] Update docs to convey release state of AI Assistant's ES|QL-query-generating functionality Apr 22, 2024
@nastasha-solomon nastasha-solomon changed the title [Request] Update docs to convey release state of AI Assistant's ES|QL-query-generating functionality [Request][Serverless & ESS] Update docs to convey release state of AI Assistant's ES|QL-query-generating functionality May 1, 2024
@nastasha-solomon
Copy link
Contributor Author

Serverless and ESS docs updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Effort: Small Issues that can be resolved quickly Feature: ES|QL Priority: High Issues that are time-sensitive and/or are of high customer importance Team: GenAI Generative AI team v8.14.0
Projects
None yet
Development

No branches or pull requests

2 participants