-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Merged
Merged
Changes from 4 commits
Commits
Show all changes
19 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 dc08c6e
Update src/oss/python/integrations/document_transformers/localai_rera…
mkhludnev 3131da4
Merge branch 'main' into localai-reranker
mkhludnev d3921ae
Update src/oss/python/integrations/document_transformers/localai_rera…
mkhludnev 3eb2473
Update src/oss/python/integrations/document_transformers/localai_rera…
mkhludnev b287901
Merge branch 'main' into localai-reranker
mkhludnev 728d80e
Merge branch 'main' into localai-reranker
mkhludnev 54ed250
Merge branch 'main' into localai-reranker
mkhludnev f7317a5
Merge branch 'main' into localai-reranker
mkhludnev b887539
Merge branch 'main' into localai-reranker
mkhludnev 7dbba4b
Merge branch 'main' into localai-reranker
mkhludnev 06f8550
Apply suggestion from @mdrxy
mdrxy b90232b
Apply suggestion from @mdrxy
mdrxy 499417d
Merge branch 'main' into localai-reranker
mdrxy 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
30 changes: 30 additions & 0 deletions
30
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,30 @@ | ||
| --- | ||
| 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) | ||
mkhludnev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
mdrxy marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| </Info> | ||
|
|
||
| This notebook shows how to use [LocalAI Reranker API](https://localai.io/features/reranker/) for document compression and retrieval. | ||
mkhludnev marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 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). | ||
mdrxy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ```bash | ||
mkhludnev marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| pip install -U langchain-localai | ||
| ``` | ||
|
|
||
| ```python | ||
| from langchain_localai import LocalAIRerank | ||
| from langchain_core.documents import Document | ||
|
|
||
| reranker = LocalAIRerank( | ||
| openai_api_key="foo", | ||
mkhludnev marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 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") | ||
mkhludnev marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
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.