File size: 2,495 Bytes
cbc00ce | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 | # -*- coding: utf-8 -*-
# Copyright (c) Alibaba, Inc. and its affiliates.
from typing import List
from dashscope.api_entities.dashscope_response import ReRankResponse
from dashscope.client.base_api import BaseApi
from dashscope.common.error import InputRequired, ModelRequired
from dashscope.common.utils import _get_task_group_and_task
class TextReRank(BaseApi):
task = "text-rerank"
"""API for rerank models.
"""
class Models:
gte_rerank = "gte-rerank"
@classmethod
def call( # type: ignore[override]
cls,
model: str,
query: str,
documents: List[str],
return_documents: bool = None,
top_n: int = None,
api_key: str = None,
**kwargs,
) -> ReRankResponse:
"""Calling rerank service.
Args:
model (str): The model to use.
query (str): The query string.
documents (List[str]): The documents to rank.
return_documents(bool, `optional`): enable return origin documents,
system default is false.
top_n(int, `optional`): how many documents to return, default return # noqa: E501
all the documents.
api_key (str, optional): The DashScope api key. Defaults to None.
Raises:
InputRequired: The query and documents are required.
ModelRequired: The model is required.
Returns:
RerankResponse: The rerank result.
"""
if query is None or documents is None or not documents:
raise InputRequired("query and documents are required!")
if model is None or not model:
raise ModelRequired("Model is required!")
task_group, function = _get_task_group_and_task(__name__)
input = { # pylint: disable=redefined-builtin
"query": query,
"documents": documents,
}
parameters = {}
if return_documents is not None:
parameters["return_documents"] = return_documents
if top_n is not None:
parameters["top_n"] = top_n
parameters = {**parameters, **kwargs}
response = super().call(
model=model,
task_group=task_group,
task=TextReRank.task,
function=function,
api_key=api_key,
input=input,
**parameters, # type: ignore[arg-type]
)
return ReRankResponse.from_api_response(response)
|