agent-framework-dxmt 1.6.0__tar.gz

agent_framework_dxmt-1.6.0/.gitignore

@@ -0,0 +1,134 @@
+# Rust build artifacts
+target/
+*.hdf5
+*.wal
+datasets/
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Environment files. Only .env.example is shared. `.env` alone is an exact-name
+# match, so `.env.production` was never actually ignored — a placeholder file that
+# someone later fills in would have been committed without a word.
+.env
+.env.*
+!.env.example
+
+# Logs
+*.log
+logs/
+
+# VectorDB specific files
+/cache/
+/data/
+/storage/
+*.db
+*.sqlite
+*.sqlite3
+
+# Test artifacts
+/test-results/
+/coverage/
+*.profraw
+# `coverage.py`'s database. `/coverage/` above is a directory and does not match it, so
+# `clients/langchain-dxmt/.coverage` was tracked -- 52 KB of binary holding absolute paths
+# from whichever machine last ran the suite, which then travelled through the move to
+# `clients/` as the one file in the tree still naming the old layout.
+.coverage
+.coverage.*
+# The queries `examples/generative_benchmark.py` generates. Cached so a rerun is free, and
+# local because they are about whatever corpus that machine pointed it at.
+examples/.generative_benchmark.json
+
+# Documentation builds
+/book/
+/docs/site/
+
+# Temporary files
+*.tmp
+*.temp
+/tmp/
+
+# Configuration files (keep templates)
+config.toml
+config.yaml
+config.json
+!config.example.*
+
+# Binary releases
+/dist/
+/release/
+*.tar.gz
+*.zip
+# Except the storage-compatibility fixtures, which are data every build has to open. Without this
+# line the archive stays behind and CI tests an expected.json against nothing.
+!tests/compat/fixtures/*/data.tar.gz
+
+# Benchmarking results
+/benches/results/
+criterion/
+
+# Memory dumps
+*.dmp
+core.*
+
+# Performance profiling
+flamegraph.svg
+perf.data*
+
+# `.dockerignore` used to be ignored here, under the heading "Docker build context", as though
+# it were something a build produces. It is source: it decides what leaves the machine when
+# anyone runs `docker build`, so it has to ship with the repository the way `.gitignore` does.
+# Ignoring it meant the protection existed only on the machine that wrote it.
+
+# Node.js (for documentation tools)
+node_modules/
+npm-debug.log*
+
+# Python (for scripts)
+__pycache__/
+*.py[cod]
+*$py.class
+.pytest_cache/
+
+# Backup files
+*.bak
+*.backup
+venv/
+archive/
+logs/
+dev-cache/
+wal/
+*.egg-info/
+
+# Local agent/editor settings
+.claude/settings.local.json
+
+# Demo corpora — third-party documents, supply your own (see examples/pdf_rag_demo.py)
+pdf/
+
+# Never commit credentials or exported customer data
+*credentials*.json
+*service-account*.json
+*.pem
+*.key
+gcp_bucket.config
+
+# Demo corpora the examples download at run time. They are other people's writing -- the
+# LlamaIndex example fetches Paul Graham's essay from run-llama/llama_index -- and are not
+# covered by this project's licence. A vendored copy was removed before the first public
+# release; this keeps the next `git add` from putting it back.
+clients/llama-index-vector-stores-dxmt/examples/data/

agent_framework_dxmt-1.6.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 上海点线面体信息科技有限公司 (Shanghai Dianxianmianti Information Technology Co., Ltd.)
+
+   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.

agent_framework_dxmt-1.6.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.5
+Name: agent-framework-dxmt
+Version: 1.6.0
+Summary: DXMT vector store and memory context provider for Microsoft Agent Framework
+Project-URL: Homepage, https://github.com/dxmt/dxmt
+Project-URL: Source, https://github.com/dxmt/dxmt/tree/main/vectordb/clients/agent-framework-dxmt
+Project-URL: Issues, https://github.com/dxmt/dxmt/issues
+Author-email: DXMT Team <contact@dxmt.online>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agent-framework,agent-memory,context-provider,dxmt,microsoft-agent-framework,vector-store
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: agent-framework-core<2,>=1.19.0
+Requires-Dist: dxmt-python-sdk<2.0.0,>=1.6.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-cov>=5; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# agent-framework-dxmt
+
+[DXMT](https://github.com/dxmt/dxmt), the open-source memory database for personal agents,
+for [Microsoft Agent Framework](https://github.com/microsoft/agent-framework): a vector store
+with keyword-hybrid search, and memory as a context provider.
+
+```bash
+pip install agent-framework-dxmt
+```
+
+A DXMT server has to be running (`vectordb serve`, or
+`docker run -p 127.0.0.1:9999:9999 -v dxmt:/data dxmtai/dxmt`). Connection settings are
+`DXMT_URL` (default `http://localhost:9999`) and `DXMT_API_KEY`, or the `url` / `api_key`
+arguments, resolved through Agent Framework's `load_settings` like every other connector.
+
+## Vector store
+
+`DXMTCollection` and `DXMTStore` implement `BaseVectorCollection` / `BaseVectorSearch` and
+`BaseVectorStore`. A collection is one DXMT table; the record's single vector field is the
+row's vector and its data fields are the payload.
+
+```python
+from dataclasses import dataclass
+from typing import Annotated
+
+from agent_framework import Filter, VectorStoreField, vectorstoremodel
+from agent_framework_dxmt import DXMTStore
+
+
+@vectorstoremodel
+@dataclass
+class Document:
+    id: Annotated[str, VectorStoreField("key")]
+    title: Annotated[str, VectorStoreField("data", is_full_text_indexed=True)]
+    year: Annotated[int, VectorStoreField("data", is_indexed=True)]
+    embedding: Annotated[list[float] | None, VectorStoreField("vector", dimensions=3)] = None
+
+
+async with DXMTStore() as store:
+    collection = store.get_collection(Document, collection_name="documents")
+    await collection.ensure_collection_exists()
+    await collection.upsert([Document("1", "Hello DXMT", 2026, [1.0, 0.0, 0.0])], generate_vectors=False)
+    results = await collection.search(vector=[1.0, 0.0, 0.0], filter=Filter("year", "gte", 2020), top=3)
+    async for item in results:
+        print(item["record"].title, item["score"])
+```
+
+What is specific to DXMT:
+
+- **Keyword-hybrid search.** A data field marked `is_full_text_indexed` gets the table's BM25
+  index, and `collection.search("hello", search_type="keyword_hybrid", additional_property_name="title")`
+  is the server's hybrid search (vector and keywords fused on the server). Most in-tree
+  connectors declare `{"vector"}` only.
+- **Server-side embedding.** `DXMTCollection(..., server_embedding={"model": "text-embedding-3-small"},
+  server_embedding_field="title")` has the server embed records whose vector is `None` and
+  queries given as text, so no embedding client runs in the agent's process.
+- **Filters.** Every portable operator (`eq`, `ne`, ranges, `between`, `in`, `not_in`,
+  `is_null`, `is_not_null`, `exists`, `contains`, `contains_any`, `contains_all`,
+  `starts_with`, `ends_with`, `contains_text`) and `and` / `or` / `not` groups, translated
+  exactly to the server's flat filter; a shape the server has no flat form for (`(a and b) or c`)
+  raises `NotImplementedError` rather than being approximated.
+- Scores are similarities (1.0 is identical under cosine); `score_threshold` is in those units.
+  One vector field per collection; `cosine_similarity` (default), `dot_prod`, `euclidean_distance`.
+
+## Memory as a context provider
+
+`DXMTContextProvider` recalls memories before a run (by meaning *and* keyword) and remembers
+the exchange after it, using DXMT's own memory API. Scope is tags: memories are written under
+`user_id` / `agent_id` / `application_id` and recalled by the separate `search_*` ids, the
+split the mem0 provider uses so a memory written under a shared agent is not read back for an
+unrelated user by accident.
+
+```python
+from agent_framework import Agent
+from agent_framework_dxmt import DXMTContextProvider
+
+memory = DXMTContextProvider(user_id="alice", search_user_id="alice")
+agent = Agent(chat_client, instructions="...", context_providers=[memory])
+await agent.run("I prefer answers in Chinese.")
+await agent.run("How should you answer me?")   # the preference is recalled into the context
+```
+
+`memory.remember(text, kind=..., supersedes=[...])`, `memory.recall(query)` and
+`memory.forget(ids)` expose the three operations directly. A memory said twice is kept once;
+a new fact can supersede an old one, which is kept as history and left out of recall. The
+same store is what every other agent on the machine sees over MCP and REST.
+
+## Tests
+
+```bash
+pytest                                  # unit tests, client mocked
+DXMT_TEST_URL=http://127.0.0.1:9999 pytest -m integration   # against a server
+```

agent_framework_dxmt-1.6.0/README.md

@@ -0,0 +1,93 @@
+# agent-framework-dxmt
+
+[DXMT](https://github.com/dxmt/dxmt), the open-source memory database for personal agents,
+for [Microsoft Agent Framework](https://github.com/microsoft/agent-framework): a vector store
+with keyword-hybrid search, and memory as a context provider.
+
+```bash
+pip install agent-framework-dxmt
+```
+
+A DXMT server has to be running (`vectordb serve`, or
+`docker run -p 127.0.0.1:9999:9999 -v dxmt:/data dxmtai/dxmt`). Connection settings are
+`DXMT_URL` (default `http://localhost:9999`) and `DXMT_API_KEY`, or the `url` / `api_key`
+arguments, resolved through Agent Framework's `load_settings` like every other connector.
+
+## Vector store
+
+`DXMTCollection` and `DXMTStore` implement `BaseVectorCollection` / `BaseVectorSearch` and
+`BaseVectorStore`. A collection is one DXMT table; the record's single vector field is the
+row's vector and its data fields are the payload.
+
+```python
+from dataclasses import dataclass
+from typing import Annotated
+
+from agent_framework import Filter, VectorStoreField, vectorstoremodel
+from agent_framework_dxmt import DXMTStore
+
+
+@vectorstoremodel
+@dataclass
+class Document:
+    id: Annotated[str, VectorStoreField("key")]
+    title: Annotated[str, VectorStoreField("data", is_full_text_indexed=True)]
+    year: Annotated[int, VectorStoreField("data", is_indexed=True)]
+    embedding: Annotated[list[float] | None, VectorStoreField("vector", dimensions=3)] = None
+
+
+async with DXMTStore() as store:
+    collection = store.get_collection(Document, collection_name="documents")
+    await collection.ensure_collection_exists()
+    await collection.upsert([Document("1", "Hello DXMT", 2026, [1.0, 0.0, 0.0])], generate_vectors=False)
+    results = await collection.search(vector=[1.0, 0.0, 0.0], filter=Filter("year", "gte", 2020), top=3)
+    async for item in results:
+        print(item["record"].title, item["score"])
+```
+
+What is specific to DXMT:
+
+- **Keyword-hybrid search.** A data field marked `is_full_text_indexed` gets the table's BM25
+  index, and `collection.search("hello", search_type="keyword_hybrid", additional_property_name="title")`
+  is the server's hybrid search (vector and keywords fused on the server). Most in-tree
+  connectors declare `{"vector"}` only.
+- **Server-side embedding.** `DXMTCollection(..., server_embedding={"model": "text-embedding-3-small"},
+  server_embedding_field="title")` has the server embed records whose vector is `None` and
+  queries given as text, so no embedding client runs in the agent's process.
+- **Filters.** Every portable operator (`eq`, `ne`, ranges, `between`, `in`, `not_in`,
+  `is_null`, `is_not_null`, `exists`, `contains`, `contains_any`, `contains_all`,
+  `starts_with`, `ends_with`, `contains_text`) and `and` / `or` / `not` groups, translated
+  exactly to the server's flat filter; a shape the server has no flat form for (`(a and b) or c`)
+  raises `NotImplementedError` rather than being approximated.
+- Scores are similarities (1.0 is identical under cosine); `score_threshold` is in those units.
+  One vector field per collection; `cosine_similarity` (default), `dot_prod`, `euclidean_distance`.
+
+## Memory as a context provider
+
+`DXMTContextProvider` recalls memories before a run (by meaning *and* keyword) and remembers
+the exchange after it, using DXMT's own memory API. Scope is tags: memories are written under
+`user_id` / `agent_id` / `application_id` and recalled by the separate `search_*` ids, the
+split the mem0 provider uses so a memory written under a shared agent is not read back for an
+unrelated user by accident.
+
+```python
+from agent_framework import Agent
+from agent_framework_dxmt import DXMTContextProvider
+
+memory = DXMTContextProvider(user_id="alice", search_user_id="alice")
+agent = Agent(chat_client, instructions="...", context_providers=[memory])
+await agent.run("I prefer answers in Chinese.")
+await agent.run("How should you answer me?")   # the preference is recalled into the context
+```
+
+`memory.remember(text, kind=..., supersedes=[...])`, `memory.recall(query)` and
+`memory.forget(ids)` expose the three operations directly. A memory said twice is kept once;
+a new fact can supersede an old one, which is kept as history and left out of recall. The
+same store is what every other agent on the machine sees over MCP and REST.
+
+## Tests
+
+```bash
+pytest                                  # unit tests, client mocked
+DXMT_TEST_URL=http://127.0.0.1:9999 pytest -m integration   # against a server
+```

agent_framework_dxmt-1.6.0/agent_framework_dxmt/__init__.py

@@ -0,0 +1,14 @@
+"""DXMT for Microsoft Agent Framework: a vector store, and memory as a context provider."""
+
+import importlib.metadata
+
+from ._context_provider import DXMTContextProvider
+from ._settings import DXMTSettings
+from ._vector_store import DXMTCollection, DXMTStore
+
+try:
+    __version__ = importlib.metadata.version("agent-framework-dxmt")
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "0.0.0"
+
+__all__ = ["DXMTCollection", "DXMTContextProvider", "DXMTSettings", "DXMTStore", "__version__"]