Merge pull request #37 from dbkinder/main

publish latest
opea-project · Sep 24, 2024 · 60c1b92 · 60c1b92
2 parents 13b7af0 + 935165d
commit 60c1b92
Show file tree

Hide file tree

Showing 355 changed files with 28,349 additions and 3,178 deletions.
diff --git a/404.html b/404.html
@@ -97,7 +97,19 @@
 </li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="getting-started/index.html">Getting Started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/README.html">Getting Started with OPEA</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/README.html#prerequisites">Prerequisites</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/README.html#understanding-opea-s-core-components">Understanding OPEA’s Core Components</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/README.html#visual-guide-to-deployment">Visual Guide to Deployment</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/README.html#setup-chatqna-parameters">Setup ChatQnA Parameters</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="getting-started/README.html#set-the-required-environment-variables">Set the required environment variables:</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/README.html#deploy-chatqna-megaservice-and-microservices">Deploy ChatQnA Megaservice and Microservices</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/README.html#interact-with-chatqna-megaservice-and-microservice">Interact with ChatQnA Megaservice and Microservice</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/README.html#whats-next">What’s Next</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="examples/index.html">GenAI Examples</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="examples/ChatQnA/ChatQnA_Guide.html">ChatQnA Sample Guide</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="examples/ChatQnA/ChatQnA_Guide.html#overview">Overview</a></li>
@@ -110,6 +122,12 @@
 <li class="toctree-l3"><a class="reference internal" href="examples/ChatQnA/ChatQnA_Guide.html#monitoring">Monitoring</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="examples/ChatQnA/deploy/index.html">ChatQnA Example Deployment Options</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="examples/ChatQnA/deploy/index.html#single-node">Single Node</a></li>
+<li class="toctree-l3"><a class="reference internal" href="examples/ChatQnA/deploy/index.html#kubernetes">Kubernetes</a></li>
+<li class="toctree-l3"><a class="reference internal" href="examples/ChatQnA/deploy/index.html#cloud-native">Cloud Native</a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="GenAIExamples/README.html">Generative AI Examples</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README.html#introduction">Introduction</a></li>
 <li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README.html#architecture">Architecture</a></li>
@@ -225,10 +243,10 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="examples/index.html#productivitysuite-application">ProductivitySuite Application</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/ProductivitySuite/README.html">OPEA Productivity Suite Application</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/ProductivitySuite/README.html">Productivity Suite Application</a></li>
 <li class="toctree-l3"><a class="reference internal" href="GenAIExamples/ProductivitySuite/docker_compose/intel/cpu/xeon/README.html">Build Mega Service of Productivity Suite on Xeon</a></li>
-<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/ProductivitySuite/docker_compose/intel/cpu/xeon/keycloak_setup_guide.html">Keycloak Configuration Setup</a></li>
-<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/ProductivitySuite/kubernetes/intel/README.html">Deploy ProductivitySuite with ReactUI</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/ProductivitySuite/docker_compose/intel/cpu/xeon/keycloak_setup_guide.html">🔐 Keycloak Configuration Setup</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/ProductivitySuite/kubernetes/intel/README.html">🚀 Deploy ProductivitySuite with ReactUI</a></li>
 <li class="toctree-l3"><a class="reference internal" href="GenAIExamples/ProductivitySuite/ui/react/README.html">Productivity Suite React UI</a></li>
 </ul>
 </li>
@@ -296,7 +314,8 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="microservices/index.html#chathistory-microservice">Chathistory Microservice</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/chathistory/mongo/README.html">Chat History Microservice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/chathistory/README.html">📝 Chat History Microservice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/chathistory/mongo/README.html">📝 Chat History Microservice with MongoDB</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="microservices/index.html#cores-microservice">Cores Microservice</a><ul>
@@ -328,7 +347,8 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="microservices/index.html#feedback-management-microservice">Feedback_management Microservice</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/feedback_management/mongo/README.html">Feedback Management Microservice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/feedback_management/README.html">🗨 Feedback Management Microservice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/feedback_management/mongo/README.html">🗨 Feedback Management Microservice with MongoDB</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="microservices/index.html#finetuning-microservice">Finetuning Microservice</a><ul>
@@ -338,9 +358,27 @@
 <li class="toctree-l2"><a class="reference internal" href="microservices/index.html#guardrails-microservice">Guardrails Microservice</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/README.html">Trust and Safety with LLM</a></li>
 <li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/bias_detection/README.html">Bias Detection Microservice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/factuality/predictionguard/README.html">Factuality Check Prediction Guard Microservice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/factuality/predictionguard/README.html#start-microservice-with-docker">🚀 Start Microservice with Docker</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/factuality/predictionguard/README.html#consume-factuality-check-service">🚀 Consume Factuality Check Service</a></li>
 <li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/llama_guard/langchain/README.html">Guardrails Microservice</a></li>
 <li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/pii_detection/README.html">PII Detection Microservice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/pii_detection/predictionguard/README.html">PII Detection Prediction Guard Microservice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/pii_detection/predictionguard/README.html#start-microservice-with-docker">🚀 Start Microservice with Docker</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/pii_detection/predictionguard/README.html#consume-pii-detection-service">🚀 Consume PII Detection Service</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/prompt_injection/predictionguard/README.html">Prompt Injection Detection Prediction Guard Microservice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/prompt_injection/predictionguard/README.html#start-microservice-with-docker">🚀 Start Microservice with Docker</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/prompt_injection/predictionguard/README.html#consume-prompt-injection-detection-service">🚀 Consume Prompt Injection Detection Service</a></li>
 <li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/toxicity_detection/README.html">Toxicity Detection Microservice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/toxicity_detection/predictionguard/README.html">Toxicity Checking Prediction Guard Microservice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/toxicity_detection/predictionguard/README.html#start-microservice-with-docker">🚀 Start Microservice with Docker</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/toxicity_detection/predictionguard/README.html#consume-toxicity-check-service">🚀 Consume Toxicity Check Service</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="microservices/index.html#image2video-microservice">Image2video Microservice</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/image2video/README.html">Image-to-Video Microservice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/image2video/README.html#start-microservice-with-python-option-1">🚀1. Start Microservice with Python (Option 1)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/image2video/README.html#start-microservice-with-docker-option-2">🚀2. Start Microservice with Docker (Option 2)</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="microservices/index.html#intent-detection-microservice">Intent_detection Microservice</a><ul>
