nemoguardrails.embeddings.providers.openai

Module Contents

Name	Description
`OpenAIEmbeddingModel`	Embedding model using OpenAI API.

class nemoguardrails.embeddings.providers.openai.OpenAIEmbeddingModel(
    embedding_model: str,
    kwargs = {}
)

Bases: EmbeddingModel

Embedding model using OpenAI API.

Parameters:

embedding_model

str

The name of the embedding model.

client

= OpenAI(**kwargs)

embedding_size

= self.embedding_size_dict[self.model]

embedding_size_dict

engine_name

= 'openai'

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

Encode a list of documents into embeddings.

Parameters:

documents

List[str]

The list of documents to be encoded.

Returns: List[List[float]]

List[List[float]]: The encoded embeddings.

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

async

Encode a list of documents into embeddings.

Parameters:

documents

List[str]

The list of documents to be encoded.

Returns: List[List[float]]

List[List[float]]: The encoded embeddings.

nemoguardrails.embeddings.providers.openai.async_client_var: ContextVar = ContextVar('async_client', default=None)