kedro_datasets_experimental.langchain.OpenAIEmbeddingsDataset

class kedro_datasets_experimental.langchain.OpenAIEmbeddingsDataset(credentials, kwargs=None)

OpenAIEmbeddingsDataset loads a OpenAIEmbeddings langchain model.

Example usage for the YAML API:

catalog.yml:

text_embedding_ada_002:
  type: langchain.OpenAIEmbeddingsDataset
  kwargs:
    model: "text-embedding-ada-002"
  credentials: openai

credentials.yml:

openai:
  openai_api_base: <openai-api-base>
  openai_api_key: <openai-api-key>

Example usage for the Python API:

 from kedro_datasets_experimental.langchain import OpenAIEmbeddingsDataset

 embeddings = OpenAIEmbeddingsDataset(
...     credentials={
...         "openai_api_base": "<openai-api-base>",
...         "openai_api_key": "<openai-api-key>",
...     },
...     kwargs={
...         "model": "text-embedding-ada-002",
...     },
... ).load()

 # See: https://python.langchain.com/docs/integrations/text_embedding/openai
 embeddings.embed_query("Hello world!")

Attributes

constructor

Return the OpenAI class to construct in the _load method.

Methods

exists()	Checks whether a dataset's output already exists by calling the provided _exists() method.
from_config(name, config[, load_version, ...])	Create a dataset instance using the configuration provided.
load()	Loads data by delegation to the provided load method.
release()	Release any cached data.
save(data)	Saves data by delegation to the provided save method.
to_config()	Converts the dataset instance into a dictionary-based configuration for serialization.

__init__(credentials, kwargs=None)

Constructor.

Parameters:

• credentials (dict[str, str]) – must contain openai_api_base and openai_api_key.

• kwargs (Optional[dict[str, Any]]) – keyword arguments passed to the underlying constructor.

property constructor: type[OpenAIEmbeddings]

Return the OpenAI class to construct in the _load method.

Return type:

type[OpenAIEmbeddings]

exists()

Checks whether a dataset’s output already exists by calling the provided _exists() method.

Return type:

bool

Returns:

Flag indicating whether the output already exists.

Raises:

DatasetError – when underlying exists method raises error.

classmethod from_config(name, config, load_version=None, save_version=None)

Create a dataset instance using the configuration provided.

Parameters:

• name (str) – Data set name.

• config (dict[str, Any]) – Data set config dictionary.

• load_version (Optional[str]) – Version string to be used for load operation if the dataset is versioned. Has no effect on the dataset if versioning was not enabled.

• save_version (Optional[str]) – Version string to be used for save operation if the dataset is versioned. Has no effect on the dataset if versioning was not enabled.

Return type:

AbstractDataset

Returns:

An instance of an AbstractDataset subclass.

Raises:

DatasetError – When the function fails to create the dataset from its config.

load()

Loads data by delegation to the provided load method.

Return type:

TypeVar(OPENAI_TYPE)

Returns:

Data returned by the provided load method.

Raises:

DatasetError – When underlying load method raises error.

release()

Release any cached data.

Raises:

DatasetError – when underlying release method raises error.

Return type:

None

save(data)

Saves data by delegation to the provided save method.

Parameters:

data (None) – the value to be saved by provided save method.

Raises:

• DatasetError – when underlying save method raises error.

• FileNotFoundError – when save method got file instead of dir, on Windows.

• NotADirectoryError – when save method got file instead of dir, on Unix.

Return type:

NoReturn

to_config()

Converts the dataset instance into a dictionary-based configuration for serialization. Ensures that any subclass-specific details are handled, with additional logic for versioning and caching implemented for CachedDataset.

Adds a key for the dataset’s type using its module and class name and includes the initialization arguments.

For CachedDataset it extracts the underlying dataset’s configuration, handles the versioned flag and removes unnecessary metadata. It also ensures the embedded dataset’s configuration is appropriately flattened or transformed.

If the dataset has a version key, it sets the versioned flag in the configuration.

Removes the metadata key from the configuration if present.

Return type:

dict[str, Any]

Returns:

A dictionary containing the dataset’s type and initialization arguments.