diff --git a/docs/modules/ROOT/images/ask_ai.png b/docs/modules/ROOT/images/ask_ai.png new file mode 100644 index 00000000..ec019f49 Binary files /dev/null and b/docs/modules/ROOT/images/ask_ai.png differ diff --git a/docs/modules/ROOT/images/ask_ai_search.png b/docs/modules/ROOT/images/ask_ai_search.png new file mode 100644 index 00000000..16b527ab Binary files /dev/null and b/docs/modules/ROOT/images/ask_ai_search.png differ diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 3e8b9e46..1681bd8a 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -1,5 +1,6 @@ .Get Started * xref:index.adoc[Overview] +* xref:ask-ai.adoc[] * xref:get-started.adoc[Deploy a Cluster] * xref:deploy-management-center.adoc[Deploy Management Center] * xref:scaling-upgrading.adoc[Scaling & Upgrading] diff --git a/docs/modules/ROOT/pages/ask-ai.adoc b/docs/modules/ROOT/pages/ask-ai.adoc new file mode 100644 index 00000000..f895bffc --- /dev/null +++ b/docs/modules/ROOT/pages/ask-ai.adoc @@ -0,0 +1,35 @@ += Ask AI +:description: Use our Ask AI feature to get instant answers to technical questions. + +{description} + +== Overview +image:ask_ai.png[Ask AI,role="related thumb right"] You can use the *Ask AI* feature available on every docs page to get answers to your technical questions. The chatbot has indexed all Hazelcast documentation, including standalone API docs microsites, and selected hazelcast.com and support content. The AI uses the information from the knowledge sources to answer questions and does not make up information if it's not listed in the sources. + +To use Ask AI, click the *Ask AI* button in the bottom right of any docs.hazelcast.com page. + +Ask AI currently indexes the following sources: + +- docs.hazelcast.com (the /latest version for all products and tools) +- API docs for languages and clients (Javadoc, C++, .NET/C#, Node.js, Python, Go) +- hazelcast.com/blog (from last two years) +- hazelcast.com/developers/clients +- support.hazelcast.com +- Hazelcast Code Samples repository + +IMPORTANT: This is an experimental custom LLM for answering technical questions about Hazelcast. Answers are based *only* on Hazelcast documentation and support sources, but may not be fully accurate so please use your best judgement. + +== Tips + +- Don't forget to rate the answers using the voting buttons. And please give detailed feedback if the answers you receive aren't correct or could be improved, as this feedback helps us improve Ask AI! +- You can ask follow up questions or clarify the scope or use case to focus the conversation and get the information you're looking for. +- You can also ask the chatbot to identify problems in code or configuration files, or create, for example, a pom.xml with certain features enabled. +- Answers are all based on English language content (see sources listed above) but you can ask and receive answers in different languages. +- If the answer is not documented in the indexed sources then Ask AI will be unable to provide an answer (feedback is especially welcome in cases where you would expect the answer to be documented and indexed). + +== Search + +You can also use the *Search* tab within Ask AI to search the same sources, and toggle between Search and Ask AI mode. + +image:ask_ai_search.png[Search with Ask AI] +