Contribute the WordLift Vector Store

[ziodave]

Description

Add support for the WordLift Vector Store.

Fixes #12107

New Package?

Did I fill in the tool.llamahub section in the pyproject.toml and provide a detailed README.md for my new integration or package?

• [x] Yes
• [ ] No

Version Bump?

Did I bump the version in the pyproject.toml file of the package I am updating? (Except for the llama-index-core package)

• [x] Yes
• [ ] No

Type of Change

• [x] New feature (non-breaking change which adds functionality)

How Has This Been Tested?

• [x] Added new unit/integration tests
• [x] Added new notebook (that tests end-to-end)
• [ ] I stared at the code and made sure it makes sense

Suggested Checklist:

• [x] I have performed a self-review of my own code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [x] I have added Google Colab support for the newly added notebooks.
• [x] My changes generate no new warnings
• [x] I have added tests that prove my fix is effective or that my feature works
• [x] New and existing unit tests pass locally with my changes
• [x] I ran make format; make lint to appease the lint gods

[review-notebook-app[bot]]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[logan-markewich]

@ziodave Seems like the tests aren't working. Have you tried running them locally?

[ziodave]

@ziodave Seems like the tests aren't working. Have you tried running them locally?

@logan-markewich yes, sorry I converted the PR to draft until we fix it. May I ask, we recreated the ubuntu-latest-unit-tester in our organization GH Runners so that we can have the GH Actions run on our fork, https://github.com/wordlift/llama_index/actions/runs/8800952266.

Oddly enough the tests pass there, is there a special configuration we need to apply to the GH Runner? This is basically the configuration we did:

cc @EthanWordlift

[logan-markewich]

@ziodave I don't think any special config is needed.

The errors in the test seem unrelated to env though

# Get the key to use for the operation.
>       key = await self.key_provider.for_query(query)
E       TypeError: object str can't be used in 'await' expression

[ziodave]

@logan-markewich we're on it, we'll update the PR soon. Thanks!

[ziodave]

@logan-markewich we're ready for review 🙏

[ziodave]

This looks mostly good to me, just worried about a few UX things that might trip up users. I wonder if we can smooth out some of this or not?

Hello @logan-markewich yes, we'll review your comments and be back soon with updates and answers.

[ziodave]

Reopening after fixing the issues. Local tests succeed. We need to check here too.

[ziodave]

We're checking the Python 3.10 test.

[ziodave]

@logan-markewich we fixed the tests. Please let us know if you need more actions from our side.

Cheers.

[logan-markewich]

I think this looks good now. My remaining concern is just around the ID and metadata stuff

[ziodave]

@logan-markewich I fixed the metadata issue, we're now sending it with the request. As per the entity ID please see my comment here.