similarity-remote-api

Documentation / similarity/similarity-remote-api

Similarity

function weighRelevanceConceptVectorAPI(
   source_sentence: string, 
   sentences: string[], 
   options?: object): Promise<any>;

Defined in: similarity/similarity-remote-api.js:18

Calculate the semantic similarity between one text and a list of other sentences by comparing their embeddings. https://huggingface.co/docs/api-inference/detailed_parameters#sentence-similarity-task

Parameter	Type	Description
`source_sentence`	`string`	The string that you wish to compare the other strings with. This can be a phrase, sentence, or longer passage, depending on the model being used.
`sentences`	`string`[]	A list of strings which will be compared against the source_sentence.
`options?`	{ `HF_API_KEY`: `string`; `model`: `string`; }
`options.HF_API_KEY?`	`string`	Required https://huggingface.co/settings/tokens
`options.model?`	`string`	default="sentence-transformers/all-MiniLM-L6-v2"

Promise<any>

array of 0-1 similarity scores for each sentence *