Skip to main content

​
OpenAIEmbedding

class OpenAIEmbedding:
Provides text embedding functionalities using OpenAI’s models. Parameters:
  • model_type (EmbeddingModelType): The model type to be used for text embeddings. (default: :obj:TEXT_EMBEDDING_3_SMALL)
  • url (Optional[str]): The url to the OpenAI service. (default: :obj:None)
  • api_key (Optional[str]): The API key for authenticating with the OpenAI service. (default: :obj:None)
  • dimensions (Union[int, NotGiven]): The text embedding output dimensions. (default: :obj:NOT_GIVEN)

​
init

def __init__(
    self,
    model_type: EmbeddingModelType = EmbeddingModelType.TEXT_EMBEDDING_3_SMALL,
    url: Optional[str] = None,
    api_key: Optional[str] = None,
    dimensions: Union[int, NotGiven] = NOT_GIVEN
):

​
embed_list

def embed_list(self, objs: list[str], **kwargs: Any):
Generates embeddings for the given texts. Parameters:
  • objs (list[str]): The texts for which to generate the embeddings. **kwargs (Any): Extra kwargs passed to the embedding API.
Returns: list[list[float]]: A list that represents the generated embedding as a list of floating-point numbers.

​
get_output_dim

def get_output_dim(self):
Returns: int: The dimensionality of the embedding for the current model.