From 04b57e399474808fbb647ba208927d14e33251ce Mon Sep 17 00:00:00 2001 From: Chris Tyler Date: Fri, 6 Jun 2025 13:28:38 +0100 Subject: [PATCH 1/3] ENG-24977 initial draft on how to enable and access the chatbot interface within a dsp --- modules/accessing-the-chat-bot-interface.adoc | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 modules/accessing-the-chat-bot-interface.adoc diff --git a/modules/accessing-the-chat-bot-interface.adoc b/modules/accessing-the-chat-bot-interface.adoc new file mode 100644 index 000000000..485f64025 --- /dev/null +++ b/modules/accessing-the-chat-bot-interface.adoc @@ -0,0 +1,43 @@ +:_module-type: PROCEDURE + +[id="accessing-the-chat-bot-interface_{context}"] += Accessing the chat bot interface + +[role='_abstract'] +Embedding a Llama stack large language model (LLM) chat bot interface directly into a data science project gives you immediate, context-aware assistance without switching tools. This allows you to quickly explore model parameters, troubleshoot errors, and experiment interactively within a data science project. + +[IMPORTANT] +==== +By default, the chat bot interface is hidden from appearing from within the data science project user interface. To show the user interface components associated with the chat bot interface, set the `disableLlamaStackClient` value to `false` in the `OdhDashboardConfig` custom resource (CR) in {openshift-platform}. +ifndef::upstream[] +For more information, see link:{rhoaidocshome}/html/managing_openshift_ai/customizing-the-dashboard#ref-dashboard-configuration-options_dashboard[Dashboard configuration options]. +endif::[] +ifdef::upstream[] +For more information, see link:{odhdocshome}/managing-odh/#ref-dashboard-configuration-options_dashboard[Dashboard configuration options]. +endif::[] +==== + +.Prerequisites +* You have logged in to {productname-long}. +* The `disableLlamaStackClient` feature flag value is set to `false` in the `OdhDashboardConfig` custom resource (CR) in {openshift-platform}. +ifndef::upstream[] +* If you are using {productname-short} groups, you are part of the user group or admin group (for example, {oai-user-group} or {oai-admin-group}) in OpenShift. +endif::[] +ifdef::upstream[] +* If you are using {productname-short} groups, you are part of the user group or admin group (for example, {odh-user-group} or {odh-admin-group}) in OpenShift. +endif::[] +* You have created a data science project. + +.Procedure +. From the {productname-short} dashboard, click *Data science projects*. ++ +The *Data science projects* page opens. +. Click the data science project for which you want to access the chat bot. ++ +A project details page opens. +. Click the *Chat bot* tab. ++ +The LlamaStack chat bot interface appears. + +.Verification +* You can access the *Chat bot* tab from within a data science project. From 60174e7aca17ea49e2a265ffd352442489620c86 Mon Sep 17 00:00:00 2001 From: Chris Tyler Date: Mon, 9 Jun 2025 09:56:12 +0100 Subject: [PATCH 2/3] Addressed peer review feedback --- modules/accessing-the-chat-bot-interface.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/accessing-the-chat-bot-interface.adoc b/modules/accessing-the-chat-bot-interface.adoc index 485f64025..b533b3ca8 100644 --- a/modules/accessing-the-chat-bot-interface.adoc +++ b/modules/accessing-the-chat-bot-interface.adoc @@ -4,11 +4,11 @@ = Accessing the chat bot interface [role='_abstract'] -Embedding a Llama stack large language model (LLM) chat bot interface directly into a data science project gives you immediate, context-aware assistance without switching tools. This allows you to quickly explore model parameters, troubleshoot errors, and experiment interactively within a data science project. +Embedding a Llama stack large language model (LLM) chat bot interface directly into a data science project gives you immediate, context-aware assistance without switching tools. You can use this interface to quickly explore model parameters, troubleshoot errors, and experiment interactively within a data science project. [IMPORTANT] ==== -By default, the chat bot interface is hidden from appearing from within the data science project user interface. To show the user interface components associated with the chat bot interface, set the `disableLlamaStackClient` value to `false` in the `OdhDashboardConfig` custom resource (CR) in {openshift-platform}. +By default, the chat bot interface is hidden from display within the data science project user interface. To show the user interface components for the chat bot interface, set the `disableLlamaStackClient` value to `false` in the `OdhDashboardConfig` custom resource (CR) in {openshift-platform}. ifndef::upstream[] For more information, see link:{rhoaidocshome}/html/managing_openshift_ai/customizing-the-dashboard#ref-dashboard-configuration-options_dashboard[Dashboard configuration options]. endif::[] @@ -37,7 +37,7 @@ The *Data science projects* page opens. A project details page opens. . Click the *Chat bot* tab. + -The LlamaStack chat bot interface appears. +The LlamaStack chat bot interface displays. .Verification * You can access the *Chat bot* tab from within a data science project. From 15acbc3c190fa5cbef7491cc172814164852ffa5 Mon Sep 17 00:00:00 2001 From: Chris Tyler Date: Wed, 11 Jun 2025 20:40:21 +0100 Subject: [PATCH 3/3] addressed peer review feedback --- modules/accessing-the-chat-bot-interface.adoc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/modules/accessing-the-chat-bot-interface.adoc b/modules/accessing-the-chat-bot-interface.adoc index b533b3ca8..b7f4e4f95 100644 --- a/modules/accessing-the-chat-bot-interface.adoc +++ b/modules/accessing-the-chat-bot-interface.adoc @@ -27,6 +27,8 @@ ifdef::upstream[] * If you are using {productname-short} groups, you are part of the user group or admin group (for example, {odh-user-group} or {odh-admin-group}) in OpenShift. endif::[] * You have created a data science project. +* You have deployed the Llama Stack Operator. +* You have configured a LlamaStackDistribution custom resource (CR) with a vLLM inference service and a Milvus vector database. .Procedure . From the {productname-short} dashboard, click *Data science projects*. @@ -41,3 +43,4 @@ The LlamaStack chat bot interface displays. .Verification * You can access the *Chat bot* tab from within a data science project. +* You can successfully send queries to the chat bot and then receive relevant answers.