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

AI Assistant docs updates for 8.16 #4326

Merged
merged 35 commits into from
Oct 16, 2024

Conversation

eedugon
Copy link
Contributor

@eedugon eedugon commented Oct 1, 2024

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:

  • Added Enterprise Search requirement in case Search Connectors are used.
  • Included Search Connectors as a way to add data to the AI Assistant KB (Use Search Connectors section)
  • Updated names for the other methods (knowledge base UI and Index API)
  • Updated the icon related screenshot.
  • Added AI Assistant Settings section with screenshot.

Pending:

  • Determine if we should update the rest of the screenshots and gif --> This will be handled in a separate issue / separate PR, and we will avoid using screenshots if not needed (thanks @bmorelli25 ).
  • Determine if we can remove the method about 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.
  • Should we add a clarification about the different nature of Search Connectors (used to populate the KB) and Stack Connectors (used to connect to LLM). Users could mix them up. --> Agreed to add a TIP in the doc.
  • I still need to add some details about Search Connectors but I was unable because of technical issues in the lab environment.
  • Backporting checks: Are the changes in this PR valid for other releases? If Search Connectors were also integrated with the AI Assistant in other releases I'd say yes, but I'm not sure about it.
  • Port to serveless decision (depends on the final content of this PR) --> Decided to not port to serverless as Search Conectors cannot be used there to populate the AI Assistant knowledge base.

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.

  • Stateful (docs/en/observability/*)
  • Serverless (docs/en/serverless/*)
  • Integrations Developer Guide (docs/en/integrations/*)
  • None of the above

Related issue

Closes #4273

Checklist

  • Product/Engineering Review
  • Writer Review

Select one.

  • This PR does not need to be ported to another doc set because:
    • The concepts in this PR only apply to one doc set (serverless or stateful)
    • The PR contains edits to both doc sets (serverless and stateful)
  • This PR needs to be ported to another doc set:
    • Port to stateful docs: <link to PR or tracking issue>
    • Port to serverless docs: <link to PR or tracking issue>

Serverless docs not updated due to #4273 (comment)

@eedugon eedugon requested a review from a team as a code owner October 1, 2024 14:00
Copy link
Contributor

github-actions bot commented Oct 1, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

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.

Copy link
Contributor

mergify bot commented Oct 1, 2024

This pull request does not have a backport label. Could you fix it @eedugon? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Oct 1, 2024
@eedugon
Copy link
Contributor Author

eedugon commented Oct 4, 2024

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.

@eedugon eedugon changed the title [WIP] AI Assistant docs updates for 8.16 AI Assistant docs updates for 8.16 Oct 7, 2024
dgieselaar
dgieselaar previously approved these changes Oct 15, 2024
alaudazzi
alaudazzi previously approved these changes Oct 15, 2024
Copy link
Contributor

@alaudazzi alaudazzi left a 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.

docs/en/observability/observability-ai-assistant.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/observability-ai-assistant.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/observability-ai-assistant.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/observability-ai-assistant.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/observability-ai-assistant.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/observability-ai-assistant.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/observability-ai-assistant.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/observability-ai-assistant.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/observability-ai-assistant.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/observability-ai-assistant.asciidoc Outdated Show resolved Hide resolved
@alaudazzi
Copy link
Contributor

Very nice PR, @eedugon!

@eedugon eedugon dismissed stale reviews from alaudazzi and dgieselaar via af79e4d October 15, 2024 15:21
eedugon and others added 12 commits October 15, 2024 17:22
@eedugon eedugon added backport-8.x Automated backport to the 8.x branch with mergify and removed backport-skip Skip notification from the automated backport with mergify labels Oct 16, 2024
alaudazzi
alaudazzi previously approved these changes Oct 16, 2024
Copy link
Contributor

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

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

LGTM

@eedugon eedugon merged commit 20cc3dc into elastic:main Oct 16, 2024
3 checks passed
@eedugon eedugon deleted the ai_assistant_updates_816 branch October 16, 2024 16:19
mergify bot pushed a commit that referenced this pull request Oct 16, 2024
* 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)
bmorelli25 pushed a commit that referenced this pull request Oct 18, 2024
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x Automated backport to the 8.x branch with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Request]: AI Assistant Settings - Update and add new options
5 participants