@ai-sdk/togetherai 0.0.0-70e0935a-20260114150030 → 0.0.0-98261322-20260122142521

package/src/reranking/togetherai-reranking-model.test.ts

@@ -0,0 +1,245 @@
+import { createTestServer } from '@ai-sdk/test-server/with-vitest';
+import fs from 'node:fs';
+import { beforeEach, describe, expect, it } from 'vitest';
+import { createTogetherAI } from '../togetherai-provider';
+import { TogetherAIRerankingOptions } from './togetherai-reranking-options';
+
+const provider = createTogetherAI({ apiKey: 'test-api-key' });
+const model = provider.rerankingModel('Salesforce/Llama-Rank-v1');
+
+describe('doRerank', () => {
+  const server = createTestServer({
+    'https://api.together.xyz/v1/rerank': {},
+  });
+
+  function prepareJsonFixtureResponse(filename: string) {
+    server.urls['https://api.together.xyz/v1/rerank'].response = {
+      type: 'json-value',
+      body: JSON.parse(
+        fs.readFileSync(`src/reranking/__fixtures__/${filename}.json`, 'utf8'),
+      ),
+    };
+    return;
+  }
+
+  describe('json documents', () => {
+    let result: Awaited<ReturnType<typeof model.doRerank>>;
+
+    beforeEach(async () => {
+      prepareJsonFixtureResponse('togetherai-reranking.1');
+
+      result = await model.doRerank({
+        documents: {
+          type: 'object',
+          values: [
+            { example: 'sunny day at the beach' },
+            { example: 'rainy day in the city' },
+          ],
+        },
+        query: 'rainy day',
+        topN: 2,
+        providerOptions: {
+          togetherai: {
+            rankFields: ['example'],
+          } satisfies TogetherAIRerankingOptions,
+        },
+      });
+    });
+
+    it('should send request with stringified json documents', async () => {
+      expect(await server.calls[0].requestBodyJson).toMatchInlineSnapshot(`
+        {
+          "documents": [
+            {
+              "example": "sunny day at the beach",
+            },
+            {
+              "example": "rainy day in the city",
+            },
+          ],
+          "model": "Salesforce/Llama-Rank-v1",
+          "query": "rainy day",
+          "rank_fields": [
+            "example",
+          ],
+          "return_documents": false,
+          "top_n": 2,
+        }
+      `);
+    });
+
+    it('should send request with the correct headers', async () => {
+      expect(server.calls[0].requestHeaders).toMatchInlineSnapshot(`
+        {
+          "authorization": "Bearer test-api-key",
+          "content-type": "application/json",
+        }
+      `);
+    });
+
+    it('should return result with warnings', async () => {
+      expect(result.warnings).toMatchInlineSnapshot(`undefined`);
+    });
+
+    it('should return result with the correct ranking', async () => {
+      expect(result.ranking).toMatchInlineSnapshot(`
+        [
+          {
+            "index": 0,
+            "relevanceScore": 0.6475887154399037,
+          },
+          {
+            "index": 5,
+            "relevanceScore": 0.6323295373206566,
+          },
+        ]
+      `);
+    });
+
+    it('should not return provider metadata (use response body instead)', async () => {
+      expect(result.providerMetadata).toMatchInlineSnapshot(`undefined`);
+    });
+
+    it('should return result with the correct response', async () => {
+      expect(result.response).toMatchInlineSnapshot(`
+        {
+          "body": {
+            "id": "oGs6Zt9-62bZhn-99529372487b1b0a",
+            "model": "Salesforce/Llama-Rank-v1",
+            "object": "rerank",
+            "results": [
+              {
+                "document": {},
+                "index": 0,
+                "relevance_score": 0.6475887154399037,
+              },
+              {
+                "document": {},
+                "index": 5,
+                "relevance_score": 0.6323295373206566,
+              },
+            ],
+            "usage": {
+              "completion_tokens": 0,
+              "prompt_tokens": 2966,
+              "total_tokens": 2966,
+            },
+          },
+          "headers": {
+            "content-length": "304",
+            "content-type": "application/json",
+          },
+          "id": "oGs6Zt9-62bZhn-99529372487b1b0a",
+          "modelId": "Salesforce/Llama-Rank-v1",
+        }
+      `);
+    });
+  });
+
+  describe('text documents', () => {
+    let result: Awaited<ReturnType<typeof model.doRerank>>;
+
+    beforeEach(async () => {
+      prepareJsonFixtureResponse('togetherai-reranking.1');
+
+      result = await model.doRerank({
+        documents: {
+          type: 'text',
+          values: ['sunny day at the beach', 'rainy day in the city'],
+        },
+        query: 'rainy day',
+        topN: 2,
+        providerOptions: {
+          togetherai: {
+            rankFields: ['example'],
+          } satisfies TogetherAIRerankingOptions,
+        },
+      });
+    });
+
+    it('should send request with text documents', async () => {
+      expect(await server.calls[0].requestBodyJson).toMatchInlineSnapshot(`
+        {
+          "documents": [
+            "sunny day at the beach",
+            "rainy day in the city",
+          ],
+          "model": "Salesforce/Llama-Rank-v1",
+          "query": "rainy day",
+          "rank_fields": [
+            "example",
+          ],
+          "return_documents": false,
+          "top_n": 2,
+        }
+      `);
+    });
+
+    it('should send request with the correct headers', async () => {
+      expect(server.calls[0].requestHeaders).toMatchInlineSnapshot(`
+        {
+          "authorization": "Bearer test-api-key",
+          "content-type": "application/json",
+        }
+      `);
+    });
+
+    it('should return result without warnings', async () => {
+      expect(result.warnings).toMatchInlineSnapshot(`undefined`);
+    });
+
+    it('should return result with the correct ranking', async () => {
+      expect(result.ranking).toMatchInlineSnapshot(`
+        [
+          {
+            "index": 0,
+            "relevanceScore": 0.6475887154399037,
+          },
+          {
+            "index": 5,
+            "relevanceScore": 0.6323295373206566,
+          },
+        ]
+      `);
+    });
+
+    it('should not return provider metadata (use response body instead)', async () => {
+      expect(result.providerMetadata).toMatchInlineSnapshot(`undefined`);
+    });
+
+    it('should return result with the correct response', async () => {
+      expect(result.response).toMatchInlineSnapshot(`
+        {
+          "body": {
+            "id": "oGs6Zt9-62bZhn-99529372487b1b0a",
+            "model": "Salesforce/Llama-Rank-v1",
+            "object": "rerank",
+            "results": [
+              {
+                "document": {},
+                "index": 0,
+                "relevance_score": 0.6475887154399037,
+              },
+              {
+                "document": {},
+                "index": 5,
+                "relevance_score": 0.6323295373206566,
+              },
+            ],
+            "usage": {
+              "completion_tokens": 0,
+              "prompt_tokens": 2966,
+              "total_tokens": 2966,
+            },
+          },
+          "headers": {
+            "content-length": "304",
+            "content-type": "application/json",
+          },
+          "id": "oGs6Zt9-62bZhn-99529372487b1b0a",
+          "modelId": "Salesforce/Llama-Rank-v1",
+        }
+      `);
+    });
+  });
+});

