Skip to content

Latest commit

 

History

History
138 lines (94 loc) · 5.87 KB

README.md

File metadata and controls

138 lines (94 loc) · 5.87 KB
Raw

InterSystems IRIS Vector Search

This year, we're adding a powerful Vector Search capability to the InterSystems IRIS Data Platform, to help you innovate faster and build intelligent applications powered by Generative AI. At the center of the new capability is a new VECTOR native datatype for IRIS SQL, along with similarity functions that leverage optimized chipset instructions (SIMD). Basically, IRIS is a SQL database that's really fast, and now has vector search built in!

Quickstart

  1. Clone the repo

    git clone https://github.com/intersystems-community/hackathon-2024.git

  2. Install IRIS Community Edtion in a container. This will be your SQL database server.

    docker run -d --name iris-comm -p 1972:1972 -p 52773:52773 -e IRIS_PASSWORD=demo -e IRIS_USERNAME=demo intersystemsdc/iris-community:latest

    After running the above command, you can access the System Management Portal via http://localhost:52773/csp/sys/UtilHome.csp.

  3. Create a Python environment and activate it (conda, venv or however you wish) For example:

    conda:

    conda create --name iris-env python=3.10
conda activate

    venv(Mac):

    python3 -m venv iris-env
source iris-env/bin/activate

    or

    venv (Windows):

    .\iris-env\Scripts\Activate

    or

    venv (Unix):

    python -m venv iris-env
source ./iris-env/bin/activate

  4. Install packages for all demos:

    pip install -r requirements.txt

  5. Install Intersystem's DB API driver . Choose one option, based on your Operating System. Usage of the driver is subject to Terms and Conditions

    Mac OS:

    pip install ./install/intersystems_irispython-5.0.1-8026-cp38.cp39.cp310.cp311.cp312-cp38.cp39.cp310.cp311.cp312-macosx_10_9_universal2.whl

    Windows AMD64:

    pip install ./install/intersystems_irispython-5.0.1-8026-cp38.cp39.cp310.cp311.cp312-cp38.cp39.cp310.cp311.cp312-win_amd64.whl

    Windows 32:

    pip install ./install/intersystems_irispython-5.0.1-8026-cp38.cp39.cp310.cp311.cp312-cp38.cp39.cp310.cp311.cp312-win32.whl

    Linux aarch64:

    pip install ./install/intersystems_irispython-5.0.1-8026-cp38.cp39.cp310.cp311.cp312-cp38.cp39.cp310.cp311.cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

    Linux x86_64:

    pip install ./install/intersystems_irispython-5.0.1-8026-cp38.cp39.cp310.cp311.cp312-cp38.cp39.cp310.cp311.cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

  6. For langchain_demo.ipynb and llama_demo.ipynb, you need an OpenAI API Key. Create a .env file in this repo to store the key:

    OPENAI_API_KEY=xxxxxxxxx

Using the Management Portal

  1. Navigate to http://localhost:52773/csp/sys/UtilHome.csp, login with username: demo, password: demo (or whatever you configured)
  2. Change the namespace (on the top left) from %SYS to USER
  3. On the left navigation pane, click 'System Explorer'
  4. Click 'SQL' -> 'Go'
  5. Here, you can execute SQL queries. You can also view the tables by clicking the relevant table on the left, under 'Tables', and then clicking 'Open Table' (above the SQL query box)

Basic Demos

IRISDatabaseOperationsUsingSQL.ipynb - Recommended!

This demo uses our latest db api driver, which is more efficient.

Here, we first demonstrate how to connect to an IRIS db and carry out basic CRUD operations.

We then use IRIS Vector seach in a whishkey dataset to find whiskeys that are priced < $100 and have a taste description similar to "earthy and creamy taste". This demo uses SQL for vector search.

langchain_demo.ipynb

IRIS now has a langchain integration as a VectorDB! In this demo, we use the langchain framework with IRIS to ingest and search through a document.

llama_demo.ipynb

IRIS now has a llama_index integration as a VectorDB! In this demo, we use the llama_index framework with IRIS to ingest and search through a document.

SQL Vector SearchSyntax

Here's some documentation on of our vector search syntax. Let us know if you need any assistance with setting up SQL queries.

Which to use?

If you need to use search with filters, use IRIS SQL. This is the most flexible way to build RAG.

If you're building a genAI app that uses a variety of langchain tools (agents, chained reasoning, api calls), go for langchain.

If you're building a simple RAG app, go for llama_index.

The fastest and easiest way to contact any InterSystems Mentor is via Slack or Discord - feel free to ask any questions about our technology, or about your project in general!

More Demos / References:

NLP Queries on Youtube Audio Transcription

Uses langchain-iris to search Youtube Audio transcriptions

langchain-iris demo

Original IRIS langhain demo, that runs the containerized IRIS in the notebook

llama-iris demo

Original IRIS llama_index demo, that runs the containerized IRIS in the notebook

InterSystems Documentation

Official page for InterSystems Documentation