Weaviate Hybrid Search

Code

1import typer
2from kern.agent import Agent
3from kern.knowledge.knowledge import Knowledge
4from kern.vectordb.search import SearchType
5from kern.vectordb.weaviate import Distance, VectorIndex, Weaviate
6from rich.prompt import Prompt
7
8vector_db = Weaviate(
9    collection="recipes",
10    search_type=SearchType.hybrid,
11    vector_index=VectorIndex.HNSW,
12    distance=Distance.COSINE,
13    local=False,  # Set to True if using Weaviate Cloud and False if using local instance
14    # Adjust alpha for hybrid search (0.0-1.0, default is 0.5), where 0 is pure keyword search, 1 is pure vector search
15    hybrid_search_alpha=0.6,
16)
17
18knowledge_base = Knowledge(
19    name="Weaviate Hybrid Search",
20    description="A knowledge base for Weaviate hybrid search",
21    vector_db=vector_db,
22)
23
24knowledge_base.insert(
25    url="https://kern-public.s3.amazonaws.com/recipes/ThaiRecipes.pdf",
26)
27
28def weaviate_agent(user: str = "user"):
29    agent = Agent(
30        user_id=user,
31        knowledge=knowledge_base,
32        search_knowledge=True,
33    )
34
35    while True:
36        message = Prompt.ask(f"[bold] :sunglasses: {user} [/bold]")
37        if message in ("exit", "bye"):
38            break
39        agent.print_response(message)
40
41if __name__ == "__main__":
42    typer.run(weaviate_agent)

Usage

Set up your virtual environment

1uv venv --python 3.12
2source .venv/bin/activate

1uv venv --python 3.12
2.venv\Scripts\activate

Install dependencies

1uv pip install -U weaviate-client typer rich pypdf openai kern-ai

Setup Weaviate

1# 1. Create account at https://console.weaviate.cloud/
2# 2. Create a cluster and copy the "REST endpoint" and "Admin" API Key
3# 3. Set environment variables:
4export WCD_URL="your-cluster-url"
5export WCD_API_KEY="your-api-key"
6# 4. Set local=False in the code

1# 1. Install Docker from https://docs.docker.com/get-docker/
2# 2. Run Weaviate locally:
3docker run -d \
4    -p 8080:8080 \
5    -p 50051:50051 \
6    --name weaviate \
7    cr.weaviate.io/semitechnologies/weaviate:1.28.4
8# 3. Set local=True in the code

Set environment variables

1export OPENAI_API_KEY=xxx

Run Agent

1python cookbook/08_knowledge/vector_db/weaviate_db/weaviate_db_hybrid_search.py