import { InferenceOutputError } from "../../lib/InferenceOutputError"; import { getDefaultTask } from "../../lib/getDefaultTask"; import type { BaseArgs, Options } from "../../types"; import { request } from "../custom/request"; export type SentenceSimilarityArgs = BaseArgs & { /** * The inputs vary based on the model. * * For example when using sentence-transformers/paraphrase-xlm-r-multilingual-v1 the inputs will have a `source_sentence` string and * a `sentences` array of strings */ inputs: Record | Record[]; }; /** * Returned values are a list of floats */ export type SentenceSimilarityOutput = number[]; /** * Calculate the semantic similarity between one text and a list of other sentences by comparing their embeddings. */ export async function sentenceSimilarity( args: SentenceSimilarityArgs, options?: Options ): Promise { const defaultTask = args.model ? await getDefaultTask(args.model, args.accessToken, options) : undefined; const res = await request(args, { ...options, taskHint: "sentence-similarity", ...(defaultTask === "feature-extraction" && { forceTask: "sentence-similarity" }), }); const isValidOutput = Array.isArray(res) && res.every((x) => typeof x === "number"); if (!isValidOutput) { throw new InferenceOutputError("Expected number[]"); } return res; }