Views
No views yet
pip install -U sentence-transformers1from sentence_transformers import CrossEncoder
2
3# Load the model, here we use our base sized model
4model = CrossEncoder("mixedbread-ai/mxbai-rerank-xsmall-v1")
5
6
7# Example query and documents
8query = "Who wrote 'To Kill a Mockingbird'?"
9documents = [
10 "'To Kill a Mockingbird' is a novel by Harper Lee published in 1960. It was immediately successful, winning the Pulitzer Prize, and has become a classic of modern American literature.",
11 "The novel 'Moby-Dick' was written by Herman Melville and first published in 1851. It is considered a masterpiece of American literature and deals with complex themes of obsession, revenge, and the conflict between good and evil.",
12 "Harper Lee, an American novelist widely known for her novel 'To Kill a Mockingbird', was born in 1926 in Monroeville, Alabama. She received the Pulitzer Prize for Fiction in 1961.",
13 "Jane Austen was an English novelist known primarily for her six major novels, which interpret, critique and comment upon the British landed gentry at the end of the 18th century.",
14 "The 'Harry Potter' series, which consists of seven fantasy novels written by British author J.K. Rowling, is among the most popular and critically acclaimed books of the modern era.",
15 "'The Great Gatsby', a novel written by American author F. Scott Fitzgerald, was published in 1925. The story is set in the Jazz Age and follows the life of millionaire Jay Gatsby and his pursuit of Daisy Buchanan."
16]
17
18# Lets get the scores
19results = model.rank(query, documents, return_documents=True, top_k=3)npm i @xenova/transformers1import { AutoTokenizer, AutoModelForSequenceClassification } from '@xenova/transformers';
2
3const model_id = 'mixedbread-ai/mxbai-rerank-xsmall-v1';
4const model = await AutoModelForSequenceClassification.from_pretrained(model_id);
5const tokenizer = await AutoTokenizer.from_pretrained(model_id);
6
7/**
8 * Performs ranking with the CrossEncoder on the given query and documents. Returns a sorted list with the document indices and scores.
9 * @param {string} query A single query
10 * @param {string[]} documents A list of documents
11 * @param {Object} options Options for ranking
12 * @param {number} [options.top_k=undefined] Return the top-k documents. If undefined, all documents are returned.
13 * @param {number} [options.return_documents=false] If true, also returns the documents. If false, only returns the indices and scores.
14 */
15async function rank(query, documents, {
16 top_k = undefined,
17 return_documents = false,
18} = {}) {
19 const inputs = tokenizer(
20 new Array(documents.length).fill(query),
21 {
22 text_pair: documents,
23 padding: true,
24 truncation: true,
25 }
26 )
27 const { logits } = await model(inputs);
28 return logits
29 .sigmoid()
30 .tolist()
31 .map(([score], i) => ({
32 corpus_id: i,
33 score,
34 ...(return_documents ? { text: documents[i] } : {})
35 }))
36 .sort((a, b) => b.score - a.score)
37 .slice(0, top_k);
38}
39
40// Example usage:
41const query = "Who wrote 'To Kill a Mockingbird'?"
42const documents = [
43 "'To Kill a Mockingbird' is a novel by Harper Lee published in 1960. It was immediately successful, winning the Pulitzer Prize, and has become a classic of modern American literature.",
44 "The novel 'Moby-Dick' was written by Herman Melville and first published in 1851. It is considered a masterpiece of American literature and deals with complex themes of obsession, revenge, and the conflict between good and evil.",
45 "Harper Lee, an American novelist widely known for her novel 'To Kill a Mockingbird', was born in 1926 in Monroeville, Alabama. She received the Pulitzer Prize for Fiction in 1961.",
46 "Jane Austen was an English novelist known primarily for her six major novels, which interpret, critique and comment upon the British landed gentry at the end of the 18th century.",
47 "The 'Harry Potter' series, which consists of seven fantasy novels written by British author J.K. Rowling, is among the most popular and critically acclaimed books of the modern era.",
48 "'The Great Gatsby', a novel written by American author F. Scott Fitzgerald, was published in 1925. The story is set in the Jazz Age and follows the life of millionaire Jay Gatsby and his pursuit of Daisy Buchanan."
49]
50
51const results = await rank(query, documents, { return_documents: true, top_k: 3 });
52console.log(results);1from mixedbread_ai.client import MixedbreadAI
2
3mxbai = MixedbreadAI(api_key="{MIXEDBREAD_API_KEY}")
4
5res = mxbai.reranking(
6 model="mixedbread-ai/mxbai-rerank-large-v1",
7 query="Who is the author of To Kill a Mockingbird?",
8 input=[
9 "To Kill a Mockingbird is a novel by Harper Lee published in 1960. It was immediately successful, winning the Pulitzer Prize, and has become a classic of modern American literature.",
10 "The novel Moby-Dick was written by Herman Melville and first published in 1851. It is considered a masterpiece of American literature and deals with complex themes of obsession, revenge, and the conflict between good and evil.",
11 "Harper Lee, an American novelist widely known for her novel To Kill a Mockingbird, was born in 1926 in Monroeville, Alabama. She received the Pulitzer Prize for Fiction in 1961.",
12 "Jane Austen was an English novelist known primarily for her six major novels, which interpret, critique and comment upon the British landed gentry at the end of the 18th century.",
13 "The Harry Potter series, which consists of seven fantasy novels written by British author J.K. Rowling, is among the most popular and critically acclaimed books of the modern era.",
14 "The Great Gatsby, a novel written by American author F. Scott Fitzgerald, was published in 1925. The story is set in the Jazz Age and follows the life of millionaire Jay Gatsby and his pursuit of Daisy Buchanan."
15 ],
16 top_k=3,
17 return_input=false
18)
19
20print(res.data)| Model | NDCG@10 | Accuracy@3 |
|---|---|---|
| Lexical Search (Lucene) | 38.0 | 66.4 |
| BAAI/bge-reranker-base | 41.6 | 66.9 |
| BAAI/bge-reranker-large | 45.2 | 70.6 |
| cohere-embed-v3 (semantic search) | 47.5 | 70.9 |
| mxbai-rerank-xsmall-v1 | 43.9 | 70.0 |
| mxbai-rerank-base-v1 | 46.9 | 72.3 |
| mxbai-rerank-large-v1 | 48.8 | 74.9 |
1@online{rerank2024mxbai,
2 title={Boost Your Search With The Crispy Mixedbread Rerank Models},
3 author={Aamir Shakir and Darius Koenig and Julius Lipp and Sean Lee},
4 year={2024},
5 url={https://www.mixedbread.ai/blog/mxbai-rerank-v1},
6}