Skip to content

feat: integrate docsearch v4 beta with ask ai#342

Merged
PaulRBerg merged 4 commits intomainfrom
feat/ask-ai
Aug 8, 2025
Merged

feat: integrate docsearch v4 beta with ask ai#342
PaulRBerg merged 4 commits intomainfrom
feat/ask-ai

Conversation

@smol-ninja
Copy link
Member

@smol-ninja smol-ninja commented Aug 6, 2025

This PR integrates Docsearch V4 which comes with Ask AI. Ask AI is managed through Algolia dashboard and uses an OpenAI API key.

Currently, I am using the default prompt but can be adjusted to our needs here.

You are a helpful AI assistant embedded in a documentation website. Users ask questions about the product, 
features, setup, troubleshooting, and best practices based on provided context. Answer accurately and concisely 
using only the provided context. Before stating information is unavailable, double-check if related content exists. 
If similar information is available, summarize clearly instead of providing no response. If no relevant information 
exists, reply: “I couldn't find this information in the provided context.” Always include relevant URLs when available. 
Avoid responses outside the provided context.

Since Docusaurus currently does not officially support V4 (there is an open PR for that), I had to create a custom search component which will be removed once that PR is merged in the Docusaurus repo.

This PR also removes Chef AI integration.


Merging this PR would address the following issues:

  1. Replace Chef AI's "Ask Sablier" with "Ask in ChatGPT" #341
  2. Better arrange (or disable) Cookbot AI on mobile #334
  3. AI bot trained on Sablier Documentation #136

We must first test it properly to verify that its indeed better than both Chef AI and "Ask in ChatGPT" option.


"Ask in ChatGPT" is free whereas this will cost us since it uses our OpenAI API key. However, as Paul mentioned here that there is some value in having an iframed AI bot in the docs site.

@smol-ninja smol-ninja changed the title [WIP] feat: integrate docsearch v4 beta with ask ai feat: integrate docsearch v4 beta with ask ai Aug 6, 2025
Copy link
Member

@PaulRBerg PaulRBerg left a comment

Choose a reason for hiding this comment

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

feedback below

Copy link
Member

@maxdesalle maxdesalle left a comment

Choose a reason for hiding this comment

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

LGTM

@smol-ninja
Copy link
Member Author

@PaulRBerg lmk if it looks good now. If yes, can you plz approve?

Copy link
Member

@PaulRBerg PaulRBerg left a comment

Choose a reason for hiding this comment

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

LGTM now, let's rock-and-roll with this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants