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

Auto Hashing ID for VectorDB Classes #4746

Open
wants to merge 6 commits into
base: 0.2
Choose a base branch
from

Conversation

mattbeardey
Copy link

Why are these changes needed?

These changes allow for users to use the MongoDBAtlas class with more modifiability. This includes enabling users to pass in embeddings, without need to create in the class (note this functionality can be extended to other VectorDB), and make use of MongoDB auto ID assignment, removing the need to insert ID at upload.

Related issue number

Closes #4728

Checks

@mattbeard03
Copy link

@mattbeardey please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, 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 Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@microsoft-github-policy-service agree

@mattbeardey
Copy link
Author

@microsoft-github-policy-service agree

@codecov-commenter
Copy link

codecov-commenter commented Dec 18, 2024

Codecov Report

Attention: Patch coverage is 0% with 39 lines in your changes missing coverage. Please review.

Project coverage is 28.86%. Comparing base (8a8fcd8) to head (3ca0a7a).
Report is 10 commits behind head on 0.2.

Files with missing lines Patch % Lines
autogen/agentchat/contrib/vectordb/mongodb.py 0.00% 39 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##              0.2    #4746      +/-   ##
==========================================
- Coverage   29.30%   28.86%   -0.44%     
==========================================
  Files         117      117              
  Lines       13013    13049      +36     
  Branches     2469     2474       +5     
==========================================
- Hits         3813     3767      -46     
- Misses       8854     8935      +81     
- Partials      346      347       +1     
Flag Coverage Δ
unittests 28.86% <0.00%> (-0.44%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ekzhu ekzhu requested a review from Copilot December 18, 2024 01:57

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

Copy link
Collaborator

@ekzhu ekzhu left a comment

Choose a reason for hiding this comment

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

@mattbeardey
Copy link
Author

Copy link
Collaborator

@thinkall thinkall left a comment

Choose a reason for hiding this comment

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

Thank you very much for the PR, @mattbeardey ! I've left some comments. However, my major concern is that with this PR, MongoDBAtlasVectorDB is no more compatible with other vectordbs in autogen if a user created db w/o giving document ids.

I'd prefer set default id for Document with something like

chunk_ids = (
[hashlib.blake2b(chunk.encode("utf-8")).hexdigest()[:HASH_LENGTH] for chunk in chunks]
if not self._vector_db.type == "qdrant"
else [str(uuid.UUID(hex=hashlib.md5(chunk.encode("utf-8")).hexdigest())) for chunk in chunks]
)

if users just don't want to set document ids manually. Is this your case, or you need to use mongodb auto generated ids for some reason?

WDYT? Thanks.

autogen/agentchat/contrib/vectordb/mongodb.py Outdated Show resolved Hide resolved
autogen/agentchat/contrib/vectordb/mongodb.py Outdated Show resolved Hide resolved
autogen/agentchat/contrib/vectordb/mongodb.py Outdated Show resolved Hide resolved
@thinkall thinkall added the 0.2 Issues which are related to the pre 0.4 codebase label Dec 18, 2024
@mattbeardey
Copy link
Author

Hi @thinkall , thoughts on fbfc164, where the ID Hashing is implemented in the base.py class, and inherited throughout, with qdrant.py implementing its own class, as per your provided code. Thanks

@thinkall
Copy link
Collaborator

Hi @thinkall , thoughts on fbfc164, where the ID Hashing is implemented in the base.py class, and inherited throughout, with qdrant.py implementing its own class, as per your provided code. Thanks

This commit looks good to me. Thank you, @mattbeardey .

@mattbeardey mattbeardey changed the title MongoDB ID None allow and pre made embeddings allow Auto Hashing ID and PreMade Embedding for VectorDB Classes Dec 21, 2024
@mattbeardey mattbeardey changed the title Auto Hashing ID and PreMade Embedding for VectorDB Classes Auto Hashing ID for VectorDB Classes Dec 21, 2024
@mattbeardey
Copy link
Author

Hi @thinkall , @ekzhu

Scaled back the PR to focus on ID only, will look to embeddings as a separate topic, as I believe there may be a need for definition on what a "Embedding Function" is, and what it returns (i.e. errors with the "to_list" method not guaranteed to be present. Will handle separately.

Please find latest pull. Thanks. Please review when possible.

Copy link
Collaborator

@thinkall thinkall left a comment

Choose a reason for hiding this comment

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

Thank you @mattbeardey , focusing on ID is a good idea!
I've just one suggestion, others look good to me!

@@ -123,7 +123,11 @@ def _wait_for_document(self, collection: Collection, index_name: str, doc: Docum
if query_result and query_result[0][0]["_id"] == doc["id"]:
return
sleep(_DELAY)

if query_result and float(query_result[0][1]) == 1.0:
Copy link
Collaborator

Choose a reason for hiding this comment

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

We may want to have documents with exactly the same content but different metadata. Like comments from different users. I'd suggest log a warning message instead of raising an error. And it's not a TimeoutError if it's an error. WDYT?

Copy link
Author

Choose a reason for hiding this comment

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

Adjusted now with a logger.warning, and check for metadata.

Copy link
Collaborator

@thinkall thinkall left a comment

Choose a reason for hiding this comment

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

LGTM, thank you @mattbeardey !

@thinkall
Copy link
Collaborator

@ekzhu , do we still support openai tests for 0.2 in the CI pipeline?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0.2 Issues which are related to the pre 0.4 codebase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

MongoDB Vector Database File Upload requires "Id" despite MongoDB Atlas automatically assigning an ID.
5 participants