caikit.interfaces.nlp.data_model.reranker

Classes

`RerankScore`	The score for one document (one query)
`RerankScores`	Scores for a query in a rerank task.
`RerankResult`	Result for one query in a rerank task.
`RerankResults`	Results list for rerank tasks (supporting multiple queries).

Module Contents

class caikit.interfaces.nlp.data_model.reranker.RerankScore[source]

Bases: caikit.core.DataObjectBase

The score for one document (one query)

document: py_to_proto.dataclass_to_proto.Annotated[caikit.core.data_model.json_dict.JsonDict | None, FieldNumber(1)]

index: py_to_proto.dataclass_to_proto.Annotated[int, FieldNumber(2)]

score: py_to_proto.dataclass_to_proto.Annotated[float, FieldNumber(3)]

text: py_to_proto.dataclass_to_proto.Annotated[str | None, FieldNumber(4)]

class caikit.interfaces.nlp.data_model.reranker.RerankScores[source]

Bases: caikit.core.DataObjectBase

Scores for a query in a rerank task. This is a list of n ReRankScore where n is based on top_n documents and each score indicates the relevance of that document for this query. Results are ordered most-relevant first.

query: py_to_proto.dataclass_to_proto.Annotated[str | None, FieldNumber(1)]

scores: py_to_proto.dataclass_to_proto.Annotated[List[RerankScore], FieldNumber(2)]

class caikit.interfaces.nlp.data_model.reranker.RerankResult[source]

Bases: caikit.core.DataObjectBase

Result for one query in a rerank task. This is a list of n ReRankScore where n is based on top_n documents and each score indicates the relevance of that document for this query. Results are ordered most-relevant first.

result: py_to_proto.dataclass_to_proto.Annotated[RerankScores, FieldNumber(1)]

producer_id: py_to_proto.dataclass_to_proto.Annotated[caikit.interfaces.common.data_model.ProducerId, FieldNumber(2)]

input_token_count: py_to_proto.dataclass_to_proto.Annotated[int | None, FieldNumber(3)]

class caikit.interfaces.nlp.data_model.reranker.RerankResults[source]

Bases: caikit.core.DataObjectBase

Results list for rerank tasks (supporting multiple queries). For multiple queries, each one has a RerankQueryResult (ranking the documents for that query).

results: py_to_proto.dataclass_to_proto.Annotated[List[RerankScores], FieldNumber(1)]

producer_id: py_to_proto.dataclass_to_proto.Annotated[caikit.interfaces.common.data_model.ProducerId, FieldNumber(2)]

input_token_count: py_to_proto.dataclass_to_proto.Annotated[int | None, FieldNumber(3)]