Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add v1.2 release notes. #277

Merged
merged 18 commits into from
Jan 27, 2025
Merged
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update v1.2 release notes for the ww4.3 updates
joshuayao committed Jan 23, 2025
commit 52b424cb49e2d56faed17c26d6cc4c516358180a
24 changes: 12 additions & 12 deletions release_notes/v1.2.md
Original file line number Diff line number Diff line change
@@ -7,12 +7,12 @@ More information about how to get started with OPEA v1.2 can be found at [Gettin
This release focuses on code refactoring for [GenAIComps](https://github.com/opea-project/GenAIComps), the epic efforts aimed at reducing redundancy, addressing technical debt, and enhancing overall maintainability and code quality. As a result, OPEA users can expect a more robust and reliable OPEA with clearer guidance and improved documentation.

OPEA v1.2 also introduces more scenarios with general availability, including:
- <b>[LlamaIndex](https://github.com/run-llama/llama_index/pull/16666) and [LangChain](https://github.com/opea-project/GenAIComps/pull/1128) integration</b>: Enabling OPEA as a backend. LlamaIndex integration currently supports [ChatQnA](https://github.com/opea-project/GenAIExamples/tree/v1.2/ChatQnA) only.
- <b>[LlamaIndex](https://github.com/run-llama/llama_index/pull/16666) and LangChain Integration</b>: Enabling OPEA as a backend. LlamaIndex integration currently supports [ChatQnA](https://github.com/opea-project/GenAIExamples/tree/v1.2/ChatQnA) only.
- <b>Model Context Protocol(MCP) Support</b>: Experimental support for MCP at Retriever.
- <b>Cloud Service Providers(CSP) Support</b>: Supported automated Terraform deployment using Intel® Optimized Cloud Modules for Terraform, available for major cloud platforms, including `Amazon Web Services (AWS)`, `Google Cloud Platform (GCP)`, and `Microsoft Azure`.
- <b>Enhanced Security</b>: [Istio Mutual TLS (mTLS)](https://github.com/opea-project/GenAIInfra/pull/702) and [OIDC (Open ID Connect) based Authentication with APISIX](https://github.com/opea-project/GenAIInfra/pull/312).
- <b>Enhancements for GenAI Evaluation:</b> [Specialized evaluation benchmarks](https://github.com/opea-project/GenAIEval/pull/141) tailored for Chinese language models, focusing on their performance and accuracy within [Chinese dataset](https://github.com/opea-project/GenAIEval/pull/48).
- <b>Helm Charts Deployment</b>: Add supports for the examples Text2Image, SearchQnA, EdgeCraftRag and their microservices.
- <b>Helm Charts Deployment</b>: Add supports for the examples Text2Image, SearchQnA and their microservices.

### Highlights

@@ -35,31 +35,31 @@ OPEA offers automated Terraform deployment using Intel® Optimized Cloud Modules
Additionally, OPEA supports manual deployment on virtual servers across `AWS`, `GCP`, `IBM Cloud`, `Azure`, and `Oracle Cloud Infrastructure (OCI)`. For detailed instructions, refer to the [manual deployment guide](https://opea-project.github.io/latest/getting-started/README.html#create-and-configure-a-virtual-server).

#### Enhanced GenAI Components
- <b>[vLLM support for embeddings and rerankings](https://github.com/opea-project/GenAIComps/issues/956)</b>Integrate vLLM as a serving framework to enhance the performance and scalability of embedding and reranking models.
- <b>[vLLM support for embeddings and rerankings](https://github.com/opea-project/GenAIComps/issues/956)</b>: Integrate vLLM as a serving framework to enhance the performance and scalability of embedding and reranking models.
- <b>Agent Microservice</b>:
- <b>SQL agent strategy:</b> Take user question, hints (optional) and history (when available), and think step by step to solve the problem by interacting with a SQL database. OPEA currently has two types of [SQL agents](https://github.com/opea-project/GenAIComps/pull/1039): `sql_agent_llama` for using with open-source LLMs and `sql_agent`: for using with OpenAI models.
- <b>Enabled user-customized tool subsets:</b> Added support for [user-defined subsets of tools](https://github.com/opea-project/GenAIComps/issues/978) for the ChatCompletion API and Assistant APIs.
- <b>Enabled persistence:</b> Introduced Redis to persist Agent configurations and historical messages for Agent recovery and multi-turn conversations.
- <b>Long-context Summarization:</b> Supported multiple modes: [`auto`](https://github.com/opea-project/GenAIComps/commit/5aba3b25), [`stuff`, `truncate`, `map_reduce`, and `refine`](https://github.com/opea-project/GenAIComps/commit/45d00020).
- <b>Standalone Microservice Deployment</b>: Enabled the deployment of OPEA components as independent services, allowing for greater flexibility, scalability, and modularity in various application scenarios.
- <b>[PDF Inputs Support](https://github.com/opea-project/GenAIComps/pull/1134):</b> Support PDF inputs for dataprep, embeddings, lvms, and retrievers.
- <b>[PDF Inputs Support](https://github.com/opea-project/GenAIComps/pull/1134):</b> Support PDF inputs for dataprep, embeddings, LVMs, and retrievers.

#### New GenAI Components
- <b>[Bedrock](https://github.com/opea-project/GenAIComps/pull/1031):</b> OPEA LLM now supports [Amazon Bedrock](https://aws.amazon.com/bedrock/) as the backend of the text generation microservice. Bedrock is a fully managed service that offers a choice of high-performing foundation models (FMs) from leading AI companies through a single API, along with a broad set of capabilities you need to build generative AI applications with security, privacy, and responsible AI.
- <b>[OpenSearch Vector Database](https://github.com/opea-project/GenAIComps/pull/1024):</b> OPEA vectorstores now supports [AWS OpenSearch](https://aws.amazon.com/opensearch-service/). OpenSearch is an open-source, enterprise-grade search and observability suite that brings order to unstructured data at scale.
- <b>[Elasticsearch Vector Database](https://github.com/opea-project/GenAIComps/pull/972):</b> OPEA vectorestores now supports [Elasticsearch vector database](https://www.elastic.co/elasticsearch/vector-database), Elasticsearch's open source vector database offering an efficient way to create, store, and search vector embeddings.
- <b>[Guardrail Hallucination Detection](https://github.com/opea-project/GenAIComps/pull/1108):</b> Added the capability of detecting `Hallucination` which spans a wide range of issues that can impact reliability, trustworthiness, and utility of AI-generated content.
- <b>[Guardrail Hallucination Detection](https://github.com/opea-project/GenAIComps/pull/1108):</b> Added the capability of detecting Hallucination which spans a wide range of issues that can impact reliability, trustworthiness, and utility of AI-generated content.

#### Enhanced GenAI Examples
- <b>ChatQnA</b>: Enabled [embedding and reranking on vLLM](https://github.com/opea-project/GenAIExamples/issues/1203), and [Jaeger UI and OpenTelemetry tracing](https://github.com/opea-project/GenAIExamples/pull/1316) for TGI serving on HPU.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please check the linked items. opea-project/GenAIExamples#1203 is still open, and tagged for v1.3 release, not v1.2.

- <b>AgentQnA</b>: Added [SQL worker agent](https://github.com/opea-project/GenAIExamples/pull/1370) and introduced a [Svelte-based GUI](https://github.com/opea-project/GenAIExamples/pull/1389) for ChatCompletion API for non-streaming interactions.
- <b>MultimodalQnA</b>: Supported [PDF](https://github.com/opea-project/GenAIExamples/pull/1381) and [audio](https://github.com/opea-project/GenAIExamples/pull/1225) inputs.
joshuayao marked this conversation as resolved.
Show resolved Hide resolved
- <b>EdgeCraftRAG</b>: Supported image/url data retrieval and display, display of LLM-used context sources in UI, pipeline remove operation in RESTful API and UI, RAG pipeline performance benchmark and display in UI. ([#GenAIExamples/1324](https://github.com/opea-project/GenAIExamples/pull/1324))
- <b>DocSum</b>: Adding [URL summary option](https://github.com/opea-project/GenAIExamples/pull/1248) to Gradio-based UI.
- <b>DocSum</b>: Added [URL summary option](https://github.com/opea-project/GenAIExamples/pull/1248) to Gradio-based UI.
- <b>DocIndexRetriever</b>: Add the pipeline without Reranking.

#### Enhanced GenAIStudio
In this release, GenAI Studio enables keycloak for multi user management, supporting sandbox environment for multi workflow execution and enables Grafana based visualization dashboards with build-in performance metric on Prometheus for model evaluation and functional nodes performance.
In this release, GenAI Studio enables Keycloak for multi-user management, supporting sandbox environment for multi-workflow execution and enables Grafana based visualization dashboards with built-in performance metric on Prometheus for model evaluation and functional nodes performance.

#### Newly Supported Models
- bge-base-zh-v1.5
@@ -163,9 +163,9 @@ The Docker images marked for renaming are now deprecated and will be removed sin
- [ChatQnA] Enable OpenTelemetry Tracing for ChatQnA TGI serving on Gaudi. ([81022355](https://github.com/opea-project/GenAIExamples/commit/81022355))
- [DocIndexRetriever] Enable the without-rerank flavor. ([a50e4e6f](https://github.com/opea-project/GenAIExamples/commit/a50e4e6f))
- [DocSum] Support Long context for DocSum. ([50dd959d](https://github.com/opea-project/GenAIExamples/commit/50dd959d))
- [DocSum] Adding URL summary option to DocSum Gradio-UI. ([84a6a6e9](https://github.com/opea-project/GenAIExamples/commit/84a6a6e9))
- [DocSum] Added URL summary option to DocSum Gradio-UI. ([84a6a6e9](https://github.com/opea-project/GenAIExamples/commit/84a6a6e9))
- [EdgeCraftRAG] Add new feature and bug fix for EC-RAG. ([6169ea49](https://github.com/opea-project/GenAIExamples/commit/6169ea49))
- [MultimodalQnA] Adds audio querying to MultimodalQ&A Example. ([c760cac2](https://github.com/opea-project/GenAIExamples/commit/c760cac2))
- [MultimodalQnA] Add audio querying to MultimodalQ&A Example. ([c760cac2](https://github.com/opea-project/GenAIExamples/commit/c760cac2))

- Changed Defaults
- [DocSum] Changed Default UI to Gradio. ([00b526c8](https://github.com/opea-project/GenAIExamples/commit/00b526c8))
@@ -191,8 +191,8 @@ The Docker images marked for renaming are now deprecated and will be removed sin
- FaqGen param fix. ([05365b61](https://github.com/opea-project/GenAIExamples/commit/05365b61))

- Documentation
- Update README.md for add K8S cluster link for Gaudi. ([91ff520b](https://github.com/opea-project/GenAIExamples/commit/91ff520b))
- Update README.md for support matrix. ([41374d86](https://github.com/opea-project/GenAIExamples/commit/41374d86))
- Update README.md for adding K8S cluster link for Gaudi. ([91ff520b](https://github.com/opea-project/GenAIExamples/commit/91ff520b))
- Update README.md for supporting matrix. ([41374d86](https://github.com/opea-project/GenAIExamples/commit/41374d86))
- Update README.md for quick start guide. ([00241d01](https://github.com/opea-project/GenAIExamples/commit/00241d01))
- Add example for AudioQnA deploy in AMD ROCm. ([006c61bc](https://github.com/opea-project/GenAIExamples/commit/006c61bc))

@@ -322,7 +322,7 @@ The Docker images marked for renaming are now deprecated and will be removed sin

<details><summary>GenAIStudio</summary>

- Add keycloak theme under assets. ([00da22d](https://github.com/opea-project/GenAIStudio/commit/00da22d))
- Add Keycloak theme under assets. ([00da22d](https://github.com/opea-project/GenAIStudio/commit/00da22d))
- Add new basic workflow after solving the bug. ([96f6590](https://github.com/opea-project/GenAIStudio/commit/96f6590))
- Let initial inputs at least match one key for prompt. ([e6c4229](https://github.com/opea-project/GenAIStudio/commit/e6c4229))
- Add more keywords, and retry another question. ([c2a6e70](https://github.com/opea-project/GenAIStudio/commit/c2a6e70))