https://github.com/oracle-samples/ai-optimizer
GenAI/RAG Sandbox for experimentation using Oracle Database AI Vector Search
https://github.com/oracle-samples/ai-optimizer
generative-ai oracle-database retreival-augmented-generation
Last synced: 27 days ago
JSON representation
GenAI/RAG Sandbox for experimentation using Oracle Database AI Vector Search
- Host: GitHub
- URL: https://github.com/oracle-samples/ai-optimizer
- Owner: oracle-samples
- License: upl-1.0
- Created: 2024-09-06T15:45:33.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-18T09:56:15.000Z (7 months ago)
- Last Synced: 2024-10-19T14:42:33.135Z (7 months ago)
- Topics: generative-ai, oracle-database, retreival-augmented-generation
- Language: Python
- Homepage: https://developer.oracle.com/microservices
- Size: 6.68 MB
- Stars: 9
- Watchers: 6
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project
README
# Oracle AI Optimizer and Toolkit
🚧 The **AI Optimizer** is currently in *Beta*
## Description
The **Oracle AI Optimizer and Toolkit** (the **AI Optimizer**) provides a streamlined environment where developers and data scientists can explore the potential of Generative Artificial Intelligence (GenAI) combined with Retrieval-Augmented Generation (RAG) capabilities. By integrating **Oracle Database 23ai** AI Vector Search, the Sandbox enables users to enhance existing Large Language Models (LLMs) through RAG.
## AI Optimizer Features
- [Configuring Embedding and Chat Models](https://oracle-samples.github.io/ai-optimizer/client/configuration/model_config)
- [Splitting and Embedding Documentation](https://oracle-samples.github.io/ai-optimizer/client/tools/split_embed)
- [Modifying System Prompts (Prompt Engineering)](https://oracle-samples.github.io/ai-optimizer/client/tools/prompt_eng)
- [Experimenting with **LLM** Parameters](https://oracle-samples.github.io/ai-optimizer/client/chatbot)
- [Testbed for auto-generated or existing Q&A datasets](https://oracle-samples.github.io/ai-optimizer/client/testbed)
## Getting Started
The **AI Optimizer** is available to install in your own environment, which may be a developer's desktop, on-premises data center environment, or a cloud provider. It can be run either on bare-metal, within a container, or in a Kubernetes Cluster.
For more information, including more details on **Setup and Configuration** please visit the [documentation](https://oracle-samples.github.io/ai-optimizer).
### Prerequisites
- Oracle Database 23ai incl. Oracle Database 23ai Free
- Python 3.11 (for running Bare-Metal)
- Container Runtime e.g. docker/podman (for running in a Container)
- Access to an Embedding and Chat Model:
- API Keys for Third-Party Models
- On-Premises Models\*
\*Oracle recommends running On-Premises Models on hardware with GPUs. For more information, please review the [Infrastructure](https://oracle-samples.github.io/ai-optimizer/infrastructure) documentation.
#### Bare-Metal Installation
To run the application on bare-metal; download the [source](https://github.com/oracle-samples/ai-optimizer) and from `src/`:
1. Create and activate a Python Virtual Environment:
```bash
cd src/
python3.11 -m venv .venv --copies
source .venv/bin/activate
pip3.11 install --upgrade pip wheel setuptools
```
1. Install the Python modules:
```bash
pip3.11 install -e ".[all]"
source .venv/bin/activate
```
1. Start Streamlit:
```bash
streamlit run launch_client.py --server.port 8501
```
1. Navigate to `http://localhost:8501`.
1. [Configure](https://oracle-samples.github.io/ai-optimizer/client/configuration) the **AI Optimizer**.
#### Container Installation
To run the application in a container; download the [source](https://github.com/oracle-samples/ai-optimizer):
1. Build the all-in-one image.
From the `src/` directory, build image:
```bash
cd src/
podman build -t ai-optimizer-aio .
```
1. Start the Container:
```bash
podman run -p 8501:8501 -it --rm ai-optimizer-aio
```
1. Navigate to `http://localhost:8501`.
1. [Configure](https://oracle-samples.github.io/ai-optimizer/client/configuration/index.html) the **AI Optimizer**.
#### Got OCI?
The **AI Optimizer** can be deployed with an Oracle Autonomous Database 23ai using infrastructure as code. Deploy the **AI Optimizer** in Oracle Cloud Infrastructure using OCI Resource Manager:
[![Deploy to Oracle Cloud][magic_button]][magic_arch_stack]
## Contributing
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md).
## Security
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process.
## License
Copyright (c) 2024 Oracle and/or its affiliates.
Released under the Universal Permissive License v1.0 as shown at [https://oss.oracle.com/licenses/upl/](https://oss.oracle.com/licenses/upl/)
See [LICENSE](./LICENSE.txt) for more details.
[magic_button]: https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg
[magic_arch_stack]: https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://github.com/oracle-samples/ai-optimizer/releases/download/v0.0.1/ai-optimizer-stack.zip