get_sentence_transformer

get_sentence_transformer(name: str | sentence_transformers.SentenceTransformer | None = None, **kwargs: Any) → sentence_transformers.SentenceTransformer[source]

Get a sentence transformer.

Parameters:
  • name – The name of the sentence transformer model on HuggingFace. If none is passed, then DEFAULT_SENTENCE_TRANSFORMER_NAME is used. If a pre-instantiated model is passed, then it is passed through.

  • kwargs – Keyword arguments to pass to sentence_transformers.SentenceTransformer.

Returns:

An instantiated sentence transformer object, which has a sentence_transformers.SentenceTransformer.encode() function