Mxbai Rerank Base V1

🚀 mxbai-rerank-base-v1

mxbai-rerank-base-v1 是強大的重排模型系列中的基礎模型。它能有效提升搜索效果，與關鍵詞搜索結合使用時表現出色，在許多情況下甚至能超越語義搜索系統。

🚀 快速開始

目前，使用我們模型的最佳方式是搭配最新版本的 sentence-transformers。

pip install -U sentence-transformers

假設你有一個查詢語句，並且想要對一組文檔進行重排。你只需一行代碼即可實現：

💻 使用示例

基礎用法

from sentence_transformers import CrossEncoder

# 加載模型，這裡我們使用基礎大小的模型
model = CrossEncoder("mixedbread-ai/mxbai-rerank-base-v1")

# 示例查詢和文檔
query = "Who wrote 'To Kill a Mockingbird'?"
documents = [
    "'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.",
    "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.",
    "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.",
    "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.",
    "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.",
    "'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."
]

# 獲取得分
results = model.rank(query, documents, return_documents=True, top_k=3)

npm i @xenova/transformers

import { AutoTokenizer, AutoModelForSequenceClassification } from '@xenova/transformers';

const model_id = 'mixedbread-ai/mxbai-rerank-base-v1';
const model = await AutoModelForSequenceClassification.from_pretrained(model_id);
const tokenizer = await AutoTokenizer.from_pretrained(model_id);

/**
 * 使用 CrossEncoder 對給定的查詢和文檔進行排名。返回一個排序後的列表，包含文檔索引和得分。
 * @param {string} query 單個查詢
 * @param {string[]} documents 文檔列表
 * @param {Object} options 排名選項
 * @param {number} [options.top_k=undefined] 返回前 k 個文檔。如果未定義，則返回所有文檔。
 * @param {boolean} [options.return_documents=false] 如果為 true，還返回文檔。如果為 false，則僅返回索引和得分。
 */
async function rank(query, documents, {
    top_k = undefined,
    return_documents = false,
} = {}) {
    const inputs = tokenizer(
        new Array(documents.length).fill(query),
        {
            text_pair: documents,
            padding: true,
            truncation: true,
        }
    )
    const { logits } = await model(inputs);
    return logits
        .sigmoid()
        .tolist()
        .map(([score], i) => ({
            corpus_id: i,
            score,
            ...(return_documents ? { text: documents[i] } : {})
        }))
        .sort((a, b) => b.score - a.score)
        .slice(0, top_k);
}

// 示例用法：
const query = "Who wrote 'To Kill a Mockingbird'?"
const documents = [
    "'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.",
    "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.",
    "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.",
    "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.",
    "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.",
    "'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."
]

const results = await rank(query, documents, { return_documents: true, top_k: 3 });
console.log(results);

📦 使用 API

你可以通過我們的 API 使用大型模型，如下所示：

from mixedbread_ai.client import MixedbreadAI

mxbai = MixedbreadAI(api_key="{MIXEDBREAD_API_KEY}")

res = mxbai.reranking(
  model="mixedbread-ai/mxbai-rerank-large-v1",
  query="Who is the author of To Kill a Mockingbird?",
  input=[
    "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.",
    "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.",
    "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.",
    "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.",
    "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.",
    "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."
  ],
  top_k=3,
  return_input=false
)

print(res.data)

該 API 還具備其他功能，例如持續訓練的重排器！更多信息請查看 文檔。

🔧 評估

我們的重排模型旨在提升你的搜索體驗。它們與關鍵詞搜索結合使用時效果極佳，在許多情況下甚至能超越語義搜索系統。

報告的結果是從 BEIR 的 11 個數據集中彙總得出的。我們使用 Pyserini 對模型進行評估。更多信息請查看我們的 博客文章 和 電子表格。

👥 社區

請加入我們的 Discord 社區，分享你的反饋和想法！我們隨時準備提供幫助，也樂於與你交流。

📄 許可證

本項目採用 Apache 2.0 許可證。