hydra-db-python 0.1.3__tar.gz

hydra_db_python-0.1.3/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2026 Hydra DB
+
+All Rights Reserved.
+
+PROPRIETARY AND CONFIDENTIAL
+
+This software is the proprietary and confidential property of AGI Context, INC ("the Company").
+Permission is hereby granted to users to install and use this software as part of the Hydra DB service, subject to the terms and conditions of the service agreement entered into with the Company.
+
+You may not, without the express written permission of the Company:
+
+1. Copy, modify, or create derivative works of the software.
+2. Distribute, sell, rent, lease, sublicense, or otherwise transfer the software to any third party.
+3. Reverse engineer, decompile, or disassemble the software, except and only to the extent that such activity is expressly permitted by applicable law notwithstanding this limitation.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

hydra_db_python-0.1.3/PKG-INFO

@@ -0,0 +1,229 @@
+Metadata-Version: 2.4
+Name: hydra-db-python
+Version: 0.1.3
+Summary: The official Python SDK for the Hydra DB (hydradb.com)
+Author-email: Soham Ratnaparkhi <soham@usecortex.ai>
+License: Copyright (c) 2026 Hydra DB
+        
+        All Rights Reserved.
+        
+        PROPRIETARY AND CONFIDENTIAL
+        
+        This software is the proprietary and confidential property of AGI Context, INC ("the Company").
+        Permission is hereby granted to users to install and use this software as part of the Hydra DB service, subject to the terms and conditions of the service agreement entered into with the Company.
+        
+        You may not, without the express written permission of the Company:
+        
+        1. Copy, modify, or create derivative works of the software.
+        2. Distribute, sell, rent, lease, sublicense, or otherwise transfer the software to any third party.
+        3. Reverse engineer, decompile, or disassemble the software, except and only to the extent that such activity is expressly permitted by applicable law notwithstanding this limitation.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://hydradb.com/
+Project-URL: Documentation, https://docs.hydradb.com/
+Keywords: hydra-db,ai,sdk,api,generative ai,rag,db
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.24
+Requires-Dist: pydantic<3,>=1.10
+Dynamic: license-file
+
+# Hydra DB Python SDK - [hydradb.com](https://www.hydradb.com/)
+
+The official Python SDK for the Hydra DB platform. Build powerful, context-aware AI applications in your Python applications.
+
+**Hydra DB** is your plug-and-play memory infrastructure. It powers intelligent, context-aware retrieval for any AI app or agent. Whether you’re building a customer support bot, research copilot, or internal knowledge assistant.
+
+[Learn more about the SDK from our docs](https://docs.hydradb.com)
+
+## Core features
+
+* **Dynamic retrieval and querying** that always retrieve the most relevant context
+* **Built-in long-term memory** that evolves with every user interaction
+* **Personalization hooks** for user preferences, intent, and history
+* **Developer-first SDK** with the most flexible APIs and fine-grained controls
+
+## Getting started
+
+### Installation
+
+```bash
+pip install hydra-db-python
+```
+
+### Client setup
+
+We provide both synchronous and asynchronous clients. Use **`AsyncHydraDB`** when working with async/await patterns, and **`HydraDB`** for traditional synchronous workflows. Client initialization does not trigger any network requests, so you can safely create as many client instances as needed. Both clients expose the exact same set of methods.
+
+```python
+import os
+from hydra_db import HydraDB, AsyncHydraDB
+
+api_key = os.environ["HYDRA_DB_API_KEY"]  # Set your Hydra DB API key in the environment variable HYDRA_DB_API_KEY. Optional, but recommended.
+
+# Sync client
+client = HydraDB(token=api_key)
+
+# Async client (for async/await usage)
+async_client = AsyncHydraDB(token=api_key)
+```
+
+### Create a Tenant
+
+You can consider a `tenant` as a single database that can have internal isolated collections called `sub-tenants`. [Know more about the concept of tenant here](https://docs.hydradb.com/essentials/multi-tenant)
+
+```python
+def create_tenant():
+    return client.tenant.create(tenant_id="my-company")
+```
+
+### Ingest Your Data
+
+When you index your data, you make it ready for retrieval from Hydra DB using natural language.
+
+```python
+# ingest in your knowledge base
+with open("a.pdf", 'rb') as f1, open("b.pdf", 'rb') as f2:
+    files = [
+        ("a.pdf", f1),
+        ("b.pdf", f2)
+    ]
+    upload_result = client.upload.knowledge(
+        tenant_id="tenant_123",
+        files=files,
+        file_metadata=[
+            {
+                "id": "doc_a",
+                "tenant_metadata": {"dept": "sales"},
+                "document_metadata": {"author": "Alice"}
+            },
+            {
+                "id": "doc_b",
+                "tenant_metadata": {"dept": "marketing"},
+                "document_metadata": {"author": "Bob"}
+            }
+        ]
+    ))
+
+# Ingest user memories
+from hydra_db import HydraDBClient
+
+client = HydraDBClient(api_key="your_api_key")
+
+# Simple text memory
+result = client.user_memory.add(
+    memories=[
+        {
+            "text": "User prefers detailed explanations and dark mode",
+            "infer": True,
+            "user_name": "John"
+        }
+    ],
+    tenant_id="tenant-01",
+    sub_tenant_id="",
+    upsert=True
+)
+
+# Markdown content
+markdown_result = client.user_memory.add(
+    memories=[
+        {
+            "text": "# Meeting Notes\n\n## Key Points\n- Budget approved",
+            "is_markdown": True,
+            "infer": False,
+            "title": "Meeting Notes"
+        }
+    ],
+    tenant_id="tenant-01",
+    sub_tenant_id="",
+    upsert=True
+)
+
+# User-assistant pairs with inference
+conversation_result = client.user_memory.add(
+    memories=[
+        {
+            "user_assistant_pairs": [
+                {"user": "What are my preferences?", "assistant": "You prefer dark mode."},
+                {"user": "How do I like reports?", "assistant": "Weekly summaries with charts."}
+            ],
+            "infer": True,
+            "user_name": "John",
+            "custom_instructions": "Extract user preferences"
+        }
+    ],
+    tenant_id="tenant-01",
+    sub_tenant_id="",
+    upsert=True
+)
+```
+
+**For a more detailed explanation** of document upload, including supported file formats, processing pipeline, metadata handling, and advanced configuration options, refer to the [Ingest Knowledge endpoint](https://docs.hydradb.com/api-reference/endpoint/add-knowledge-memories).
+
+### Search
+
+```python
+# Semantic Recall
+results = client.recall.full_recall(
+    query="Which mode does user prefer",
+    tenant_id="tenant_1234",
+    sub_tenant_id="sub_tenant_4567",
+    alpha=0.8,
+    recency_bias=0
+)
+
+# Get ingested data (memories + knowledge base)
+all_sources = client.data.list_data(
+    tenant_id="tenant_1234",
+    sub_tenant_id="sub_tenant_4567"
+)
+```
+
+**For a more detailed explanation** of search and retrieval, including query parameters, scoring mechanisms, result structure, and advanced search features, refer to the [Search endpoint documentation](https://docs.hydradb.com/api-reference/endpoint/search).
+
+## SDK Method Structure & Type Safety
+
+Our SDKs follow a predictable pattern that mirrors the API structure while providing full type safety.
+
+> **Method Mapping** : `client.<group>.<function_name>` mirrors  `api.hydradb.com/<group>/<function_name>`
+>
+> For example: `client.upload.upload_text()` corresponds to `POST /upload/upload_text`
+
+The SDKs provide exact type parity with the API specification:
+
+- **Request Parameters** : Every field documented in the API reference (required, optional, types, validation rules) is reflected in the SDK method signatures
+- **Response Objects** : Return types match the exact JSON schema documented for each endpoint
+- **Error Types** : Exception structures mirror the error response formats from the API
+- **Nested Objects** : Complex nested parameters and responses maintain their full structure and typing
+
+> This means you can rely on your IDE’s autocomplete and type checking. If a parameter is optional in the API docs, it’s optional in the SDK. If a response contains a specific field, your IDE will know about it. Our SDKs are built in such a way that your IDE will automatically provide **autocompletion, type-checking, inline documentation with examples, and compile time validation** for each and every method.
+>
+> Just hit **Cmd+Space/Ctrl+Space**
+
+## Links
+
+- **Homepage:** [hydradb.com](https://www.hydradb.com/)
+- **Documentation:** [docs.usecortex.ai](https://docs.usecortex.ai/)
+
+## Our docs
+
+Please refer to our [API reference](https://docs.usecortex.ai/api-reference/introduction) for detailed explanations of every API endpoint, parameter options, and advanced use cases.
+
+## Support
+
+If you have any questions or need help, please reach out to our support team at [founders@usecortex.ai](mailto:founders@usecortex.ai).

hydra_db_python-0.1.3/README.md

@@ -0,0 +1,184 @@
+# Hydra DB Python SDK - [hydradb.com](https://www.hydradb.com/)
+
+The official Python SDK for the Hydra DB platform. Build powerful, context-aware AI applications in your Python applications.
+
+**Hydra DB** is your plug-and-play memory infrastructure. It powers intelligent, context-aware retrieval for any AI app or agent. Whether you’re building a customer support bot, research copilot, or internal knowledge assistant.
+
+[Learn more about the SDK from our docs](https://docs.hydradb.com)
+
+## Core features
+
+* **Dynamic retrieval and querying** that always retrieve the most relevant context
+* **Built-in long-term memory** that evolves with every user interaction
+* **Personalization hooks** for user preferences, intent, and history
+* **Developer-first SDK** with the most flexible APIs and fine-grained controls
+
+## Getting started
+
+### Installation
+
+```bash
+pip install hydra-db-python
+```
+
+### Client setup
+
+We provide both synchronous and asynchronous clients. Use **`AsyncHydraDB`** when working with async/await patterns, and **`HydraDB`** for traditional synchronous workflows. Client initialization does not trigger any network requests, so you can safely create as many client instances as needed. Both clients expose the exact same set of methods.
+
+```python
+import os
+from hydra_db import HydraDB, AsyncHydraDB
+
+api_key = os.environ["HYDRA_DB_API_KEY"]  # Set your Hydra DB API key in the environment variable HYDRA_DB_API_KEY. Optional, but recommended.
+
+# Sync client
+client = HydraDB(token=api_key)
+
+# Async client (for async/await usage)
+async_client = AsyncHydraDB(token=api_key)
+```
+
+### Create a Tenant
+
+You can consider a `tenant` as a single database that can have internal isolated collections called `sub-tenants`. [Know more about the concept of tenant here](https://docs.hydradb.com/essentials/multi-tenant)
+
+```python
+def create_tenant():
+    return client.tenant.create(tenant_id="my-company")
+```
+
+### Ingest Your Data
+
+When you index your data, you make it ready for retrieval from Hydra DB using natural language.
+
+```python
+# ingest in your knowledge base
+with open("a.pdf", 'rb') as f1, open("b.pdf", 'rb') as f2:
+    files = [
+        ("a.pdf", f1),
+        ("b.pdf", f2)
+    ]
+    upload_result = client.upload.knowledge(
+        tenant_id="tenant_123",
+        files=files,
+        file_metadata=[
+            {
+                "id": "doc_a",
+                "tenant_metadata": {"dept": "sales"},
+                "document_metadata": {"author": "Alice"}
+            },
+            {
+                "id": "doc_b",
+                "tenant_metadata": {"dept": "marketing"},
+                "document_metadata": {"author": "Bob"}
+            }
+        ]
+    ))
+
+# Ingest user memories
+from hydra_db import HydraDBClient
+
+client = HydraDBClient(api_key="your_api_key")
+
+# Simple text memory
+result = client.user_memory.add(
+    memories=[
+        {
+            "text": "User prefers detailed explanations and dark mode",
+            "infer": True,
+            "user_name": "John"
+        }
+    ],
+    tenant_id="tenant-01",
+    sub_tenant_id="",
+    upsert=True
+)
+
+# Markdown content
+markdown_result = client.user_memory.add(
+    memories=[
+        {
+            "text": "# Meeting Notes\n\n## Key Points\n- Budget approved",
+            "is_markdown": True,
+            "infer": False,
+            "title": "Meeting Notes"
+        }
+    ],
+    tenant_id="tenant-01",
+    sub_tenant_id="",
+    upsert=True
+)
+
+# User-assistant pairs with inference
+conversation_result = client.user_memory.add(
+    memories=[
+        {
+            "user_assistant_pairs": [
+                {"user": "What are my preferences?", "assistant": "You prefer dark mode."},
+                {"user": "How do I like reports?", "assistant": "Weekly summaries with charts."}
+            ],
+            "infer": True,
+            "user_name": "John",
+            "custom_instructions": "Extract user preferences"
+        }
+    ],
+    tenant_id="tenant-01",
+    sub_tenant_id="",
+    upsert=True
+)
+```
+
+**For a more detailed explanation** of document upload, including supported file formats, processing pipeline, metadata handling, and advanced configuration options, refer to the [Ingest Knowledge endpoint](https://docs.hydradb.com/api-reference/endpoint/add-knowledge-memories).
+
+### Search
+
+```python
+# Semantic Recall
+results = client.recall.full_recall(
+    query="Which mode does user prefer",
+    tenant_id="tenant_1234",
+    sub_tenant_id="sub_tenant_4567",
+    alpha=0.8,
+    recency_bias=0
+)
+
+# Get ingested data (memories + knowledge base)
+all_sources = client.data.list_data(
+    tenant_id="tenant_1234",
+    sub_tenant_id="sub_tenant_4567"
+)
+```
+
+**For a more detailed explanation** of search and retrieval, including query parameters, scoring mechanisms, result structure, and advanced search features, refer to the [Search endpoint documentation](https://docs.hydradb.com/api-reference/endpoint/search).
+
+## SDK Method Structure & Type Safety
+
+Our SDKs follow a predictable pattern that mirrors the API structure while providing full type safety.
+
+> **Method Mapping** : `client.<group>.<function_name>` mirrors  `api.hydradb.com/<group>/<function_name>`
+>
+> For example: `client.upload.upload_text()` corresponds to `POST /upload/upload_text`
+
+The SDKs provide exact type parity with the API specification:
+
+- **Request Parameters** : Every field documented in the API reference (required, optional, types, validation rules) is reflected in the SDK method signatures
+- **Response Objects** : Return types match the exact JSON schema documented for each endpoint
+- **Error Types** : Exception structures mirror the error response formats from the API
+- **Nested Objects** : Complex nested parameters and responses maintain their full structure and typing
+
+> This means you can rely on your IDE’s autocomplete and type checking. If a parameter is optional in the API docs, it’s optional in the SDK. If a response contains a specific field, your IDE will know about it. Our SDKs are built in such a way that your IDE will automatically provide **autocompletion, type-checking, inline documentation with examples, and compile time validation** for each and every method.
+>
+> Just hit **Cmd+Space/Ctrl+Space**
+
+## Links
+
+- **Homepage:** [hydradb.com](https://www.hydradb.com/)
+- **Documentation:** [docs.usecortex.ai](https://docs.usecortex.ai/)
+
+## Our docs
+
+Please refer to our [API reference](https://docs.usecortex.ai/api-reference/introduction) for detailed explanations of every API endpoint, parameter options, and advanced use cases.
+
+## Support
+
+If you have any questions or need help, please reach out to our support team at [founders@usecortex.ai](mailto:founders@usecortex.ai).

hydra_db_python-0.1.3/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "hydra-db-python"
+
+version = "0.1.3"
+
+authors = [
+  { name = "Soham Ratnaparkhi", email = "soham@usecortex.ai" },
+]
+description = "The official Python SDK for the Hydra DB (hydradb.com)"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { file = "LICENSE" }
+keywords = ["hydra-db", "ai", "sdk", "api", "generative ai", "rag", "db"]
+
+# Add classifiers to help users find your package on PyPI
+classifiers = [
+    # See https://pypi.org/classifiers/
+    "Development Status :: 5 - Production/Stable",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+
+dependencies = [
+  "httpx>=0.24",
+  "pydantic>=1.10,<3",
+]
+
+[project.urls]
+Homepage = "https://hydradb.com/"
+Documentation = "https://docs.hydradb.com/"
+

hydra_db_python-0.1.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

hydra_db_python-0.1.3/src/hydra_db/__init__.py

@@ -0,0 +1,160 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .types import (
+    ActualErrorResponse,
+    AddMemoryResponse,
+    Alpha,
+    ApiKeyCreateResponse,
+    AttachmentModel,
+    BatchProcessingStatus,
+    Bm25OperatorType,
+    CollectionStats,
+    ContentFilter,
+    ContentModel,
+    CustomPropertyDefinition,
+    DeleteResult,
+    DeleteUserMemoryResponse,
+    Entity,
+    ErrorResponse,
+    FetchMode,
+    ForcefulRelationsPayload,
+    GraphContext,
+    Infra,
+    InfraStatusResponse,
+    InsertResult,
+    ListContentKind,
+    ListUserMemoriesResponse,
+    MemoryItem,
+    MemoryResultItem,
+    MilvusDataType,
+    PaginationMeta,
+    PathTriplet,
+    ProcessingStatus,
+    ProcessingStatusIndexingStatus,
+    QnASearchResponse,
+    RawEmbeddingDocument,
+    RawEmbeddingSearchResult,
+    RawEmbeddingVector,
+    RecallSearchRequest,
+    RelationEvidence,
+    RetrievalResult,
+    RetrieveMode,
+    ScoredPathResponse,
+    SearchMode,
+    SourceDeleteResponse,
+    SourceDeleteResultItem,
+    SourceFetchResponse,
+    SourceGraphRelationsResponse,
+    SourceInfo,
+    SourceListResponse,
+    SourceModel,
+    SourceStatus,
+    SourceUploadResponse,
+    SourceUploadResultItem,
+    SubTenantIdsResponse,
+    SupportedLlmProviders,
+    TenantCreateAcceptedResponse,
+    TenantDeleteResponse,
+    TenantStatsResponse,
+    TripletWithEvidence,
+    UserAssistantPair,
+    UserMemory,
+    VectorStoreChunk,
+)
+from .errors import (
+    BadRequestError,
+    ForbiddenError,
+    InternalServerError,
+    NotFoundError,
+    ServiceUnavailableError,
+    TooManyRequestsError,
+    UnauthorizedError,
+    UnprocessableEntityError,
+)
+from . import data, embeddings, fetch, key, recall, tenant, upload
+from .client import AsyncHydraDB, HydraDB
+from .environment import HydraDBEnvironment
+from .fetch import FetchListDataResponse
+
+__all__ = [
+    "ActualErrorResponse",
+    "AddMemoryResponse",
+    "Alpha",
+    "ApiKeyCreateResponse",
+    "AsyncHydraDB",
+    "AttachmentModel",
+    "BadRequestError",
+    "BatchProcessingStatus",
+    "Bm25OperatorType",
+    "CollectionStats",
+    "ContentFilter",
+    "ContentModel",
+    "CustomPropertyDefinition",
+    "DeleteResult",
+    "DeleteUserMemoryResponse",
+    "Entity",
+    "ErrorResponse",
+    "FetchListDataResponse",
+    "FetchMode",
+    "ForbiddenError",
+    "ForcefulRelationsPayload",
+    "GraphContext",
+    "HydraDB",
+    "HydraDBEnvironment",
+    "Infra",
+    "InfraStatusResponse",
+    "InsertResult",
+    "InternalServerError",
+    "ListContentKind",
+    "ListUserMemoriesResponse",
+    "MemoryItem",
+    "MemoryResultItem",
+    "MilvusDataType",
+    "NotFoundError",
+    "PaginationMeta",
+    "PathTriplet",
+    "ProcessingStatus",
+    "ProcessingStatusIndexingStatus",
+    "QnASearchResponse",
+    "RawEmbeddingDocument",
+    "RawEmbeddingSearchResult",
+    "RawEmbeddingVector",
+    "RecallSearchRequest",
+    "RelationEvidence",
+    "RetrievalResult",
+    "RetrieveMode",
+    "ScoredPathResponse",
+    "SearchMode",
+    "ServiceUnavailableError",
+    "SourceDeleteResponse",
+    "SourceDeleteResultItem",
+    "SourceFetchResponse",
+    "SourceGraphRelationsResponse",
+    "SourceInfo",
+    "SourceListResponse",
+    "SourceModel",
+    "SourceStatus",
+    "SourceUploadResponse",
+    "SourceUploadResultItem",
+    "SubTenantIdsResponse",
+    "SupportedLlmProviders",
+    "TenantCreateAcceptedResponse",
+    "TenantDeleteResponse",
+    "TenantStatsResponse",
+    "TooManyRequestsError",
+    "TripletWithEvidence",
+    "UnauthorizedError",
+    "UnprocessableEntityError",
+    "UserAssistantPair",
+    "UserMemory",
+    "VectorStoreChunk",
+    "data",
+    "embeddings",
+    "fetch",
+    "key",
+    "recall",
+    "tenant",
+    "upload",
+]