HomepageAdmin PortalSign up
Changelog
Back to All
added

Metadata filter on Knowlegde Base Chunks

4 days ago

Knowledge Base chunks can now be enriched with metadata at creation through the Chunks API.
When searching your Knowledge Base, you can now filter results by metadata to limit results to specific chunk attributes.

Highlights:
• Add custom metadata to each Knowledge Base chunk at creation.
• Search using metadata filters to refine results.

📘

To learn more about search, see Searching a knowledge base and the related API.

Example: Search with metadata filter

curl --location 'http://my.orq.ai/v2/knowledge/{knowledge_id}/search' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer $ORQ_API_KEY' \
--data '{
    "query": "What we the top editions of science fiction books",
    "filter": {
        "edition": {
            "gte": 2020
        }
    },
    "search_options":{
        "include_metadata": true,
        "include_vectors": true,
        "include_scores": true
    }
}'

from orq_ai_sdk import Orq
import os

client = Orq(api_key=os.getenv("ORQ_API_KEY"))

client.knowledge.search(
    knowledge_id="unique_knowledge_id",
    query={"edition": {"$gte": 2020}},
    search_options={
        "include_metadata": True,
        "include_vectors": True,
        "include_scores": True,
    },
)

import { Orq } from '@orq-ai/node';

const orq = new Orq({
  apiKey: 'ORQ_API_KEY',
});

orq.knowledge.search({
  knowledgeId: 'unique_knowledge_id',
  query: { edition: { $gte: 2020 } },
  searchOptions: {
    includeMetadata: true,
    includeVectors: true,
    includeScores: true,
  },
});