From 81552db1c84ca845a45c77a318ba91c8ec138482 Mon Sep 17 00:00:00 2001 From: Mikhail Khludnev Date: Tue, 4 Nov 2025 22:45:05 +0300 Subject: [PATCH 1/9] Documenting thirdparty langchain-localai reranker Signed-off-by: Mikhail Khludnev --- .../document_transformers/localai_rerank.mdx | 30 +++++++++++++++++++ .../integrations/text_embedding/localai.mdx | 2 +- 2 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 src/oss/python/integrations/document_transformers/localai_rerank.mdx diff --git a/src/oss/python/integrations/document_transformers/localai_rerank.mdx b/src/oss/python/integrations/document_transformers/localai_rerank.mdx new file mode 100644 index 000000000..a4761b723 --- /dev/null +++ b/src/oss/python/integrations/document_transformers/localai_rerank.mdx @@ -0,0 +1,30 @@ +--- +title: LocalAI Reranker +--- + + +**`langchain-localai` is a 3rd party integration package for LocalAI. It provides a simple way to use LocalAI services in LangChain.** + +The source code is available on [Github](https://github.com/mkhludnev/langchain-localai) + + + +This notebook shows how to use [LocalAI Reranker API](https://localai.io/features/reranker/) for document compression and retrieval. +Let's load the `LocalAIRerank` class. In order to use the `LocalAIRerank` class, you need to have the LocalAI service hosted somewhere and configure the reranker. See the documentation at [localai.io/basics/getting_started/index.html](https://localai.io/basics/getting_started/index.html) and [localai.io/features/reranker/index.html](https://localai.io/features/reranker/index.html). + +```bash +pip install -U langchain-localai +``` + +```python +from langchain_localai import LocalAIRerank +from langchain_core.documents import Document + +reranker = LocalAIRerank( + openai_api_key="foo", + model="bge-reranker-v2-m3", + openai_api_base="http://localhost:8080", + ) +reranked_docs = reranker.compress_documents(documents=[ + Document(page_content="bar"),Document(page_content="baz")], query="foo") +``` diff --git a/src/oss/python/integrations/text_embedding/localai.mdx b/src/oss/python/integrations/text_embedding/localai.mdx index 0106d2f7c..83170229d 100644 --- a/src/oss/python/integrations/text_embedding/localai.mdx +++ b/src/oss/python/integrations/text_embedding/localai.mdx @@ -1,5 +1,5 @@ --- -title: LocalAI +title: LocalAI Embedding --- From d7b208657b5c05f7f91ae8e7892b57354b202fdf Mon Sep 17 00:00:00 2001 From: mkhludnev Date: Tue, 4 Nov 2025 22:51:58 +0300 Subject: [PATCH 2/9] Documenting thirdparty langchain-localai reranker Signed-off-by: Mikhail Khludnev --- src/oss/python/integrations/text_embedding/localai.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/oss/python/integrations/text_embedding/localai.mdx b/src/oss/python/integrations/text_embedding/localai.mdx index 83170229d..9f25e9ab1 100644 --- a/src/oss/python/integrations/text_embedding/localai.mdx +++ b/src/oss/python/integrations/text_embedding/localai.mdx @@ -1,5 +1,5 @@ --- -title: LocalAI Embedding +title: LocalAI Embeddings --- From a8e01edaba367f5308490d4c539f1b9e88a13be2 Mon Sep 17 00:00:00 2001 From: Mikhail Khludnev Date: Tue, 4 Nov 2025 23:02:05 +0300 Subject: [PATCH 3/9] Update src/oss/python/integrations/document_transformers/localai_rerank.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../integrations/document_transformers/localai_rerank.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/oss/python/integrations/document_transformers/localai_rerank.mdx b/src/oss/python/integrations/document_transformers/localai_rerank.mdx index a4761b723..c721c74de 100644 --- a/src/oss/python/integrations/document_transformers/localai_rerank.mdx +++ b/src/oss/python/integrations/document_transformers/localai_rerank.mdx @@ -5,7 +5,7 @@ title: LocalAI Reranker **`langchain-localai` is a 3rd party integration package for LocalAI. It provides a simple way to use LocalAI services in LangChain.** -The source code is available on [Github](https://github.com/mkhludnev/langchain-localai) +The source code is available on [GitHub](https://github.com/mkhludnev/langchain-localai) From 9865331dbfc40c32fe2ea993a10e11698b4e7354 Mon Sep 17 00:00:00 2001 From: Mikhail Khludnev Date: Tue, 4 Nov 2025 23:02:22 +0300 Subject: [PATCH 4/9] Update src/oss/python/integrations/document_transformers/localai_rerank.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../integrations/document_transformers/localai_rerank.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/oss/python/integrations/document_transformers/localai_rerank.mdx b/src/oss/python/integrations/document_transformers/localai_rerank.mdx index c721c74de..ba3f5fee5 100644 --- a/src/oss/python/integrations/document_transformers/localai_rerank.mdx +++ b/src/oss/python/integrations/document_transformers/localai_rerank.mdx @@ -26,5 +26,5 @@ reranker = LocalAIRerank( openai_api_base="http://localhost:8080", ) reranked_docs = reranker.compress_documents(documents=[ - Document(page_content="bar"),Document(page_content="baz")], query="foo") + Document(page_content="bar"), Document(page_content="baz")], query="foo") ``` From c6036ca53a25335821934725cdae6f63bd6062b0 Mon Sep 17 00:00:00 2001 From: Mikhail Khludnev Date: Wed, 5 Nov 2025 10:19:29 +0300 Subject: [PATCH 5/9] Update src/oss/python/integrations/document_transformers/localai_rerank.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../integrations/document_transformers/localai_rerank.mdx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/oss/python/integrations/document_transformers/localai_rerank.mdx b/src/oss/python/integrations/document_transformers/localai_rerank.mdx index ba3f5fee5..49c28c6e3 100644 --- a/src/oss/python/integrations/document_transformers/localai_rerank.mdx +++ b/src/oss/python/integrations/document_transformers/localai_rerank.mdx @@ -17,11 +17,14 @@ pip install -U langchain-localai ``` ```python +import os from langchain_localai import LocalAIRerank from langchain_core.documents import Document +# Set your LocalAI/OpenAI API key as an environment variable for security. +# For example, in your shell: export OPENAI_API_KEY="your-key-here" reranker = LocalAIRerank( - openai_api_key="foo", + openai_api_key=os.environ.get("OPENAI_API_KEY"), model="bge-reranker-v2-m3", openai_api_base="http://localhost:8080", ) From 4fa63352bc6bd2895401f155e506022dc90fe8b1 Mon Sep 17 00:00:00 2001 From: Mikhail Khludnev Date: Wed, 5 Nov 2025 10:19:37 +0300 Subject: [PATCH 6/9] Update src/oss/python/integrations/document_transformers/localai_rerank.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../integrations/document_transformers/localai_rerank.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/oss/python/integrations/document_transformers/localai_rerank.mdx b/src/oss/python/integrations/document_transformers/localai_rerank.mdx index 49c28c6e3..e9a0b74f6 100644 --- a/src/oss/python/integrations/document_transformers/localai_rerank.mdx +++ b/src/oss/python/integrations/document_transformers/localai_rerank.mdx @@ -9,7 +9,7 @@ The source code is available on [GitHub](https://github.com/mkhludnev/langchain- -This notebook shows how to use [LocalAI Reranker API](https://localai.io/features/reranker/) for document compression and retrieval. +This notebook shows how to use [LocalAI Reranker API](https://localai.io/features/reranker/) for document compression and retrieval. Let's load the `LocalAIRerank` class. In order to use the `LocalAIRerank` class, you need to have the LocalAI service hosted somewhere and configure the reranker. See the documentation at [localai.io/basics/getting_started/index.html](https://localai.io/basics/getting_started/index.html) and [localai.io/features/reranker/index.html](https://localai.io/features/reranker/index.html). ```bash From dc08c6e8206b43dbc701084d245910a0f08220ae Mon Sep 17 00:00:00 2001 From: Mikhail Khludnev Date: Thu, 6 Nov 2025 11:00:48 +0300 Subject: [PATCH 7/9] Update src/oss/python/integrations/document_transformers/localai_rerank.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../integrations/document_transformers/localai_rerank.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/oss/python/integrations/document_transformers/localai_rerank.mdx b/src/oss/python/integrations/document_transformers/localai_rerank.mdx index e9a0b74f6..c3a8222b0 100644 --- a/src/oss/python/integrations/document_transformers/localai_rerank.mdx +++ b/src/oss/python/integrations/document_transformers/localai_rerank.mdx @@ -24,10 +24,10 @@ from langchain_core.documents import Document # Set your LocalAI/OpenAI API key as an environment variable for security. # For example, in your shell: export OPENAI_API_KEY="your-key-here" reranker = LocalAIRerank( - openai_api_key=os.environ.get("OPENAI_API_KEY"), - model="bge-reranker-v2-m3", - openai_api_base="http://localhost:8080", - ) + openai_api_key=os.environ.get("OPENAI_API_KEY"), + model="bge-reranker-v2-m3", + openai_api_base="http://localhost:8080", +) reranked_docs = reranker.compress_documents(documents=[ Document(page_content="bar"), Document(page_content="baz")], query="foo") ``` From d3921ae0a240a22479fd6537eb4c900bfdaf3106 Mon Sep 17 00:00:00 2001 From: Mikhail Khludnev Date: Thu, 6 Nov 2025 11:04:43 +0300 Subject: [PATCH 8/9] Update src/oss/python/integrations/document_transformers/localai_rerank.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../document_transformers/localai_rerank.mdx | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/oss/python/integrations/document_transformers/localai_rerank.mdx b/src/oss/python/integrations/document_transformers/localai_rerank.mdx index c3a8222b0..7ece475ea 100644 --- a/src/oss/python/integrations/document_transformers/localai_rerank.mdx +++ b/src/oss/python/integrations/document_transformers/localai_rerank.mdx @@ -28,6 +28,12 @@ reranker = LocalAIRerank( model="bge-reranker-v2-m3", openai_api_base="http://localhost:8080", ) -reranked_docs = reranker.compress_documents(documents=[ - Document(page_content="bar"), Document(page_content="baz")], query="foo") +reranked_docs = reranker.compress_documents( + documents=[ + Document(page_content="Green tea is rich in antioxidants and may improve brain function."), + Document(page_content="Coffee contains caffeine and can increase alertness."), + Document(page_content="Black tea has a strong flavor and contains various polyphenols."), + ], + query="What are the health benefits of green tea?" +) ``` From 3eb24731ecd3fb6f9c8e14d1e519a1cd571a2d2e Mon Sep 17 00:00:00 2001 From: Mikhail Khludnev Date: Thu, 6 Nov 2025 11:05:13 +0300 Subject: [PATCH 9/9] Update src/oss/python/integrations/document_transformers/localai_rerank.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .../integrations/document_transformers/localai_rerank.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/oss/python/integrations/document_transformers/localai_rerank.mdx b/src/oss/python/integrations/document_transformers/localai_rerank.mdx index 7ece475ea..e569b8290 100644 --- a/src/oss/python/integrations/document_transformers/localai_rerank.mdx +++ b/src/oss/python/integrations/document_transformers/localai_rerank.mdx @@ -12,7 +12,7 @@ The source code is available on [GitHub](https://github.com/mkhludnev/langchain- This notebook shows how to use [LocalAI Reranker API](https://localai.io/features/reranker/) for document compression and retrieval. Let's load the `LocalAIRerank` class. In order to use the `LocalAIRerank` class, you need to have the LocalAI service hosted somewhere and configure the reranker. See the documentation at [localai.io/basics/getting_started/index.html](https://localai.io/basics/getting_started/index.html) and [localai.io/features/reranker/index.html](https://localai.io/features/reranker/index.html). -```bash +```python pip install -U langchain-localai ```