Releases: opea-project/docs
Generative AI Docs v1.4 Release Notes
OPEA Release Notes v1.4
We are excited to announce the release of OPEA version 1.4, which includes significant contributions from the open-source community. This release addresses over 330 pull requests.
More information about how to get started with OPEA v1.4 can be found on the Getting Started page. All project source code is maintained in the opea-project organization. To pull Docker images, please access the Docker Hub. For instructions on deploying Helm Charts, please refer to the guide.
Table of Contents
- OPEA Release Notes v1.4
What's New in OPEA v1.4
This release includes new features, optimizations, and user-focused updates.
Advanced Agent Capabilities
-
MCP (Model Context Protocol) Support: The OPEA agent now supports the MCP, allowing for standardized and more efficient integration with external data and services. (GenAIComps#1678, GenAIComps#1810)
-
Deep Research Agent: The example is designed to handle complex, multi-step research. It leverages langchain-ai/open_deep_research and supports Intel Gaudi accelerators. (GenAIExamples#2117)
Components as MCP Servers
OPEA components can now serve as Model Context Protocol (MCP) servers, allowing external MCP-compatible frameworks and applications to integrate with OPEA seamlessly. (GenAIComps#1652)
KubeAI Operator for OPEA
The KubeAI Operator now features an improved autoscaler, monitoring support, optimized resource placement via NRI plugins, and expanded support for new models on Gaudi. (GenAIInfra#967, GenAIInfra#1052, GenAIInfra#1054, GenAIInfra#1089, GenAIInfra#1113, GenAIInfra#1144, GenAIInfra#1150)
New GenAI Capabilities
- Fine-Tuning of Reasoning Models: This feature is compatible with the dataset format used in FreedomIntelligence/medical-o1-reasoning-SFT, enabling you to customize models with your own data. (GenAIComps#1839)
- HybridRAG: Combined GraphRAG (knowledge graph-based retrieval) and VectorRAG (vector database retrieval) for enhanced accuracy and contextual relevance. (GenAIExamples#1968)
- LLM Router: LLM Router decides which downstream LLM serving endpoint is best suited for an incoming prompt. (GenAIComps#1716)
- OPEA Store: Redis and MongoDB have been integrated into OPEA Store. (GenAIComps#1816, GenAIComps#1818)
- Guardrails: Added Input/Output Guardrails to enforce content safety and prevent the creation of inappropriate outputs. (GenAIComps#1798)
- Language Detection: The microservice is used to ensure the pipeline's response matches the query's language. (GenAIComps#1774)
- Prompt Template: The microservice can dynamically generate system and user prompts based on structured inputs and document context. (GenAIComps#1826)
- Air-gapped Environment Support: Some OPEA microservices can now be deployed in an air-gapped Docker environment. (GenAIComps#1480)
- Remote Inference Endpoints Support: Added support for remote inference endpoints for OPEA examples. (GenAIExamples#1973)
Better User Experience
- One-click Deployment: You can now deploy 8 OPEA examples with one click. ChatQnA can deploy in an air-gapped Docker environment. (GenAIExamples#1727)
- GenAIStudio: Added support for drag-and-drop creation of documentation summarization and code generation applications. (GenAIStudio#61)
- Documentation Refinement: Refined READMEs for key examples and components to help readers easily locate documentation tailored to deployment, customization, and hardware. (GenAIExamples#1673, GenAIComps#1398)
Newly Supported Models
OPEA introduces support for the following models in this release.
Model | TGI-Gaudi | vLLM-CPU | vLLM-Gaudi | vLLM-ROCm | OVMS | Optimum-Habana | PredictionGuard | SGLANG-CPU |
---|---|---|---|---|---|---|---|---|
meta-llama/Llama-4-Scout-17B-16E-Instruct | - | - | - | - | - | - | - | ✓ |
meta-llama/Llama-4-Maverick-17B-128E-Instruct | - | - | - | - | - | - | - | ✓ |
(✓: supported; -: not validated; x: unsupported)
Newly Supported Hardware
- Support for AMD® EPYC™ has been added for 11 OPEA examples. (GenAIExamples#2083)
Newly Supported OS
- Support for openEuler has been added. (GenAIExamples#2088, GenAIComps#1813)
Updated Dependencies
Dependency | Hardware | Scope | Version | Version in OPEA v1.3 | Comments |
---|---|---|---|---|---|
huggingface/text-embeddings-inference | all | all supported examples | cpu-1.7 | cpu-1.6 | |
vllm | Xeon | all supported examples except EdgeCraftRAG | v0.10.0 | v0.8.3 |
Changes to Default Behavior
CodeTrans
: The default model changed frommistralai/Mistral-7B-Instruct-v0.3
toQwen/Qwen2.5-Coder-7B-Instruct
on Xeon and Gaudi.
Validated Hardware
- Intel® Gaudi® AI Accelerators (2nd)
- Intel® Xeon® Scalable processor (3rd)
- Intel® Arc™ Graphics GPU (A770)
- AMD® EPYC™ processors (4th, 5th)
Validated Software
- Docker version 28.3.3
- Docker Compose version v2.39.1
- Intel® Gaudi® software and drivers v1.21
- Kubernetes v1.32.7
- TEI v1.7
- TGI v2.4.0 (Xeon, EPYC), v2.3.1 (Gaudi), v2.4.1 (ROCm)
- Torch v2.5.1
- Ubuntu 22.04
- vLLM v0.10.0 (Xeon, EPYC), v0.6.6.post1+Gaudi-1.20.0 (Gaudi)
Known Issues
- AvatarChatbot cannot run in a K8s environment due to a functional gap in the wav2clip service. (GenAIExamples#1506)
Full Changelogs
- GenAIExamples: v1.3...v1.4
- GenAIComps: v1.3...v1.4
- GenAIInfra: v1.3...v1.4
- GenAIEval: v1.3...v1.4
- GenAIStudio: v1.3...v1.4
- docs: v1.3...v1.4
Contributors
This release would not have been possible without the contributions of the following organizations and individuals.
Contributing Organizations
AMD
: AMD EPYC support.Bud
: Components as MCP Servers.Intel
: Development and improvements to GenAI examples, components, infrastructure, evaluation, and studio.MariaDB
: Added ChatQnA docker-compose example on Intel Xeon using Mari...
OPEA Docs v1.3 Release
For information on updates and additions in this version of OPEA, see the latest release notes.
OPEA Docs v1.1 Release
What's Changed
- doc: initial ChatQnA example and placeholders by @dbkinder in #87
- RFC: Guardrails gateway by @zhxie in #23
- rfc submission for OPEA GenAIStudio by @chinyixiang in #72
- doc: tweak organization of TSC and governance docs by @dbkinder in #92
- updating text on faq and index by @craigmateo in #89
- doc: add new GenAIExample folder by @dbkinder in #90
- doc: add pymarkdown tool by @dbkinder in #91
- doc: improved use of globbing in toctree by @dbkinder in #99
- RFC - AI Avatar Animation Design by @ctao456 in #59
- doc: replace OPEA_API word doc with rst version by @dbkinder in #94
- doc: fix markdown in recent rfcs by @dbkinder in #95
- doc: update rfc template headings by @dbkinder in #97
- doc: update Makefile to use a clean logfile by @dbkinder in #101
- doc: update docbuild instructions by @dbkinder in #98
- doc: add ChatQnA deploy on xeon example by @dbkinder in #104
- docs: improve examples presentation by @dbkinder in #105
- doc: fix redirect by @dbkinder in #116
- Added Gaudi.md to render on github.io by @preethivenkatesh in #121
- doc: tweak pymarkdown linter excluded rules by @dbkinder in #127
- doc: fix referenced doc name change by @dbkinder in #126
- doc: auto toctree for examples and microservices by @dbkinder in #130
- add contributor guide for GenAIComp and GenAIExample by @rbrugaro in #107
- Update gaudi.md to render on github.io by @ctao456 in #129
- xeon documentation by @srinarayan-srikanthan in #123
- nvidia documentation by @srinarayan-srikanthan in #122
- doc: remove GenAIInfra placeholder by @dbkinder in #135
- github.io documentation for aipc by @devpramod in #124
- doc: update CONTRIBUTING by @dbkinder in #136
- doc: fix relative images and raw HTML by @dbkinder in #134
- doc: configure myst handling of mermaid diagrams by @dbkinder in #133
- doc: tweak deploy titles in ChatQnA guide by @dbkinder in #139
- doc: cleanup unused conf.py stuff by @dbkinder in #138
- update genaiexample introduction in docs by @ZhaoqiongZ in #141
- Minor text, architecture merge, refresh from previous PR by @tomlenth in #140
- doc: fix headings with leading spaces by @dbkinder in #143
- doc fix up hard URL references with in-page target by @dbkinder in #144
- doc: tweak maketoc script by @dbkinder in #142
- doc: reapply link name changer in ChatQna_Guide by @dbkinder in #145
- ChatQnA guide by @tomlenth in #146
- Fix invalid link by @ctao456 in #149
- doc: correction to fix-github-md-refs by @dbkinder in #147
- doc: one more tweak to the md refs fixing script by @dbkinder in #166
- add v1.0 release notes by @kevinintel in #102
- Update v1.0.md by @kevinintel in #169
- doc: fix missing references to README.md by @dbkinder in #170
- Adding getting started with video by @srinarayan-srikanthan in #171
- doc: fix link to deploy options in get started by @dbkinder in #173
- doc: update doc guidelines and building content by @dbkinder in #175
- doc: remove test directory by @dbkinder in #176
- Remove sharepoint locations by @ctao456 in #178
- doc: add more to doc guidelines and build by @dbkinder in #180
- doc: add direct links to deploy options by @dbkinder in #184
- doc: fix more link issues by @dbkinder in #183
- doc: a few last doc tweaks by @dbkinder in #187
- Added tabs for pull / build on xeon by @srinarayan-srikanthan in #182
- doc: fix deploy links in ChatQnA by @dbkinder in #188
- inline install commands fow aws by @srinarayan-srikanthan in #189
- Added link to ITDC by @snarktank in #196
- doc: update requirements.txt by @dbkinder in #197
- doc: update known issues filter by @dbkinder in #198
- ChatQnA for Gaudi: add tabs for build/pull and update instructions by @alexsin368 in #185
- [RFC] : Extend the current DocSum by @MSCetin37 in #193
- Add hyperlinks and paths validation. by @ZePan110 in #177
- Hierarchical Multi Agents rfc by @xuechendi in #29
- Fix the issue of exiting due to inability to find hyperlinks. by @ZePan110 in #199
- RFC for Edge Craft RAG by @myqi in #70
- rfc: AI gateway API by @daixiang0 in #67
- One click build doc by @NeoZhangJianyu in #200
- update for daily build doc: bug fix and review comments by @NeoZhangJianyu in #203
- Creating issue templates for the repository by @SachinVarghese in #201
- fix the format issue when build online doc by @NeoZhangJianyu in #206
- Add community info to GSG by @tomlenth in #205
- [online doc] fix tab error in online doc by @NeoZhangJianyu in #207
- RFC with enhancements to MultimodalQnA by @dmsuehir in #208
- Update hyperlinks in doc_guidelines.rst and docbuild.rst by @jiahuit1 in #212
- add link to getting started across chatqna, different hardware modes by @devpramod in #191
- Update OPEA API spec to 1.0 version by @ftian1 in #167
- Update README.md for usage experience by @yinghu5 in #215
- Update ChatQnA APIC deploy document by @xiguiw in #216
- Ibm getting started by @devpramod in #221
- Update README.md for fix link by @yinghu5 in #229
- combine ibm, aws into tabs, add tabset for getting started by @devpramod in #230
- Revert "combine ibm, aws into tabs, add tabset for getting started" by @yinghu5 in #231
- add tabset for aws, gcp and ibm cloud by @devpramod in #232
- Update up-to-date public information for the avatar chatbot example by @ctao456 in #228
- [Doc] check error of make html by @NeoZhangJianyu in #236
- Clean up GenAI Examples page by @intelkevinputnam in #238
- Exclude portal.azure.com by @ZePan110 in #239
- Adding Azure instructions by @srinarayan-srikanthan in #237
- Add CONTRIBUTING.md file to root folder by @jiahuit1 in #226
- fix format issue, add CONTRIBUTING.md to index by @NeoZhangJianyu in #240
- oci instruction by @srinarayan-srikanthan in #242
- Update on gsg by @srinarayan-srikanthan in #245
- add ci for build online doc by @NeoZhangJianyu in #241
- support copy all image to html folder by @NeoZhangJianyu in #247
- Update opea-custom.js to fix235 by @yinghu5 in #249
- reformat agentQnA sample guide by @abdulari in https://github.com/op...