Retrieval

AIMon offers a set of tools that help improve retrieval quality. These tools are intended to be used in conjunction with the AIMon evaluation tools to help you identify and fix issues with your retrieval pipeline. Currently, tools supported are as follows:

• Domain adaptable re-ranking

Domain Adaptable Re-ranking

Domain Adaptable Re-ranking is a technique that allows you to customize an AIMon selected re-ranker to your specific domain. This customization can be done by providing a description of the task that the re-ranker is being used for along with a set of examples of query-document pairs that would "teach" the re-ranker on how to rank documents for your specific task. All of this can be done through a simple AIMon API call.

Code Example

Python

from aimon import Client
import os

aimon_client = Client(auth_header="Bearer {}".format(os.getenv("AIMON_API_KEY")))

queries=["What is the capital of France?"], 
context_docs=["Paris", "New York"]
scores = aimon_client.retrieval.rerank(
    context_docs=context_docs, 
    queries=queries,
    task_definition="Your task is to grade the relevance of context document against a specified user query.", 
)
print(scores)
# [[35.25, 15.4375]]

TypeScript

const runRerank = async () => {
  const queries = ["What is the capital of France?"];
  const contextDocs = ["Paris", "New York"];
  const taskDefinition =
    "Your task is to grade the relevance of context document against a specified user query.";
  const body = {
    queries,
    context_docs: contextDocs,
    task_definition: taskDefinition,
  };
  const scores = await aimon.retrieval.rerank(body);
  console.log("Scores: ", scores);
};

runRerank();

// Scores:  [ [ 37, 20.25 ] ]