This repository has been archived by the owner on Nov 13, 2024. It is now read-only.
KB initial docstring #76
Merged
Conversation
This file contains 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
Comment on lines
57
to
59
| Init the knowledge base object. | ||
| Note: The knowledge base is not connected to the index | ||
| until connect() is called. |
There was a problem hiding this comment.
Should probably include a minimal example of how to use a knowledgeBase, something like:
When creating a new Resin service, the user must first create the underlying Pinecone index.
This is a one-time setup process - the index will exist on Pinecone's managed service until it is deleted.>>> kb = KnowLedgeBase('my_index') >>> kb.create_resin_index()In any future interactions, the user simply needs to connect to the existing service:
>>> kb = KnowLedgeBase('my_index') >>> kb.connect() .... kb.upsert(my_documents) knowledge_base.query(queries=[Query(text="Who was the president in 1996?", top_k=10)])
Comment on lines
71
to
72
| index_params: A dictionary of parameters to pass to the index creation API. | ||
| see https://docs.pinecone.io/docs/python-client#create_index |
There was a problem hiding this comment.
(@acatav I agree, adding this param to the constructor is really ugly...
I'll try to find a way to remove it and still support from_config.
igiloh-pinecone
suggested changes
Oct 17, 2023
Co-authored-by: igiloh-pinecone <118673156+igiloh-pinecone@users.noreply.github.com>
…ings-template # Conflicts: # resin/knoweldge_base/base.py
Co-authored-by: igiloh-pinecone <118673156+igiloh-pinecone@users.noreply.github.com>
Co-authored-by: igiloh-pinecone <118673156+igiloh-pinecone@users.noreply.github.com>
Co-authored-by: igiloh-pinecone <118673156+igiloh-pinecone@users.noreply.github.com>
Co-authored-by: igiloh-pinecone <118673156+igiloh-pinecone@users.noreply.github.com>
Co-authored-by: igiloh-pinecone <118673156+igiloh-pinecone@users.noreply.github.com>
Co-authored-by: igiloh-pinecone <118673156+igiloh-pinecone@users.noreply.github.com>
Co-authored-by: igiloh-pinecone <118673156+igiloh-pinecone@users.noreply.github.com>
Co-authored-by: igiloh-pinecone <118673156+igiloh-pinecone@users.noreply.github.com>
igiloh-pinecone
approved these changes
Oct 17, 2023
# Conflicts: # src/resin/knoweldge_base/knowledge_base.py
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Initial docstrings for KB
Type of Change
Test Plan
No need