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

Fetch and use Botkube website and docs for AI assistant #25

Merged
merged 9 commits into from
May 8, 2024
Merged

Conversation

pkosiec
Copy link
Collaborator

@pkosiec pkosiec commented May 7, 2024

Description

Changes proposed in this pull request:

  • Fetch Botkube website and docs for AI assistant
  • Use Botkube website and docs for AI assistant
  • Add Readme for assistant setup
  • Migrate assistant setup to TypeScript
    • we need to use beta functionality (vertex store, file search) which isn't available in the unofficial Go client.

NOTE: While the LLM was instructed to use Botkube docs as much as possible, it still hallucinates sometimes. That's why I didn't do the requirement "Add footnote to the AI response: response assumes you use the latest Botkube" as I think "AI-generated content may be incorrect" is enough as it is right now.

I think the response quality will increase once we:

  • split our documentation to two separate parts (directories/sections): Botkube self-hosted installation and Botkube Cloud
  • add more examples for e.g. plugin configuration
  • include plugin JSON schemas for configuration syntax?

Screenshots

Screenshot 2024-05-07 at 15 40 54
Screenshot 2024-05-07 at 15 42 28
Screenshot 2024-05-07 at 15 42 38
image
image
image
image
image
image
image
image

Pretty close, but partially incorrect:
image

Related issue(s)

See https://github.com/kubeshop/botkube-cloud/issues/956

@pkosiec pkosiec added the enhancement New feature or request label May 7, 2024
@pkosiec pkosiec marked this pull request as ready for review May 7, 2024 14:06
@pkosiec pkosiec requested a review from a team May 7, 2024 14:06
hack/assistant-setup/index.ts Outdated Show resolved Hide resolved
Copy link
Collaborator

@mszostok mszostok left a comment

Choose a reason for hiding this comment

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

I did a code review, the code LGTM 🚀 Tomorrow I can test that or we can just merge it to dev and test it there.

I only have a some concerns about overall process for fetching docs.

hack/assistant-setup/README.md Outdated Show resolved Hide resolved
hack/assistant-setup/README.md Show resolved Hide resolved
hack/assistant-setup/README.md Show resolved Hide resolved
hack/assistant-setup/content-fetcher/main.go Outdated Show resolved Hide resolved
hack/assistant-setup/content-fetcher/main.go Show resolved Hide resolved
hack/assistant-setup/tools.ts Show resolved Hide resolved
hack/assistant-setup/tools.ts Show resolved Hide resolved
@pkosiec
Copy link
Collaborator Author

pkosiec commented May 8, 2024

As agreed, I'll do a follow-up PR with:

  • Add "purge" option for botkube.io/blog/* + botkube.io/learn/* in docs fetcher (disabled by default)
  • Update release process in https://docs.botkube.io/community/contribute/release
    • Mention to release Botkube Cloud plugins every Botkube release (without details)
  • Describe release process here in Readme: https://github.com/kubeshop/botkube-cloud-plugins?tab=readme-ov-file#release
    • Every Botkube Cloud plugins release will refetch all files and update assistant
  • Update GitHub actions release job for Botkube Cloud plugins
    • Fetch docs and update AI assistant during release, with botkube.io/blog/* + botkube.io/learn/* purge disabled
  • Fix vertex store deletion for different envs

Thanks @mszostok for feedback!

@pkosiec pkosiec merged commit 18faad0 into main May 8, 2024
4 checks passed
@pkosiec pkosiec deleted the ai-docs branch May 8, 2024 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants