nemoguardrails.embeddings.providers.sentence_transformers

Module Contents

Classes

Name	Description
`SentenceTransformerEmbeddingModel`	Embedding model using sentence-transformers.

Functions

Name	Description
`get_executor`	-

API

class nemoguardrails.embeddings.providers.sentence_transformers.SentenceTransformerEmbeddingModel(
    embedding_model: str,
    kwargs = {}
)

Bases: EmbeddingModel

Embedding model using sentence-transformers.

This class represents an embedding model that utilizes the sentence-transformers library for generating sentence embeddings.

Parameters:

embedding_model

str

The name or path of the pre-trained sentence-transformers model.

embedding_size

= self.model.get_sentence_embedding_dimension()

engine_name

= 'SentenceTransformers'

model

nemoguardrails.embeddings.providers.sentence_transformers.SentenceTransformerEmbeddingModel.encode(
    documents: typing.List[str]
) -> typing.List[typing.List[float]]

Encode a list of documents into their corresponding sentence embeddings.

Parameters:

documents

List[str]

The list of documents to be encoded.

Returns: List[List[float]]

List[List[float]]: The list of sentence embeddings, where each embedding is a list of floats.

nemoguardrails.embeddings.providers.sentence_transformers.SentenceTransformerEmbeddingModel.encode_async(
    documents: typing.List[str]
) -> typing.List[typing.List[float]]

async

Encode a list of documents into their corresponding sentence embeddings.

Parameters:

documents

List[str]

The list of documents to be encoded.

Returns: List[List[float]]

List[List[float]]: The list of sentence embeddings, where each embedding is a list of floats.

nemoguardrails.embeddings.providers.sentence_transformers.get_executor()