Skip to content

Embedding Models API

OpenAIEmbeddingModel 

OpenAIEmbeddingModel(client: OpenAI, model_id: str, params: dict | OpenAIEmbeddingParams | None = None)

Bases: BaseEmbeddingModel[OpenAI, OpenAIEmbeddingParams]

Creates embeddings via an OpenAI-compatible client.

Source code in ai4rag/rag/embedding/openai_model.py 
36
37
def __init__(self, client: OpenAI, model_id: str, params: dict | OpenAIEmbeddingParams | None = None):
    super().__init__(client=client, model_id=model_id, params=params)

Attributes

params property writable 

params: OpenAIEmbeddingParams

Get model params.

Methods:

embed_documents 

embed_documents(texts: list[str]) -> list[list[float]]

Embeds given list of strings. The maximum batch size supported is 2048 chunks, hence we need to do it iteratively.

Parameters:

  • texts (list[str]) –

    List of text-like chunks.

Returns:

  • list[list[float]] –

    Embeddings made from the list of texts.

Source code in ai4rag/rag/embedding/openai_model.py 
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
def embed_documents(self, texts: list[str]) -> list[list[float]]:
    """Embeds given list of strings.
    The maximum batch size supported is 2048 chunks,
    hence we need to do it iteratively.

    Parameters
    ----------
    texts : list[str]
        List of text-like chunks.

    Returns
    -------
    list[list[float]]
        Embeddings made from the list of texts.
    """
    resp = []
    for idx in range(0, len(texts), self._BATCH_SIZE):
        resp.extend(self._embed_text(text_input=texts[idx : idx + self._BATCH_SIZE]))

    return resp

embed_query 

embed_query(query: str) -> list[float]

Embeds given query.

Parameters:

  • query (str) –

    Single text-like chunk.

Returns:

  • list[] –

    Embeddings made from a single text.

Source code in ai4rag/rag/embedding/openai_model.py 
248
249
250
251
252
253
254
255
256
257
258
259
260
261
def embed_query(self, query: str) -> list[float]:
    """Embeds given query.

    Parameters
    ----------
    query : str
        Single text-like chunk.

    Returns
    -------
    list[]
        Embeddings made from a single text.
    """
    return self._embed_text(text_input=query)[0]