package/src/reranking/togetherai-reranking-model.ts

@@ -0,0 +1,101 @@
+import { RerankingModelV3 } from '@ai-sdk/provider';
+import {
+  combineHeaders,
+  createJsonErrorResponseHandler,
+  createJsonResponseHandler,
+  FetchFunction,
+  parseProviderOptions,
+  postJsonToApi,
+} from '@ai-sdk/provider-utils';
+import {
+  togetheraiErrorSchema,
+  TogetherAIRerankingInput,
+  togetheraiRerankingResponseSchema,
+} from './togetherai-reranking-api';
+import {
+  TogetherAIRerankingModelId,
+  togetheraiRerankingOptionsSchema,
+} from './togetherai-reranking-options';
+
+type TogetherAIRerankingConfig = {
+  provider: string;
+  baseURL: string;
+  headers: () => Record<string, string | undefined>;
+  fetch?: FetchFunction;
+};
+
+export class TogetherAIRerankingModel implements RerankingModelV3 {
+  readonly specificationVersion = 'v3';
+  readonly modelId: TogetherAIRerankingModelId;
+
+  private readonly config: TogetherAIRerankingConfig;
+
+  constructor(
+    modelId: TogetherAIRerankingModelId,
+    config: TogetherAIRerankingConfig,
+  ) {
+    this.modelId = modelId;
+    this.config = config;
+  }
+
+  get provider(): string {
+    return this.config.provider;
+  }
+
+  // see https://docs.together.ai/reference/rerank-1
+  async doRerank({
+    documents,
+    headers,
+    query,
+    topN,
+    abortSignal,
+    providerOptions,
+  }: Parameters<RerankingModelV3['doRerank']>[0]): Promise<
+    Awaited<ReturnType<RerankingModelV3['doRerank']>>
+  > {
+    const rerankingOptions = await parseProviderOptions({
+      provider: 'togetherai',
+      providerOptions,
+      schema: togetheraiRerankingOptionsSchema,
+    });
+
+    const {
+      responseHeaders,
+      value: response,
+      rawValue,
+    } = await postJsonToApi({
+      url: `${this.config.baseURL}/rerank`,
+      headers: combineHeaders(this.config.headers(), headers),
+      body: {
+        model: this.modelId,
+        documents: documents.values,
+        query,
+        top_n: topN,
+        rank_fields: rerankingOptions?.rankFields,
+        return_documents: false, // reduce response size
+      } satisfies TogetherAIRerankingInput,
+      failedResponseHandler: createJsonErrorResponseHandler({
+        errorSchema: togetheraiErrorSchema,
+        errorToMessage: data => data.error.message,
+      }),
+      successfulResponseHandler: createJsonResponseHandler(
+        togetheraiRerankingResponseSchema,
+      ),
+      abortSignal,
+      fetch: this.config.fetch,
+    });
+
+    return {
+      ranking: response.results.map(result => ({
+        index: result.index,
+        relevanceScore: result.relevance_score,
+      })),
+      response: {
+        id: response.id ?? undefined,
+        modelId: response.model ?? undefined,
+        headers: responseHeaders,
+        body: rawValue,
+      },
+    };
+  }
+}

