Skip to content

Commit cd21e32

Browse files
authored
Update Documents for AI Database (#306)
1 parent f1c6ad5 commit cd21e32

File tree

10 files changed

+25
-25
lines changed

10 files changed

+25
-25
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
## Description
99

10-
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 VectorSearch and SelectAI, the Sandbox enables users to enhance existing Large Language Models (LLMs) through RAG.
10+
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 AI Database** VectorSearch and SelectAI, the Sandbox enables users to enhance existing Large Language Models (LLMs) through RAG.
1111

1212
## AI Optimizer Features
1313

@@ -25,7 +25,7 @@ For more information, including more details on **Setup and Configuration** plea
2525

2626
### Prerequisites
2727

28-
- Oracle Database 23ai incl. Oracle Database 23ai Free
28+
- Oracle AI Database incl. Oracle AI Database Free
2929
- Python 3.11 (for running Bare-Metal)
3030
- Container Runtime e.g. docker/podman (for running in a Container)
3131
- Access to an Embedding and Chat Model:
@@ -89,7 +89,7 @@ To run the application in a container; download the [source](https://github.com/
8989

9090
The **AI Optimizer** can be deployed in Oracle Cloud Infrastructure (OCI) using Infrastructure as Code (IaC).
9191

92-
Choose either a light-weight Virtual Machine or robust Oracle Kubernetes Engine deployment, both with an Oracle Autonomous Database 23ai:
92+
Choose either a light-weight Virtual Machine or robust Oracle Kubernetes Engine deployment, both with an Oracle Autonomous Database:
9393
[![Deploy to Oracle Cloud][magic_button]][magic_arch_stack]
9494

9595
For more information, please visit the [IaC Documentation](https://oracle.github.io/ai-optimizer/advanced/iac/index.html).

docs/content/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The {{< full_app_ref >}} provides a streamlined environment where developers and
1717

1818
- **GenAI**: Powers the generation of text, images, or other data based on prompts using pre-trained **LLM**s.
1919
- **RAG**: Enhances **LLM**s by retrieving relevant, real-time information allowing models to provide up-to-date and accurate responses.
20-
- **Vector Database**: A database, including Oracle Database 23ai, that can natively store and manage vector embeddings and handle the unstructured data they describe, such as documents, images, video, or audio.
20+
- **Vector Database**: A database, including Oracle AI Database, that can natively store and manage vector embeddings and handle the unstructured data they describe, such as documents, images, video, or audio.
2121

2222
## Features
2323

@@ -40,7 +40,7 @@ The [Walkthrough](walkthrough) is a great way to familiarize yourself with the *
4040

4141
## Prerequisites
4242

43-
- Oracle Database 23ai incl. Oracle Database 23ai Free
43+
- Oracle AI Database incl. Oracle AI Database Free
4444
- Python 3.11 (for running Bare-Metal)
4545
- Container Runtime e.g. docker/podman (for running in a Container)
4646
- Access to an Embedding and Chat Model:

docs/content/advanced/helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ A containerized Autonomous Oracle Database:
146146
type: "ADB-FREE"
147147
image:
148148
repository: container-registry.oracle.com/database/adb-free
149-
tag: latest-23ai
149+
tag: latest
150150
```
151151

152152
**ADB-S**

docs/content/client/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The {{< full_app_ref >}} consists of an API Server ([**ai-optimizer-server**](#a
1515
![Architecture Overview](images/arch_overview.png)
1616

1717
The following additional components, not delivered with the {{< short_app_ref >}}, are also required. These can be run On-Premises or in the Cloud:
18-
- [Oracle Database 23ai](#database), including [Oracle Database 23ai **Free**](https://www.oracle.com/uk/database/free/)
18+
- [Oracle AI Database](#database), including [Oracle AI Database **Free**](https://www.oracle.com/database/free)
1919
- Access to at least one [Large Language Model](#large-language-model)
2020
- Access to at least one [Embedding Model](#embedding-model) (for Retrieval Augmented Generation)
2121

@@ -45,7 +45,7 @@ You can develop and replace the provided client with any REST capable client.
4545

4646
## Database
4747

48-
[Oracle Database 23ai](https://www.oracle.com/uk/database/23ai/), including [Oracle Database 23ai **Free**](https://www.oracle.com/uk/database/free/) provides a persistent data store for the {{< short_app_ref >}}.
48+
[Oracle AI Database](https://www.oracle.com/database), including [Oracle AI Database **Free**](https://www.oracle.com/database/free) provides a persistent data store for the {{< short_app_ref >}}.
4949

5050
![Database](./images/vector_storage.png)
5151

@@ -54,7 +54,7 @@ You can develop and replace the provided client with any REST capable client.
5454
The **AI Optimizer** can be used to interact with language models without having the database configured, but additional functionality such as RAG, will not be available without the database.
5555
{{% /notice %}}
5656

57-
The 23ai database provides:
57+
Oracle AI Database provides:
5858

5959
- the Vector Store for split and embedded documents used for Retrieval Augmented Generation (RAG).
6060
- storage for the [Testbed](testbed) Q&A Test Sets and Evaluations

docs/content/client/configuration/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ For more information on the currently supported models and how to configure them
2525

2626
## 🗄️ Database Configuration
2727

28-
A 23ai Oracle Database is required to store the embedding vectors to enable Retrieval-Augmented Generation (RAG). The ChatBot can be used without a configured database, but you will be unable to split/embed or experiment with RAG in the ChatBot.
28+
Oracle AI Database is required to store the embedding vectors to enable Retrieval-Augmented Generation (RAG). The ChatBot can be used without a configured database, but you will be unable to split/embed or experiment with RAG in the ChatBot.
2929

3030
For more information on configuring the database, please read about [Database Configuration](db_config/).
3131

docs/content/client/configuration/db_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Licensed under the Universal Permissive License v1.0 as shown at http://oss.orac
1010
spell-checker: ignore tablespace mycomplexsecret mycomplexwalletsecret
1111
-->
1212

13-
To use the Retrieval-Augmented Generation (RAG) functionality of the {{< short_app_ref >}}, you will need to setup/enable an [embedding model](../model_config) and have access to an **Oracle Database 23ai**. Both the [Always Free Oracle Autonomous Database Serverless (ADB-S)](https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-always-free.html) and the [Oracle Database 23ai Free](https://www.oracle.com/uk/database/free/get-started/) are supported. They are a great, no-cost, way to get up and running quickly.
13+
To use the Retrieval-Augmented Generation (RAG) functionality of the {{< short_app_ref >}}, you will need to setup/enable an [embedding model](../model_config) and have access to an **Oracle AI Database**. Both the [Always Free Oracle Autonomous Database Serverless (ADB-S)](https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-always-free.html) and the [Oracle AI Database Free](https://www.oracle.com/database/free/get-started/) are supported. They are a great, no-cost, way to get up and running quickly.
1414

1515
## Configuration
1616

docs/content/walkthrough/_index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Licensed under the Universal Permissive License v1.0 as shown at http://oss.orac
1111
spell-checker: ignore mxbai, ollama, sqlplus, sysdba, spfile, freepdb, tablespace, firewalld, hnsw
1212
-->
1313

14-
This walkthrough will guide you through a basic installation of the {{< full_app_ref >}}. It will allow you to experiment with GenAI, using Retrieval-Augmented Generation (**RAG**) with Oracle Database 23ai at the core.
14+
This walkthrough will guide you through a basic installation of the {{< full_app_ref >}}. It will allow you to experiment with GenAI, using Retrieval-Augmented Generation (**RAG**) with the Oracle AI Database at the core.
1515

1616
By the end of the walkthrough you will be familiar with:
1717

@@ -50,7 +50,7 @@ You will run four container images to establish the "Infrastructure":
5050

5151
- On-Premises **LLM** - llama3.1
5252
- On-Premises Embedding Model - mxbai-embed-large
53-
- Vector Storage/SelectAI - Oracle Database 23ai Free
53+
- Vector Storage/SelectAI - Oracle AI Database Free
5454
- The {{< short_app_ref >}}
5555

5656
### LLM - llama3.1
@@ -158,11 +158,11 @@ The {{< short_app_ref >}} provides an easy to use front-end for experimenting wi
158158
podman run -d --name ai-optimizer-aio --network=host localhost/ai-optimizer-aio:latest
159159
```
160160

161-
### Vector Storage - Oracle Database 23ai Free
161+
### Vector Storage - Oracle AI Database Free
162162

163-
AI Vector Search in Oracle Database 23ai provides the ability to store and query private business data using a natural language interface. The {{< short_app_ref >}} uses these capabilities to provide more accurate and relevant **LLM** responses via Retrieval-Augmented Generation (**RAG**). [Oracle Database 23ai Free](https://www.oracle.com/uk/database/free/get-started/) provides an ideal, no-cost vector store for this walkthrough.
163+
AI Vector Search in Oracle AI Database provides the ability to store and query private business data using a natural language interface. The {{< short_app_ref >}} uses these capabilities to provide more accurate and relevant **LLM** responses via Retrieval-Augmented Generation (**RAG**). [Oracle AI Database Free](https://www.oracle.com/database/free/get-started/) provides an ideal, no-cost vector store for this walkthrough.
164164

165-
To start Oracle Database 23ai Free:
165+
To start the Oracle AI Database Free:
166166

167167
1. Start the container:
168168

@@ -259,7 +259,7 @@ To configure the On-Premises Embedding Model, navigate back to the _Configuratio
259259

260260
### Configure the Database
261261

262-
To configure Oracle Database 23ai Free, navigate to the _Configuration_ screen and _Databases_ tab:
262+
To configure Oracle AI Database Free, navigate to the _Configuration_ screen and _Databases_ tab:
263263

264264
1. Enter the Database Username: `WALKTHROUGH`
265265
1. Enter the Database Password for the database user: `OrA_41_OpTIMIZER`
@@ -304,7 +304,7 @@ After the splitting and embedding process completes, you can query the Vector St
304304

305305
From the command line:
306306

307-
1. Connect to the Oracle Database 23ai Database:
307+
1. Connect to the Oracle AI Database:
308308

309309
```bash
310310
podman exec -it ai-optimizer-db sqlplus 'WALKTHROUGH/OrA_41_OpTIMIZER@FREEPDB1'
@@ -326,12 +326,12 @@ For this guided experiment, perform the following:
326326

327327
1. Ask the _ChatBot_:
328328
```text
329-
In Oracle Database 23ai, how do I use AHF?
329+
In Oracle AI Database, how do I use AHF?
330330
```
331331

332332
Responses may vary, but generally the _ChatBot_'s response will be inaccurate, including:
333333

334-
- Not understanding that 23ai is an Oracle Database release. This is known as knowledge-cutoff.
334+
- Not understanding that there is a Oracle AI Database release. This is known as knowledge-cutoff.
335335
- Suggestions that AFH has to do with a non-existant Hybrid Feature and running `emcli` commands. These are hallucinations.
336336

337337
Now select "Vector Search" in the Toolkit options and simply ask: `Are you sure?`

helm/examples/values-kind-adb-free.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ server:
1212
type: "ADB-FREE"
1313
image:
1414
repository: container-registry.oracle.com/database/adb-free
15-
tag: latest-23ai
15+
tag: latest
1616
# oci_config:
1717
# fileSecretName: "oci-config-file"
1818
client:

opentofu/variables.tf

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,10 @@ variable "infrastructure" {
8484
variable "adb_version" {
8585
description = "Autonomous Database Version"
8686
type = string
87-
default = "23ai"
87+
default = "26ai"
8888
validation {
89-
condition = contains(["23ai"], var.adb_version)
90-
error_message = "Must be 23ai."
89+
condition = contains(["26ai"], var.adb_version)
90+
error_message = "Must be 26ai."
9191
}
9292
}
9393

src/server/wip/createRDFGraph.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ def create_semantic_relationships():
307307
(r"overview of oracle ai vector search", r"get started"),
308308
(r"why use oracle ai vector search", r"get started"),
309309
(r"get started", r"generate vector embeddings"),
310-
(r"oracle database 23ai release updates", r"get started"),
310+
(r"oracle ai database release updates", r"get started"),
311311
(r"conventions", r"overview of oracle ai vector search"),
312312
(r"preface", r"overview"),
313313
(r"introduction", r"get started"),

0 commit comments

Comments
 (0)