-
Notifications
You must be signed in to change notification settings - Fork 270
feat: Add Amazon S3 Vectors document store integration #3149
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
dotKokott
wants to merge
12
commits into
deepset-ai:main
Choose a base branch
from
dotKokott:feature/amazon-s3-vectors-integration
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.
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
7a0960d
feat: add Amazon S3 Vectors document store integration
dotKokott c6c808e
fix: pin boto3>=1.42.0, fix pydoc filename, quote GITHUB_OUTPUT in wo…
dotKokott 7381e96
fix: pin haystack-ai>=2.26.1 for FilterPolicy support
dotKokott ef0cbfc
refactor: align test style with repo conventions
dotKokott 3a542d4
refactor: trim tests to high-signal only
dotKokott 88362a7
docs: add service limits to component docstrings
dotKokott 56876ec
Refactor S3 Vectors document store: use Haystack built-in filter util…
dotKokott 52854c6
ci: add AWS authentication step for integration tests
dotKokott fdc3067
docs: use single backticks for inline code in docstrings
dotKokott f229a90
docs(amazon-s3-vectors): minimize README to repo convention
dotKokott c7b42e2
fix(amazon-s3-vectors): validate all documents up front in write_docu…
dotKokott 3eb9a38
test(amazon-s3-vectors): adopt Haystack base test mixins for integrat…
dotKokott 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
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
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
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,156 @@ | ||
| # This workflow comes from https://github.com/ofek/hatch-mypyc | ||
| # https://github.com/ofek/hatch-mypyc/blob/5a198c0ba8660494d02716cfc9d79ce4adfb1442/.github/workflows/test.yml | ||
| name: Test / amazon-s3-vectors | ||
|
|
||
| on: | ||
| schedule: | ||
| - cron: "0 0 * * *" | ||
| pull_request: | ||
| paths: | ||
| - "integrations/amazon_s3_vectors/**" | ||
| - "!integrations/amazon_s3_vectors/*.md" | ||
| - ".github/workflows/amazon_s3_vectors.yml" | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - "integrations/amazon_s3_vectors/**" | ||
| - "!integrations/amazon_s3_vectors/*.md" | ||
| - ".github/workflows/amazon_s3_vectors.yml" | ||
|
|
||
| defaults: | ||
| run: | ||
| working-directory: integrations/amazon_s3_vectors | ||
|
|
||
| concurrency: | ||
| group: amazon_s3_vectors-${{ github.head_ref || github.sha }} | ||
| cancel-in-progress: true | ||
|
|
||
| permissions: | ||
| id-token: write | ||
| contents: read | ||
|
|
||
| env: | ||
| PYTHONUNBUFFERED: "1" | ||
| FORCE_COLOR: "1" | ||
| TEST_MATRIX_OS: '["ubuntu-latest", "windows-latest", "macos-latest"]' | ||
| TEST_MATRIX_PYTHON: '["3.10", "3.14"]' | ||
|
|
||
| AWS_REGION: "us-east-1" | ||
|
|
||
| jobs: | ||
| compute-test-matrix: | ||
| runs-on: ubuntu-slim | ||
| defaults: | ||
| run: | ||
| working-directory: . | ||
| outputs: | ||
| os: ${{ steps.set.outputs.os }} | ||
| python-version: ${{ steps.set.outputs.python-version }} | ||
| steps: | ||
| - id: set | ||
| run: | | ||
| echo 'os=${{ github.event_name == 'push' && '["ubuntu-latest"]' || env.TEST_MATRIX_OS }}' >> "$GITHUB_OUTPUT" | ||
| echo 'python-version=${{ github.event_name == 'push' && '["3.10"]' || env.TEST_MATRIX_PYTHON }}' >> "$GITHUB_OUTPUT" | ||
|
|
||
| run: | ||
| name: Python ${{ matrix.python-version }} on ${{ startsWith(matrix.os, 'macos-') && 'macOS' || startsWith(matrix.os, 'windows-') && 'Windows' || 'Linux' }} | ||
| needs: compute-test-matrix | ||
| permissions: | ||
| id-token: write | ||
| contents: write | ||
| pull-requests: write | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| os: ${{ fromJSON(needs.compute-test-matrix.outputs.os) }} | ||
| python-version: ${{ fromJSON(needs.compute-test-matrix.outputs.python-version) }} | ||
|
|
||
| steps: | ||
| - name: Support longpaths | ||
| if: matrix.os == 'windows-latest' | ||
| working-directory: . | ||
| run: git config --system core.longpaths true | ||
|
|
||
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
|
|
||
| - name: Set up Python ${{ matrix.python-version }} | ||
| uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
|
|
||
| - name: Install Hatch | ||
| run: pip install --upgrade hatch | ||
| - name: Lint | ||
| if: matrix.python-version == '3.10' && runner.os == 'Linux' | ||
| run: hatch run fmt-check && hatch run test:types | ||
|
|
||
| - name: Run unit tests | ||
| run: hatch run test:unit-cov-retry | ||
|
|
||
| # On PR: posts coverage comment (directly on same-repo PRs; via artifact for fork PRs). On push to main: stores coverage baseline on data branch. | ||
| - name: Store unit tests coverage | ||
| id: coverage_comment | ||
| if: matrix.python-version == '3.10' && runner.os == 'Linux' && github.event_name != 'schedule' | ||
| uses: py-cov-action/python-coverage-comment-action@7188638f871f721a365d644f505d1ff3df20d683 # v3.40 | ||
| with: | ||
| GITHUB_TOKEN: ${{ github.token }} | ||
| COVERAGE_PATH: integrations/amazon_s3_vectors | ||
| SUBPROJECT_ID: amazon_s3_vectors | ||
| MINIMUM_GREEN: 90 | ||
| MINIMUM_ORANGE: 60 | ||
|
|
||
| - name: Upload coverage comment to be posted | ||
| if: matrix.python-version == '3.10' && runner.os == 'Linux' && github.event_name == 'pull_request' && steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true' | ||
| uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 | ||
| with: | ||
| name: coverage-comment-amazon_s3_vectors | ||
| path: python-coverage-comment-action-amazon_s3_vectors.txt | ||
|
|
||
| # Do not authenticate on PRs from forks and on PRs created by dependabot | ||
| - name: AWS authentication | ||
| id: aws-auth | ||
| if: github.event_name == 'schedule' || (github.event.pull_request.head.repo.full_name == github.repository && !startsWith(github.event.pull_request.head.ref, 'dependabot/')) | ||
| uses: aws-actions/configure-aws-credentials@ec61189d14ec14c8efccab744f656cffd0e33f37 | ||
| with: | ||
| aws-region: ${{ env.AWS_REGION }} | ||
| role-to-assume: ${{ secrets.AWS_CI_ROLE_ARN }} | ||
|
|
||
| - name: Run integration tests | ||
| if: success() && steps.aws-auth.outcome == 'success' | ||
| run: hatch run test:integration-cov-append-retry | ||
|
|
||
| - name: Store combined coverage | ||
| if: github.event_name == 'push' | ||
| uses: py-cov-action/python-coverage-comment-action@7188638f871f721a365d644f505d1ff3df20d683 # v3.40 | ||
| with: | ||
| GITHUB_TOKEN: ${{ github.token }} | ||
| COVERAGE_PATH: integrations/amazon_s3_vectors | ||
| SUBPROJECT_ID: amazon_s3_vectors-combined | ||
| MINIMUM_GREEN: 90 | ||
| MINIMUM_ORANGE: 60 | ||
|
|
||
| - name: Run unit tests with lowest direct dependencies | ||
| if: github.event_name != 'push' | ||
| run: | | ||
| hatch run uv pip compile pyproject.toml --resolution lowest-direct --output-file requirements_lowest_direct.txt | ||
| hatch -e test env run -- uv pip install -r requirements_lowest_direct.txt | ||
| hatch run test:unit | ||
|
|
||
| - name: Nightly - run unit tests with Haystack main branch | ||
| if: github.event_name == 'schedule' | ||
| run: | | ||
| hatch env prune | ||
| hatch -e test env run -- uv pip install git+https://github.com/deepset-ai/haystack.git@main | ||
| hatch run test:unit | ||
|
|
||
|
|
||
| notify-slack-on-failure: | ||
| needs: run | ||
| if: failure() && github.event_name == 'schedule' | ||
| runs-on: ubuntu-slim | ||
| steps: | ||
| - uses: deepset-ai/notify-slack-action@3cda73b77a148f16f703274198e7771340cf862b # v1 | ||
| with: | ||
| slack-webhook-url: ${{ secrets.SLACK_WEBHOOK_URL_NOTIFICATIONS }} | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.