Skip to content

Commit

Permalink
DOC-191: Add Ask AI page (#1343)
Browse files Browse the repository at this point in the history
Adds Ask AI page to nav so it features prominently and also provides
some detail and tips.

Backport strategy TBD but we can replicate this page in each of the
other products too (initially the same but can always diverge in future
and e.g. make tips more MC appropriate).

- [ ] Decide what versions we backport to
  • Loading branch information
oliverhowell authored Nov 1, 2024
1 parent e6ed3b5 commit 27bd3e2
Show file tree
Hide file tree
Showing 19 changed files with 45 additions and 172 deletions.
1 change: 1 addition & 0 deletions antora-playbook-local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ site:
docsearch_id: 'QK2EAH8GB0'
docsearch_api: 'ef7bd9485eafbd75d6e8425949eda1f5'
docsearch_index: 'prod_hazelcast_docs'
ai_search_id: '6b326171-dd1e-40c6-a948-1f9bb6c0ed52'
urls:
html_extension_style: drop
content:
Expand Down
1 change: 1 addition & 0 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ site:
docsearch_id: 'QK2EAH8GB0'
docsearch_api: 'ef7bd9485eafbd75d6e8425949eda1f5'
docsearch_index: 'prod_hazelcast_docs'
ai_search_id: '6b326171-dd1e-40c6-a948-1f9bb6c0ed52'
content:
sources:
- url: .
Expand Down
Binary file added docs/modules/ROOT/images/Ask_AI_JDK.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/modules/ROOT/images/Ask_AI_demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/modules/ROOT/images/ask_ai.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/modules/ROOT/images/ask_ai_search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.Get started
* xref:whats-new.adoc[What's new]
* xref:what-is-hazelcast.adoc[What is Hazelcast Platform]
* xref:ask-ai.adoc[]
* xref:getting-started:editions.adoc[Available versions]
* Start a local cluster
** xref:getting-started:get-started-docker.adoc[Docker]
Expand Down
33 changes: 33 additions & 0 deletions docs/modules/ROOT/pages/ask-ai.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
= Ask AI
:description: Use our Ask AI feature to get instant answers to technical questions.

== 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]

8 changes: 8 additions & 0 deletions docs/modules/ROOT/pages/whats-new.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ NOTE: The What's New page for Hazelcast Platform 6.0-SNAPSHOT will be available

{description}

== Get instant answers with new Hazelcast Ask AI

On every docs page you can now click the *Ask AI* button in the bottom right and get instant answers to all your questions about Hazelcast Platform, and our tools and clients. Ask AI is powered by the entire suite of Hazelcast documentation, including the latest docs from docs.hazelcast.com, the various API docs microsites, the latest official blogs, and a bunch of code samples and support knowledgebase articles.

image:Ask_AI_JDK.png[Ask AI example]

Give it a try now - for more information, see xref:ask-ai.adoc[].

== New Vector Collection for building semantic search (BETA)
[.enterprise]*Enterprise*

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/getting-started/pages/support.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ A support subscription from Hazelcast will allow you to get the most value out o
selection of Hazelcast. Our customers benefit from rapid response times to technical
support inquiries, access to critical software patches, and other services which
will help you achieve increased productivity and quality. Learn more about Hazelcast support subscriptions:
https://hazelcast.com/pricing/?utm_source=docs-website[hazelcast.com/pricing]
https://hazelcast.com/pricing/?utm_source=docs-website[https://hazelcast.com/pricing/]

If your organization subscribes to Hazelcast support,
and you already have an account setup, you can login to your account and open
Expand Down
Binary file removed docs/modules/whats-new/assets/glove.png
Binary file not shown.
3 changes: 0 additions & 3 deletions docs/modules/whats-new/assets/stars-L.svg

This file was deleted.

3 changes: 0 additions & 3 deletions docs/modules/whats-new/assets/stars-M.svg

This file was deleted.

3 changes: 0 additions & 3 deletions docs/modules/whats-new/assets/stars-S.svg

This file was deleted.

Binary file removed docs/modules/whats-new/favicon-16x16.png
Binary file not shown.
Binary file removed docs/modules/whats-new/favicon-32x32.png
Binary file not shown.
Binary file removed docs/modules/whats-new/favicon.ico
Binary file not shown.
152 changes: 0 additions & 152 deletions docs/modules/whats-new/styles.css

This file was deleted.

10 changes: 0 additions & 10 deletions docs/modules/whats-new/whats-new.adoc

This file was deleted.

0 comments on commit 27bd3e2

Please sign in to comment.