-
Notifications
You must be signed in to change notification settings - Fork 162
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
AI Assistant docs updates for 8.16 #4326
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
This pull request does not have a backport label. Could you fix it @eedugon? 🙏
|
I have added the Search Connectors related content after performing some tests in a 8.16-SNAPSHOT lab, and after reading https://www.elastic.co/observability-labs/blog/elastic-rag-ai-assistant-application-issues-llm-github The content is aligned with the shared blog post. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left a few editing suggestions, otherwise LGTM.
Very nice PR, @eedugon! |
Co-authored-by: Arianna Laudazzi <[email protected]>
Co-authored-by: Arianna Laudazzi <[email protected]>
Co-authored-by: Arianna Laudazzi <[email protected]>
Co-authored-by: Arianna Laudazzi <[email protected]>
Co-authored-by: Arianna Laudazzi <[email protected]>
Co-authored-by: Arianna Laudazzi <[email protected]>
Co-authored-by: Arianna Laudazzi <[email protected]>
Co-authored-by: Arianna Laudazzi <[email protected]>
Co-authored-by: Arianna Laudazzi <[email protected]>
Co-authored-by: Arianna Laudazzi <[email protected]>
Co-authored-by: Arianna Laudazzi <[email protected]>
Co-authored-by: Arianna Laudazzi <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Co-authored-by: Arianna Laudazzi <[email protected]>
* initial structure change to add settings and search connectors * enterprise search requirement added * search connectors explained * fixed image link * extra comma removed from json example * ai settings moved to the end * tbd content added * screenshots deleted * some you-cans removed * connectors distinction included * minor updates * AI Assistant icon added * AI Assistant icon added * AI Assistant icon added * search connectors setup added * passive voice and to_do_this update * reindex method changes cancelled * override search connector indices list * reindex method removed * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * missing link added * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> --------- Co-authored-by: Arianna Laudazzi <[email protected]> (cherry picked from commit 20cc3dc)
* initial structure change to add settings and search connectors * enterprise search requirement added * search connectors explained * fixed image link * extra comma removed from json example * ai settings moved to the end * tbd content added * screenshots deleted * some you-cans removed * connectors distinction included * minor updates * AI Assistant icon added * AI Assistant icon added * AI Assistant icon added * search connectors setup added * passive voice and to_do_this update * reindex method changes cancelled * override search connector indices list * reindex method removed * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> * missing link added * Update docs/en/observability/observability-ai-assistant.asciidoc Co-authored-by: Arianna Laudazzi <[email protected]> --------- Co-authored-by: Arianna Laudazzi <[email protected]> (cherry picked from commit 20cc3dc) Co-authored-by: Edu González de la Herrán <[email protected]>
Description
AI Assistant doc updates for 8.16, applying changes requested in #4273.
Preview link: https://observability-docs_bk_4326.docs-preview.app.elstc.co/guide/en/observability/master/obs-ai-assistant.html
The PR includes:
Use Search Connectors
section)Pending:
using the Index and Reindex API calls to add data to the AI Assistant KB
, as it's too advanced and also doesn't appear completely accurate (maybe we could move that to another type of document) --> Moved to a new issue ([Request]: Consider removing or updating the reindex method on the Observability AI Assistant doc #4352) for a later stage and decision.Search Connectors
were also integrated with the AI Assistant in other releases I'd sayyes
, but I'm not sure about it.Other concerns:
Search Connectors
wording: Should we use Connectors or Search Connectors? I think Connectors is more ambiguous considering we have other type of connectors.Documentation sets edited in this PR
Check all that apply.
docs/en/observability/*
)docs/en/serverless/*
)docs/en/integrations/*
)Related issue
Closes #4273
Checklist
Select one.
Serverless docs not updated due to #4273 (comment)