Skip to content
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

Azure CosmosDB Mongo vCore Storage Integrations #16176

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

aayush3011
Copy link
Contributor

@aayush3011 aayush3011 commented Sep 24, 2024

Description

Storage Integration:

  • Chat Store
  • Index Store
  • KVStore
  • Document Store

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?

  • 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)

  • Yes
  • No

Type of Change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

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

Suggested Checklist:

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

@dosubot dosubot bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Sep 24, 2024
@logan-markewich logan-markewich self-assigned this Sep 25, 2024
@aayush3011
Copy link
Contributor Author

@masci @fatmelon Friendly ping on this PR.



class AzureCosmosMongoVCoreKVStore(BaseKVStore, ABC):
"""Creates an AzureCosmosMongoVCoreKVStore."""
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason that the existing mongo kvstore doesn't work for azure here?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like its using pymongo under the hood, so I would expect the existing mongo kvstore (and other associated integrations) to work fine 👀

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@logan-markewich , we want to keep our integration separate with a different user agent for tracking purposes.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aayush3011 can't we just insert the user-agent in the existing mongodb integrations? Seems like something generally useful for anyone

Otherwise we have completely duplicate code just for a small difference, feels kind of icky

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@logan-markewich we would have to somehow figure out that this is an azure cosmos mongoDB and insert the necessary user agent. To do so, the user then needs to send some keyword like"azure" or "cosmos" as a property when creating using the kvStore.

Copy link
Contributor Author

@aayush3011 aayush3011 Oct 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@logan-markewich We want to differentiate between whether its a vector store, or any other storage integration. And we have the language in the user agent as well to differentiate between Python and Typescript LlamaIndex implementation

Copy link
Collaborator

@logan-markewich logan-markewich Oct 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The kvstore is only used for doctores and index stores -- sorry, but still not seeing the argument for introducing all this code duplication and bloat just to add a user agent

We can have llama-index-docstore-py/llama-index-kvstore-py/llama-index-index-store-py be the user agent for the existing mongodb kvstores for example

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a maintainer, I do not want to debug two versions of the same class, there's already too much code in the repo as it is 😉

Copy link
Contributor Author

@aayush3011 aayush3011 Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@logan-markewich Sure, I get your point. Would this be okay if we ask the customer to send "api=azure" in the kwargs and place a check for it to add the azure cosmos db specific user agent. If this approach doesn't seems good, we can go with what you suggested.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both seem fine to me, although the approach with the least amount of effort from the user will probably be the easiest

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:XL This PR changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants