Keyword search (BM25)

from topk_sdk.schema import text, keyword_index

client.collections().create(
    "books",
    schema={
        "title": text().index(keyword_index()),
        "description": text().index(keyword_index()),
    },
)

import { text, keywordIndex } from "topk-js/schema";

await client.collections().create("books", {
  title: text().index(keywordIndex()),
  description: text().index(keywordIndex()),
});

CREATE TABLE books (
  title       TEXT INDEX keyword_index(),
  description TEXT INDEX keyword_index()
);

from topk_sdk.query import select, fn, match, field

docs = client.collection("books").query(
    select(
        "title",
        "description",
        # Score documents using BM25 algorithm
        text_score=fn.bm25_score(),
    )
    # Filter documents that have the `great` keyword in the `title` field
    # or the `novel` in any of the text-indexed fields.
    .filter(
        match("great", field="title") | match("novel")
    )
    # Return top 10 documents with the highest text score
    .sort(field("text_score"), asc=False).limit(10)
)

# Example result:

[
  {
    _id: '1',
    title: 'The Great Gatsby',
    description: 'A novel about a great man who wants to be rich and famous',
    text_score: 0.864456057548523
  },
  {
    _id: '2',
    title: 'The Catcher in the Rye',
    description: 'A novel about a boy who wants to be a writer',
    text_score: 0.1948474943637848,
  }
]

import { select, field, fn, match } from "topk-js/query";

const docs = await client.collection("books").query(
  select({
    title: field("title"),
    description: field("description"),
    // Score documents using BM25 algorithm
    text_score: fn.bm25Score(),
  })
  // Filter documents that have the `great` keyword in the `title` field
  // or the `novel` in any of the text-indexed fields.
  .filter(match("great", { field: "title" }).or(match("novel")))
  // Return top 10 documents with the highest text score
  .sort(field("text_score"), false).limit(10)
);

// Example result:

[
  {
    _id: '1',
    title: 'The Great Gatsby',
    description: 'A novel about a great man who wants to be rich and famous',
    text_score: 0.864456057548523
  },
  {
    _id: '2',
    title: 'The Catcher in the Rye',
    description: 'A novel about a boy who wants to be a writer',
    text_score: 0.1948474943637848,
  }
]

SELECT
  title,
  description,
  bm25_score() AS text_score
FROM books
WHERE match('great') OR match('novel')
ORDER BY text_score DESC
LIMIT 10;