-
Notifications
You must be signed in to change notification settings - Fork 575
Documenting thirdparty langchain-localai reranker #1282
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mkhludnev
wants to merge
6
commits into
langchain-ai:main
Choose a base branch
from
mkhludnev:localai-reranker
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+34
−1
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
81552db
Documenting thirdparty langchain-localai reranker
mkhludnev d7b2086
Documenting thirdparty langchain-localai reranker
mkhludnev a8e01ed
Update src/oss/python/integrations/document_transformers/localai_rera…
mkhludnev 9865331
Update src/oss/python/integrations/document_transformers/localai_rera…
mkhludnev c6036ca
Update src/oss/python/integrations/document_transformers/localai_rera…
mkhludnev 4fa6335
Update src/oss/python/integrations/document_transformers/localai_rera…
mkhludnev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
33 changes: 33 additions & 0 deletions
33
src/oss/python/integrations/document_transformers/localai_rerank.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,33 @@ | ||||||||||||||||||
| --- | ||||||||||||||||||
| title: LocalAI Reranker | ||||||||||||||||||
| --- | ||||||||||||||||||
|
|
||||||||||||||||||
| <Info> | ||||||||||||||||||
| **`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) | ||||||||||||||||||
|
|
||||||||||||||||||
| </Info> | ||||||||||||||||||
|
|
||||||||||||||||||
| 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 | ||||||||||||||||||
| 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=os.environ.get("OPENAI_API_KEY"), | ||||||||||||||||||
| model="bge-reranker-v2-m3", | ||||||||||||||||||
| openai_api_base="http://localhost:8080", | ||||||||||||||||||
| ) | ||||||||||||||||||
|
Comment on lines
+27
to
+30
|
||||||||||||||||||
| 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", | |
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| title: LocalAI | ||
| title: LocalAI Embeddings | ||
| --- | ||
|
|
||
| <Info> | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.