deepeval-goodmem 0.1.0__tar.gz

deepeval_goodmem-0.1.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 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 Support. 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 support.
+
+   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 GoodMem
+
+   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.

deepeval_goodmem-0.1.0/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: deepeval-goodmem
+Version: 0.1.0
+Summary: DeepEval AI framework plugin for GoodMem, a retrieval-augmented generation (RAG) memory service.
+Author: PAIR Systems
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+License-File: LICENSE
+Requires-Dist: httpx>=0.24.0,<1
+Requires-Dist: pytest>=7.0 ; extra == "dev"
+Requires-Dist: pytest-timeout ; extra == "dev"
+Requires-Dist: build ; extra == "dev"
+Requires-Dist: twine ; extra == "dev"
+Requires-Dist: openai>=1.12.0 ; extra == "examples"
+Project-URL: homepage, https://github.com/PAIR-Systems-Inc/goodmem_deepeval
+Project-URL: issues, https://github.com/PAIR-Systems-Inc/goodmem_deepeval/issues
+Project-URL: source, https://github.com/PAIR-Systems-Inc/goodmem_deepeval
+Provides-Extra: dev
+Provides-Extra: examples
+
+# deepeval-goodmem
+
+[GoodMem](https://goodmem.ai) integration for
+[DeepEval](https://deepeval.com).
+
+GoodMem gives AI agents retrieval-augmented generation (RAG) memory. Store
+documents in a space and GoodMem chunks, embeds, and indexes them so your
+agent can pull back the most relevant passages on any question.
+
+This package exposes the GoodMem API as a set of DeepEval-flavoured operation
+classes. Each operation has a `run(...)` method that returns a JSON string,
+making them callable from any evaluation script, test harness, or scoring
+pipeline.
+
+## Installation
+
+```bash
+pip install deepeval-goodmem
+```
+
+For local development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quickstart
+
+```python
+import json
+import os
+
+os.environ["GOODMEM_BASE_URL"] = "https://localhost:8080"
+os.environ["GOODMEM_API_KEY"] = "gm_xxxxxxxxxxxxxxxxxxxxxxxx"
+os.environ["GOODMEM_VERIFY_SSL"] = "false"  # self-signed local server
+
+from deepeval_goodmem import (
+    GoodMemCreateMemory,
+    GoodMemCreateSpace,
+    GoodMemListEmbedders,
+    GoodMemRetrieveMemories,
+)
+
+embedders = json.loads(GoodMemListEmbedders().run())
+embedder_id = embedders["embedders"][0]["embedderId"]
+
+space = json.loads(
+    GoodMemCreateSpace().run(name="quickstart", embedder_id=embedder_id)
+)
+space_id = space["spaceId"]
+
+GoodMemCreateMemory().run(
+    space_id=space_id,
+    text_content="The capital of France is Paris.",
+)
+
+results = json.loads(
+    GoodMemRetrieveMemories().run(
+        query="What is the capital of France?",
+        space_ids=space_id,
+        max_results=3,
+    )
+)
+print(results)
+```
+
+Every operation's `run(...)` returns a JSON string. On success the parsed
+object includes `"success": true` and operation-specific fields. On failure
+it includes `"success": false` and an `"error"` field.
+
+The local GoodMem dev server ships with TLS even on localhost. Set
+`GOODMEM_VERIFY_SSL=false` to accept the self-signed certificate during
+development; production deployments behind a trusted certificate should
+leave it at the default of `true`.
+
+## Available operations
+
+| Operation | Description |
+|---|---|
+| `GoodMemListEmbedders` | List embedder models available on the server |
+| `GoodMemListSpaces` | List all spaces accessible to the API key |
+| `GoodMemGetSpace` | Fetch a space by ID |
+| `GoodMemCreateSpace` | Create a space (idempotent by name) |
+| `GoodMemUpdateSpace` | Update a space's name, labels, or public-read flag |
+| `GoodMemDeleteSpace` | Delete a space and all of its memories |
+| `GoodMemCreateMemory` | Store text or a file as a memory |
+| `GoodMemListMemories` | List memories in a space, with pagination and filters |
+| `GoodMemRetrieveMemories` | Semantic retrieval across one or more spaces |
+| `GoodMemGetMemory` | Fetch a memory by ID, with optional content |
+| `GoodMemDeleteMemory` | Delete a memory |
+
+### Retrieval options
+
+`GoodMemRetrieveMemories` accepts the following parameters in addition to
+`query`, `space_ids`, and `max_results`:
+
+| Parameter | Type | Description |
+|---|---|---|
+| `metadata_filter` | str | SQL-style JSONPath filter applied server-side to every space key. Example: `CAST(val('$.category') AS TEXT) = 'feat'` |
+| `wait_for_indexing` | bool | Poll for results when none come back on the first call (default `True`) |
+| `max_wait_seconds` | float | Polling budget (default `60.0`) |
+| `poll_interval` | float | Seconds between polls (default `5.0`) |
+| `reranker_id` | str | Reranker model to refine result ordering |
+| `llm_id` | str | LLM that generates a contextual abstract reply |
+| `relevance_threshold` | float | Minimum score (0-1) for inclusion |
+| `llm_temperature` | float | Creativity (0-2) for the LLM post-processor |
+| `chronological_resort` | bool | Reorder results by creation time |
+
+## Environment variables
+
+| Variable | Description |
+|---|---|
+| `GOODMEM_BASE_URL` | Base URL of the GoodMem API server |
+| `GOODMEM_API_KEY` | API key sent as `X-API-Key` |
+| `GOODMEM_VERIFY_SSL` | Set to `false` to skip TLS verification (default `true`) |
+
+When the env vars are set, every operation constructor can be called with
+no arguments.
+
+## End-to-end example
+
+[`examples/example_usage.py`](examples/example_usage.py) walks through three
+scenarios: persistent project context, a scribe and analyst pipeline, and
+metadata-driven retrieval. The answering step uses OpenAI; install with
+`pip install deepeval-goodmem[examples]` and set `OPENAI_API_KEY` before
+running.
+
+```bash
+python examples/example_usage.py
+```
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).
+

deepeval_goodmem-0.1.0/README.md

@@ -0,0 +1,134 @@
+# deepeval-goodmem
+
+[GoodMem](https://goodmem.ai) integration for
+[DeepEval](https://deepeval.com).
+
+GoodMem gives AI agents retrieval-augmented generation (RAG) memory. Store
+documents in a space and GoodMem chunks, embeds, and indexes them so your
+agent can pull back the most relevant passages on any question.
+
+This package exposes the GoodMem API as a set of DeepEval-flavoured operation
+classes. Each operation has a `run(...)` method that returns a JSON string,
+making them callable from any evaluation script, test harness, or scoring
+pipeline.
+
+## Installation
+
+```bash
+pip install deepeval-goodmem
+```
+
+For local development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quickstart
+
+```python
+import json
+import os
+
+os.environ["GOODMEM_BASE_URL"] = "https://localhost:8080"
+os.environ["GOODMEM_API_KEY"] = "gm_xxxxxxxxxxxxxxxxxxxxxxxx"
+os.environ["GOODMEM_VERIFY_SSL"] = "false"  # self-signed local server
+
+from deepeval_goodmem import (
+    GoodMemCreateMemory,
+    GoodMemCreateSpace,
+    GoodMemListEmbedders,
+    GoodMemRetrieveMemories,
+)
+
+embedders = json.loads(GoodMemListEmbedders().run())
+embedder_id = embedders["embedders"][0]["embedderId"]
+
+space = json.loads(
+    GoodMemCreateSpace().run(name="quickstart", embedder_id=embedder_id)
+)
+space_id = space["spaceId"]
+
+GoodMemCreateMemory().run(
+    space_id=space_id,
+    text_content="The capital of France is Paris.",
+)
+
+results = json.loads(
+    GoodMemRetrieveMemories().run(
+        query="What is the capital of France?",
+        space_ids=space_id,
+        max_results=3,
+    )
+)
+print(results)
+```
+
+Every operation's `run(...)` returns a JSON string. On success the parsed
+object includes `"success": true` and operation-specific fields. On failure
+it includes `"success": false` and an `"error"` field.
+
+The local GoodMem dev server ships with TLS even on localhost. Set
+`GOODMEM_VERIFY_SSL=false` to accept the self-signed certificate during
+development; production deployments behind a trusted certificate should
+leave it at the default of `true`.
+
+## Available operations
+
+| Operation | Description |
+|---|---|
+| `GoodMemListEmbedders` | List embedder models available on the server |
+| `GoodMemListSpaces` | List all spaces accessible to the API key |
+| `GoodMemGetSpace` | Fetch a space by ID |
+| `GoodMemCreateSpace` | Create a space (idempotent by name) |
+| `GoodMemUpdateSpace` | Update a space's name, labels, or public-read flag |
+| `GoodMemDeleteSpace` | Delete a space and all of its memories |
+| `GoodMemCreateMemory` | Store text or a file as a memory |
+| `GoodMemListMemories` | List memories in a space, with pagination and filters |
+| `GoodMemRetrieveMemories` | Semantic retrieval across one or more spaces |
+| `GoodMemGetMemory` | Fetch a memory by ID, with optional content |
+| `GoodMemDeleteMemory` | Delete a memory |
+
+### Retrieval options
+
+`GoodMemRetrieveMemories` accepts the following parameters in addition to
+`query`, `space_ids`, and `max_results`:
+
+| Parameter | Type | Description |
+|---|---|---|
+| `metadata_filter` | str | SQL-style JSONPath filter applied server-side to every space key. Example: `CAST(val('$.category') AS TEXT) = 'feat'` |
+| `wait_for_indexing` | bool | Poll for results when none come back on the first call (default `True`) |
+| `max_wait_seconds` | float | Polling budget (default `60.0`) |
+| `poll_interval` | float | Seconds between polls (default `5.0`) |
+| `reranker_id` | str | Reranker model to refine result ordering |
+| `llm_id` | str | LLM that generates a contextual abstract reply |
+| `relevance_threshold` | float | Minimum score (0-1) for inclusion |
+| `llm_temperature` | float | Creativity (0-2) for the LLM post-processor |
+| `chronological_resort` | bool | Reorder results by creation time |
+
+## Environment variables
+
+| Variable | Description |
+|---|---|
+| `GOODMEM_BASE_URL` | Base URL of the GoodMem API server |
+| `GOODMEM_API_KEY` | API key sent as `X-API-Key` |
+| `GOODMEM_VERIFY_SSL` | Set to `false` to skip TLS verification (default `true`) |
+
+When the env vars are set, every operation constructor can be called with
+no arguments.
+
+## End-to-end example
+
+[`examples/example_usage.py`](examples/example_usage.py) walks through three
+scenarios: persistent project context, a scribe and analyst pipeline, and
+metadata-driven retrieval. The answering step uses OpenAI; install with
+`pip install deepeval-goodmem[examples]` and set `OPENAI_API_KEY` before
+running.
+
+```bash
+python examples/example_usage.py
+```
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).

deepeval_goodmem-0.1.0/deepeval_goodmem/__init__.py

@@ -0,0 +1,31 @@
+"""DeepEval plugin for GoodMem, the retrieval-augmented generation (RAG) memory backend for AI agents."""
+
+from deepeval_goodmem._base import GoodMemOperation
+from deepeval_goodmem._client import GoodMemClient
+from deepeval_goodmem.create_memory import GoodMemCreateMemory
+from deepeval_goodmem.create_space import GoodMemCreateSpace
+from deepeval_goodmem.delete_memory import GoodMemDeleteMemory
+from deepeval_goodmem.delete_space import GoodMemDeleteSpace
+from deepeval_goodmem.get_memory import GoodMemGetMemory
+from deepeval_goodmem.get_space import GoodMemGetSpace
+from deepeval_goodmem.list_embedders import GoodMemListEmbedders
+from deepeval_goodmem.list_memories import GoodMemListMemories
+from deepeval_goodmem.list_spaces import GoodMemListSpaces
+from deepeval_goodmem.retrieve_memories import GoodMemRetrieveMemories
+from deepeval_goodmem.update_space import GoodMemUpdateSpace
+
+__all__ = [
+    "GoodMemClient",
+    "GoodMemCreateMemory",
+    "GoodMemCreateSpace",
+    "GoodMemDeleteMemory",
+    "GoodMemDeleteSpace",
+    "GoodMemGetMemory",
+    "GoodMemGetSpace",
+    "GoodMemListEmbedders",
+    "GoodMemListMemories",
+    "GoodMemListSpaces",
+    "GoodMemOperation",
+    "GoodMemRetrieveMemories",
+    "GoodMemUpdateSpace",
+]

deepeval_goodmem-0.1.0/deepeval_goodmem/_base.py

@@ -0,0 +1,89 @@
+"""Base class for GoodMem operations."""
+
+import json
+import os
+from typing import Any
+
+from deepeval_goodmem._client import GoodMemClient
+
+
+def _env_bool(value: str | None, default: bool = True) -> bool:
+    """Parse a boolean from an environment variable string."""
+    if value is None:
+        return default
+    return value.strip().lower() in {"1", "true", "yes", "y", "on"}
+
+
+class GoodMemOperation:
+    """Base class for GoodMem operation wrappers.
+
+    Each subclass exposes a single GoodMem API action and serializes its
+    result as a JSON string.
+
+    Args:
+        goodmem_base_url: The GoodMem API base URL. Falls back to the
+            `GOODMEM_BASE_URL` environment variable.
+        goodmem_api_key: The GoodMem API key. Falls back to the
+            `GOODMEM_API_KEY` environment variable.
+        goodmem_verify_ssl: Whether to verify SSL certificates. Falls back
+            to the `GOODMEM_VERIFY_SSL` environment variable (default: True).
+    """
+
+    name: str = "goodmem_operation"
+    description: str = ""
+
+    def __init__(
+        self,
+        *,
+        goodmem_base_url: str | None = None,
+        goodmem_api_key: str | None = None,
+        goodmem_verify_ssl: bool | None = None,
+    ) -> None:
+        base_url = goodmem_base_url or os.environ.get("GOODMEM_BASE_URL")
+        api_key = goodmem_api_key or os.environ.get("GOODMEM_API_KEY")
+
+        if not base_url:
+            msg = (
+                "GoodMem base URL is required. Pass `goodmem_base_url` or set "
+                "the GOODMEM_BASE_URL environment variable."
+            )
+            raise ValueError(msg)
+        if not api_key:
+            msg = (
+                "GoodMem API key is required. Pass `goodmem_api_key` or set "
+                "the GOODMEM_API_KEY environment variable."
+            )
+            raise ValueError(msg)
+
+        if goodmem_verify_ssl is None:
+            verify_ssl = _env_bool(os.environ.get("GOODMEM_VERIFY_SSL"), default=True)
+        else:
+            verify_ssl = goodmem_verify_ssl
+
+        self.goodmem_base_url = base_url
+        self.goodmem_api_key = api_key
+        self.goodmem_verify_ssl = verify_ssl
+
+    def _client(self) -> GoodMemClient:
+        """Return a fresh `GoodMemClient` for this operation."""
+        return GoodMemClient(
+            base_url=self.goodmem_base_url,
+            api_key=self.goodmem_api_key,
+            verify_ssl=self.goodmem_verify_ssl,
+        )
+
+    def run(self, **kwargs: Any) -> str:
+        """Run the operation and return the result as a JSON string.
+
+        On failure, the JSON payload contains `success: false` and an
+        `error` field with the exception message.
+        """
+        try:
+            result = self._run(**kwargs)
+        except Exception as e:
+            result = {"success": False, "error": str(e)}
+        return json.dumps(result)
+
+    def _run(self, **kwargs: Any) -> dict[str, Any]:
+        """Perform the API call. Subclasses must implement this."""
+        raise NotImplementedError