projectdavid 1.0.24__tar.gz

projectdavid-1.0.24/CHANGELOG.md

@@ -0,0 +1,256 @@
+## [1.0.24](https://github.com/frankie336/entitites_sdk/compare/v1.0.23...v1.0.24) (2025-04-08)
+
+
+### Bug Fixes
+
+* name change-projectdavid ([0632dc7](https://github.com/frankie336/entitites_sdk/commit/0632dc74fc7b3a500365b95cde21c9dbc6d3e4fc))
+
+## [1.0.23](https://github.com/frankie336/entitites_sdk/compare/v1.0.22...v1.0.23) (2025-04-08)
+
+
+### Bug Fixes
+
+* name change ([0c7d4dd](https://github.com/frankie336/entitites_sdk/commit/0c7d4ddd04538ee0d089bbf96e1aaffd65e67e81))
+
+## [1.0.22](https://github.com/frankie336/entitites_sdk/compare/v1.0.21...v1.0.22) (2025-04-08)
+
+
+### Bug Fixes
+
+* name change ([654c9e9](https://github.com/frankie336/entitites_sdk/commit/654c9e936bf28d7e0c754c93ca9f5d68b16b4f36))
+
+## [1.0.21](https://github.com/frankie336/entitites_sdk/compare/v1.0.20...v1.0.21) (2025-04-08)
+
+
+### Bug Fixes
+
+* workflow ([583145e](https://github.com/frankie336/entitites_sdk/commit/583145ec50ca882332613e802ae0c5f55c9122ce))
+
+## [1.0.20](https://github.com/frankie336/entitites_sdk/compare/v1.0.19...v1.0.20) (2025-04-08)
+
+
+### Bug Fixes
+
+* black formatting. ([34572e3](https://github.com/frankie336/entitites_sdk/commit/34572e32c5858bda4b19efbc21455609d79a2c84))
+* conditional release in ci. ([22242ee](https://github.com/frankie336/entitites_sdk/commit/22242ee05ea0ca5552b82d56c7ac7fcb2bba0ad7))
+* def _internal_add_file_to_vector_store_async-validation-type ([fa97c40](https://github.com/frankie336/entitites_sdk/commit/fa97c4064ea542601199b117f6c4a1d6a6e69fa6))
+* entities release.json ([884a2b5](https://github.com/frankie336/entitites_sdk/commit/884a2b56aa6d864dab45a718ae135bcef7206895))
+* entities release.json2 ([8c0c8d6](https://github.com/frankie336/entitites_sdk/commit/8c0c8d6c078fa04c4aeb230a1680e430c379c7a4))
+* entities release.json3 ([0c09a5f](https://github.com/frankie336/entitites_sdk/commit/0c09a5ff942cfd02b86906feb8cb8775e02a6a08))
+* entities version in requirements.txt. ([34d7394](https://github.com/frankie336/entitites_sdk/commit/34d7394199b86692ef4ddaa4b5c6cd721afefe81))
+* entities version in requirements.txt2. ([bd47a4c](https://github.com/frankie336/entitites_sdk/commit/bd47a4c8071fedec21c7418c5c7da5c3ee76711b))
+* entities version in requirements.txt3. ([3d49ff9](https://github.com/frankie336/entitites_sdk/commit/3d49ff9d20271c6bb02f01f622e7b8bffdb81d24))
+* entities_common version. ([edd6cd2](https://github.com/frankie336/entitites_sdk/commit/edd6cd24bf5d3fd16c2fa159316e166f347605d6))
+* isort ([072f3c4](https://github.com/frankie336/entitites_sdk/commit/072f3c430903c778d8504524f4b220d99aaaa0a3))
+* isort import order ([6595b0d](https://github.com/frankie336/entitites_sdk/commit/6595b0d7e1ba800d06e85f32d3dfa793541ff9b6))
+* isort imports ([0a16a41](https://github.com/frankie336/entitites_sdk/commit/0a16a41b68160f7afffe1d951879ad01d9f84c55))
+* isort imports3 ([fe515b1](https://github.com/frankie336/entitites_sdk/commit/fe515b14e804b4381eed23e2568a980b051c76ed))
+* publish ([6eee97a](https://github.com/frankie336/entitites_sdk/commit/6eee97ad114cd4f119a9e6610b8981c8739d9eaa))
+* remove non release branch from CI logic ([4e37ece](https://github.com/frankie336/entitites_sdk/commit/4e37ece55899dd64ee666cb6327393d5fc9316f2))
+* remove non release branch from CI logic2 ([db1bb94](https://github.com/frankie336/entitites_sdk/commit/db1bb9422cc70326001f14ee82df4963c6c3a954))
+* run black formatting. ([babcdf1](https://github.com/frankie336/entitites_sdk/commit/babcdf178ee3ce5e159b890dca64a10350f2e70e))
+* scripts/update_pyproject_version.py ([ee62a49](https://github.com/frankie336/entitites_sdk/commit/ee62a49866c1a36058e56ca801556a0c533b95d1))
+* toml file path ([f1ec5b4](https://github.com/frankie336/entitites_sdk/commit/f1ec5b4df7c5ad02cf811f5fb9dcd956045defe6))
+
+## [1.0.19](https://github.com/frankie336/entitites_sdk/compare/v1.0.18...v1.0.19) (2025-04-07)
+
+
+### Bug Fixes
+
+* def _internal_add_file_to_vector_store_async-validation-type ([bd21178](https://github.com/frankie336/entitites_sdk/commit/bd2117874842e52d403aff905cc44944166ac46d))
+
+## [1.0.18](https://github.com/frankie336/entitites_sdk/compare/v1.0.17...v1.0.18) (2025-04-07)
+
+
+### Bug Fixes
+
+* def _internal_add_file_to_vector_store_async ([60e88b3](https://github.com/frankie336/entitites_sdk/commit/60e88b35cf53aad55c17d4376282c5aa5c689efa))
+
+## [1.0.17](https://github.com/frankie336/entitites_sdk/compare/v1.0.16...v1.0.17) (2025-04-07)
+
+
+### Bug Fixes
+
+* store_name param ([3fc8b50](https://github.com/frankie336/entitites_sdk/commit/3fc8b5047b103b1860c26cbe82efa77cdd1bda91))
+
+## [1.0.16](https://github.com/frankie336/entitites_sdk/compare/v1.0.15...v1.0.16) (2025-04-07)
+
+
+### Bug Fixes
+
+* store_name param ([d991581](https://github.com/frankie336/entitites_sdk/commit/d9915812dae6aa00d819b81f62a49a09154ee348))
+
+## [1.0.15](https://github.com/frankie336/entitites_sdk/compare/v1.0.14...v1.0.15) (2025-04-06)
+
+
+### Bug Fixes
+
+* Vector store collection name issue ([eed4db5](https://github.com/frankie336/entitites_sdk/commit/eed4db5c3dcffbdc5a9b11d3495bec3e18706825))
+
+## [1.0.14](https://github.com/frankie336/entitites_sdk/compare/v1.0.13...v1.0.14) (2025-04-06)
+
+
+### Bug Fixes
+
+* Migrate vector store endpoints ([7efbeea](https://github.com/frankie336/entitites_sdk/commit/7efbeeaebf0306f7f6d6d62c47f878e586c161d9))
+
+## [1.0.13](https://github.com/frankie336/entitites_sdk/compare/v1.0.12...v1.0.13) (2025-04-06)
+
+
+### Bug Fixes
+
+* add sentence-transformers dependency to toml ([0c684b5](https://github.com/frankie336/entitites_sdk/commit/0c684b558c2c8b1b018ddd0a52b2052ee5ae4b99))
+
+## [1.0.12](https://github.com/frankie336/entitites_sdk/compare/v1.0.11...v1.0.12) (2025-04-06)
+
+
+### Bug Fixes
+
+* add validators dependency ([2c52f21](https://github.com/frankie336/entitites_sdk/commit/2c52f212035ed9245540d93df064aedf4a2cb7e0))
+
+## [1.0.11](https://github.com/frankie336/entitites_sdk/compare/v1.0.10...v1.0.11) (2025-04-06)
+
+
+### Bug Fixes
+
+* README.md with correct badge ([a59df73](https://github.com/frankie336/entitites_sdk/commit/a59df73a289e5847d2246686da448ab1d4ad257c))
+
+## [1.0.10](https://github.com/frankie336/entitites_sdk/compare/v1.0.9...v1.0.10) (2025-04-06)
+
+
+### Bug Fixes
+
+* Add missing dependencies to toml ([5a78cdc](https://github.com/frankie336/entitites_sdk/commit/5a78cdc170390ffcc95f85aba000e9868a7d33db))
+
+## [1.0.9](https://github.com/frankie336/entitites_sdk/compare/v1.0.8...v1.0.9) (2025-04-06)
+
+
+### Bug Fixes
+
+* _version.py relative import error ([96a5be4](https://github.com/frankie336/entitites_sdk/commit/96a5be4dd5ad85bb158332c7ca86dfe87151af31))
+
+## [1.0.8](https://github.com/frankie336/entitites_sdk/compare/v1.0.7...v1.0.8) (2025-04-06)
+
+
+### Bug Fixes
+
+* test_tag_release.yml ([53bb318](https://github.com/frankie336/entitites_sdk/commit/53bb3186d60dfc38ba76c3180cc064a3f193d42e))
+
+## [1.0.7](https://github.com/frankie336/entitites_sdk/compare/v1.0.6...v1.0.7) (2025-04-06)
+
+
+### Bug Fixes
+
+* update workflow to use new trusted publisher and build flow ([1179def](https://github.com/frankie336/entitites_sdk/commit/1179def6e74ef2cbcb4dc570cd76d239ad84e1b2))
+
+## [1.0.6](https://github.com/frankie336/entitites_sdk/compare/v1.0.5...v1.0.6) (2025-04-06)
+
+
+### Bug Fixes
+
+* align pyproject version to v1.0.5 ([e8d12e0](https://github.com/frankie336/entitites_sdk/commit/e8d12e0e86f46d745a8b8731c7e663180e04c143))
+
+## [1.0.5](https://github.com/frankie336/entitites_sdk/compare/v1.0.4...v1.0.5) (2025-04-06)
+
+
+### Bug Fixes
+
+* bump version to 1.0.4 ([37650d9](https://github.com/frankie336/entitites_sdk/commit/37650d948585fa3e176016b49dcad2967c83a4f2))
+* Test workflow-8 ([cc0c25e](https://github.com/frankie336/entitites_sdk/commit/cc0c25ef60732bd28d5d70ad6554745439124cf4))
+
+## [1.0.4](https://github.com/frankie336/entitites_sdk/compare/v1.0.3...v1.0.4) (2025-04-06)
+
+
+### Bug Fixes
+
+* Test workflow-3 ([0fb760c](https://github.com/frankie336/entitites_sdk/commit/0fb760c0a3dbc2a7e43256ad891e900808cf0eac))
+
+## [1.0.3](https://github.com/frankie336/entitites_sdk/compare/v1.0.2...v1.0.3) (2025-04-06)
+
+
+### Bug Fixes
+
+* Test workflow-2 ([cc8730f](https://github.com/frankie336/entitites_sdk/commit/cc8730f290b2b2a3ff10f3fc76092650debcbb5f))
+
+## [1.0.2](https://github.com/frankie336/entitites_sdk/compare/v1.0.1...v1.0.2) (2025-04-06)
+
+
+### Bug Fixes
+
+* Test workflow ([afc8e6b](https://github.com/frankie336/entitites_sdk/commit/afc8e6b4e036baa5f4a66a5bf8bed62c2ec2fde7))
+
+## [1.0.1](https://github.com/frankie336/entitites_sdk/compare/v1.0.0...v1.0.1) (2025-04-06)
+
+
+### Bug Fixes
+
+* entities_common version issue again ([6dc6c45](https://github.com/frankie336/entitites_sdk/commit/6dc6c4500c81e61278bdb0254881cc1dfc537798))
+
+# 1.0.0 (2025-04-06)
+
+
+### Bug Fixes
+
+* Fix auto release ([a9a1b2e](https://github.com/frankie336/entitites_sdk/commit/a9a1b2e0d03a707be0510e171fd57cb0c3c7d5f2))
+* Require latest entities_common in toml ([6ca402b](https://github.com/frankie336/entitites_sdk/commit/6ca402b0532946eef68e93862324d281e181cc39))
+* resolve entities_common version issue ([6b64ef6](https://github.com/frankie336/entitites_sdk/commit/6b64ef6bdde7f21245a728d106d3f95daa1422b9))
+
+
+### Features
+
+* add support for auto version tagging ([5ea9aed](https://github.com/frankie336/entitites_sdk/commit/5ea9aed79fa4f37789c463458409126d60da2388))
+
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [0.3.1] - 2025-04-05
+
+### Added
+- Trusted publishing setup for PyPI and TestPyPI, including GitHub Actions workflow with tag-based trigger.
+- `scripts/pin_entities_common.py`: utility to pin latest commit SHA from `entities_common` into `pyproject.toml` and `requirements.txt`.
+- CI workflow `pin-dependencies.yml` that auto-pins `entities_common` on each push to `main`.
+
+### Fixed
+- Flake8 linting issues across `file_processor.py` due to missing typing imports.
+- `LiteralString` fallback import for Python < 3.11 environments.
+- Typos and inconsistencies in GitHub workflow tags (`test-v*` vs `v*`) that prevented job execution.
+
+### Changed
+- Replaced dynamic `entities_common` Git dependency with pinned SHA references.
+- Made the `publish` workflow fully conformant with [Trusted Publishing](https://docs.pypi.org/trusted-publishers/).
+
+
+
+## [0.3.0] - 2025-04-04
+
+### Added
+- Introduced `RunMonitorClient` with full lifecycle event handling for assistant runs.
+- Added `EntitiesInternalInterface` as a unified internal service orchestrator.
+- `ActionsClient`, `MessagesClient`, `RunsClient`, and `VectorStoreClient` now wrapped and lazy-loaded under `Entities(...)`.
+- Support for tool invocation streaming with `on_action_required`, `on_tool_invoked`, and `on_complete` callbacks.
+- `code_interpreter_stream` and `file_download_url` support in SSE stream parsing.
+
+### Changed
+- Moved `EntitiesEventHandler` logic from Flask backend into internal API and SDK boundary.
+- enties_common package is now an auto installed dependency. No meed to install it directly. 
+
+---
+
+## [0.2.0] - 2025-03-01
+
+### Added
+
+---
+
+## [0.1.0-alpha] - 2025-01-15
+
+### Added
+- Core SDK skeleton: `Entities`, `UsersClient`, `MessagesClient`, etc.
+- Basic message submission and tool output lifecycle.
+- Initial assistant threading and function call support.

projectdavid-1.0.24/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.md
+include LICENSE
+include pyproject.toml
+include _version.py
+include CHANGELOG.md
+
+recursive-include src *
+recursive-include docs *
+recursive-exclude * __pycache__ *.pyc *.pyo *.pyd *.so *.dylib *.egg-info

projectdavid-1.0.24/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: projectdavid
+Version: 1.0.24
+Summary: Python SDK for interacting with the Entities Assistant API.
+Author-email: Francis Neequaye Armah <francis.neequaye@projectdavid.co.uk>
+License: MIT
+Keywords: AI,SDK,Entities,LLM,Assistant
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.24.1
+Requires-Dist: pydantic>=2.0
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: aiofiles>=23.2.1
+Requires-Dist: ollama>=0.3.0
+Requires-Dist: entities_common>=0.1.14
+Requires-Dist: qdrant-client
+Requires-Dist: pdfplumber
+Requires-Dist: validators
+Requires-Dist: sentence-transformers
+Provides-Extra: dev
+Requires-Dist: black>=23.3; extra == "dev"
+Requires-Dist: isort>=5.12; extra == "dev"
+Requires-Dist: pytest>=7.2; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+# Entity SDK
+[![Test, Tag, Publish Status](https://github.com/frankie336/entitites_sdk/actions/workflows/test_tag_release.yml/badge.svg)](https://github.com/frankie336/entitites_sdk/actions/workflows/test_tag_release.yml)
+
+The **Entity SDK** is a composable, Pythonic interface to the [Entities API](https://github.com/frankie336/entities_api) for building intelligent applications across **local, open-source**, and **cloud LLMs**.
+
+It unifies:
+
+- Users, threads, assistants, messages, runs, inference
+- **Function calling**, **code interpretation**, and **structured streaming**
+- Vector memory, file uploads, and secure tool orchestration
+
+Local inference is fully supported via [Ollama](https://github.com/ollama).
+
+---
+
+## 🔌 Supported Inference Providers
+
+| Provider                                         | Type                     |
+|--------------------------------------------------|--------------------------|
+| [Ollama](https://github.com/ollama)              |  **Local** (Self-Hosted) |
+| [DeepSeek](https://platform.deepseek.com/)       | ☁ **Cloud** (Open-Source) |
+| [Hyperbolic](https://hyperbolic.xyz/)            | ☁ **Cloud** (Proprietary) |
+| [OpenAI](https://platform.openai.com/)           | ☁ **Cloud** (Proprietary) |
+| [Together AI](https://www.together.ai/)          | ☁ **Cloud** (Aggregated) |
+| [Azure Foundry](https://azure.microsoft.com)     | ☁ **Cloud** (Enterprise) |
+
+---
+
+## 📦 Installation
+
+```bash
+pip install entities
+
+```
+
+---
+
+##  Quick Start
+
+```python
+from entities import Entities
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+
+client = Entities(
+    base_url='http://localhost:9000',
+    api_key=os.getenv("API_KEY")
+)
+
+user = client.users.create_user(name="demo_user")
+thread = client.threads.create_thread(participant_ids=[user.id])
+assistant = client.assistants.create_assistant(name="Demo Assistant")
+
+message = client.messages.create_message(
+    thread_id=thread.id,
+    role="user",
+    content="Hello, assistant!",
+    assistant_id=assistant.id
+)
+
+run = client.runs.create_run(
+    assistant_id=assistant.id,
+    thread_id=thread.id
+)
+
+stream = client.inference.stream_inference_response(
+    provider="Hyperbolic",
+    model="meta-llama/Llama-3.3-70B-Instruct-Turbo",
+    thread_id=thread.id,
+    message_id=message.id,
+    run_id=run.id,
+    assistant_id=assistant.id
+)
+
+for chunk in stream:
+    print(chunk)
+```
+
+---
+
+## 📚 Documentation
+
+| Domain              | Link                                                   |
+|---------------------|--------------------------------------------------------|
+| Assistants          | [assistants.md](/docs/assistants.md)                   |
+| Threads             | [threads.md](/docs/threads.md)                         |
+| Messages            | [messages.md](/docs/messages.md)                       |
+| Runs                | [runs.md](/docs/runs.md)                               |
+| Inference           | [inference.md](/docs/inference.md)                     |
+| Streaming           | [streams.md](/docs/streams.md)                         |
+| Function Calling    | [function_calling.md](/docs/function_calling.md)       |
+| Code Interpretation | [code_interpretation.md](/docs/code_interpretation.md) |
+| Files               | [files.md](/docs/files.md)                             |
+| Vector Store(RAG)   | [vector_store.md](/docs/vector_store.md)               |
+| Versioning          | [versioning.md](/docs/versioning.md)                   |
+
+---
+
+## ✅ Compatibility & Requirements
+
+- Python **3.10+**
+- Compatible with **local** or **cloud** deployments of the Entities API
+
+---
+
+## 🌍 Related Repositories
+
+- 🔌 [Entities API](https://github.com/frankie336/entities_api) — containerized API backend
+- 
+- 📚 [entities_common](https://github.com/frankie336/entities_common) — shared validation, schemas, utilities, and tools.
+      This package is auto installed as dependency of entities SDK or entities API.

projectdavid-1.0.24/README.md

@@ -0,0 +1,113 @@
+# Entity SDK
+[![Test, Tag, Publish Status](https://github.com/frankie336/entitites_sdk/actions/workflows/test_tag_release.yml/badge.svg)](https://github.com/frankie336/entitites_sdk/actions/workflows/test_tag_release.yml)
+
+The **Entity SDK** is a composable, Pythonic interface to the [Entities API](https://github.com/frankie336/entities_api) for building intelligent applications across **local, open-source**, and **cloud LLMs**.
+
+It unifies:
+
+- Users, threads, assistants, messages, runs, inference
+- **Function calling**, **code interpretation**, and **structured streaming**
+- Vector memory, file uploads, and secure tool orchestration
+
+Local inference is fully supported via [Ollama](https://github.com/ollama).
+
+---
+
+## 🔌 Supported Inference Providers
+
+| Provider                                         | Type                     |
+|--------------------------------------------------|--------------------------|
+| [Ollama](https://github.com/ollama)              |  **Local** (Self-Hosted) |
+| [DeepSeek](https://platform.deepseek.com/)       | ☁ **Cloud** (Open-Source) |
+| [Hyperbolic](https://hyperbolic.xyz/)            | ☁ **Cloud** (Proprietary) |
+| [OpenAI](https://platform.openai.com/)           | ☁ **Cloud** (Proprietary) |
+| [Together AI](https://www.together.ai/)          | ☁ **Cloud** (Aggregated) |
+| [Azure Foundry](https://azure.microsoft.com)     | ☁ **Cloud** (Enterprise) |
+
+---
+
+## 📦 Installation
+
+```bash
+pip install entities
+
+```
+
+---
+
+##  Quick Start
+
+```python
+from entities import Entities
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+
+client = Entities(
+    base_url='http://localhost:9000',
+    api_key=os.getenv("API_KEY")
+)
+
+user = client.users.create_user(name="demo_user")
+thread = client.threads.create_thread(participant_ids=[user.id])
+assistant = client.assistants.create_assistant(name="Demo Assistant")
+
+message = client.messages.create_message(
+    thread_id=thread.id,
+    role="user",
+    content="Hello, assistant!",
+    assistant_id=assistant.id
+)
+
+run = client.runs.create_run(
+    assistant_id=assistant.id,
+    thread_id=thread.id
+)
+
+stream = client.inference.stream_inference_response(
+    provider="Hyperbolic",
+    model="meta-llama/Llama-3.3-70B-Instruct-Turbo",
+    thread_id=thread.id,
+    message_id=message.id,
+    run_id=run.id,
+    assistant_id=assistant.id
+)
+
+for chunk in stream:
+    print(chunk)
+```
+
+---
+
+## 📚 Documentation
+
+| Domain              | Link                                                   |
+|---------------------|--------------------------------------------------------|
+| Assistants          | [assistants.md](/docs/assistants.md)                   |
+| Threads             | [threads.md](/docs/threads.md)                         |
+| Messages            | [messages.md](/docs/messages.md)                       |
+| Runs                | [runs.md](/docs/runs.md)                               |
+| Inference           | [inference.md](/docs/inference.md)                     |
+| Streaming           | [streams.md](/docs/streams.md)                         |
+| Function Calling    | [function_calling.md](/docs/function_calling.md)       |
+| Code Interpretation | [code_interpretation.md](/docs/code_interpretation.md) |
+| Files               | [files.md](/docs/files.md)                             |
+| Vector Store(RAG)   | [vector_store.md](/docs/vector_store.md)               |
+| Versioning          | [versioning.md](/docs/versioning.md)                   |
+
+---
+
+## ✅ Compatibility & Requirements
+
+- Python **3.10+**
+- Compatible with **local** or **cloud** deployments of the Entities API
+
+---
+
+## 🌍 Related Repositories
+
+- 🔌 [Entities API](https://github.com/frankie336/entities_api) — containerized API backend
+- 
+- 📚 [entities_common](https://github.com/frankie336/entities_common) — shared validation, schemas, utilities, and tools.
+      This package is auto installed as dependency of entities SDK or entities API.

projectdavid-1.0.24/docs/assistants.md

@@ -0,0 +1,46 @@
+from tkinter.font import names
+
+# Assistants
+
+## Overview
+
+Create an Assistant by defining its custom instructions and picking a model. If helpful, add files and enable tools like Code Interpreter, File Search, and Function calling.
+
+### Basic Assistant Operations 
+
+```python
+
+from entities import Entities
+
+client = Entities()
+
+# Create assistant
+
+assistant = client.assistants.create_assistant(
+    name='Mathy',
+    description='test_case',
+    model='llama3.1',
+    instructions='You are a helpful math tutor.'
+)
+print(f"Assistant created: ID: {assistant.id}")
+
+# Retrieve an Assistant
+
+retrieved_assistant = client.assistants.retrieve_assistant(assistant_id=assistant.id)
+
+print(retrieved_assistant)
+
+# Update and assistant
+
+client.assistants.update_assistant(
+    assistant_id=assistant.id,
+    name = 'Mathy',
+    description='test_update',
+    instructions='You are now a world class poker player.'
+)
+
+# Delete an assistant 
+
+client.assistants.delete_assistant(assistant_id=assistant.id)   
+
+```

projectdavid-1.0.24/docs/code_interpretation.md

@@ -0,0 +1,32 @@
+# Code Interpretation
+
+A code interpreter is a specialized [tool](/docs/function_calling.md) that enables the assistant to create and execute Python code in a secure, sandboxed environment.
+
+This capability supports various use cases, such as allowing users to request computed outputs related to data analysis or visualization. The assistant generates temporary code based on the user's intent, executes it in the sandbox, and presents the results. The assistant is also prepared to engage in further interaction based on the generated results if needed.
+
+
+![Diagram](code_interpreter3.png)
+
+
+The code interpreter is enabled by default, so no additional coding is required. Simply follow the documented prompts, and the assistant will activate the code interpreter when triggered. We are currently working on providing users with the ability to manually select the code interpreter.
+
+**Turning on Code Interpreter**
+
+```python
+from src.api.entities import CommonEntitiesInternalInterface
+from src.api.entities import code_interpreter
+
+available_functions = {
+    'code_interpreter': code_interpreter
+    # Add other functions as needed
+}
+
+client = entities_api.CommonEntitiesInternalInterface(available_functions=available_functions)
+```
+
+**Call the client with the code_interpreter handler injected in**
+
+```python
+
+client = entities_api.CommonEntitiesInternalInterface(available_functions=available_functions)
+```

projectdavid-1.0.24/docs/database.md

@@ -0,0 +1,5 @@
+
+
+
+
+![Network Diagram](../images/database.png)

projectdavid-1.0.24/docs/docker_comtainers.md

@@ -0,0 +1,22 @@
+# Docker Containers 
+
+## Overview
+
+This project utilizes a multi-container Docker architecture to provide a robust and scalable application environment. The containerized services include:
+
+MySQL Database (my_mysql_cosmic_catalyst): A MySQL 8.0 container that handles all persistent data storage.
+
+Qdrant Vector Search (qdrant_server): A container running the latest Qdrant image to manage vector searches for advanced data retrieval.
+
+API Server (fastapi_cosmic_catalyst): A FastAPI-based service responsible for handling client requests and business logic.
+
+Sandbox Environment (sandbox_api): A secure, isolated container for executing code and testing new features without affecting production.
+
+Samba File Sharing (samba_server): A Samba server container that provides file sharing capabilities, ensuring efficient storage management.
+
+All these containers are networked through a custom Docker bridge network, ensuring seamless communication and integrated operation across the system.
+
+
+
+
+![Network Diagram](../images/docker_containers.png)