swarmauri_vectorstore_persistentchromadb 0.6.0.dev154__tar.gz → 0.6.1.dev6__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [2025] [Jacob Stewart @ Swarmauri]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,77 @@
1
+ Metadata-Version: 2.3
2
+ Name: swarmauri_vectorstore_persistentchromadb
3
+ Version: 0.6.1.dev6
4
+ Summary: A Persistent ChromaDB based Vector Store
5
+ License: Apache-2.0
6
+ Author: Jacob Stewart
7
+ Author-email: jacob@swarmauri.com
8
+ Requires-Python: >=3.10,<3.13
9
+ Classifier: License :: OSI Approved :: Apache Software License
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Programming Language :: Python :: 3.10
12
+ Classifier: Programming Language :: Python :: 3.11
13
+ Classifier: Programming Language :: Python :: 3.12
14
+ Requires-Dist: chromadb (>=0.5.17,<0.6.0)
15
+ Requires-Dist: swarmauri_base (>=0.6.1.dev6,<0.7.0)
16
+ Requires-Dist: swarmauri_core (>=0.6.1.dev6,<0.7.0)
17
+ Requires-Dist: swarmauri_embedding_doc2vec (>=0.6.1.dev6,<0.7.0)
18
+ Requires-Dist: swarmauri_standard (>=0.6.1.dev6,<0.7.0)
19
+ Project-URL: Repository, http://github.com/swarmauri/swarmauri-sdk
20
+ Description-Content-Type: text/markdown
21
+
22
+ ![Swarmauri Logo](https://res.cloudinary.com/dbjmpekvl/image/upload/v1730099724/Swarmauri-logo-lockup-2048x757_hww01w.png)
23
+
24
+ <div align="center">
25
+
26
+ ![PyPI - Downloads](https://img.shields.io/pypi/dm/swarmauri_vectorstore_persistentchromadb)
27
+ ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/swarmauri_vectorstore_persistentchromadb)
28
+ ![PyPI - License](https://img.shields.io/pypi/l/swarmauri_vectorstore_persistentchromadb)
29
+ ![PyPI - Version](https://img.shields.io/pypi/v/swarmauri_vectorstore_persistentchromadb?label=swarmauri_vectorstore_persistentchromadb&color=green)
30
+
31
+ </div>
32
+
33
+ ---
34
+
35
+ # Persistent ChromaDB Vector Store
36
+
37
+ A persistent vector store implementation using ChromaDB for document storage and retrieval with embeddings.
38
+
39
+ ## Installation
40
+
41
+ ```bash
42
+ pip install swarmauri_vectorstore_persistentchromadb
43
+ ```
44
+
45
+ ## Usage
46
+
47
+ ```python
48
+ from swarmauri.documents.Document import Document
49
+ from swarmauri.vector_stores.PersistentChromaDBVectorStore import PersistentChromaDBVectorStore
50
+
51
+ # Initialize the vector store
52
+ vector_store = PersistentChromaDBVectorStore(
53
+ path="./chromadb_data",
54
+ collection_name="my_collection",
55
+ vector_size=100
56
+ )
57
+
58
+ # Connect to the store
59
+ vector_store.connect()
60
+
61
+ # Add documents
62
+ documents = [
63
+ Document(content="first document"),
64
+ Document(content="second document"),
65
+ Document(content="third document")
66
+ ]
67
+ vector_store.add_documents(documents)
68
+
69
+ # Retrieve similar documents
70
+ results = vector_store.retrieve(query="document", top_k=2)
71
+ ```
72
+
73
+ ## Want to help?
74
+
75
+ If you want to contribute to swarmauri-sdk, read up on our [guidelines for contributing](https://github.com/swarmauri/swarmauri-sdk/blob/master/contributing.md) that will help you get started.
76
+
77
+
@@ -0,0 +1,55 @@
1
+ ![Swarmauri Logo](https://res.cloudinary.com/dbjmpekvl/image/upload/v1730099724/Swarmauri-logo-lockup-2048x757_hww01w.png)
2
+
3
+ <div align="center">
4
+
5
+ ![PyPI - Downloads](https://img.shields.io/pypi/dm/swarmauri_vectorstore_persistentchromadb)
6
+ ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/swarmauri_vectorstore_persistentchromadb)
7
+ ![PyPI - License](https://img.shields.io/pypi/l/swarmauri_vectorstore_persistentchromadb)
8
+ ![PyPI - Version](https://img.shields.io/pypi/v/swarmauri_vectorstore_persistentchromadb?label=swarmauri_vectorstore_persistentchromadb&color=green)
9
+
10
+ </div>
11
+
12
+ ---
13
+
14
+ # Persistent ChromaDB Vector Store
15
+
16
+ A persistent vector store implementation using ChromaDB for document storage and retrieval with embeddings.
17
+
18
+ ## Installation
19
+
20
+ ```bash
21
+ pip install swarmauri_vectorstore_persistentchromadb
22
+ ```
23
+
24
+ ## Usage
25
+
26
+ ```python
27
+ from swarmauri.documents.Document import Document
28
+ from swarmauri.vector_stores.PersistentChromaDBVectorStore import PersistentChromaDBVectorStore
29
+
30
+ # Initialize the vector store
31
+ vector_store = PersistentChromaDBVectorStore(
32
+ path="./chromadb_data",
33
+ collection_name="my_collection",
34
+ vector_size=100
35
+ )
36
+
37
+ # Connect to the store
38
+ vector_store.connect()
39
+
40
+ # Add documents
41
+ documents = [
42
+ Document(content="first document"),
43
+ Document(content="second document"),
44
+ Document(content="third document")
45
+ ]
46
+ vector_store.add_documents(documents)
47
+
48
+ # Retrieve similar documents
49
+ results = vector_store.retrieve(query="document", top_k=2)
50
+ ```
51
+
52
+ ## Want to help?
53
+
54
+ If you want to contribute to swarmauri-sdk, read up on our [guidelines for contributing](https://github.com/swarmauri/swarmauri-sdk/blob/master/contributing.md) that will help you get started.
55
+
@@ -1,58 +1,59 @@
1
- [tool.poetry]
2
- name = "swarmauri_vectorstore_persistentchromadb"
3
- version = "0.6.0.dev154"
4
- description = "A Persistent ChromaDB based Vector Store"
5
- authors = ["Jacob Stewart <jacob@swarmauri.com>"]
6
- license = "Apache-2.0"
7
- readme = "README.md"
8
- repository = "http://github.com/swarmauri/swarmauri-sdk"
9
- classifiers = [
10
- "License :: OSI Approved :: Apache Software License",
11
- "Programming Language :: Python :: 3.10",
12
- "Programming Language :: Python :: 3.11",
13
- "Programming Language :: Python :: 3.12"
14
- ]
15
-
16
- [tool.poetry.dependencies]
17
- python = ">=3.10,<3.13"
18
-
19
- # Swarmauri
20
- swarmauri_core = {version = "^0.6.0.dev154"}
21
- swarmauri_base = {version = "^0.6.0.dev154"}
22
- swarmauri_embedding_doc2vec = {version = "^0.6.0.dev154"}
23
-
24
-
25
- # Dependencies
26
- chromadb = "^0.5.17"
27
-
28
- [tool.poetry.group.dev.dependencies]
29
- flake8 = "^7.0"
30
- pytest = "^8.0"
31
- pytest-asyncio = ">=0.24.0"
32
- pytest-xdist = "^3.6.1"
33
- pytest-json-report = "^1.5.0"
34
- python-dotenv = "*"
35
- requests = "^2.32.3"
36
-
37
- [build-system]
38
- requires = ["poetry-core>=1.0.0"]
39
- build-backend = "poetry.core.masonry.api"
40
-
41
- [tool.pytest.ini_options]
42
- norecursedirs = ["combined", "scripts"]
43
-
44
- markers = [
45
- "test: standard test",
46
- "unit: Unit tests",
47
- "integration: Integration tests",
48
- "acceptance: Acceptance tests",
49
- "experimental: Experimental tests"
50
- ]
51
- log_cli = true
52
- log_cli_level = "INFO"
53
- log_cli_format = "%(asctime)s [%(levelname)s] %(message)s"
54
- log_cli_date_format = "%Y-%m-%d %H:%M:%S"
55
- asyncio_default_fixture_loop_scope = "function"
56
-
57
- [tool.poetry.plugins."swarmauri.vector_stores"]
1
+ [tool.poetry]
2
+ name = "swarmauri_vectorstore_persistentchromadb"
3
+ version = "0.6.1.dev6"
4
+ description = "A Persistent ChromaDB based Vector Store"
5
+ authors = ["Jacob Stewart <jacob@swarmauri.com>"]
6
+ license = "Apache-2.0"
7
+ readme = "README.md"
8
+ repository = "http://github.com/swarmauri/swarmauri-sdk"
9
+ classifiers = [
10
+ "License :: OSI Approved :: Apache Software License",
11
+ "Programming Language :: Python :: 3.10",
12
+ "Programming Language :: Python :: 3.11",
13
+ "Programming Language :: Python :: 3.12"
14
+ ]
15
+
16
+ [tool.poetry.dependencies]
17
+ python = ">=3.10,<3.13"
18
+
19
+ # Swarmauri
20
+ swarmauri_core = {version = "^0.6.1.dev6"}
21
+ swarmauri_base = {version = "^0.6.1.dev6"}
22
+ swarmauri_standard = {version = "^0.6.1.dev6"}
23
+ swarmauri_embedding_doc2vec = {version = "^0.6.1.dev6"}
24
+
25
+
26
+ # Dependencies
27
+ chromadb = "^0.5.17"
28
+
29
+ [tool.poetry.group.dev.dependencies]
30
+ flake8 = "^7.0"
31
+ pytest = "^8.0"
32
+ pytest-asyncio = ">=0.24.0"
33
+ pytest-xdist = "^3.6.1"
34
+ pytest-json-report = "^1.5.0"
35
+ python-dotenv = "*"
36
+ requests = "^2.32.3"
37
+
38
+ [build-system]
39
+ requires = ["poetry-core>=1.0.0"]
40
+ build-backend = "poetry.core.masonry.api"
41
+
42
+ [tool.pytest.ini_options]
43
+ norecursedirs = ["combined", "scripts"]
44
+
45
+ markers = [
46
+ "test: standard test",
47
+ "unit: Unit tests",
48
+ "integration: Integration tests",
49
+ "acceptance: Acceptance tests",
50
+ "experimental: Experimental tests"
51
+ ]
52
+ log_cli = true
53
+ log_cli_level = "INFO"
54
+ log_cli_format = "%(asctime)s [%(levelname)s] %(message)s"
55
+ log_cli_date_format = "%Y-%m-%d %H:%M:%S"
56
+ asyncio_default_fixture_loop_scope = "function"
57
+
58
+ [tool.poetry.plugins."swarmauri.vector_stores"]
58
59
  PersistentChromaDBVectorStore = "swarmauri_vectorstore_persistentchromadb.PersistentChromaDBVectorStore:PersistentChromaDBVectorStore"
@@ -1,188 +1,188 @@
1
- import logging
2
- import chromadb
3
-
4
- from typing import List, Union, Literal
5
-
6
- from swarmauri_standard.documents.concrete.Document import Document
7
- from swarmauri_embedding_doc2vec.Doc2VecEmbedding import Doc2VecEmbedding
8
- from swarmauri.distances.concrete.CosineDistance import CosineDistance
9
-
10
- from swarmauri.vector_stores.base.VectorStoreBase import VectorStoreBase
11
- from swarmauri.vector_stores.base.VectorStoreRetrieveMixin import (
12
- VectorStoreRetrieveMixin,
13
- )
14
- from swarmauri.vector_stores.base.VectorStoreSaveLoadMixin import (
15
- VectorStoreSaveLoadMixin,
16
- )
17
- from swarmauri.vector_stores.base.VectorStorePersistentMixin import (
18
- VectorStorePersistentMixin,
19
- )
20
- from swarmauri_core.ComponentBase import ComponentBase
21
-
22
-
23
- @ComponentBase.register_type(VectorStoreBase, "PersistentChromaDBVectorStore")
24
- class PersistentChromaDBVectorStore(
25
- VectorStoreSaveLoadMixin,
26
- VectorStoreRetrieveMixin,
27
- VectorStorePersistentMixin,
28
- VectorStoreBase,
29
- ):
30
- type: Literal["PersistentChromaDBVectorStore"] = "PersistentChromaDBVectorStore"
31
-
32
- def __init__(self, **kwargs):
33
- """
34
- Initialize the PersistentChromaDBVectorStore.
35
-
36
- Args:
37
- Args:
38
- **kwargs: keyword arguments.
39
- """
40
- super().__init__(**kwargs)
41
-
42
- self._embedder = Doc2VecEmbedding(vector_size=self.vector_size)
43
- self._distance = CosineDistance()
44
-
45
- def connect(self) -> None:
46
- """
47
- Establish a connection to ChromaDB and get or create the collection.
48
- """
49
- # settings = Settings(
50
- # chroma_api_impl="chromadb.api.fastapi.FastAPI", # Use FastAPI if LocalAPI is not supported
51
- # chroma_server_host="localhost", # Server host
52
- # chroma_server_http_port=8000, # Server port
53
- # )
54
- #
55
- # self.client = chromadb.Client(
56
- # settings=settings,
57
- # )
58
- self.client = chromadb.Client()
59
-
60
- self.collection = self.client.get_or_create_collection(
61
- name=self.collection_name
62
- )
63
- logging.info(
64
- f"Connected to ChromaDB at {self.path}, collection: {self.collection_name}"
65
- )
66
-
67
- def disconnect(self) -> None:
68
- """
69
- Close the connection to ChromaDB.
70
- """
71
- if self.client:
72
- # Perform any necessary cleanup here
73
- self.client = None
74
- self.collection = None
75
-
76
- def add_document(self, document: Document) -> None:
77
- embedding = None
78
- if not document.embedding:
79
- self._embedder.fit([document.content]) # Fit only once
80
- embedding = (
81
- self._embedder.transform([document.content])[0].to_numpy().tolist()
82
- )
83
- else:
84
- embedding = document.embedding
85
-
86
- self.collection.add(
87
- ids=[document.id],
88
- documents=[document.content],
89
- embeddings=[embedding],
90
- metadatas=[document.metadata],
91
- )
92
-
93
- def add_documents(self, documents: List[Document]) -> None:
94
- ids = [doc.id for doc in documents]
95
- texts = [doc.content for doc in documents]
96
-
97
- for doc in documents:
98
- self._embedder.fit([doc.content])
99
-
100
- embeddings = [
101
- self._embedder.infer_vector(doc.content).value for doc in documents
102
- ]
103
- metadatas = [doc.metadata for doc in documents]
104
- if metadatas[0]:
105
- self.collection.add(
106
- ids=ids, documents=texts, embeddings=embeddings, metadatas=metadatas
107
- )
108
- else:
109
- self.collection.add(ids=ids, documents=texts, embeddings=embeddings)
110
-
111
- def get_document(self, doc_id: str) -> Union[Document, None]:
112
- results = self.collection.get(ids=[doc_id])
113
- if not results["metadatas"][0]:
114
- results["metadatas"][0] = {}
115
- if results["ids"]:
116
- document = Document(
117
- id=results["ids"][0],
118
- content=results["documents"][0],
119
- metadata=results["metadatas"][0],
120
- )
121
- return document
122
- return None
123
-
124
- def get_all_documents(self) -> List[Document]:
125
- results = self.collection.get()
126
- documents = [
127
- Document(
128
- id=results["ids"][idx],
129
- content=results["documents"][idx],
130
- metadata=results["metadatas"][idx],
131
- )
132
- for idx in range(len(results["ids"]))
133
- ]
134
- return documents
135
-
136
- def delete_document(self, doc_id: str) -> None:
137
- self.collection.delete(ids=[doc_id])
138
-
139
- def update_document(self, doc_id: str, updated_document: Document) -> None:
140
- document_vector = None
141
- # Precompute the embedding outside the update process
142
- if not updated_document.embedding:
143
- # Transform without refitting to avoid vocabulary issues
144
- document_vector = self._embedder.transform([updated_document.content])[0]
145
- else:
146
- document_vector = updated_document.embedding
147
-
148
- document_vector = document_vector.to_numpy().tolist()
149
-
150
- updated_document.embedding = document_vector
151
-
152
- self.delete_document(doc_id)
153
- self.add_document(updated_document)
154
-
155
- def clear_documents(self) -> None:
156
- documents = self.get_all_documents()
157
- doc_ids = [doc.id for doc in documents]
158
- self.collection.delete(ids=doc_ids)
159
-
160
- def document_count(self) -> int:
161
- return len(self.get_all_documents())
162
-
163
- def retrieve(self, query: str, top_k: int = 5) -> List[Document]:
164
- query_embedding = self._embedder.infer_vector(query).value
165
- # print(query_embedding)
166
-
167
- results = self.collection.query(
168
- query_embeddings=query_embedding, n_results=top_k
169
- )
170
-
171
- return [
172
- Document(
173
- id=results["ids"][0][idx],
174
- content=results["documents"][0][idx],
175
- metadata=(
176
- results["metadatas"][0][idx] if results["metadatas"][0][idx] else {}
177
- ),
178
- )
179
- for idx in range(len(results["ids"][0]))
180
- ]
181
-
182
- # Override the model_dump_json method
183
- def model_dump_json(self, *args, **kwargs) -> str:
184
- # Call the disconnect method before serialization
185
- self.disconnect()
186
-
187
- # Now proceed with the usual JSON serialization
188
- return super().model_dump_json(*args, **kwargs)
1
+ import logging
2
+ import chromadb
3
+
4
+ from typing import List, Union, Literal
5
+
6
+ from swarmauri_standard.documents.Document import Document
7
+ from swarmauri_embedding_doc2vec.Doc2VecEmbedding import Doc2VecEmbedding
8
+ from swarmauri_standard.distances.CosineDistance import CosineDistance
9
+
10
+ from swarmauri_base.vector_stores.VectorStoreBase import VectorStoreBase
11
+ from swarmauri_base.vector_stores.VectorStoreRetrieveMixin import (
12
+ VectorStoreRetrieveMixin,
13
+ )
14
+ from swarmauri_base.vector_stores.VectorStoreSaveLoadMixin import (
15
+ VectorStoreSaveLoadMixin,
16
+ )
17
+ from swarmauri_base.vector_stores.VectorStorePersistentMixin import (
18
+ VectorStorePersistentMixin,
19
+ )
20
+ from swarmauri_core.ComponentBase import ComponentBase
21
+
22
+
23
+ @ComponentBase.register_type(VectorStoreBase, "PersistentChromaDBVectorStore")
24
+ class PersistentChromaDBVectorStore(
25
+ VectorStoreSaveLoadMixin,
26
+ VectorStoreRetrieveMixin,
27
+ VectorStorePersistentMixin,
28
+ VectorStoreBase,
29
+ ):
30
+ type: Literal["PersistentChromaDBVectorStore"] = "PersistentChromaDBVectorStore"
31
+
32
+ def __init__(self, **kwargs):
33
+ """
34
+ Initialize the PersistentChromaDBVectorStore.
35
+
36
+ Args:
37
+ Args:
38
+ **kwargs: keyword arguments.
39
+ """
40
+ super().__init__(**kwargs)
41
+
42
+ self._embedder = Doc2VecEmbedding(vector_size=self.vector_size)
43
+ self._distance = CosineDistance()
44
+
45
+ def connect(self) -> None:
46
+ """
47
+ Establish a connection to ChromaDB and get or create the collection.
48
+ """
49
+ # settings = Settings(
50
+ # chroma_api_impl="chromadb.api.fastapi.FastAPI", # Use FastAPI if LocalAPI is not supported
51
+ # chroma_server_host="localhost", # Server host
52
+ # chroma_server_http_port=8000, # Server port
53
+ # )
54
+ #
55
+ # self.client = chromadb.Client(
56
+ # settings=settings,
57
+ # )
58
+ self.client = chromadb.Client()
59
+
60
+ self.collection = self.client.get_or_create_collection(
61
+ name=self.collection_name
62
+ )
63
+ logging.info(
64
+ f"Connected to ChromaDB at {self.path}, collection: {self.collection_name}"
65
+ )
66
+
67
+ def disconnect(self) -> None:
68
+ """
69
+ Close the connection to ChromaDB.
70
+ """
71
+ if self.client:
72
+ # Perform any necessary cleanup here
73
+ self.client = None
74
+ self.collection = None
75
+
76
+ def add_document(self, document: Document) -> None:
77
+ embedding = None
78
+ if not document.embedding:
79
+ self._embedder.fit([document.content]) # Fit only once
80
+ embedding = (
81
+ self._embedder.transform([document.content])[0].to_numpy().tolist()
82
+ )
83
+ else:
84
+ embedding = document.embedding
85
+
86
+ self.collection.add(
87
+ ids=[document.id],
88
+ documents=[document.content],
89
+ embeddings=[embedding],
90
+ metadatas=[document.metadata],
91
+ )
92
+
93
+ def add_documents(self, documents: List[Document]) -> None:
94
+ ids = [doc.id for doc in documents]
95
+ texts = [doc.content for doc in documents]
96
+
97
+ for doc in documents:
98
+ self._embedder.fit([doc.content])
99
+
100
+ embeddings = [
101
+ self._embedder.infer_vector(doc.content).value for doc in documents
102
+ ]
103
+ metadatas = [doc.metadata for doc in documents]
104
+ if metadatas[0]:
105
+ self.collection.add(
106
+ ids=ids, documents=texts, embeddings=embeddings, metadatas=metadatas
107
+ )
108
+ else:
109
+ self.collection.add(ids=ids, documents=texts, embeddings=embeddings)
110
+
111
+ def get_document(self, doc_id: str) -> Union[Document, None]:
112
+ results = self.collection.get(ids=[doc_id])
113
+ if not results["metadatas"][0]:
114
+ results["metadatas"][0] = {}
115
+ if results["ids"]:
116
+ document = Document(
117
+ id=results["ids"][0],
118
+ content=results["documents"][0],
119
+ metadata=results["metadatas"][0],
120
+ )
121
+ return document
122
+ return None
123
+
124
+ def get_all_documents(self) -> List[Document]:
125
+ results = self.collection.get()
126
+ documents = [
127
+ Document(
128
+ id=results["ids"][idx],
129
+ content=results["documents"][idx],
130
+ metadata=results["metadatas"][idx],
131
+ )
132
+ for idx in range(len(results["ids"]))
133
+ ]
134
+ return documents
135
+
136
+ def delete_document(self, doc_id: str) -> None:
137
+ self.collection.delete(ids=[doc_id])
138
+
139
+ def update_document(self, doc_id: str, updated_document: Document) -> None:
140
+ document_vector = None
141
+ # Precompute the embedding outside the update process
142
+ if not updated_document.embedding:
143
+ # Transform without refitting to avoid vocabulary issues
144
+ document_vector = self._embedder.transform([updated_document.content])[0]
145
+ else:
146
+ document_vector = updated_document.embedding
147
+
148
+ document_vector = document_vector.to_numpy().tolist()
149
+
150
+ updated_document.embedding = document_vector
151
+
152
+ self.delete_document(doc_id)
153
+ self.add_document(updated_document)
154
+
155
+ def clear_documents(self) -> None:
156
+ documents = self.get_all_documents()
157
+ doc_ids = [doc.id for doc in documents]
158
+ self.collection.delete(ids=doc_ids)
159
+
160
+ def document_count(self) -> int:
161
+ return len(self.get_all_documents())
162
+
163
+ def retrieve(self, query: str, top_k: int = 5) -> List[Document]:
164
+ query_embedding = self._embedder.infer_vector(query).value
165
+ # print(query_embedding)
166
+
167
+ results = self.collection.query(
168
+ query_embeddings=query_embedding, n_results=top_k
169
+ )
170
+
171
+ return [
172
+ Document(
173
+ id=results["ids"][0][idx],
174
+ content=results["documents"][0][idx],
175
+ metadata=(
176
+ results["metadatas"][0][idx] if results["metadatas"][0][idx] else {}
177
+ ),
178
+ )
179
+ for idx in range(len(results["ids"][0]))
180
+ ]
181
+
182
+ # Override the model_dump_json method
183
+ def model_dump_json(self, *args, **kwargs) -> str:
184
+ # Call the disconnect method before serialization
185
+ self.disconnect()
186
+
187
+ # Now proceed with the usual JSON serialization
188
+ return super().model_dump_json(*args, **kwargs)
@@ -0,0 +1,16 @@
1
+ from .PersistentChromaDBVectorStore import PersistentChromaDBVectorStore
2
+
3
+ __all__ = ["PersistentChromaDBVectorStore"]
4
+
5
+ try:
6
+ # For Python 3.8 and newer
7
+ from importlib.metadata import version, PackageNotFoundError
8
+ except ImportError:
9
+ # For older Python versions, use the backport
10
+ from importlib_metadata import version, PackageNotFoundError
11
+
12
+ try:
13
+ __version__ = version("swarmauri_vectorstore_persistentchromadb")
14
+ except PackageNotFoundError:
15
+ # If the package is not installed (for example, during development)
16
+ __version__ = "0.0.0"
@@ -1,21 +0,0 @@
1
- Metadata-Version: 2.3
2
- Name: swarmauri_vectorstore_persistentchromadb
3
- Version: 0.6.0.dev154
4
- Summary: A Persistent ChromaDB based Vector Store
5
- License: Apache-2.0
6
- Author: Jacob Stewart
7
- Author-email: jacob@swarmauri.com
8
- Requires-Python: >=3.10,<3.13
9
- Classifier: License :: OSI Approved :: Apache Software License
10
- Classifier: Programming Language :: Python :: 3
11
- Classifier: Programming Language :: Python :: 3.10
12
- Classifier: Programming Language :: Python :: 3.11
13
- Classifier: Programming Language :: Python :: 3.12
14
- Requires-Dist: chromadb (>=0.5.17,<0.6.0)
15
- Requires-Dist: swarmauri_base (>=0.6.0.dev154,<0.7.0)
16
- Requires-Dist: swarmauri_core (>=0.6.0.dev154,<0.7.0)
17
- Requires-Dist: swarmauri_embedding_doc2vec (>=0.6.0.dev154,<0.7.0)
18
- Project-URL: Repository, http://github.com/swarmauri/swarmauri-sdk
19
- Description-Content-Type: text/markdown
20
-
21
- # Swarmauri Example Community Package
@@ -1 +0,0 @@
1
- # Swarmauri Example Community Package
@@ -1,14 +0,0 @@
1
- from .PersistentChromaDBVectorStore import PersistentChromaDBVectorStore
2
-
3
- __version__ = "0.6.0.dev26"
4
- __long_desc__ = """
5
-
6
- # Swarmauri PersistentChromaDB Plugin
7
-
8
- This repository includes an PersistentChromaDB of a Swarmauri Plugin.
9
-
10
- Visit us at: https://swarmauri.com
11
- Follow us at: https://github.com/swarmauri
12
- Star us at: https://github.com/swarmauri/swarmauri-sdk
13
-
14
- """