milvus-logo
LFAI
< Docs
  • Python
    • Rerankers

__call__()

This operation in CrossEncoderRerankFunction takes in a query and document strings and returns a list of RerankResult objects with the top k documents ranked by score.

Request syntax

# Instance created
ce_rf = CrossEncoderRerankFunction()

# __call__ method will be called
ce_rf(
    query: str,
    documents: List[str],
    top_k: int = 5
) -> List[RerankResult]

PARAMETERS:

  • query (string)

    The query string to use for ranking.

  • documents (List[str])

    A list of document strings that will be ranked for the given query.

  • top_k (int)

    The maximum number of top ranked documents to return. Defaults to 5.

RETURN TYPE:

List[RerankResult]

RETURNS:

A list of RerankResult objects.

├── RerankResult
|    └── text
|    └── score
|    └── index

Each RerankResult object contains:

  • text: The matched document text.

  • score: The score assigned to that document by the reranking model.

  • index: The index of the document in the original documents list.

EXCEPTIONS:

  • ImportError

    This exception will be raised when the Sentence Transformer module is not installed.

Examples

from pymilvus.model.reranker import CrossEncoderRerankFunction

# Define the rerank function
ce_rf = CrossEncoderRerankFunction(
    model_name="cross-encoder/ms-marco-MiniLM-L-6-v2",  # Specify the model name. Defaults to an emtpy string.
    device="cpu" # Specify the device to use, e.g., 'cpu' or 'cuda:0'
)

query = "What event in 1956 marked the official birth of artificial intelligence as a discipline?"

documents = [
    "In 1950, Alan Turing published his seminal paper, 'Computing Machinery and Intelligence,' proposing the Turing Test as a criterion of intelligence, a foundational concept in the philosophy and development of artificial intelligence.",
    "The Dartmouth Conference in 1956 is considered the birthplace of artificial intelligence as a field; here, John McCarthy and others coined the term 'artificial intelligence' and laid out its basic goals.",
    "In 1951, British mathematician and computer scientist Alan Turing also developed the first program designed to play chess, demonstrating an early example of AI in game strategy.",
    "The invention of the Logic Theorist by Allen Newell, Herbert A. Simon, and Cliff Shaw in 1955 marked the creation of the first true AI program, which was capable of solving logic problems, akin to proving mathematical theorems."
]

ce_rf(query, documents)

# [RerankResult(text="The Dartmouth Conference in 1956 is considered the birthplace of artificial intelligence as a field; here, John McCarthy and others coined the term 'artificial intelligence' and laid out its basic goals.", score=6.250532627105713, index=1),
#  RerankResult(text="In 1950, Alan Turing published his seminal paper, 'Computing Machinery and Intelligence,' proposing the Turing Test as a criterion of intelligence, a foundational concept in the philosophy and development of artificial intelligence.", score=-2.9546022415161133, index=0),
#  RerankResult(text='The invention of the Logic Theorist by Allen Newell, Herbert A. Simon, and Cliff Shaw in 1955 marked the creation of the first true AI program, which was capable of solving logic problems, akin to proving mathematical theorems.', score=-4.771512031555176, index=3),
#  RerankResult(text='In 1951, British mathematician and computer scientist Alan Turing also developed the first program designed to play chess, demonstrating an early example of AI in game strategy.', score=-8.325657844543457, index=2)]