package/src/reranking/togetherai-reranking-options.ts

@@ -0,0 +1,27 @@
+import { FlexibleSchema, lazySchema, zodSchema } from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
+
+// see https://docs.together.ai/docs/serverless-models#rerank-models
+export type TogetherAIRerankingModelId =
+  | 'Salesforce/Llama-Rank-v1'
+  | 'mixedbread-ai/Mxbai-Rerank-Large-V2'
+  | (string & {});
+
+export type TogetherAIRerankingOptions = {
+  /**
+   * List of keys in the JSON Object document to rank by.
+   * Defaults to use all supplied keys for ranking.
+   *
+   * @example ["title", "text"]
+   */
+  rankFields?: string[];
+};
+
+export const togetheraiRerankingOptionsSchema: FlexibleSchema<TogetherAIRerankingOptions> =
+  lazySchema(() =>
+    zodSchema(
+      z.object({
+        rankFields: z.array(z.string()).optional(),
+      }),
+    ),
+  );

package/src/togetherai-chat-options.ts

@@ -0,0 +1,36 @@
+// https://docs.together.ai/docs/serverless-models#chat-models
+export type TogetherAIChatModelId =
+  | 'meta-llama/Llama-3.3-70B-Instruct-Turbo'
+  | 'meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo'
+  | 'meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo'
+  | 'meta-llama/Meta-Llama-3.1-405B-Instruct-Turbo'
+  | 'meta-llama/Meta-Llama-3-8B-Instruct-Turbo'
+  | 'meta-llama/Meta-Llama-3-70B-Instruct-Turbo'
+  | 'meta-llama/Llama-3.2-3B-Instruct-Turbo'
+  | 'meta-llama/Meta-Llama-3-8B-Instruct-Lite'
+  | 'meta-llama/Meta-Llama-3-70B-Instruct-Lite'
+  | 'meta-llama/Llama-3-8b-chat-hf'
+  | 'meta-llama/Llama-3-70b-chat-hf'
+  | 'nvidia/Llama-3.1-Nemotron-70B-Instruct-HF'
+  | 'Qwen/Qwen2.5-Coder-32B-Instruct'
+  | 'Qwen/QwQ-32B-Preview'
+  | 'microsoft/WizardLM-2-8x22B'
+  | 'google/gemma-2-27b-it'
+  | 'google/gemma-2-9b-it'
+  | 'databricks/dbrx-instruct'
+  | 'deepseek-ai/deepseek-llm-67b-chat'
+  | 'deepseek-ai/DeepSeek-V3'
+  | 'google/gemma-2b-it'
+  | 'Gryphe/MythoMax-L2-13b'
+  | 'meta-llama/Llama-2-13b-chat-hf'
+  | 'mistralai/Mistral-7B-Instruct-v0.1'
+  | 'mistralai/Mistral-7B-Instruct-v0.2'
+  | 'mistralai/Mistral-7B-Instruct-v0.3'
+  | 'mistralai/Mixtral-8x7B-Instruct-v0.1'
+  | 'mistralai/Mixtral-8x22B-Instruct-v0.1'
+  | 'NousResearch/Nous-Hermes-2-Mixtral-8x7B-DPO'
+  | 'Qwen/Qwen2.5-7B-Instruct-Turbo'
+  | 'Qwen/Qwen2.5-72B-Instruct-Turbo'
+  | 'Qwen/Qwen2-72B-Instruct'
+  | 'upstage/SOLAR-10.7B-Instruct-v1.0'
+  | (string & {});

package/src/togetherai-completion-options.ts

@@ -0,0 +1,9 @@
+// https://docs.together.ai/docs/serverless-models#language-models
+export type TogetherAICompletionModelId =
+  | 'meta-llama/Llama-2-70b-hf'
+  | 'mistralai/Mistral-7B-v0.1'
+  | 'mistralai/Mixtral-8x7B-v0.1'
+  | 'Meta-Llama/Llama-Guard-7b'
+  | 'codellama/CodeLlama-34b-Instruct-hf'
+  | 'Qwen/Qwen2.5-Coder-32B-Instruct'
+  | (string & {});

package/src/togetherai-embedding-options.ts

@@ -0,0 +1,11 @@
+// https://docs.together.ai/docs/serverless-models#embedding-models
+export type TogetherAIEmbeddingModelId =
+  | 'togethercomputer/m2-bert-80M-2k-retrieval'
+  | 'togethercomputer/m2-bert-80M-32k-retrieval'
+  | 'togethercomputer/m2-bert-80M-8k-retrieval'
+  | 'WhereIsAI/UAE-Large-V1'
+  | 'BAAI/bge-large-en-v1.5'
+  | 'BAAI/bge-base-en-v1.5'
+  | 'sentence-transformers/msmarco-bert-base-dot-v5'
+  | 'bert-base-uncased'
+  | (string & {});