Quick Start

Choose a deployment path to install the AI Optimizer on a developer workstation, on premises, or in a cloud environment.

Prefer a Step-by-Step?

The Walkthrough is a great way to install and familiarize yourself with the AI Optimizer and its features in a containerized, development environment.

Prerequisites

Every deployment requires a connection to Oracle AI Database, including Oracle AI Database Free. The local client and all-in-one container provide a setup page for configuring this connection.

Install the tool required by your deployment path:

• uv for bare-metal installation
• A container runtime, such as Docker or Podman, for container installation

The features you use determine the remaining requirements:

Feature	Requirement
Agents and flows	Access to a language model
Vector Search	Access to an embedding model
NL2SQL	SQLcl installed where the Server runs and available on PATH

The all-in-one container includes SQLcl. Language and embedding models can use third-party APIs or run on premises.

_{*Oracle recommends running on-premises models on hardware with GPUs.}

Deployment Options

Available deployment options:

• Bare-Metal Installation
• Container Installation
• Oracle Cloud Infrastructure
• Kubernetes

---

Bare-Metal Installation

To run the AI Optimizer on bare-metal:

1. Download and extract the latest release into a new directory:

   Latest Release: TAR.GZ archive

   For example:

   curl -LO https://github.com/oracle/ai-optimizer/releases/latest/download/ai-optimizer-src.tar.gz
   mkdir ai-optimizer
   tar zxf ai-optimizer-src.tar.gz -C ai-optimizer
   
   cd ai-optimizer

2. Create the project environment and install the application:

   uv sync --all-extras

3. (Optional) Create an environment file to pre-configure the application:

   cp src/.env.example src/.env.dev

   Edit src/.env.dev as needed. You can supply the required Oracle AI Database connection in this file or enter it on the local setup page for the current client process. See Environment Variables for details.

4. Start the application:

   uv run python src/entrypoint.py client

5. Navigate to http://localhost:8501.

6. Configure the AI Optimizer.

---

Container Installation

To run the AI Optimizer in a container, use the following podman commands. You can substitute docker for podman.

1. Download and extract the latest release into a new directory:

   Latest Release: TAR.GZ archive

   For example:

   curl -LO https://github.com/oracle/ai-optimizer/releases/latest/download/ai-optimizer-src.tar.gz
   mkdir ai-optimizer
   tar zxf ai-optimizer-src.tar.gz -C ai-optimizer
   
   cd ai-optimizer

2. Build the container image.

   note

   macOS Silicon users may need to specify --arch amd64

   podman build -f src/Dockerfile -t localhost/ai-optimizer-aio:dev .

3. Start the container:

   podman run -v ai-optimizer-data:/app/data -p 8501:8501 -it --rm localhost/ai-optimizer-aio:dev

4. Navigate to http://localhost:8501.

5. Complete the required Oracle AI Database setup page. A successful configuration is stored in the ai-optimizer-data container volume.

6. Configure the AI Optimizer.

---

Oracle Cloud Infrastructure

The included OpenTofu Infrastructure as Code (IaC) can deploy the AI Optimizer and its supporting infrastructure in Oracle Cloud Infrastructure (OCI). It can provision an Autonomous Database or connect the deployment to an existing Oracle database. See Infrastructure as Code for deployment instructions.

---

Kubernetes

The AI Optimizer can be deployed into a Kubernetes cluster using a Helm chart. For more information, see Kubernetes / Helm.