Skip to content

Update VecDB quickstart setup guidance #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jasperan merged 1 commit into from
Oct 12, 2026
Merged

Update VecDB quickstart setup guidance #376

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions notebooks/vecdb/start_here/quickstart.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,15 @@
"\n",
"## Before you begin\n",
"\n",
"1. [Choose a database deployment](https://docs.oracle.com/en/cloud/paas/autonomous-database/vcapi/use-adb-s.html) and complete its setup.\n",
"2. If required [create a new vector user name and password](https://docs.oracle.com/en/cloud/paas/autonomous-database/vcapi/manage-users.html), and copy the **SDK REST endpoint**.\n",
"3. Load the `all_MiniLM_L12_v2` embedding model [using the Vector Database Console](https://docs.oracle.com/en/database/oracle/sql-developer-web/sdwad/vdb-load-model-using-vector-database-console.html). The model name in Section 3 must match the loaded model exactly.\n",
"Set up your Oracle AI Database environment before you install the SDK:\n",
"\n",
"This notebook uses the SDK REST endpoint, not the Console URL."
"1. [Choose a database deployment](https://docs.oracle.com/en/cloud/paas/autonomous-database/vcapi/setup/choose-database-deployment.html), then complete the setup page for your deployment.\n",
"2. Save the vector-user name and password, and copy the SDK REST endpoint. You do not use the Console URL in the Python configuration.\n",
"3. This quickstart uses integrated embeddings. Load the `all_MiniLM_L12_v2` embedding model before running it. You can use another integrated embedding model; if you do, replace the `model` value in the table creation step with the exact name of the model you loaded. \n",
"See [Load a Model Using the Vector Database Console](https://docs.oracle.com/en/database/oracle/sql-developer-web/sdwad/vdb-load-model-using-vector-database-console.html).\n",
"\n",
"The quickstart uses the SDK REST endpoint, not the Console URL, and uses username and password authentication by default. For bearer-token configuration, see [Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/vcapi/configuration.html).\n",
"\n"
]
},
{
Expand Down
Loading