メインコンテンツまでスキップ

__call__()

JinaRerankFunction のこの操作は、クエリとドキュメント文字列を受け取り、スコア順にランク付けされた上位 k 件のドキュメントを含む RerankResult オブジェクトのリストを返します。

リクエスト構文​

python
# Instance created
jina_rf = JinaRerankFunction()

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

パラメーター:

  • query (string)

    ランキングに使用するクエリ文字列。

  • documents (List[str])

    指定されたクエリに対してランク付けされるドキュメント文字列のリスト。

  • top_k (int)

    返される上位ランクのドキュメントの最大数。デフォルトは 5 です。

戻り値の型:

List[RerankResult]

戻り値:

RerankResult オブジェクトのリスト。

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

各 RerankResult オブジェクトには以下が含まれます。

  • text: 一致したドキュメントテキスト。

  • score: reranking モデルによってそのドキュメントに割り当てられたスコア。

  • index: 元の documents リスト内でのドキュメントのインデックス。

例外:

  • RuntimeError

    Jina API からのレスポンスに results キーが含まれていない場合、この例外が発生します。

例​

python
from pymilvus.model.reranker import JinaRerankFunction

jina_rf = JinaRerankFunction(
    model_name="jina-reranker-v1-base-en", # Defaults to `jina-reranker-v1-base-en`
    api_key="YOUR_JINAAI_API_KEY"
)

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."
]

jina_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=0.9370958209037781, index=1),
#  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=0.35420963168144226, index=3),
#  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=0.3498658835887909, index=0),
#  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=0.2728956639766693, index=2)]
Ctrl I