Added docs for PebbloRetrievalQA chain #40
Closed
Conversation
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
rahul-trip
approved these changes
May 27, 2024
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "%pip install --upgrade --quiet langchain langchain-community langchain-openai qdrant_client" |
| "\n", | ||
| "**PebbloRetrievalQA chain supports the following vector databases:**\n", | ||
| "- Qdrant\n", | ||
| "- Pinecone\n", |
There was a problem hiding this comment.
Is pinecone fully supported? just checking.
Comment on lines
114
to
120
| " \"pebblo_semantic_topics\": [\"financial-report\"],\n", | ||
| " \"pebblo_semantic_entities\": [\"us-bank-account-number\"],\n", |
Comment on lines
164
to
172
| " llm=llm,\n", | ||
| " app_name=\"pebblo-identity-retriever-app\",\n", | ||
| " retriever=vectordb.as_retriever(),\n", | ||
| " verbose=True,\n", |
There was a problem hiding this comment.
owner, description should be added ?
| "source": [ | ||
| "auth = {\n", | ||
| " \"user_id\": \"[email protected]\",\n", | ||
| " \"authorized_identities\": [\n", |
There was a problem hiding this comment.
authorized_identities in AuthContext is renamed to user_auth
srics
reviewed
May 29, 2024
| "> PebbloRetrievalQA is a Retrieval chain with Identity & Semantic Enforcement for question-answering\n", | ||
| "against a vector database.\n", | ||
| "\n", | ||
| "This notebook covers how to retrieve documents using Identity & Semantic Enforcement (Deny Topics/Entities).\n", |
There was a problem hiding this comment.
Add a sentence/link here such as "You can also visit for more details on Pebblo and its SafeRetriever feature"
| "### Steps:\n", | ||
| "\n", | ||
| "1. **Loading Documents:**\n", | ||
| "We will load documents with authorization and semantic metadata into an in-memory Qdrant vectorstore. This vectorstore will be used as a retriever in PebbloRetrievalQA.\n", |
There was a problem hiding this comment.
Add a note here about using PebbloSafeLoader to load docs with auth & semantic metadata. We want to convey that this chain is best used with PebbloSafeLoader as the counterpart on the ingestion side.
| "id": "33a8afe1-3071-4118-9714-a17cba809ee4", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "### Using PromptTemplate to provide additional instructions\n", |
There was a problem hiding this comment.
Add section number ...
Suggested change
| "### Using PromptTemplate to provide additional instructions\n", | |
| "### 3. Using PromptTemplate to provide additional instructions\n", |
| "source": [ | ||
| "### 1. Without semantic enforcement\n", | ||
| "\n", | ||
| "Since no semantic enforcement is applied, the system should return the answer.\n" |
There was a problem hiding this comment.
Suggested change
| "Since no semantic enforcement is applied, the system should return the answer.\n" | |
| "Since no semantic enforcement is applied, the system should return the answer without excluding any context due to semantic labels associated with the context..\n" |
Raj725
force-pushed
the
pebblo_retrieval_chain_docs
branch
2 times, most recently
from
734fa6e to
a2bd828
Compare
Raj725
force-pushed
the
pebblo_retrieval_chain_docs
branch
from
a2bd828 to
fc4c4bb
Compare
Raj725
force-pushed
the
pebblo_retrieval_chain_docs
branch
2 times, most recently
from
121e5e8 to
75bac79
Compare
Raj725
force-pushed
the
pebblo_retrieval_chain_docs
branch
from
75bac79 to
1ab796b
Compare
|
Closing this PR as the code/docs changes are merged to Langchain master via langchain-ai#20746 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.