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

Update Observability AI Assistant docs #3205

Merged
merged 12 commits into from
Sep 8, 2023

Conversation

mdbirnstiehl
Copy link
Contributor

@mdbirnstiehl mdbirnstiehl commented Sep 1, 2023

This PR closes Issue 3139

I've added the new set up instructions using the connector, added details about chat and functions, and updated the requirements.

Preview here.

A couple of questions:

  • Do we need to add requirements for knowledge base?
  • I updated the requirements to specifically mention gpt-4, but do we want to clarify more that they technically can use 3.5, but the experience will be worse?

@mdbirnstiehl mdbirnstiehl added the backport-8.10 Automated backport with mergify label Sep 1, 2023
@mdbirnstiehl mdbirnstiehl self-assigned this Sep 1, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Sep 1, 2023

A documentation preview will be available soon:

@mdbirnstiehl mdbirnstiehl marked this pull request as ready for review September 5, 2023 15:47
@mdbirnstiehl mdbirnstiehl requested a review from a team as a code owner September 5, 2023 15:47
@dgieselaar
Copy link
Member

@mdbirnstiehl:

Do we need to add requirements for knowledge base?

Yes! Especially the part about it requiring a 4gb ML node. I think this is part of the trial now, but good to clarify anyway.

I updated the requirements to specifically mention gpt-4, but do we want to clarify more that they technically can use 3.5, but the experience will be worse?

Sgtm. @SeanHeelan can you also chime in?

@almudenasanz
Copy link

@mdbirnstiehl we have updated the contextual prompt for alerting - logs and now it supports spikes or drops, so we renamed it to "log rate change", so we would need to update this line in the docs:

Alerting — provides possible log spike causes and remediation suggestions.

@CoenWarmer
Copy link

CoenWarmer commented Sep 6, 2023

@mdbirnstiehl Could you also include instructions on how to add information to the Assistant's knowledge base by indexing documents? @almudenasanz wrote up the steps over here.

Just to be clear, there's two ways of adding information to the knowledge base at the moment:

  • A user can ask the Assistant to remember something. Doing that will cause the Assistant to use the summarize function and store the resulting information into the knowledge base. Example: "My name is John. Remember that."
  • A user can manually add information directly into the index via Elasticsearch APIs (described above in Almu's write up).

In 8.11 we want to offer a way to do this via GUI as well.

@mdbirnstiehl
Copy link
Contributor Author

@almudenasanz @CoenWarmer @dgieselaar I've made the suggested updates if you wouldn't mind taking another look. Thank you!

Copy link
Member

@dgieselaar dgieselaar left a comment

Choose a reason for hiding this comment

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

Looks good, would like @SeanHeelan to take a look

Copy link

@SeanHeelan SeanHeelan left a comment

Choose a reason for hiding this comment

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

Looks good to me, bar the one issue I've pointed out

Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

Looks good. Just a few nitpicks.

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
@mdbirnstiehl mdbirnstiehl merged commit af843a8 into elastic:main Sep 8, 2023
1 check passed
mergify bot pushed a commit that referenced this pull request Sep 8, 2023
mdbirnstiehl added a commit that referenced this pull request Sep 8, 2023
(cherry picked from commit af843a8)

Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.10 Automated backport with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[REQUEST]: New/updated docs for AI Assistant for Observability
6 participants