@@ -377,7 +415,8 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="microservices/index.html#prompt-registry-microservice">Prompt_registry Microservice</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/prompt_registry/mongo/README.html">Prompt Registry Microservice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/prompt_registry/README.html">🧾 Prompt Registry Microservice</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/prompt_registry/mongo/README.html">🧾 Prompt Registry Microservice with MongoDB</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="microservices/index.html#ragas-microservice">Ragas Microservice</a><ul class="simple">
@@ -455,6 +494,7 @@
 </li>
 <li class="toctree-l2"><a class="reference internal" href="deploy/index.html#installation-guides">Installation Guides</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="guide/installation/gmc_install/gmc_install.html">GenAI-microservices-connector(GMC) Installation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="guide/installation/k8s_install/README.html">Kubernetes Installation Options</a></li>
 <li class="toctree-l3"><a class="reference internal" href="guide/installation/k8s_install/k8s_instal_aws_eks.html">Kubernetes Installation using AWS EKS Cluster</a></li>
 <li class="toctree-l3"><a class="reference internal" href="guide/installation/k8s_install/k8s_install_kubeadm.html">Kubernetes installation demo using kubeadm</a></li>
 <li class="toctree-l3"><a class="reference internal" href="guide/installation/k8s_install/k8s_install_kubespray.html">Kubernetes installation using Kubespray</a></li>
@@ -569,6 +609,7 @@
 <li class="toctree-l2"><a class="reference internal" href="GenAIEval/evals/benchmark/grafana/README.html">Setup Prometheus and Grafana to visualize microservice metrics</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="GenAIEval/evals/benchmark/grafana/README.html#setup-prometheus">1. Setup Prometheus</a></li>
 <li class="toctree-l3"><a class="reference internal" href="GenAIEval/evals/benchmark/grafana/README.html#setup-grafana">2. Setup Grafana</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIEval/evals/benchmark/grafana/README.html#import-grafana-dashboard">3. Import Grafana Dashboard</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="GenAIEval/evals/benchmark/stresscli/README.html">StressCli</a><ul>
@@ -612,6 +653,13 @@
 <li class="toctree-l3"><a class="reference internal" href="GenAIEval/evals/metrics/bleu/README.html#further-references">Further References</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="GenAIEval/evals/metrics/ragas/README.html">OPEA adaption of ragas (LLM-as-a-judge evaluation of Retrieval Augmented Generation)</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="GenAIEval/evals/metrics/ragas/README.html#user-data">User data</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIEval/evals/metrics/ragas/README.html#launch-huggingface-endpoint-on-intel-s-gaudi-machines">Launch HuggingFace endpoint on Intel’s Gaudi machines</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIEval/evals/metrics/ragas/README.html#run-opea-ragas-pipeline-using-your-desired-list-of-metrics">Run OPEA ragas pipeline using your desired list of metrics</a></li>
+<li class="toctree-l3"><a class="reference internal" href="GenAIEval/evals/metrics/ragas/README.html#troubleshooting">Troubleshooting</a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="developer-guides/index.html">Developer Guides</a><ul>
@@ -775,7 +823,7 @@
   <div role="contentinfo">
     <p>&#169; Copyright 2024 OPEA™, a Series of LF Projects, LLC.
 
-<span class="lastupdated">Published on Sep 20, 2024.</span>
+<span class="lastupdated">Published on Sep 24, 2024.</span>
 
   </div>