feat (reranking) : Support for reranking models

README.md

@@ -1 +1 @@
-packages/ai/README.md
+packages/ai/README.md

packages/ai/core/rerank/__snapshots__/rerank.test.ts.snap

@@ -0,0 +1,134 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`telemetry > should not record telemetry inputs / outputs when disabled 1`] = `
+[
+  {
+    "attributes": {
+      "ai.model.id": "mock-model-id",
+      "ai.model.provider": "mock-provider",
+      "ai.operationId": "ai.rerank",
+      "ai.usage.tokens": 10,
+      "operation.name": "ai.rerank",
+    },
+    "events": [],
+    "name": "ai.rerank",
+  },
+  {
+    "attributes": {
+      "ai.model.id": "mock-model-id",
+      "ai.model.provider": "mock-provider",
+      "ai.operationId": "ai.rerank.doRerank",
+      "ai.usage.tokens": 10,
+      "operation.name": "ai.rerank.doRerank",
+    },
+    "events": [],
+    "name": "ai.rerank.doRerank",
+  },
+]
+`;
+
+exports[`telemetry > should record telemetry data when enabled (multiple calls path) 1`] = `
+[
+  {
+    "attributes": {
+      "ai.model.id": "mock-model-id",
+      "ai.model.provider": "mock-provider",
+      "ai.operationId": "ai.rerank",
+      "ai.rerankedDocuments": "[]",
+      "ai.rerankedIndices": "[1,0]",
+      "ai.telemetry.functionId": "test-function-id",
+      "ai.telemetry.metadata.test1": "value1",
+      "ai.telemetry.metadata.test2": false,
+      "ai.usage.tokens": 20,
+      "ai.values": "["sunny day at the beach","rainy day in the city"]",
+      "operation.name": "ai.rerank test-function-id",
+      "resource.name": "test-function-id",
+    },
+    "events": [],
+    "name": "ai.rerank",
+  },
+  {
+    "attributes": {
+      "ai.model.id": "mock-model-id",
+      "ai.model.provider": "mock-provider",
+      "ai.operationId": "ai.rerank.doRerank",
+      "ai.rerankedDocuments": "[]",
+      "ai.rerankedIndices": "[1]",
+      "ai.telemetry.functionId": "test-function-id",
+      "ai.telemetry.metadata.test1": "value1",
+      "ai.telemetry.metadata.test2": false,
+      "ai.usage.tokens": 10,
+      "ai.values": [
+        "["sunny day at the beach"]",
+      ],
+      "operation.name": "ai.rerank.doRerank test-function-id",
+      "resource.name": "test-function-id",
+    },
+    "events": [],
+    "name": "ai.rerank.doRerank",
+  },
+  {
+    "attributes": {
+      "ai.model.id": "mock-model-id",
+      "ai.model.provider": "mock-provider",
+      "ai.operationId": "ai.rerank.doRerank",
+      "ai.rerankedDocuments": "[]",
+      "ai.rerankedIndices": "[0]",
+      "ai.telemetry.functionId": "test-function-id",
+      "ai.telemetry.metadata.test1": "value1",
+      "ai.telemetry.metadata.test2": false,
+      "ai.usage.tokens": 10,
+      "ai.values": [
+        "["rainy day in the city"]",
+      ],
+      "operation.name": "ai.rerank.doRerank test-function-id",
+      "resource.name": "test-function-id",
+    },
+    "events": [],
+    "name": "ai.rerank.doRerank",
+  },
+]
+`;
+
+exports[`telemetry > should record telemetry data when enabled (single call path) 1`] = `
+[
+  {
+    "attributes": {
+      "ai.model.id": "mock-model-id",
+      "ai.model.provider": "mock-provider",
+      "ai.operationId": "ai.rerank",
+      "ai.rerankedDocuments": "["rainy day in the city","sunny day at the beach"]",
+      "ai.rerankedIndices": "[1,0]",
+      "ai.telemetry.functionId": "test-function-id",
+      "ai.telemetry.metadata.test1": "value1",
+      "ai.telemetry.metadata.test2": false,
+      "ai.usage.tokens": 10,
+      "ai.values": "["sunny day at the beach","rainy day in the city"]",
+      "operation.name": "ai.rerank test-function-id",
+      "resource.name": "test-function-id",
+    },
+    "events": [],
+    "name": "ai.rerank",
+  },
+  {
+    "attributes": {
+      "ai.model.id": "mock-model-id",
+      "ai.model.provider": "mock-provider",
+      "ai.operationId": "ai.rerank.doRerank",
+      "ai.rerankedDocuments": "["rainy day in the city","sunny day at the beach"]",
+      "ai.rerankedIndices": "[1,0]",
+      "ai.telemetry.functionId": "test-function-id",
+      "ai.telemetry.metadata.test1": "value1",
+      "ai.telemetry.metadata.test2": false,
+      "ai.usage.tokens": 10,
+      "ai.values": [
+        "["sunny day at the beach","rainy day in the city"]",
+      ],
+      "operation.name": "ai.rerank.doRerank test-function-id",
+      "resource.name": "test-function-id",
+    },
+    "events": [],
+    "name": "ai.rerank.doRerank",
+  },
+]
+`;

packages/ai/core/rerank/index.ts

@@ -0,0 +1,2 @@
+export * from './rerank';
+export * from './rerank-result';

packages/ai/core/rerank/rerank-result.ts

@@ -0,0 +1,40 @@
+import { RerankedDocumentIndex } from '../types';
+import { RerankingModelUsage } from '../types/usage';
+
+/**
+The result of an `rerank` call.
+It contains the documents, the reranked indices, and additional information.
+ */
+export interface RerankResult<VALUE> {
+  /**
+  The documents that were reranked.
+     */
+  readonly documents: Array<VALUE>;
+
+  /**
+  The reranked indices.
+    */
+  readonly rerankedIndices: Array<RerankedDocumentIndex>;
+
+  /**
+   * The reranked documents.
+   * Only available if `returnDocuments` was set to `true`.
+   * The order of the documents is the same as the order of the indices.
+   */
+  readonly rerankedDocuments?: Array<VALUE>;
+
+  /**
+  The reranking token usage.
+    */
+  readonly usage: RerankingModelUsage;
+
+  /**
+  Optional raw response data.
+     */
+  readonly rawResponse?: {
+    /**
+  Response headers.
+       */
+    headers?: Record<string, string>;
+  };
+}