Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oracle-samples/oaim-sandbox
GenAI/RAG Sandbox for experimentation using Oracle Database AI Vector Search
https://github.com/oracle-samples/oaim-sandbox
generative-ai oracle-database retreival-augmented-generation
Last synced: 3 days ago
JSON representation
GenAI/RAG Sandbox for experimentation using Oracle Database AI Vector Search
- Host: GitHub
- URL: https://github.com/oracle-samples/oaim-sandbox
- Owner: oracle-samples
- License: upl-1.0
- Created: 2024-09-06T15:45:33.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-18T09:56:15.000Z (27 days ago)
- Last Synced: 2024-10-19T14:42:33.135Z (26 days 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 Microservices Sandbox
🚧 Developer Preview
## Description
The **Oracle AI Microservices Sandbox** 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.
## Sandbox Features
- [Configuring Embedding and Chat Models](https://oracle-samples.github.io/oaim-sandbox/sandbox/configuration/model_config)
- [Splitting and Embedding Documentation](https://oracle-samples.github.io/oaim-sandbox/sandbox/tools/split_embed)
- [Storing Embedded Documents into the Oracle Database](https://oracle-samples.github.io/oaim-sandbox/sandbox/tools/split_embed)
- [Modifying System Prompts (Prompt Engineering)](https://oracle-samples.github.io/oaim-sandbox/sandbox/tools/prompt_eng)
- [Experimenting with **LLM** Parameters](https://oracle-samples.github.io/oaim-sandbox/sandbox/chatbot)
- [Testing Framework on auto-generated or existing Q&A datasets](https://oracle-samples.github.io/oaim-sandbox/sandbox/test_framework)
## Getting Started
The **Oracle AI Microservices Sandbox** 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/oaim-sandbox).
### 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/oaim-sandbox/infrastructure) documentation.
#### Bare-Metal Installation
To run the application on bare-metal; download the [source](https://github.com/oracle-samples/oaim-sandbox) and from the top-level directory:
1. Create and activate a Python Virtual Environment:
```bash
python3.11 -m venv .venv
source .venv/bin/activate
pip3 install --upgrade pip wheel
```
1. Install the Python modules:
```bash
pip3 install -r app/requirements.txt
```
1. Start Streamlit:
```bash
cd app/src
streamlit run oaim-sandbox.py --server.port 8501
```
1. Navigate to `http://localhost:8501`.
1. [Configure](https://oracle-samples.github.io/oaim-sandbox/sandbox/configuration) the Sandbox.
#### Container Installation
To run the application in a container; download the [source](https://github.com/oracle-samples/oaim-sandbox) and from the top-level directory:
1. Build the image.
From the `app/` directory, build Image:
```bash
podman build -t oaim-sandbox .
```
1. Start the Container:
```bash
podman run -p 8501:8501 -it --rm oaim-sandbox
```
1. Navigate to `http://localhost:8501`.
1. [Configure](https://oracle-samples.github.io/oaim-sandbox/sandbox/configuration/index.html) the Sandbox.
## 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.