diff --git a/.github/scripts/check_diff.py b/.github/scripts/check_diff.py index 3afa442..9952555 100644 --- a/.github/scripts/check_diff.py +++ b/.github/scripts/check_diff.py @@ -2,7 +2,7 @@ import sys from typing import Dict -LIB_DIRS = ["libs/mixedbreadai"] +LIB_DIRS = ["libs/mixedbread-ai"] if __name__ == "__main__": files = sys.argv[1:] diff --git a/.github/workflows/_release.yml b/.github/workflows/_release.yml index 3698860..bd26bc0 100644 --- a/.github/workflows/_release.yml +++ b/.github/workflows/_release.yml @@ -12,7 +12,7 @@ on: working-directory: required: true type: string - default: 'libs/mixedbreadai' + default: 'libs/mixedbread-ai' env: PYTHON_VERSION: "3.11" diff --git a/.github/workflows/_scheduled_test.yml b/.github/workflows/_scheduled_test.yml index ea4165f..89f4427 100644 --- a/.github/workflows/_scheduled_test.yml +++ b/.github/workflows/_scheduled_test.yml @@ -1,5 +1,5 @@ name: Scheduled tests -run-name: langchain-mixedbreadai Scheduled tests +run-name: langchain-mixedbread-ai Scheduled tests on: workflow_dispatch: @@ -20,7 +20,7 @@ jobs: - "3.8" - "3.11" working-directory: - - "libs/mixedbreadai" + - "libs/mixedbread-ai" steps: - uses: actions/checkout@v4 diff --git a/README.md b/README.md index 9fb65ff..01d86e7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,3 @@ -# langchain-mixedbreadai +# langchain-mixedbread-ai This repository contains the [Mixedbread AI](https://www.mixedbread.ai) Integration with Langchain. diff --git a/libs/mixedbreadai/.gitignore b/libs/mixedbread-ai/.gitignore similarity index 100% rename from libs/mixedbreadai/.gitignore rename to libs/mixedbread-ai/.gitignore diff --git a/libs/mixedbreadai/LICENSE b/libs/mixedbread-ai/LICENSE similarity index 100% rename from libs/mixedbreadai/LICENSE rename to libs/mixedbread-ai/LICENSE diff --git a/libs/mixedbreadai/Makefile b/libs/mixedbread-ai/Makefile similarity index 89% rename from libs/mixedbreadai/Makefile rename to libs/mixedbread-ai/Makefile index 4e063ef..61b8938 100644 --- a/libs/mixedbreadai/Makefile +++ b/libs/mixedbread-ai/Makefile @@ -24,8 +24,8 @@ integration_test integration_tests: PYTHON_FILES=. MYPY_CACHE=.mypy_cache lint format: PYTHON_FILES=. -lint_diff format_diff: PYTHON_FILES=$(shell git diff --relative=libs/partners/mixedbreadai --name-only --diff-filter=d master | grep -E '\.py$$|\.ipynb$$') -lint_package: PYTHON_FILES=langchain_mixedbreadai +lint_diff format_diff: PYTHON_FILES=$(shell git diff --relative=libs/partners/mixedbread-ai --name-only --diff-filter=d master | grep -E '\.py$$|\.ipynb$$') +lint_package: PYTHON_FILES=langchain_mixedbread_ai lint_tests: PYTHON_FILES=tests lint_tests: MYPY_CACHE=.mypy_cache_test @@ -45,7 +45,7 @@ spell_check: spell_fix: poetry run codespell --toml pyproject.toml -w -check_imports: $(shell find langchain_mixedbreadai -name '*.py') +check_imports: $(shell find langchain_mixedbread_ai -name '*.py') poetry run python ./scripts/check_imports.py $^ ###################### diff --git a/libs/mixedbreadai/README.md b/libs/mixedbread-ai/README.md similarity index 88% rename from libs/mixedbreadai/README.md rename to libs/mixedbread-ai/README.md index afb6871..3967c35 100644 --- a/libs/mixedbreadai/README.md +++ b/libs/mixedbread-ai/README.md @@ -1,11 +1,11 @@ -# langchain-mixedbreadai +# langchain-mixedbread-ai -This package contains the LangChain integration with MixedbreadAI +This package contains the LangChain integration with Mixedbread AI ## Installation ```bash -pip install -U langchain-mixedbreadai +pip install -U langchain-mixedbread-ai ``` And you should configure credentials by setting the following environment variables: @@ -17,7 +17,7 @@ And you should configure credentials by setting the following environment variab `MixedbreadAIEmbeddings` class exposes embeddings from MixedbreadAI. ```python -from langchain_mixedbreadai import MixedbreadAIEmbeddings +from langchain_mixedbread_ai import MixedbreadAIEmbeddings embeddings = MixedbreadAIEmbeddings(mxbai_api_key="a legit baker id") embeddings.embed_query("What is the meaning of life?") @@ -28,7 +28,7 @@ embeddings.embed_query("What is the meaning of life?") `MixedbreadAIRerank` class exposes reranker from MixedbreadAI. ```python -from langchain_mixedbreadai import MixedbreadAIRerank +from langchain_mixedbread_ai import MixedbreadAIRerank reranker = MixedbreadAIRerank(mxbai_api_key="a legit baker id", top_n=3) reranker.rerank( diff --git a/libs/mixedbreadai/docs/mixedbreadai-embeddings.ipynb b/libs/mixedbread-ai/docs/mixedbreadai-embeddings.ipynb similarity index 99% rename from libs/mixedbreadai/docs/mixedbreadai-embeddings.ipynb rename to libs/mixedbread-ai/docs/mixedbreadai-embeddings.ipynb index 235b3ab..61dcf78 100644 --- a/libs/mixedbreadai/docs/mixedbreadai-embeddings.ipynb +++ b/libs/mixedbread-ai/docs/mixedbreadai-embeddings.ipynb @@ -30,7 +30,7 @@ "outputs": [], "source": [ "# install package\n", - "%pip install -U langchain-mixedbreadai" + "%pip install -U langchain-mixedbread-ai" ] }, { @@ -60,7 +60,7 @@ }, "outputs": [], "source": [ - "from langchain_mixedbreadai.embeddings import EncodingFormat, MixedbreadAIEmbeddings\n", + "from langchain_mixedbread_ai.embeddings import EncodingFormat, MixedbreadAIEmbeddings\n", "\n", "your_api_key = \"you need a key to your oven\"\n", "\n", diff --git a/libs/mixedbreadai/docs/mixedbreadai-rerank.ipynb b/libs/mixedbread-ai/docs/mixedbreadai-rerank.ipynb similarity index 98% rename from libs/mixedbreadai/docs/mixedbreadai-rerank.ipynb rename to libs/mixedbread-ai/docs/mixedbreadai-rerank.ipynb index 12fab1b..3d28e64 100644 --- a/libs/mixedbreadai/docs/mixedbreadai-rerank.ipynb +++ b/libs/mixedbread-ai/docs/mixedbreadai-rerank.ipynb @@ -30,7 +30,7 @@ "outputs": [], "source": [ "# install package\n", - "%pip install -U langchain-mixedbreadai" + "%pip install -U langchain-mixedbread-ai" ] }, { @@ -60,7 +60,7 @@ }, "outputs": [], "source": [ - "from langchain_mixedbreadai.rerank import MixedbreadAIRerank\n", + "from langchain_mixedbread_ai.rerank import MixedbreadAIRerank\n", "\n", "your_api_key = \"a key to oven\"\n", "\n", diff --git a/libs/mixedbreadai/langchain_mixedbreadai/__init__.py b/libs/mixedbread-ai/langchain_mixedbread_ai/__init__.py similarity index 73% rename from libs/mixedbreadai/langchain_mixedbreadai/__init__.py rename to libs/mixedbread-ai/langchain_mixedbread_ai/__init__.py index ab6113c..51fd36c 100644 --- a/libs/mixedbreadai/langchain_mixedbreadai/__init__.py +++ b/libs/mixedbread-ai/langchain_mixedbread_ai/__init__.py @@ -1,7 +1,7 @@ from importlib import metadata -from langchain_mixedbreadai.embeddings import MixedbreadAIEmbeddings -from langchain_mixedbreadai.rerank import MixedbreadAIRerank +from langchain_mixedbread_ai.embeddings import MixedbreadAIEmbeddings +from langchain_mixedbread_ai.rerank import MixedbreadAIRerank try: __version__ = metadata.version(__package__) diff --git a/libs/mixedbreadai/langchain_mixedbreadai/client.py b/libs/mixedbread-ai/langchain_mixedbread_ai/client.py similarity index 98% rename from libs/mixedbreadai/langchain_mixedbreadai/client.py rename to libs/mixedbread-ai/langchain_mixedbread_ai/client.py index 6823e43..5919c7a 100644 --- a/libs/mixedbreadai/langchain_mixedbreadai/client.py +++ b/libs/mixedbread-ai/langchain_mixedbread_ai/client.py @@ -8,7 +8,7 @@ USER_AGENT = "@mixedbread-ai/langchain" -class MixedBreadAIClient(BaseModel): +class MixedbreadAIClient(BaseModel): _client: MixedbreadAI = Field(default=None, exclude=True) _aclient: AsyncMixedbreadAI = Field(default=None, exclude=True) _request_options: Optional[RequestOptions] = Field(default=None, exclude=True) diff --git a/libs/mixedbreadai/langchain_mixedbreadai/embeddings.py b/libs/mixedbread-ai/langchain_mixedbread_ai/embeddings.py similarity index 97% rename from libs/mixedbreadai/langchain_mixedbreadai/embeddings.py rename to libs/mixedbread-ai/langchain_mixedbread_ai/embeddings.py index b13d80b..dab0618 100644 --- a/libs/mixedbreadai/langchain_mixedbreadai/embeddings.py +++ b/libs/mixedbread-ai/langchain_mixedbread_ai/embeddings.py @@ -6,12 +6,12 @@ from langchain_core.utils.iter import batch_iterate from mixedbread_ai.types import EncodingFormat, TruncationStrategy # type: ignore -from langchain_mixedbreadai.client import MixedBreadAIClient +from langchain_mixedbread_ai.client import MixedbreadAIClient logger = logging.getLogger(__name__) -class MixedbreadAIEmbeddings(MixedBreadAIClient, Embeddings): +class MixedbreadAIEmbeddings(MixedbreadAIClient, Embeddings): """ Implements the Embeddings interface with Mixedbread AI's embedding API. diff --git a/libs/mixedbreadai/langchain_mixedbreadai/py.typed b/libs/mixedbread-ai/langchain_mixedbread_ai/py.typed similarity index 100% rename from libs/mixedbreadai/langchain_mixedbreadai/py.typed rename to libs/mixedbread-ai/langchain_mixedbread_ai/py.typed diff --git a/libs/mixedbreadai/langchain_mixedbreadai/rerank.py b/libs/mixedbread-ai/langchain_mixedbread_ai/rerank.py similarity index 97% rename from libs/mixedbreadai/langchain_mixedbreadai/rerank.py rename to libs/mixedbread-ai/langchain_mixedbread_ai/rerank.py index fff7a67..03cbe81 100644 --- a/libs/mixedbreadai/langchain_mixedbreadai/rerank.py +++ b/libs/mixedbread-ai/langchain_mixedbread_ai/rerank.py @@ -9,10 +9,10 @@ from langchain_core.pydantic_v1 import Field from mixedbread_ai import RankedDocument # type: ignore -from langchain_mixedbreadai.client import MixedBreadAIClient +from langchain_mixedbread_ai.client import MixedbreadAIClient -class MixedbreadAIRerank(MixedBreadAIClient, BaseDocumentCompressor): +class MixedbreadAIRerank(MixedbreadAIClient, BaseDocumentCompressor): """ Document compressor that uses `Mixedbread AI Rerank API`. diff --git a/libs/mixedbreadai/poetry.lock b/libs/mixedbread-ai/poetry.lock similarity index 100% rename from libs/mixedbreadai/poetry.lock rename to libs/mixedbread-ai/poetry.lock diff --git a/libs/mixedbreadai/pyproject.toml b/libs/mixedbread-ai/pyproject.toml similarity index 98% rename from libs/mixedbreadai/pyproject.toml rename to libs/mixedbread-ai/pyproject.toml index e02090d..b999b24 100644 --- a/libs/mixedbreadai/pyproject.toml +++ b/libs/mixedbread-ai/pyproject.toml @@ -10,7 +10,7 @@ repository = "https://github.com/mixedbread-ai/langchain-mixedbread-ai" license = "MIT" [tool.poetry.urls] -"Source Code" = "https://github.com/mixedbread-ai/langchain-mixedbreadai.git/tree/main/libs/mixedbread-ai" +"Source Code" = "https://github.com/mixedbread-ai/langchain-mixedbread-ai.git/tree/main/libs/mixedbread-ai" [tool.poetry.dependencies] python = ">=3.8.1,<4.0" diff --git a/libs/mixedbreadai/scripts/check_imports.py b/libs/mixedbread-ai/scripts/check_imports.py similarity index 100% rename from libs/mixedbreadai/scripts/check_imports.py rename to libs/mixedbread-ai/scripts/check_imports.py diff --git a/libs/mixedbreadai/scripts/check_pydantic.sh b/libs/mixedbread-ai/scripts/check_pydantic.sh similarity index 100% rename from libs/mixedbreadai/scripts/check_pydantic.sh rename to libs/mixedbread-ai/scripts/check_pydantic.sh diff --git a/libs/mixedbreadai/scripts/lint_imports.sh b/libs/mixedbread-ai/scripts/lint_imports.sh similarity index 100% rename from libs/mixedbreadai/scripts/lint_imports.sh rename to libs/mixedbread-ai/scripts/lint_imports.sh diff --git a/libs/mixedbreadai/tests/__init__.py b/libs/mixedbread-ai/tests/__init__.py similarity index 100% rename from libs/mixedbreadai/tests/__init__.py rename to libs/mixedbread-ai/tests/__init__.py diff --git a/libs/mixedbreadai/tests/conftest.py b/libs/mixedbread-ai/tests/conftest.py similarity index 100% rename from libs/mixedbreadai/tests/conftest.py rename to libs/mixedbread-ai/tests/conftest.py diff --git a/libs/mixedbreadai/tests/integration_tests/__init__.py b/libs/mixedbread-ai/tests/integration_tests/__init__.py similarity index 100% rename from libs/mixedbreadai/tests/integration_tests/__init__.py rename to libs/mixedbread-ai/tests/integration_tests/__init__.py diff --git a/libs/mixedbreadai/tests/integration_tests/cassettes/test_langchain_mixedbreadai_embedding_documents.yaml b/libs/mixedbread-ai/tests/integration_tests/cassettes/test_langchain_mixedbreadai_embedding_documents.yaml similarity index 100% rename from libs/mixedbreadai/tests/integration_tests/cassettes/test_langchain_mixedbreadai_embedding_documents.yaml rename to libs/mixedbread-ai/tests/integration_tests/cassettes/test_langchain_mixedbreadai_embedding_documents.yaml diff --git a/libs/mixedbreadai/tests/integration_tests/cassettes/test_langchain_mixedbreadai_embedding_query.yaml b/libs/mixedbread-ai/tests/integration_tests/cassettes/test_langchain_mixedbreadai_embedding_query.yaml similarity index 100% rename from libs/mixedbreadai/tests/integration_tests/cassettes/test_langchain_mixedbreadai_embedding_query.yaml rename to libs/mixedbread-ai/tests/integration_tests/cassettes/test_langchain_mixedbreadai_embedding_query.yaml diff --git a/libs/mixedbreadai/tests/integration_tests/cassettes/test_langchain_mixedbreadai_rerank.yaml b/libs/mixedbread-ai/tests/integration_tests/cassettes/test_langchain_mixedbreadai_rerank.yaml similarity index 100% rename from libs/mixedbreadai/tests/integration_tests/cassettes/test_langchain_mixedbreadai_rerank.yaml rename to libs/mixedbread-ai/tests/integration_tests/cassettes/test_langchain_mixedbreadai_rerank.yaml diff --git a/libs/mixedbreadai/tests/integration_tests/test_compile.py b/libs/mixedbread-ai/tests/integration_tests/test_compile.py similarity index 100% rename from libs/mixedbreadai/tests/integration_tests/test_compile.py rename to libs/mixedbread-ai/tests/integration_tests/test_compile.py diff --git a/libs/mixedbreadai/tests/integration_tests/test_embeddings.py b/libs/mixedbread-ai/tests/integration_tests/test_embeddings.py similarity index 67% rename from libs/mixedbreadai/tests/integration_tests/test_embeddings.py rename to libs/mixedbread-ai/tests/integration_tests/test_embeddings.py index 2faf0d3..6195163 100644 --- a/libs/mixedbreadai/tests/integration_tests/test_embeddings.py +++ b/libs/mixedbread-ai/tests/integration_tests/test_embeddings.py @@ -2,11 +2,11 @@ import pytest -from langchain_mixedbreadai.embeddings import MixedbreadAIEmbeddings +from langchain_mixedbread_ai.embeddings import MixedbreadAIEmbeddings @pytest.mark.vcr() -def test_langchain_mixedbreadai_embedding_documents() -> None: +def test_langchain_mixedbread_ai_embedding_documents() -> None: documents = ["foo bar"] embedding = MixedbreadAIEmbeddings() output = embedding.embed_documents(documents) @@ -15,7 +15,7 @@ def test_langchain_mixedbreadai_embedding_documents() -> None: @pytest.mark.vcr() -def test_langchain_mixedbreadai_embedding_query() -> None: +def test_langchain_mixedbread_ai_embedding_query() -> None: document = "foo bar" embedding = MixedbreadAIEmbeddings() output = embedding.embed_query(document) diff --git a/libs/mixedbreadai/tests/integration_tests/test_rerank.py b/libs/mixedbread-ai/tests/integration_tests/test_rerank.py similarity index 71% rename from libs/mixedbreadai/tests/integration_tests/test_rerank.py rename to libs/mixedbread-ai/tests/integration_tests/test_rerank.py index a016dff..86c2e8f 100644 --- a/libs/mixedbreadai/tests/integration_tests/test_rerank.py +++ b/libs/mixedbread-ai/tests/integration_tests/test_rerank.py @@ -1,10 +1,10 @@ import pytest -from langchain_mixedbreadai import MixedbreadAIRerank +from langchain_mixedbread_ai import MixedbreadAIRerank @pytest.mark.vcr() -def test_langchain_mixedbreadai_rerank() -> None: +def test_langchain_mixedbread_ai_rerank() -> None: texts = ["Mockingbird", "Moby-Dick"] query = "Moby-Dick" reranker = MixedbreadAIRerank(top_n=3) diff --git a/libs/mixedbreadai/tests/unit_tests/__init__.py b/libs/mixedbread-ai/tests/unit_tests/__init__.py similarity index 100% rename from libs/mixedbreadai/tests/unit_tests/__init__.py rename to libs/mixedbread-ai/tests/unit_tests/__init__.py diff --git a/libs/mixedbreadai/tests/unit_tests/test_embeddings.py b/libs/mixedbread-ai/tests/unit_tests/test_embeddings.py similarity index 71% rename from libs/mixedbreadai/tests/unit_tests/test_embeddings.py rename to libs/mixedbread-ai/tests/unit_tests/test_embeddings.py index 88d75e3..663b3ee 100644 --- a/libs/mixedbreadai/tests/unit_tests/test_embeddings.py +++ b/libs/mixedbread-ai/tests/unit_tests/test_embeddings.py @@ -1,6 +1,6 @@ """Test embedding model integration.""" -from langchain_mixedbreadai.embeddings import MixedbreadAIEmbeddings +from langchain_mixedbread_ai.embeddings import MixedbreadAIEmbeddings def test_initialization() -> None: diff --git a/libs/mixedbreadai/tests/unit_tests/test_imports.py b/libs/mixedbread-ai/tests/unit_tests/test_imports.py similarity index 78% rename from libs/mixedbreadai/tests/unit_tests/test_imports.py rename to libs/mixedbread-ai/tests/unit_tests/test_imports.py index ae22c2e..3e7082e 100644 --- a/libs/mixedbreadai/tests/unit_tests/test_imports.py +++ b/libs/mixedbread-ai/tests/unit_tests/test_imports.py @@ -1,4 +1,4 @@ -from langchain_mixedbreadai import __all__ +from langchain_mixedbread_ai import __all__ EXPECTED_ALL = ["MixedbreadAIEmbeddings", "MixedbreadAIRerank", "__version__"] diff --git a/libs/mixedbreadai/tests/unit_tests/test_rerank.py b/libs/mixedbread-ai/tests/unit_tests/test_rerank.py similarity index 67% rename from libs/mixedbreadai/tests/unit_tests/test_rerank.py rename to libs/mixedbread-ai/tests/unit_tests/test_rerank.py index f2b4300..0461326 100644 --- a/libs/mixedbreadai/tests/unit_tests/test_rerank.py +++ b/libs/mixedbread-ai/tests/unit_tests/test_rerank.py @@ -1,4 +1,4 @@ -from langchain_mixedbreadai.rerank import MixedbreadAIRerank +from langchain_mixedbread_ai.rerank import MixedbreadAIRerank def test_initialization() -> None: