"""
Cohere dataset definition.
"""
from typing import Any, NoReturn
from kedro.io import AbstractDataset, DatasetError
from langchain_cohere import ChatCohere
[docs]
class ChatCohereDataset(AbstractDataset[None, ChatCohere]):
"""``ChatCohereDataset`` loads a ChatCohere `langchain <https://python.langchain.com/>`_ model.
Example usage for the :doc:`YAML API <kedro:data/data_catalog_yaml_examples>`:
catalog.yml:
.. code-block:: yaml
command:
type: langchain.ChatCohereDataset
kwargs:
model: "command"
temperature: 0.0
credentials: cohere
credentials.yml:
.. code-block:: yaml
cohere:
cohere_api_url: <cohere-api-base>
cohere_api_key: <cohere-api-key>
Example usage for the
`Python API <https://docs.kedro.org/en/stable/data/\
advanced_data_catalog_usage.html>`_:
.. code-block:: pycon
>>> from kedro_datasets_experimental.langchain import ChatCohereDataset
>>> llm = ChatCohereDataset(
... credentials={
... "cohere_api_key": "xxx",
... "cohere_api_url": "xxx",
... },
... kwargs={
... "model": "command",
... "temperature": 0.0,
... },
... ).load()
>>>
>>> # See: https://python.langchain.com/v0.1/docs/integrations/chat/cohere/
>>> llm.invoke("Hello world!")
"""
[docs]
def __init__(self, credentials: dict[str, str], kwargs: dict[str, Any] = None):
"""Constructor.
Args:
credentials: must contain `cohere_api_url` and `cohere_api_key`.
kwargs: keyword arguments passed to the underlying constructor.
"""
self.cohere_api_url = credentials["cohere_api_url"]
self.cohere_api_key = credentials["cohere_api_key"]
self.kwargs = kwargs or {}
def _describe(self) -> dict[str, Any]:
return {**self.kwargs}
[docs]
def save(self, data: None) -> NoReturn:
raise DatasetError(f"{self.__class__.__name__} is a read only dataset type")
[docs]
def load(self) -> ChatCohere:
return ChatCohere(cohere_api_key=self.cohere_api_key, base_url=self.cohere_api_url, **self.kwargs)
