diff options
Diffstat (limited to '.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info')
6 files changed, 366 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/INSTALLER b/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/INSTALLER new file mode 100644 index 00000000..a1b589e3 --- /dev/null +++ b/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/INSTALLER @@ -0,0 +1 @@ +pip diff --git a/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/METADATA b/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/METADATA new file mode 100644 index 00000000..c27d808e --- /dev/null +++ b/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/METADATA @@ -0,0 +1,133 @@ +Metadata-Version: 2.4 +Name: vecs +Version: 0.4.5 +Summary: pgvector client +Home-page: https://github.com/supabase/vecs +Author: Oliver Rice +License: MIT +Classifier: Development Status :: 4 - Beta +Classifier: Natural Language :: English +Classifier: Operating System :: OS Independent +Classifier: Programming Language :: Python +Classifier: Programming Language :: Python :: 3 +Classifier: Programming Language :: Python :: 3.8 +Classifier: Programming Language :: Python :: 3.9 +Classifier: Programming Language :: Python :: 3.10 +Classifier: Programming Language :: Python :: 3.11 +Classifier: Programming Language :: Python :: 3.12 +Description-Content-Type: text/markdown +License-File: LICENSE +Requires-Dist: pgvector==0.3.* +Requires-Dist: sqlalchemy==2.* +Requires-Dist: psycopg2-binary==2.9.* +Requires-Dist: flupy==1.* +Requires-Dist: deprecated==1.2.* +Provides-Extra: dev +Requires-Dist: pytest; extra == "dev" +Requires-Dist: parse; extra == "dev" +Requires-Dist: numpy; extra == "dev" +Requires-Dist: pytest-cov; extra == "dev" +Provides-Extra: docs +Requires-Dist: mkdocs; extra == "docs" +Requires-Dist: pygments; extra == "docs" +Requires-Dist: pymdown-extensions; extra == "docs" +Requires-Dist: pymarkdown; extra == "docs" +Requires-Dist: mike; extra == "docs" +Provides-Extra: text-embedding +Requires-Dist: sentence-transformers==2.*; extra == "text-embedding" +Dynamic: author +Dynamic: classifier +Dynamic: description +Dynamic: description-content-type +Dynamic: home-page +Dynamic: license +Dynamic: license-file +Dynamic: provides-extra +Dynamic: requires-dist +Dynamic: summary + +# vecs + +<p> + <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.7+-blue.svg" alt="Python version" height="18"></a> + <a href="https://github.com/supabase/vecs/actions"> + <img src="https://github.com/supabase/vecs/workflows/tests/badge.svg" alt="test status" height="18"> + </a> + <a href="https://github.com/supabase/vecs/actions"> + <img src="https://github.com/supabase/vecs/workflows/pre-commit/badge.svg" alt="Pre-commit Status" height="18"> + </a> +</p> + +<p> + <a href="https://badge.fury.io/py/vecs"><img src="https://badge.fury.io/py/vecs.svg" alt="PyPI version" height="18"></a> + <a href="https://github.com/supabase/vecs/blob/master/LICENSE"><img src="https://img.shields.io/pypi/l/markdown-subtemplate.svg" alt="License" height="18"></a> + <a href="https://pypi.org/project/vecs/"><img src="https://img.shields.io/pypi/dm/vecs.svg" alt="Download count" height="18"></a> +</p> + +--- + +**Documentation**: <a href="https://supabase.github.io/vecs/latest/" target="_blank">https://supabase.github.io/vecs/latest/</a> + +**Source Code**: <a href="https://github.com/supabase/vecs" target="_blank">https://github.com/supabase/vecs</a> + +--- + +`vecs` is a python client for managing and querying vector stores in PostgreSQL with the [pgvector extension](https://github.com/pgvector/pgvector). This guide will help you get started with using vecs. + +If you don't have a Postgres database with the pgvector ready, see [hosting](https://supabase.github.io/vecs/hosting/) for easy options. + +## Installation + +Requires: + +- Python 3.7+ + +You can install vecs using pip: + +```sh +pip install vecs +``` + +## Usage + +Visit the [quickstart guide](https://supabase.github.io/vecs/latest/api) for more complete info. + +```python +import vecs + +DB_CONNECTION = "postgresql://<user>:<password>@<host>:<port>/<db_name>" + +# create vector store client +vx = vecs.create_client(DB_CONNECTION) + +# create a collection of vectors with 3 dimensions +docs = vx.get_or_create_collection(name="docs", dimension=3) + +# add records to the *docs* collection +docs.upsert( + records=[ + ( + "vec0", # the vector's identifier + [0.1, 0.2, 0.3], # the vector. list or np.array + {"year": 1973} # associated metadata + ), + ( + "vec1", + [0.7, 0.8, 0.9], + {"year": 2012} + ) + ] +) + +# index the collection for fast search performance +docs.create_index() + +# query the collection filtering metadata for "year" = 2012 +docs.query( + data=[0.4,0.5,0.6], # required + limit=1, # number of records to return + filters={"year": {"$eq": 2012}}, # metadata filters +) + +# Returns: ["vec1"] +``` diff --git a/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/RECORD b/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/RECORD new file mode 100644 index 00000000..3f6a68e6 --- /dev/null +++ b/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/RECORD @@ -0,0 +1,24 @@ +vecs-0.4.5.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4 +vecs-0.4.5.dist-info/METADATA,sha256=jEquoQguzcgyxtidGIJtv3X6H0ST-75e1P9zsz2JbIE,4295 +vecs-0.4.5.dist-info/RECORD,, +vecs-0.4.5.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91 +vecs-0.4.5.dist-info/licenses/LICENSE,sha256=yVuuHRzgI17MzTVgt3LsHvuX80innw--CmNPDCzO_iw,11358 +vecs-0.4.5.dist-info/top_level.txt,sha256=7JC5S8fIo5nRx7rqmlDIY7cUXifh0RabJ728hnZemdM,5 +vecs/__init__.py,sha256=77E9camiWOFWOyc-NfTbUjqtdAEthCSJfJrxSY2os6M,516 +vecs/__pycache__/__init__.cpython-312.pyc,, +vecs/__pycache__/client.cpython-312.pyc,, +vecs/__pycache__/collection.cpython-312.pyc,, +vecs/__pycache__/exc.cpython-312.pyc,, +vecs/adapter/__init__.py,sha256=Ip5lyoPdrjgx5YY26JUZYzaSI7F34lbL4FsgN6laPf4,363 +vecs/adapter/__pycache__/__init__.cpython-312.pyc,, +vecs/adapter/__pycache__/base.cpython-312.pyc,, +vecs/adapter/__pycache__/markdown.cpython-312.pyc,, +vecs/adapter/__pycache__/noop.cpython-312.pyc,, +vecs/adapter/__pycache__/text.cpython-312.pyc,, +vecs/adapter/base.py,sha256=rWxbY4pWGNaCJvMQVRoaOeqji7nYS3SSKvKfcqycmTo,3269 +vecs/adapter/markdown.py,sha256=TR4EVnX9L8h6zFXG_Zx0FIFtt3JRhW9GPwXSkUCF2GY,3082 +vecs/adapter/noop.py,sha256=8TqsEScMMlCmcFoh4PBP4EOwnRzdqPDUFS8mqqAX6EM,1668 +vecs/adapter/text.py,sha256=x4H_RJ77-mml3JxiKkKcKA1qHsm4Wyxbs9AZkZ_7aZ0,5239 +vecs/client.py,sha256=4VYmFDjNM5BW2XV0Hd_Qr10alKpvEpnZ_HFuzwYPbiY,7218 +vecs/collection.py,sha256=Ot0aAMooeF82Zp_NVMdSOlaqaMUyMZEZM4w6D0uWxCk,34063 +vecs/exc.py,sha256=R6bHhbDjmwPg9UeZFJFkxTrzgcO73oES4f1NRBQCn-Q,1687 diff --git a/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/WHEEL b/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/WHEEL new file mode 100644 index 00000000..17e2e07c --- /dev/null +++ b/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/WHEEL @@ -0,0 +1,5 @@ +Wheel-Version: 1.0 +Generator: setuptools (77.0.3) +Root-Is-Purelib: true +Tag: py3-none-any + diff --git a/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/licenses/LICENSE b/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/licenses/LICENSE new file mode 100644 index 00000000..57bc88a1 --- /dev/null +++ b/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/licenses/LICENSE @@ -0,0 +1,202 @@ + 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 [yyyy] [name of copyright owner] + + 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. + diff --git a/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/top_level.txt b/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/top_level.txt new file mode 100644 index 00000000..e5feb212 --- /dev/null +++ b/.venv/lib/python3.12/site-packages/vecs-0.4.5.dist-info/top_level.txt @@ -0,0 +1 @@ +vecs |