agentvectordb 0.0.1__tar.gz

agentvectordb-0.0.1/LICENCE

@@ -0,0 +1,204 @@
+
+"""
+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.
+"""

agentvectordb-0.0.1/MANIFEST.in

@@ -0,0 +1,9 @@
+include LICENSE
+include README.md
+include pyproject.toml
+
+recursive-exclude docs *
+recursive-exclude examples *
+recursive-exclude tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[cod]

agentvectordb-0.0.1/PKG-INFO

@@ -0,0 +1,289 @@
+Metadata-Version: 2.4
+Name: agentvectordb
+Version: 0.0.1
+Summary: AgentVectorDB: The Cognitive Core for Your AI Agents. A lightweight, embeddable vector database for Agentic AI systems, built on LanceDB.
+Home-page: https://github.com/superagenticai/agentvectordb
+Author: Shashi Jagtap
+Author-email: Shashi Jagtap <shashi@super-agentic.ai>
+Project-URL: Homepage, https://github.com/superagenticai/agentvectordb
+Project-URL: Repository, https://github.com/superagenticai/agentvectordb
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+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
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Database
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENCE
+Requires-Dist: lancedb
+Requires-Dist: pandas
+Requires-Dist: pydantic>=2.0
+Requires-Dist: numpy
+Requires-Dist: pyarrow>=12.0.1
+Requires-Dist: tantivy
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# 🧠 AgentVectorDB
+
+[![PyPI version](https://badge.fury.io/py/agentvectordb.svg)](https://badge.fury.io/py/agentvectordb)
+[![Python versions](https://img.shields.io/pypi/pyversions/agentvectordb.svg)](https://pypi.org/project/agentvectordb/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+[![Tests](https://github.com/superagenticai/agentvectordb/workflows/Tests/badge.svg)](https://github.com/superagenticai/agentvectordb/actions)
+[![Documentation](https://readthedocs.org/projects/agentvectordb/badge/?version=latest)](https://agentvectordb.readthedocs.io/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Coverage](https://codecov.io/gh/superagenticai/agentvectordb/branch/main/graph/badge.svg)](https://codecov.io/gh/superagenticai/agentvectordb)
+
+**AgentVectorDB: The Cognitive Core for Your AI Agents**
+
+AgentVectorDB is a lightweight, embeddable vector database designed for agentic AI systems. It empowers your agents with persistent memory, semantic search, and tools for internal reasoning and learning. Built on the performance and simplicity of [LanceDB](https://github.com/lancedb/lancedb), AgentVectorDB is the default memory layer for sophisticated AI agents, offering a familiar "collection-based" API.
+
+---
+
+## 🚀 Why AgentVectorDB?
+
+- **Familiar API:** Uses a `Store -> Collection` model, similar to other popular vector databases.
+- **Lightweight & Embeddable:** Runs directly within your agent's process using LanceDB. No separate server, minimal dependencies.
+- **Agent-Centric Schema:** Default schema includes fields like `type` (observation, thought, goal), `source`, `importance_score`, and `last_accessed_at` to provide a cognitive framework for each memory entry.
+- **Temporal Dynamics:** Built-in support for recency, memory decay (`prune_memories`), and tracking when memories were last accessed.
+- **Rich Querying:** Powerful semantic search combined with SQL filtering (`filter_sql`) for maximum flexibility.
+- **Seamless Embedding Integration:** Works with [LanceDB's embedding functions](https://lancedb.github.io/lancedb/embeddings/) or your custom embedding models, configurable per collection.
+- **Asynchronous API:** Provides `AsyncAgentVectorDBStore` and `AsyncAgentMemoryCollection` for integration with async-first agent frameworks.
+- **Open Source & Extensible:** Built with best practices, ready for community contributions.
+
+---
+
+## ✨ Features at a Glance
+
+- **Persistent Storage:** File-based, no server required.
+- **Vector Search:** Efficient ANN search.
+- **Metadata Filtering:** Use `filter_sql` for powerful filtering.
+- **CRUD Operations:** Add, retrieve, update, and delete memories.
+- **Batch Operations:** Efficiently add multiple memories.
+- **Memory Pruning:** `prune_memories` method for memory decay strategies.
+- **Dynamic Schema:** Flexible Pydantic-based schemas per collection.
+- **Timestamp Tracking:** Automatic `created_at` and optional `last_accessed_at` updates.
+- **Async Support:** Fully asynchronous API available.
+
+---
+
+## 📦 Installation
+
+```bash
+pip install agentvectordb
+```
+
+Or for the latest development version:
+```bash
+pip install git+https://github.com/superagenticai/agentvectordb.git
+```
+
+To install locally for development:
+```bash
+git clone https://github.com/superagenticai/agentvectordb.git
+cd agentvectordb
+pip install -e .[dev]
+```
+
+---
+
+## 🏁 Quickstart
+
+```python
+import asyncio
+import os
+import shutil
+from agentvectordb import AgentVectorDBStore, AsyncAgentVectorDBStore
+from agentvectordb.embeddings import DefaultTextEmbeddingFunction
+
+print("\033[1;36m")
+print("🧠🚀 Welcome to AgentVectorDB Quickstart! 🚀🧠")
+print("A lightweight, embeddable vector database for agentic AI systems, built on LanceDB.\n")
+print("\033[0m")
+
+DB_DIR = "./_agentvectordb_mvp_quickstart_db"
+ef = DefaultTextEmbeddingFunction(dimension=64)
+
+def cleanup_db_dir(db_directory):
+    if os.path.exists(db_directory):
+        shutil.rmtree(db_directory)
+    os.makedirs(db_directory, exist_ok=True)
+
+cleanup_db_dir(DB_DIR)
+
+# --- Synchronous API ---
+print("\033[1;34m🔹 [SYNC] Episodic Memory Demo\033[0m")
+store = AgentVectorDBStore(db_path=DB_DIR)
+episodic_memories = store.get_or_create_collection(
+    name="episodic_stream",
+    embedding_function=ef,
+    update_last_accessed_on_query=True,
+    recreate=True
+)
+episodic_memories.add(
+    content="User inquired about AgentVectorDB's collection feature.",
+    type="user_interaction",
+    source="chat_interface",
+    tags=["agentvectordb_feature", "collections_api"]
+)
+episodic_memories.add(
+    content="Agent decided to use the 'episodic_stream' collection for observations.",
+    type="internal_decision",
+    source="agent_reasoner",
+    importance_score=0.7
+)
+query_results = episodic_memories.query(
+    query_text="AgentVectorDB collection feature",
+    k=1,
+    filter_sql="type = 'user_interaction'"
+)
+print("\033[1;32m\n🌟 Sync Query Results:\033[0m")
+for res in query_results:
+    print(f"\033[1;33m  • {res.get('content', 'N/A')} \033[0m\033[0;35m(Type: {res.get('type')})\033[0m")
+
+# --- Asynchronous API ---
+async def async_example_main():
+    print("\n\033[1;34m🔹 [ASYNC] Agent Thoughts Log Demo\033[0m")
+    async_store = AsyncAgentVectorDBStore(db_path=DB_DIR)
+    agent_thoughts = await async_store.get_or_create_collection(
+        name="agent_thoughts_log",
+        embedding_function=ef,
+        update_last_accessed_on_query=True,
+        recreate=True
+    )
+    await agent_thoughts.add(
+        content="Async thought: Need to plan next steps for Project Nebula.",
+        type="planning_thought",
+        importance_score=0.85,
+        metadata={"project": "Nebula", "status": "pending_review"}
+    )
+    async_results = await agent_thoughts.query(
+        query_text="Project Nebula planning",
+        k=1,
+        filter_sql="metadata.extra LIKE '%Nebula%'"
+    )
+    print("\033[1;32m\n🌟 Async Query Results:\033[0m")
+    for res in async_results:
+        print(f"\033[1;33m  • {res.get('content', 'N/A')} \033[0m\033[0;35m(Importance: {res.get('importance_score')})\033[0m")
+    collections = await async_store.list_collections()
+    print("\n\033[1;36m📚 Collections in the async store:\033[0m")
+    for coll_name in collections:
+        print(f"  - {coll_name}")
+
+    print("\n\033[1;36m🎉 Quickstart complete! Explore more with AgentVectorDB.\033[0m")
+
+if __name__ == "__main__":
+    asyncio.run(async_example_main())
+```
+
+---
+
+## 🛠️ API Overview
+
+### `AgentVectorDBStore(db_path: str)`
+
+- **db_path:** Directory where LanceDB database files are stored.
+
+**Methods:**
+
+- `get_or_create_collection(...)` – Create or open a collection.
+- `list_collections()` – List all collections.
+- `delete_collection(name: str)` – Delete a collection.
+
+### `AgentMemoryCollection`
+
+- **Properties:** `name`, `embedding_function`, `schema`
+- **Methods:** `add`, `add_batch`, `query`, `get_by_id`, `delete`, `count`, `prune_memories`, `__len__`
+
+### Asynchronous API
+
+- `AsyncAgentVectorDBStore`
+- `AsyncAgentMemoryCollection`
+    - All methods of their synchronous counterparts are available as `async` methods.
+
+---
+
+## 📚 Advanced Usage
+
+### Multiple Collections
+
+```python
+store = AgentVectorDBStore(db_path="./my_multi_agent_db")
+kb_ef = DefaultTextEmbeddingFunction(dimension=128)
+knowledge_base = store.get_or_create_collection(
+    name="knowledge_base",
+    embedding_function=kb_ef
+)
+knowledge_base.add(content="The Earth revolves around the Sun.", type="astronomy_fact")
+```
+
+### Filtering with `filter_sql`
+
+```python
+results = my_collection.query(
+    query_text="relevant topic",
+    k=5,
+    filter_sql="type = 'log_entry' AND importance_score > 0.5 AND metadata.extra LIKE '%user123%'"
+)
+```
+
+### Memory Pruning
+
+```python
+pruned_count = observations.prune_memories(
+    max_age_seconds=86400 * 7,
+    min_importance_score=0.3,
+    filter_logic="AND",
+    dry_run=False
+)
+print(f"Pruned {pruned_count} old/unimportant observations.")
+```
+
+---
+
+## 🧑‍💻 More Examples
+
+See the [`examples/`](./examples/) directory for:
+
+- `quickstart.py` – Full sync & async demo
+- `sync_basic_usage.py` – Minimal synchronous usage
+- `async_batch_add.py` – Async batch add/query
+- `metadata_filtering.py` – Metadata and SQL filtering
+- `prune_and_count.py` – Pruning and counting
+- `async_delete.py` – Async deletion
+
+---
+
+## 🛤️ Roadmap & Contributing
+
+AgentVectorDB is actively evolving. Planned features include:
+- More sophisticated filter builders
+- Reflection/summarization helpers
+- Schema evolution helpers
+- Community-driven extensions
+
+**Contributions are welcome!** Please see `CONTRIBUTING.md` for guidelines.
+
+---
+
+## 📄 License
+
+This project is licensed under the Apache-2.0 License.
+
+---
+
+**AgentVectorDB: Give your AI agents a memory!**