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 许可证。