-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding AstraDB as a DocumentStore (#144)
* astra haystack integration * add delete * test * update init for AstraClient and AstraDocumentStore * Added method fetch_documents_by_id and fetch_document_by_id * Added count_document * Removed _index from init * Included batching and minor improvements in test module * bug fix:AstraClient.find_index not checking for status code and status key before getting collection from response * add update_document(), insert(), and find_document() to AstraClient, refactor upsert() * implement write_documents * Add precommit hook and git actions * Minor changes to documentation and add requirements file * Refactor json calls to AstraClient * rename folder * Add example script * add convert_filters function * fix write_documents failng with DuplicatePolicy.FAIL when there are no duplicates. * log additional info for insert and update in AstraDataStore.write_documents() * fix: fixing document parsing and filter documents bugs * Add to search and delete to example * Adding reqs and remove mistaken pop content * adding logger back to astra client * haystack version matching Document schema * set duplicates policy on datastore init, set default duplicate policy for write_documents to None * Prepare for ci cd * Add tests to git actions * Modifying haystack rag pipeline example * Update return type from queryResponse to Document * Update single retriever parent references * Add rag example and readme * Update examples with DuplicatePolicy * Update Readme with DuplicatePolicy * fix cicd pipeline * remove describe index stats * Update requirements.txt and pyproject.toml with haystack versions * select haystack 1.22.1 * pop id_hash_keys from metadata in Response object * fix requirements for pipeline_example * fix haystack version typo in pyproject.toml * fix id_hash_key can't be set at haystack Document init * comment out currently unused indexing pipeline in examples/example.py * refoctor find * Add unit tests * Skip tests with unsupported filter * more fixes * fixing unit test link * more fixes * Add model_name to astra_store on initializing in test_document_store.py * all tests passing * Convert document[id] to document[_id] in write_documents * Change id to _id in filter_documents * fix lint isssue for python3.9 * fixing similarity score flag * pipeline example fix * examples document type fix * Black Linting fixes * change to pyproject.toml to use haystack 2.0, update test_document_store.py imports and tests for haysyack 2.0, remove readme, license, and pyproject.toml from tests dir * use new Document dataclass * skip tests * update write_documents for haystack 2.0 * remove -m "unit" option in Actions to not deselect tests * remove model_name from test_document_store.py * Fix setting default duplicates policy * test if datastore empty before deleting * Raise exception if Document _id not string when writing documents * Implement batch size for delete limited to 20 * filters mapping * add test for default write documents behavior * add to_dict and from_dict * update examples * update retriever for haystack 2.0. Fix integration tests for updated retriever. * fix linting errors * remove preprocessor.py in examples/ * Pipeline examples document fix * pipeline examples lint fix * prepare for directory structure in haystack integrations repo * Add Ci + Add PR fixes * Linter fixes * Update integrations/astra/tests/test_document_store.py Co-authored-by: Julian Risch <[email protected]> --------- Co-authored-by: Rihab Ben Aicha <[email protected]> Co-authored-by: Mouna Tayahi <[email protected]> Co-authored-by: ElenaKusevska <[email protected]> Co-authored-by: Jagannath S Bilgi <[email protected]> Co-authored-by: david-polo <[email protected]> Co-authored-by: Obioma Anomnachi <[email protected]> Co-authored-by: Elena Kusevska <[email protected]> Co-authored-by: mouna <[email protected]> Co-authored-by: Mouna Tayahi <[email protected]> Co-authored-by: mounaTay <[email protected]> Co-authored-by: Julian Risch <[email protected]>
- Loading branch information
12 people
authored
Jan 11, 2024
1 parent
cbdc5d1
commit 0b55a52
Showing
21 changed files
with
2,220 additions
and
1 deletion.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # This workflow comes from https://github.com/ofek/hatch-mypyc | ||
| # https://github.com/ofek/hatch-mypyc/blob/5a198c0ba8660494d02716cfc9d79ce4adfb1442/.github/workflows/test.yml | ||
| name: Test / astra | ||
|
|
||
| on: | ||
| schedule: | ||
| - cron: "0 0 * * *" | ||
| pull_request: | ||
| paths: | ||
| - 'integrations/astra/**' | ||
| - '.github/workflows/astra.yml' | ||
|
|
||
| defaults: | ||
| run: | ||
| working-directory: integrations/astra | ||
|
|
||
| concurrency: | ||
| group: astra-${{ github.head_ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| env: | ||
| PYTHONUNBUFFERED: "1" | ||
| FORCE_COLOR: "1" | ||
|
|
||
| jobs: | ||
| run: | ||
| name: Python ${{ matrix.python-version }} on ${{ startsWith(matrix.os, 'macos-') && 'macOS' || startsWith(matrix.os, 'windows-') && 'Windows' || 'Linux' }} | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| fail-fast: false | ||
| max-parallel: 1 | ||
| matrix: | ||
| os: [ubuntu-latest, windows-latest, macos-latest] | ||
| python-version: ['3.9', '3.10'] | ||
|
|
||
| steps: | ||
| - name: Support longpaths | ||
| if: matrix.os == 'windows-latest' | ||
| working-directory: . | ||
| run: git config --system core.longpaths true | ||
|
|
||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up Python ${{ matrix.python-version }} | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
|
|
||
| - name: Install Hatch | ||
| run: pip install --upgrade hatch | ||
|
|
||
| - name: Lint | ||
| if: matrix.python-version == '3.9' && runner.os == 'Linux' | ||
| run: hatch run lint:all | ||
|
|
||
| - name: Run tests | ||
| env: | ||
| ASTRA_DB_APPLICATION_TOKEN: ${{ secrets.ASTRA_DB_APPLICATION_TOKEN }} | ||
| ASTRA_DB_ID: ${{ secrets.ASTRA_DB_ID }} | ||
| run: hatch run cov |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,201 @@ | ||
| Apache License | ||
| Version 2.0, January 2004 | ||
| http://www.apache.org/licenses/ | ||
|
|
||
| TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
|
||
| 1. Definitions. | ||
|
|
||
| "License" shall mean the terms and conditions for use, reproduction, | ||
| and distribution as defined by Sections 1 through 9 of this document. | ||
|
|
||
| "Licensor" shall mean the copyright owner or entity authorized by | ||
| the copyright owner that is granting the License. | ||
|
|
||
| "Legal Entity" shall mean the union of the acting entity and all | ||
| other entities that control, are controlled by, or are under common | ||
| control with that entity. For the purposes of this definition, | ||
| "control" means (i) the power, direct or indirect, to cause the | ||
| direction or management of such entity, whether by contract or | ||
| otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
| outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
|
||
| "You" (or "Your") shall mean an individual or Legal Entity | ||
| exercising permissions granted by this License. | ||
|
|
||
| "Source" form shall mean the preferred form for making modifications, | ||
| including but not limited to software source code, documentation | ||
| source, and configuration files. | ||
|
|
||
| "Object" form shall mean any form resulting from mechanical | ||
| transformation or translation of a Source form, including but | ||
| not limited to compiled object code, generated documentation, | ||
| and conversions to other media types. | ||
|
|
||
| "Work" shall mean the work of authorship, whether in Source or | ||
| Object form, made available under the License, as indicated by a | ||
| copyright notice that is included in or attached to the work | ||
| (an example is provided in the Appendix below). | ||
|
|
||
| "Derivative Works" shall mean any work, whether in Source or Object | ||
| form, that is based on (or derived from) the Work and for which the | ||
| editorial revisions, annotations, elaborations, or other modifications | ||
| represent, as a whole, an original work of authorship. For the purposes | ||
| of this License, Derivative Works shall not include works that remain | ||
| separable from, or merely link (or bind by name) to the interfaces of, | ||
| the Work and Derivative Works thereof. | ||
|
|
||
| "Contribution" shall mean any work of authorship, including | ||
| the original version of the Work and any modifications or additions | ||
| to that Work or Derivative Works thereof, that is intentionally | ||
| submitted to Licensor for inclusion in the Work by the copyright owner | ||
| or by an individual or Legal Entity authorized to submit on behalf of | ||
| the copyright owner. For the purposes of this definition, "submitted" | ||
| means any form of electronic, verbal, or written communication sent | ||
| to the Licensor or its representatives, including but not limited to | ||
| communication on electronic mailing lists, source code control systems, | ||
| and issue tracking systems that are managed by, or on behalf of, the | ||
| Licensor for the purpose of discussing and improving the Work, but | ||
| excluding communication that is conspicuously marked or otherwise | ||
| designated in writing by the copyright owner as "Not a Contribution." | ||
|
|
||
| "Contributor" shall mean Licensor and any individual or Legal Entity | ||
| on behalf of whom a Contribution has been received by Licensor and | ||
| subsequently incorporated within the Work. | ||
|
|
||
| 2. Grant of Copyright License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| copyright license to reproduce, prepare Derivative Works of, | ||
| publicly display, publicly perform, sublicense, and distribute the | ||
| Work and such Derivative Works in Source or Object form. | ||
|
|
||
| 3. Grant of Patent License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| (except as stated in this section) patent license to make, have made, | ||
| use, offer to sell, sell, import, and otherwise transfer the Work, | ||
| where such license applies only to those patent claims licensable | ||
| by such Contributor that are necessarily infringed by their | ||
| Contribution(s) alone or by combination of their Contribution(s) | ||
| with the Work to which such Contribution(s) was submitted. If You | ||
| institute patent litigation against any entity (including a | ||
| cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
| or a Contribution incorporated within the Work constitutes direct | ||
| or contributory patent infringement, then any patent licenses | ||
| granted to You under this License for that Work shall terminate | ||
| as of the date such litigation is filed. | ||
|
|
||
| 4. Redistribution. You may reproduce and distribute copies of the | ||
| Work or Derivative Works thereof in any medium, with or without | ||
| modifications, and in Source or Object form, provided that You | ||
| meet the following conditions: | ||
|
|
||
| (a) You must give any other recipients of the Work or | ||
| Derivative Works a copy of this License; and | ||
|
|
||
| (b) You must cause any modified files to carry prominent notices | ||
| stating that You changed the files; and | ||
|
|
||
| (c) You must retain, in the Source form of any Derivative Works | ||
| that You distribute, all copyright, patent, trademark, and | ||
| attribution notices from the Source form of the Work, | ||
| excluding those notices that do not pertain to any part of | ||
| the Derivative Works; and | ||
|
|
||
| (d) If the Work includes a "NOTICE" text file as part of its | ||
| distribution, then any Derivative Works that You distribute must | ||
| include a readable copy of the attribution notices contained | ||
| within such NOTICE file, excluding those notices that do not | ||
| pertain to any part of the Derivative Works, in at least one | ||
| of the following places: within a NOTICE text file distributed | ||
| as part of the Derivative Works; within the Source form or | ||
| documentation, if provided along with the Derivative Works; or, | ||
| within a display generated by the Derivative Works, if and | ||
| wherever such third-party notices normally appear. The contents | ||
| of the NOTICE file are for informational purposes only and | ||
| do not modify the License. You may add Your own attribution | ||
| notices within Derivative Works that You distribute, alongside | ||
| or as an addendum to the NOTICE text from the Work, provided | ||
| that such additional attribution notices cannot be construed | ||
| as modifying the License. | ||
|
|
||
| You may add Your own copyright statement to Your modifications and | ||
| may provide additional or different license terms and conditions | ||
| for use, reproduction, or distribution of Your modifications, or | ||
| for any such Derivative Works as a whole, provided Your use, | ||
| reproduction, and distribution of the Work otherwise complies with | ||
| the conditions stated in this License. | ||
|
|
||
| 5. Submission of Contributions. Unless You explicitly state otherwise, | ||
| any Contribution intentionally submitted for inclusion in the Work | ||
| by You to the Licensor shall be under the terms and conditions of | ||
| this License, without any additional terms or conditions. | ||
| Notwithstanding the above, nothing herein shall supersede or modify | ||
| the terms of any separate license agreement you may have executed | ||
| with Licensor regarding such Contributions. | ||
|
|
||
| 6. Trademarks. This License does not grant permission to use the trade | ||
| names, trademarks, service marks, or product names of the Licensor, | ||
| except as required for reasonable and customary use in describing the | ||
| origin of the Work and reproducing the content of the NOTICE file. | ||
|
|
||
| 7. Disclaimer of Warranty. Unless required by applicable law or | ||
| agreed to in writing, Licensor provides the Work (and each | ||
| Contributor provides its Contributions) on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
| implied, including, without limitation, any warranties or conditions | ||
| of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
| PARTICULAR PURPOSE. You are solely responsible for determining the | ||
| appropriateness of using or redistributing the Work and assume any | ||
| risks associated with Your exercise of permissions under this License. | ||
|
|
||
| 8. Limitation of Liability. In no event and under no legal theory, | ||
| whether in tort (including negligence), contract, or otherwise, | ||
| unless required by applicable law (such as deliberate and grossly | ||
| negligent acts) or agreed to in writing, shall any Contributor be | ||
| liable to You for damages, including any direct, indirect, special, | ||
| incidental, or consequential damages of any character arising as a | ||
| result of this License or out of the use or inability to use the | ||
| Work (including but not limited to damages for loss of goodwill, | ||
| work stoppage, computer failure or malfunction, or any and all | ||
| other commercial damages or losses), even if such Contributor | ||
| has been advised of the possibility of such damages. | ||
|
|
||
| 9. Accepting Warranty or Additional Liability. While redistributing | ||
| the Work or Derivative Works thereof, You may choose to offer, | ||
| and charge a fee for, acceptance of support, warranty, indemnity, | ||
| or other liability obligations and/or rights consistent with this | ||
| License. However, in accepting such obligations, You may act only | ||
| on Your own behalf and on Your sole responsibility, not on behalf | ||
| of any other Contributor, and only if You agree to indemnify, | ||
| defend, and hold each Contributor harmless for any liability | ||
| incurred by, or claims asserted against, such Contributor by reason | ||
| of your accepting any such warranty or additional liability. | ||
|
|
||
| END OF TERMS AND CONDITIONS | ||
|
|
||
| APPENDIX: How to apply the Apache License to your work. | ||
|
|
||
| To apply the Apache License to your work, attach the following | ||
| boilerplate notice, with the fields enclosed by brackets "[]" | ||
| replaced with your own identifying information. (Don't include | ||
| the brackets!) The text should be enclosed in the appropriate | ||
| comment syntax for the file format. We also recommend that a | ||
| file or class name and description of purpose be included on the | ||
| same "printed page" as the copyright notice for easier | ||
| identification within third-party archives. | ||
|
|
||
| Copyright 2023-present deepset GmbH | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| [](https://github.com/deepset-ai/document-store/actions/workflows/test.yml) | ||
|
|
||
| # Astra Store | ||
|
|
||
| ## Installation | ||
| install astra-haystack package locally to run integration tests: | ||
|
|
||
| Open in gitpod: | ||
| [](https://gitpod.io/#https://github.com/Anant/astra-haystack/tree/main) | ||
|
|
||
| Switch Python version to 3.9 (Requires 3.8+ but not 3.12) | ||
| ``` | ||
| pyenv install 3.9 | ||
| pyenv local 3.9 | ||
| ``` | ||
|
|
||
| Local install for the package | ||
| `pip install -e .` | ||
| To execute integration tests, add needed environment variables | ||
| `ASTRA_DB_ID=<id>` | ||
| `ASTRA_DB_APPLICATION_TOKEN=<token>` | ||
| and execute | ||
| `python examples/example.py` | ||
|
|
||
| Install requirements | ||
| `pip install -r requirements.txt` | ||
|
|
||
| Export environment variables | ||
| ``` | ||
| export KEYSPACE_NAME= | ||
| export COLLECTION_NAME= | ||
| export OPENAI_API_KEY= | ||
| export ASTRA_DB_ID= | ||
| export ASTRA_DB_REGION= | ||
| export ASTRA_DB_APPLICATION_TOKEN= | ||
| ``` | ||
|
|
||
| run the python examples | ||
| `python example/example.py` | ||
| or | ||
| `python example/pipeline_example.py` | ||
|
|
||
| ## Usage | ||
|
|
||
| This package includes Astra Document Store and Astra Retriever classes that integrate with Haystack, allowing you to easily perform document retrieval or RAG with Astra, and include those functions in Haystack pipelines. | ||
|
|
||
| ### In order to use the Document Store directly: | ||
|
|
||
| Import the Document Store: | ||
| ``` | ||
| from astra_store.document_store import AstraDocumentStore | ||
| from haystack.preview.document_stores import DuplicatePolicy | ||
| ``` | ||
|
|
||
| Load in environment variables: | ||
| ``` | ||
| astra_id = os.getenv("ASTRA_DB_ID", "") | ||
| astra_region = os.getenv("ASTRA_DB_REGION", "us-east1") | ||
| astra_application_token = os.getenv("ASTRA_DB_APPLICATION_TOKEN", "") | ||
| collection_name = os.getenv("COLLECTION_NAME", "haystack_vector_search") | ||
| keyspace_name = os.getenv("KEYSPACE_NAME", "recommender_demo") | ||
| ``` | ||
|
|
||
| Create the Document Store object: | ||
| ``` | ||
| document_store = AstraDocumentStore( | ||
| astra_id=astra_id, | ||
| astra_region=astra_region, | ||
| astra_collection=collection_name, | ||
| astra_keyspace=keyspace_name, | ||
| astra_application_token=astra_application_token, | ||
| duplicates_policy=DuplicatePolicy.SKIP, | ||
| embedding_dim=384, | ||
| ) | ||
| ``` | ||
|
|
||
| Then you can use the document store functions like count_document below: | ||
| `document_store.count_documents()` | ||
|
|
||
| ### Using the Astra Retriever with Haystack Pipelines | ||
|
|
||
| Create the Document Store object like above, then import and create the Pipeline: | ||
|
|
||
| ``` | ||
| from haystack.preview import Pipeline | ||
| pipeline = Pipeline() | ||
| ``` | ||
|
|
||
| Add your AstraRetriever into the pipeline | ||
| `pipeline.add_component(instance=AstraSingleRetriever(document_store=document_store), name="retriever")` | ||
|
|
||
| Add other components and connect them as desired. Then run your pipeline: | ||
| `pipeline.run(...)` |
Empty file.
Oops, something went wrong.