From 199ccb1d70851715c0625fc0b63356c4b668097a Mon Sep 17 00:00:00 2001 From: anumathad-o Date: Thu, 10 Sep 2026 11:41:02 +0200 Subject: [PATCH] Update Readme for merge conflict --- README.md | 167 ------------------------------------------------------ 1 file changed, 167 deletions(-) diff --git a/README.md b/README.md index 8d63c77..b4e2512 100644 --- a/README.md +++ b/README.md @@ -33,25 +33,6 @@ pip install oracle-vecdb uv add oracle-vecdb ``` -### Connect -### Requirements - -- **Python:** 3.10+ -- **Oracle AI Database:** 23.26.3+ -- **ORDS:** 26.2.2+ - -### Installation - -Install with `pip` or `uv`: - -```bash -# pip -pip install oracle-vecdb - -# uv -uv add oracle-vecdb -``` - ### Connect ```python @@ -60,7 +41,6 @@ from oracle_vecdb import OracleVecDB, Configuration config = Configuration( rest_url="https://:/ords//_/db-api/stable/vecdb/", access_token="", - access_token="", ) vecdb = OracleVecDB(config) @@ -68,19 +48,14 @@ vecdb = OracleVecDB(config) ### Run a semantic search with metadata filtering -> This example assumes a vector table named demo already exists and contains data. See the [full quickstart](https://docs.oracle.com/en/cloud/paas/autonomous-vector-database/vcapi/quickstart.html) for create_vector_table() and upsert(). -### Run a semantic search with metadata filtering - > This example assumes a vector table named demo already exists and contains data. See the [full quickstart](https://docs.oracle.com/en/cloud/paas/autonomous-vector-database/vcapi/quickstart.html) for create_vector_table() and upsert(). ```python results = vecdb.query( table_name="demo", query_by={"text": "family film"}, # uses integrated embeddings for the query text - query_by={"text": "family film"}, # uses integrated embeddings for the query text filters={"genre": {"$eq": "drama"}}, top_k=3, - top_k=3, ) for index in range(len(results)): @@ -202,120 +177,6 @@ Learn Oracle VecDB hands-on. The Oracle AI Developer Hub includes runnable noteb [Browse all VecDB notebooks โ†’](https://github.com/oracle-devrel/oracle-ai-developer-hub/tree/main/notebooks/vecdb) ---- -### โšก **Integrated embeddings. Automatic vector indexing. Semantic search + structured filtering. One Python SDK.** - -[Read the full quickstart โ†’](https://docs.oracle.com/en/cloud/paas/autonomous-vector-database/vcapi/quickstart.html) - ---- - -# ๐Ÿงช See what you can build - -Complete applications built with `oracle-vecdb` are available in the [Oracle AI Developer Hub](https://github.com/oracle-devrel/oracle-ai-developer-hub/tree/main/apps/vecdb). - -## ๐ŸŒฒ Semantic + Geospatial Search - -**Combine vector similarity with spatial filtering in one application.** - -Semantic search plus geographic and structured constraints, powered by Oracle AI Database. - -![Ask the Parks โ€” semantic, metadata, and spatial search with Oracle VecDB](https://raw.githubusercontent.com/oracle-devrel/oracle-ai-developer-hub/main/apps/vecdb/vecdb_ask_parks/static/assets/ask_the_parks_demo.gif) - -**Oracle Spatial ยท Vector Search ยท Oracle VecDB** - -[View the sample app โ†’](https://github.com/oracle-devrel/oracle-ai-developer-hub/tree/main/apps/vecdb/vecdb_ask_parks) - ---- - -## ๐Ÿ’ป Semantic Code Search - -**Search source code by meaning, not just keywords.** - -Use natural-language queries to find relevant functions, files, and surrounding code. - -![Semantic Code Search - natural-language query, ranked code results, repository navigation, and highlighted source code](https://raw.githubusercontent.com/oracle-devrel/oracle-ai-developer-hub/main/apps/vecdb/semantic_code_search/images/semantic_code_search.gif) - -**FastAPI ยท React ยท Jina Embeddings ยท Oracle VecDB** - -[View the sample app โ†’](https://github.com/oracle-devrel/oracle-ai-developer-hub/tree/main/apps/vecdb/semantic_code_search) - ---- - -## ๐Ÿค– RAG Document Chatbot - -**Upload documents and ask grounded questions over their content.** - -Chunk documents, generate embeddings, retrieve relevant context, and pass it to an LLM for grounded answers. - -![Document Chatbot UI showing uploaded documents, a user question, retrieved context, and a grounded answer](https://raw.githubusercontent.com/oracle-devrel/oracle-ai-developer-hub/main/apps/vecdb/doc_chatbot/images/doc_chat_bot.gif) - -**Streamlit ยท OpenAI / Ollama ยท Oracle VecDB** - -[View the sample app โ†’](https://github.com/oracle-devrel/oracle-ai-developer-hub/tree/main/apps/vecdb/doc_chatbot) - ---- - -**More examples:** Multi-Modal Product Search, Product Recommendations ยท hands-on notebooks - -[Explore all sample applications โ†’](https://github.com/oracle-devrel/oracle-ai-developer-hub/tree/main/apps/vecdb) - ---- - -# ๐Ÿ’ก Why Oracle VecDB? - -Modern AI applications often need vector search plus the structured data around each result. - -Oracle VecDB lets Python applications use vector search alongside relational, spatial, and all other capabilities of the Oracle AI Database. - -Use Oracle VecDB to: - -- ๐Ÿ”Ž Run semantic and similarity search -- ๐ŸŒ Combine vector search with spatial and structured queries -- ๐Ÿค– Build RAG applications and AI agents -- ๐Ÿง  Use integrated embeddings or bring your own vectors -- โšก Create vector indexes automatically by default -- ๐ŸŽ›๏ธ Tune HNSW and embedding settings when needed - -If you're building enterprise AI apps, the data you need is probably already in an Oracle AI Database, VecDB can reduce the need to move or synchronize that data into a separate vector database. - ---- - -# ๐Ÿ““ Hands-on notebooks - -Learn Oracle VecDB hands-on. The Oracle AI Developer Hub includes runnable notebooks that take you from first query to production-oriented tuning. - -## ๐Ÿง  Embeddings & RAG - -- **Integrated embeddings** โ€” generate embeddings as part of the VecDB workflow -- **Bring Your Own Vectors** โ€” use embeddings from your preferred model or provider -- **Gemini RAG** โ€” build retrieval-augmented generation with Gemini -- **OCI Generative AI embeddings** โ€” use OCI-hosted embedding models with VecDB -- **Oracle Private AI Services Container** - use in an air-gapped environment with OpenAI-style inference layer - -[Explore embeddings & RAG notebooks โ†’](https://github.com/oracle-devrel/oracle-ai-developer-hub/tree/main/notebooks/vecdb) - -## ๐Ÿ”Ž Search & filtering - -- **Semantic search** โ€” retrieve results by meaning rather than keywords -- **Metadata filtering** โ€” combine vector similarity with structured constraints -- **Search diagnostics** โ€” inspect and understand vector-search behavior -- **Financial-data search** โ€” apply vector retrieval to structured financial datasets - -[Explore search notebooks โ†’](https://github.com/oracle-devrel/oracle-ai-developer-hub/tree/main/notebooks/vecdb) - -## โšก Performance & scale - -- **HNSW tuning** โ€” understand and tune vector-index search parameters -- **Bulk vector loading** โ€” compare approaches for loading larger datasets -- **Index management** โ€” create, inspect, and manage vector indexes -- **Maintenance workflows** โ€” operate vector tables and indexes over time - -[Explore performance notebooks โ†’](https://github.com/oracle-devrel/oracle-ai-developer-hub/tree/main/notebooks/vecdb) - -> **New to Oracle VecDB?** Start with integrated embeddings and semantic search, then move on to filtering and HNSW tuning. - -[Browse all VecDB notebooks โ†’](https://github.com/oracle-devrel/oracle-ai-developer-hub/tree/main/notebooks/vecdb) - --- ## Examples @@ -335,18 +196,6 @@ Learn Oracle VecDB hands-on. The Oracle AI Developer Hub includes runnable noteb - **[GitHub Releases](https://github.com/oracle/vecdb-python-sdk/releases)** - **[Locally-managed REST](https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/26.2/)** ---- ---- - -# ๐Ÿ“š Documentation - -- **[Getting Started](https://docs.oracle.com/en/cloud/paas/autonomous-vector-database/vcapi/quickstart.html)** -- **[Python API Reference](https://docs.oracle.com/en/cloud/paas/autonomous-vector-database/vcapi/python-api-reference.html)** -- **[Sample Applications](https://github.com/oracle-devrel/oracle-ai-developer-hub/tree/main/apps/vecdb)** -- **[Hands-on Notebooks](https://github.com/oracle-devrel/oracle-ai-developer-hub/tree/main/notebooks/vecdb)** -- **[GitHub Releases](https://github.com/oracle/vecdb-python-sdk/releases)** -- **[Locally-managed REST](https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/26.2/)** - --- ## Help @@ -357,8 +206,6 @@ Problem reports can be raised in [GitHub Issues](https://github.com/oracle/vecdb --- ---- - ## ๐Ÿค Contributing This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md) @@ -367,18 +214,12 @@ This project welcomes contributions from the community. Before submitting a pull --- -[Open an issue โ†’](https://github.com/oracle/vecdb-python-sdk/issues) - ---- - ## ๐Ÿ” Security Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process --- ---- - ## ๐Ÿ“„ License See [LICENSE.txt](./LICENSE.txt), [THIRD_PARTY_LICENSE.txt](./THIRD_PARTY_LICENSE.txt), and [NOTICE.txt](./NOTICE.txt). @@ -390,11 +231,3 @@ See [LICENSE.txt](./LICENSE.txt), [THIRD_PARTY_LICENSE.txt](./THIRD_PARTY_LICENS **[Star `oracle/vecdb-python-sdk` โ†’](https://github.com/oracle/vecdb-python-sdk)** It helps you follow the project and helps other Python and AI developers discover it. - ---- - -## โญ Like Oracle VecDB? - -**[Star `oracle/vecdb-python-sdk` โ†’](https://github.com/oracle/vecdb-python-sdk)** - -It helps you follow the project and helps other Python and AI developers discover it.