projectdavid 1.33.21__tar.gz → 1.39.3__tar.gz

{projectdavid-1.33.21 → projectdavid-1.39.3}/CHANGELOG.md

@@ -1,3 +1,276 @@
+## [1.39.3](https://github.com/frankie336/projectdavid/compare/v1.39.2...v1.39.3) (2026-01-20)
+
+
+### Bug Fixes
+
+* Add tool_call_id param to poll_and_execute_action ([b7ac9c4](https://github.com/frankie336/projectdavid/commit/b7ac9c45b38762021380eecb09abf903085fd6e1))
+
+## [1.39.2](https://github.com/frankie336/projectdavid/compare/v1.39.1...v1.39.2) (2026-01-20)
+
+
+### Bug Fixes
+
+* update to projectdavid_common==0.21.1 ([4fad973](https://github.com/frankie336/projectdavid/commit/4fad973a49fa93792bcb76d0eb3ce770f1311560))
+* update to projectdavid_common==0.21.1 ([83faf8e](https://github.com/frankie336/projectdavid/commit/83faf8e9f3391646957bd127500555fb981f7d23))
+
+## [1.39.1](https://github.com/frankie336/projectdavid/compare/v1.39.0...v1.39.1) (2026-01-19)
+
+
+### Bug Fixes
+
+* Add tool_call_id to actions_client.py ([1f7dffd](https://github.com/frankie336/projectdavid/commit/1f7dffd411be5d1a6cbb15d76117ba586796cf10))
+* Add tool_call_id to actions_client.py ([c4d5821](https://github.com/frankie336/projectdavid/commit/c4d58217149bd1fbd53207c746f8f75bb6dbe654))
+
+# [1.39.0](https://github.com/frankie336/projectdavid/compare/v1.38.1...v1.39.0) (2026-01-17)
+
+
+### Features
+
+* Implement 0.20.0 projectdavid_common==0.20.0 ([589939b](https://github.com/frankie336/projectdavid/commit/589939b926768faa1617a80c30069a51ddedcdac))
+* removed unused imports ([743e5c2](https://github.com/frankie336/projectdavid/commit/743e5c21f8b25ef8d9d76f90497ed889bae5e3a0))
+
+## [1.38.1](https://github.com/frankie336/projectdavid/compare/v1.38.0...v1.38.1) (2026-01-17)
+
+
+### Bug Fixes
+
+* implement explicit action lifecycle management and tool error reporting ([d84a59b](https://github.com/frankie336/projectdavid/commit/d84a59bd5c172f95248f529345e2c2ea7651d1b4))
+
+# [1.38.0](https://github.com/frankie336/projectdavid/compare/v1.37.1...v1.38.0) (2026-01-15)
+
+
+### Features
+
+* cutting back to full fat version. ([9473363](https://github.com/frankie336/projectdavid/commit/9473363167c476501be59958184f5a9b983e566f))
+
+## [1.37.1](https://github.com/frankie336/projectdavid/compare/v1.37.0...v1.37.1) (2026-01-15)
+
+
+### Bug Fixes
+
+* Implementing light weight projectdavid ([134459d](https://github.com/frankie336/projectdavid/commit/134459d21bd0969175595d1bf565d988882724a3))
+* Implementing light weight projectdavid ([6f5548b](https://github.com/frankie336/projectdavid/commit/6f5548b965c764f7f48fd4bd436eb3da114d5b20))
+
+# [1.37.0](https://github.com/frankie336/projectdavid/compare/v1.36.1...v1.37.0) (2026-01-14)
+
+
+### Features
+
+* **sdk:** refactor streaming logic into a single-pass state machine ([8088dba](https://github.com/frankie336/projectdavid/commit/8088dba46865330ae66a6098dc9eaa1bb85d2282))
+* **sdk:** refactor streaming logic into a single-pass state machine ([afd24b7](https://github.com/frankie336/projectdavid/commit/afd24b7918bc9487db0fdb9ffa34855a23a3a87e))
+
+## [1.36.1](https://github.com/frankie336/projectdavid/compare/v1.36.0...v1.36.1) (2025-10-15)
+
+
+### Bug Fixes
+
+* Correctly handle optional truncation_strategy in run creation ([ef10d2e](https://github.com/frankie336/projectdavid/commit/ef10d2e67ca13f04feb3b87edf3c956cf0a91e0c))
+
+# [1.36.0](https://github.com/frankie336/projectdavid/compare/v1.35.0...v1.36.0) (2025-10-14)
+
+
+### Features
+
+* **deps:** bump projectdavid_common; align Runs schema + client ([f70d5fc](https://github.com/frankie336/projectdavid/commit/f70d5fcc0164037b78ac0c14d325a5f30d4daa07))
+
+# [1.35.0](https://github.com/frankie336/projectdavid/compare/v1.34.13...v1.35.0) (2025-10-13)
+
+
+### Features
+
+* **deps:** bump projectdavid_common; align Runs schema + client ([23d525e](https://github.com/frankie336/projectdavid/commit/23d525e10a8dd3a4ee39fb3c0e7c0be42832e1a7))
+
+## [1.34.13](https://github.com/frankie336/projectdavid/compare/v1.34.12...v1.34.13) (2025-09-30)
+
+
+### Bug Fixes
+
+* correct projectdavid_common==0.17.19 ([1a72e36](https://github.com/frankie336/projectdavid/commit/1a72e368ab0228f26c3dae08be0cc9a0b4edfcbe))
+
+## [1.34.12](https://github.com/frankie336/projectdavid/compare/v1.34.11...v1.34.12) (2025-09-30)
+
+
+### Bug Fixes
+
+* correct projectdavid_common==0.17.19 ([d636c31](https://github.com/frankie336/projectdavid/commit/d636c31066e33bce0332df2538093040ae36f40f))
+* set truncation strategy to auto ([3d00a38](https://github.com/frankie336/projectdavid/commit/3d00a383eb688a51f9d8bbfc66b0a47e52e86b2a))
+* set truncation strategy to auto ([357ec09](https://github.com/frankie336/projectdavid/commit/357ec09bc34ca36d837cae4e279e740074d9756d))
+
+## [1.34.11](https://github.com/frankie336/projectdavid/compare/v1.34.10...v1.34.11) (2025-08-25)
+
+
+### Bug Fixes
+
+* set tool choice default from 'None' --> None ([0288eb3](https://github.com/frankie336/projectdavid/commit/0288eb30ac173b2fc7323158454a726da7883c81))
+* set tool choice default from 'None' --> None ([dd172b5](https://github.com/frankie336/projectdavid/commit/dd172b5a0d1f08a2aa7ccb1714141f80e2954130))
+
+## [1.34.10](https://github.com/frankie336/projectdavid/compare/v1.34.9...v1.34.10) (2025-08-22)
+
+
+### Bug Fixes
+
+* remove redundant epoch helper ([e53c074](https://github.com/frankie336/projectdavid/commit/e53c074f2c50e39bc44ceec911acb42dc9dcc930))
+
+## [1.34.9](https://github.com/frankie336/projectdavid/compare/v1.34.8...v1.34.9) (2025-08-22)
+
+
+### Bug Fixes
+
+* remove redundant epoch helper ([4d2171a](https://github.com/frankie336/projectdavid/commit/4d2171a5cff841edd33b36027d5648c1d132ffbf))
+
+## [1.34.8](https://github.com/frankie336/projectdavid/compare/v1.34.7...v1.34.8) (2025-08-22)
+
+
+### Bug Fixes
+
+* set incomplete_details type to string ([2af2d16](https://github.com/frankie336/projectdavid/commit/2af2d16843139884b9878edcd0c5b452a0e28e30))
+
+## [1.34.7](https://github.com/frankie336/projectdavid/compare/v1.34.6...v1.34.7) (2025-08-21)
+
+
+### Bug Fixes
+
+* Normalize time stamps to epoch integer format instead of datetime. ([43af583](https://github.com/frankie336/projectdavid/commit/43af5830f80d9eafde694449d7119a2da8a8d127))
+
+## [1.34.6](https://github.com/frankie336/projectdavid/compare/v1.34.5...v1.34.6) (2025-08-20)
+
+
+### Bug Fixes
+
+* epoch time on .create_run ([be013d4](https://github.com/frankie336/projectdavid/commit/be013d4e98724a2c252a7daa5b31bfda61253d15))
+
+## [1.34.5](https://github.com/frankie336/projectdavid/compare/v1.34.4...v1.34.5) (2025-08-17)
+
+
+### Bug Fixes
+
+* Adding update_run ([10b1c6f](https://github.com/frankie336/projectdavid/commit/10b1c6f1b7da9f77d3bd7c9478edf8f1dc41fc82))
+
+## [1.34.4](https://github.com/frankie336/projectdavid/compare/v1.34.3...v1.34.4) (2025-08-15)
+
+
+### Bug Fixes
+
+* Adding update_run ([ce98a68](https://github.com/frankie336/projectdavid/commit/ce98a688150c5073d1041815542012e486cf706e))
+
+## [1.34.3](https://github.com/frankie336/projectdavid/compare/v1.34.2...v1.34.3) (2025-08-13)
+
+
+### Bug Fixes
+
+* rename list_all_runs and list_runs ([7efb822](https://github.com/frankie336/projectdavid/commit/7efb8220c82184df941fc897132ca3caa96d07a0))
+
+## [1.34.2](https://github.com/frankie336/projectdavid/compare/v1.34.1...v1.34.2) (2025-08-13)
+
+
+### Bug Fixes
+
+* standard model ([8c8785b](https://github.com/frankie336/projectdavid/commit/8c8785babe81420ee211499a4d8972e8a42d5d2e))
+
+## [1.34.1](https://github.com/frankie336/projectdavid/compare/v1.34.0...v1.34.1) (2025-08-13)
+
+
+### Bug Fixes
+
+* correctly import RunListResponse ([7f923cc](https://github.com/frankie336/projectdavid/commit/7f923ccfcaac890f1eaf0b94406f5ee003b2cf4e))
+
+# [1.34.0](https://github.com/frankie336/projectdavid/compare/v1.33.33...v1.34.0) (2025-08-12)
+
+
+### Features
+
+* Adding runs list methods. ([61975b2](https://github.com/frankie336/projectdavid/commit/61975b2c8fa44de254b979160566bd8e89b6799b))
+
+## [1.33.33](https://github.com/frankie336/projectdavid/compare/v1.33.32...v1.33.33) (2025-07-10)
+
+
+### Bug Fixes
+
+* wrap delete_message in a return envelope ([7ed1815](https://github.com/frankie336/projectdavid/commit/7ed18155b85d39cbecf0354c16b2a8a20131b9e2))
+* wrap delete_message in a return envelope ([3e9e6fb](https://github.com/frankie336/projectdavid/commit/3e9e6fbb93ec0670c0e9a39b7eb446bcb1e7df40))
+
+## [1.33.32](https://github.com/frankie336/projectdavid/compare/v1.33.31...v1.33.32) (2025-07-09)
+
+
+### Bug Fixes
+
+* use project_david_common 0.17.9 and refactor list_messages to use new envelope ([3fc565c](https://github.com/frankie336/projectdavid/commit/3fc565ce1f69af47fc102d5abd55f90a1fce2288))
+* use project_david_common 0.17.9 and refactor list_messages to use new envelope ([3d802ef](https://github.com/frankie336/projectdavid/commit/3d802efc8cd0ec7425d0d1a1ead944c4d23d0838))
+* use project_david_common 0.17.9 and refactor list_messages to use new envelope ([0549842](https://github.com/frankie336/projectdavid/commit/054984252097c9e843a12fed9a87eacea95aee33))
+
+## [1.33.31](https://github.com/frankie336/projectdavid/compare/v1.33.30...v1.33.31) (2025-07-08)
+
+
+### Bug Fixes
+
+* update_thread ([2041347](https://github.com/frankie336/projectdavid/commit/2041347839922e2745d14e4ad9136f1aa797b254))
+
+## [1.33.30](https://github.com/frankie336/projectdavid/compare/v1.33.29...v1.33.30) (2025-07-06)
+
+
+### Bug Fixes
+
+* Add DeleteThread schema2. ([de9fd17](https://github.com/frankie336/projectdavid/commit/de9fd17d81116c503ebda23d90d7cb031938b952))
+* Add DeleteThread schema2. ([c43cdd6](https://github.com/frankie336/projectdavid/commit/c43cdd6c950847cb1a79e686848ca42d958126b9))
+* Add DeleteThread schema2. ([0c4c548](https://github.com/frankie336/projectdavid/commit/0c4c54878d10d5535c4427481ebd32d7910b15f8))
+* Add DeleteThread schema3. ([540c445](https://github.com/frankie336/projectdavid/commit/540c445829809e785dcab0b0dcd1600b0913ffcf))
+
+## [1.33.29](https://github.com/frankie336/projectdavid/compare/v1.33.28...v1.33.29) (2025-07-06)
+
+
+### Bug Fixes
+
+* Add DeleteThread schema. ([d4f1270](https://github.com/frankie336/projectdavid/commit/d4f1270863fcefadc949e165125287a7b52e1ef6))
+
+## [1.33.28](https://github.com/frankie336/projectdavid/compare/v1.33.27...v1.33.28) (2025-07-01)
+
+
+### Bug Fixes
+
+* remove platform_tools from assistant create method signature and payload. ([8caf3b0](https://github.com/frankie336/projectdavid/commit/8caf3b00f5d45422af9bda088ed266b9c39dddee))
+
+## [1.33.27](https://github.com/frankie336/projectdavid/compare/v1.33.26...v1.33.27) (2025-06-30)
+
+
+### Bug Fixes
+
+* correct list method! ([bf17205](https://github.com/frankie336/projectdavid/commit/bf1720583f37cf09844a06c5c95f319ba5192d41))
+
+## [1.33.26](https://github.com/frankie336/projectdavid/compare/v1.33.25...v1.33.26) (2025-06-30)
+
+
+### Bug Fixes
+
+* Remove platform_tools from request body ([01f79be](https://github.com/frankie336/projectdavid/commit/01f79be53bbe5b9e29c14c3757044a954c65711d))
+
+## [1.33.25](https://github.com/frankie336/projectdavid/compare/v1.33.24...v1.33.25) (2025-06-28)
+
+
+### Bug Fixes
+
+* attempt to load api-key from client users .env file ([3bf2f26](https://github.com/frankie336/projectdavid/commit/3bf2f26506c8755adb510d7f6ed852e9aca47a46))
+
+## [1.33.24](https://github.com/frankie336/projectdavid/compare/v1.33.23...v1.33.24) (2025-06-22)
+
+
+### Bug Fixes
+
+* Remove Kargs from FileProcessor() ([17a19b3](https://github.com/frankie336/projectdavid/commit/17a19b36f2275bc408b60333f4798b1a462fb96c))
+
+## [1.33.23](https://github.com/frankie336/projectdavid/compare/v1.33.22...v1.33.23) (2025-06-17)
+
+
+### Bug Fixes
+
+* Back out from vision support - resource issue. Revisit in grand plan-17 ([db124a0](https://github.com/frankie336/projectdavid/commit/db124a0a5da8da045ef2e6edc01827252a0bad11))
+
+## [1.33.22](https://github.com/frankie336/projectdavid/compare/v1.33.21...v1.33.22) (2025-06-16)
+
+
+### Bug Fixes
+
+* Back out from vision support - resource issue. Revisit in grand plan-16 ([bc3c298](https://github.com/frankie336/projectdavid/commit/bc3c298034ee40580ec4e92223782a9f2aee279f))
+
 ## [1.33.21](https://github.com/frankie336/projectdavid/compare/v1.33.20...v1.33.21) (2025-06-16)
 
 

{projectdavid-1.33.21/src/projectdavid.egg-info → projectdavid-1.39.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: projectdavid
-Version: 1.33.21
+Version: 1.39.3
 Summary: Python SDK for interacting with the Entities Assistant API.
 Author-email: Francis Neequaye Armah <francis.neequaye@projectdavid.co.uk>
 License: PolyForm Noncommercial License 1.0.0
@@ -20,7 +20,7 @@ Requires-Dist: pydantic<3.0,>=2.0
 Requires-Dist: python-dotenv<2.0,>=1.0.1
 Requires-Dist: aiofiles<25.0,>=23.2.1
 Requires-Dist: ollama<0.5.0,>=0.4.4
-Requires-Dist: projectdavid_common==0.17.2
+Requires-Dist: projectdavid_common==0.21.1
 Requires-Dist: qdrant-client<2.0.0,>=1.0.0
 Requires-Dist: pdfplumber<0.12.0,>=0.11.0
 Requires-Dist: validators<0.35.0,>=0.29.0
@@ -29,13 +29,6 @@ Requires-Dist: sseclient-py
 Requires-Dist: requests
 Requires-Dist: python-docx
 Requires-Dist: python-pptx
-Requires-Dist: open_clip_torch>=2.24
-Requires-Dist: pillow>=10.2
-Requires-Dist: transformers>=4.41
-Requires-Dist: accelerate>=0.28
-Requires-Dist: sentencepiece>=0.2
-Requires-Dist: ultralytics>=8.2.21
-Requires-Dist: pytesseract>=0.3
 Provides-Extra: dev
 Requires-Dist: black>=23.3; extra == "dev"
 Requires-Dist: isort>=5.12; extra == "dev"
@@ -43,17 +36,6 @@ Requires-Dist: pytest>=7.2; extra == "dev"
 Requires-Dist: mypy>=1.0; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: twine; extra == "dev"
-Provides-Extra: vision
-Requires-Dist: torch>=2.2.1; extra == "vision"
-Requires-Dist: torchvision>=0.17.1; extra == "vision"
-Requires-Dist: torchaudio>=2.2.1; extra == "vision"
-Requires-Dist: open_clip_torch>=2.24; extra == "vision"
-Requires-Dist: pillow>=10.2; extra == "vision"
-Requires-Dist: transformers>=4.41; extra == "vision"
-Requires-Dist: accelerate>=0.28; extra == "vision"
-Requires-Dist: sentencepiece>=0.2; extra == "vision"
-Requires-Dist: ultralytics>=8.2.21; extra == "vision"
-Requires-Dist: pytesseract>=0.3; extra == "vision"
 Dynamic: license-file
 
 # Entity  — by Project David
@@ -244,7 +226,7 @@ Would you like a deeper dive into any of these trends?
 
 
 
-## 📚 Documentation
+##  Documentation
 
 | Domain              | Link                                                   |
 |---------------------|--------------------------------------------------------|
@@ -269,9 +251,9 @@ Would you like a deeper dive into any of these trends?
 
 ---
 
-## 🌍 Related Repositories
+##   Related Repositories
 
-- 🔌 [Entities API](https://github.com/frankie336/entities_api) — containerized API backend
+-   [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.
+-   [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.33.21 → projectdavid-1.39.3}/README.md

@@ -186,7 +186,7 @@ Would you like a deeper dive into any of these trends?
 
 
 
-## 📚 Documentation
+##  Documentation
 
 | Domain              | Link                                                   |
 |---------------------|--------------------------------------------------------|
@@ -211,9 +211,9 @@ Would you like a deeper dive into any of these trends?
 
 ---
 
-## 🌍 Related Repositories
+##   Related Repositories
 
-- 🔌 [Entities API](https://github.com/frankie336/entities_api) — containerized API backend
+-   [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.
+-   [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.39.3/docs/UPDATE-V133.23.md

@@ -0,0 +1,153 @@
+> **PLEASE NOTE:**
+>
+>  As of V1.33.23 Thread creation no longer requires participant_ids to be passed in:
+>   
+
+```python
+thread = client.threads.create_thread(participant_ids=user.id)
+
+# Can be shortened to: 
+
+thread = client.threads.create_thread() 
+
+```
+
+
+## Function call error surfacing 
+
+Function call error trace stack messages are now surfaced to the message dialogue. If the assistant 
+does not proactively say so, you can force this with a followup prompt like:
+```python
+"What happened?"
+```
+
+Sometimes it receives the error but does not proactively reveal.  Please be aware that your consumers 
+will have access to stack trace messages. OpenAI do this, the risk is minimal.
+
+# Data Ingestion and Search Methods
+
+## Vector Store Standard Data Ingestion Pipeline
+
+As of **projectdavid v1.33.23** Json output from function calls are now suppressed by default.  
+You can reveal Json output them with:
+
+```python
+
+sync_stream.stream_chunks(
+            provider=PROVIDER,
+            model=MODEL,
+            timeout_per_chunk=60.0,
+            suppress_fc=True,
+        ):
+...        
+```
+
+Please see [here](https://github.com/frankie336/projectdavid/blob/master/docs/inference.md) 
+for  detailed use example.  
+
+
+## Vector Store Standard Data Ingestion Pipeline
+
+Our standard public ingestion method, `VectorStoreClient.add_file_to_vector_store`, will:
+
+- Pre-process files.
+- Chunk files.
+- Generate embeddings.
+- Upload processed chunks to the specified vector store.
+- Prepare file contents for semantic search.
+
+This method is designed primarily for individual files containing mostly unstructured text. It’s powerful and will cover most Retrieval-Augmented Generation (RAG) use cases.
+
+For detailed instructions, please refer to our [usage documentation](https://github.com/frankie336/projectdavid/blob/master/docs/vector_store.md).
+
+You can also find a real-world usage example in our cookbook here:
+[Basic Vector Embeddings Search Example](https://github.com/frankie336/entities_cook_book/blob/master/recipes/vector_store/basic_vector_embeddings_search.py).
+
+## Your Vector Store Custom Data Ingestion Pipeline
+
+We directly leverage our embedding model to craft a customized ingestion pipeline using `FileProcessor.embedding_model`. This pipeline:
+
+- Pre-processes structured datasets (e.g., MovieLens).
+- Converts each movie record into its own chunk.
+- Manually constructs rich text embeddings from multiple metadata fields (title, genres, release year, etc.).
+
+In summary, this custom pipeline is optimized for granular semantic results from structured datasets such as MovieLens. This approach can easily be adapted to other similar datasets, especially useful in recommendation algorithms.
+
+The custom pipeline example is available [here](#).
+
+## Search Methods
+
+As of **projectdavid v1.33.23** ([PyPI Link](https://pypi.org/project/projectdavid/)), the following search methods are available:
+
+### `VectorStoreClient.vector_file_search_raw`
+
+> **PLEASE NOTE:**
+>
+> This method was previously named `VectorStoreClient.vector_file_search`. Please update your code accordingly when migrating to v1.33.23.
+
+- Returns raw dictionaries with results ranked by corresponding `K` values in descending order.
+- Currently used in our semantic search examples on vectorized instances of the MovieLens dataset.
+
+#### Batch Search Example:
+
+[Batch Search on MovieLens](https://github.com/frankie336/entities_cook_book/blob/master/recipes/reccomender/batch_search_movielens.py)
+
+#### Fuzzy Search App Example:
+
+[Fuzzy Search App](https://github.com/frankie336/entities_cook_book/blob/master/recipes/reccomender/search_movielens-v2.py)
+
+
+
+### `VectorStoreClient.simple_vector_file_search`
+
+Returns a data structure optimized for interpretation and synthesis by LLM models, suitable for function call returns with potential citations.
+
+**Example Response:**
+
+```json
+{
+  "object": "vector_store.file_search_result",
+  "data": [
+    {
+      "object": "vector_store.file_hit",
+      "index": 0,
+      "text": "Title: Toy Story. Genres: Animation, Children's, Comedy. Released in 1995.",
+      "score": 0.92,
+      "meta_data": {
+        "item_id": 1,
+        "title": "Toy Story",
+        "genres": ["Animation", "Children's", "Comedy"],
+        "release_year": 1995,
+        "IMDb_URL": "http://www.imdb.com/title/tt0114709/"
+      },
+      "vector_id": "vec_abc123",
+      "store_id": "vect_mqfWyNlZbacer73PQu4Upy"
+    },
+    {
+      "object": "vector_store.file_hit",
+      "index": 1,
+      "text": "Title: The Lion King. Genres: Animation, Children's, Musical. Released in 1994.",
+      "score": 0.89,
+      "meta_data": {
+        "item_id": 2,
+        "title": "The Lion King",
+        "genres": ["Animation", "Children's", "Musical"],
+        "release_year": 1994,
+        "IMDb_URL": "http://www.imdb.com/title/tt0110357/"
+      },
+      "vector_id": "vec_def456",
+      "store_id": "vect_mqfWyNlZbacer73PQu4Upy"
+    }
+  ],
+  "answer": "Here are 2 fun kids' movies from the 1990s: **Toy Story** (1995, Animation/Comedy) and **The Lion King** (1994, Animation/Musical). Both are highly rated family films.",
+  "query": "fun kids movies from the 1990s"
+}
+```
+
+### `VectorStoreClient.attended_file_search`
+
+Utilizes an integrated AI agent to synthesize analysis and employs a specialized post-processing ranking model to ensure highly precise results. Outputs use a similar envelope as `simple_vector_file_search`. Ideal for quick demonstrations or standalone push-button integrations.
+
+### `VectorStoreClient.unattended_file_search`
+
+Employs the same advanced post-processing ranking model as `attended_file_search`, but without integrated synthesis. Suitable for standard function call implementations.

{projectdavid-1.33.21 → projectdavid-1.39.3}/docs/assistants.md

@@ -24,6 +24,7 @@ assistant = client.assistants.create_assistant(
 )
 print(f"Assistant created: ID: {assistant.id}")
 
+
 # Retrieve an Assistant
 
 retrieved_assistant = client.assistants.retrieve_assistant(assistant_id=assistant.id)

projectdavid-1.39.3/docs/inference.md

@@ -0,0 +1,116 @@
+from sympy import python
+
+# Inference
+
+## Overview
+
+Inference is the final stage of the Entities API workflow, where the assistant processes a prompt and generates a response. This stage highlights the assistant's intelligence and capabilities. Inference can be executed on edge devices or in the cloud, according to your specific needs. Our API supports both options, allowing flexibility tailored to your use case.
+
+---
+
+## Basic Inference Streaming Example
+
+The following example demonstrates how to:
+
+1. Create an assistant and a thread.
+2. Send a user message.
+3. Initiate a run.
+4. Stream the assistant's response via the Hyperbolic provider.
+
+### Requirements
+
+Ensure the following environment variables are set:
+
+- `ENTITIES_API_KEY`: API key for Entities API access.
+- `BASE_URL`: Base URL of the Entities API instance (default: `http://localhost:9000`).
+- `HYPERBOLIC_API_KEY`: API key for the Hyperbolic provider.
+- `ENTITIES_USER_ID`: User ID associated with the Entities API.
+
+### Example Implementation
+
+```python
+import os
+from dotenv import load_dotenv
+from projectdavid import Entity
+
+# Load environment variables from .env file
+load_dotenv()
+
+# Initialize Entities API client
+client = Entity(
+    base_url=os.getenv("BASE_URL", "http://localhost:9000"),
+    api_key=os.getenv("ENTITIES_API_KEY")
+)
+
+# Constants for Hyperbolic provider
+API_KEY = "your-hyperbolic-key-here"
+
+MODEL = "hyperbolic/deepseek-ai/DeepSeek-V3-0324"
+PROVIDER = "Hyperbolic"
+
+def main():
+
+    # Create assistant (can be reused across runs)
+    assistant = client.assistants.create_assistant(
+        name="test_assistant",
+        instructions="You are a helpful AI assistant",)
+
+    # Create thread (can also be reused)
+    thread = client.threads.create_thread()
+
+
+    # Create user message
+    message = client.messages.create_message(
+        thread_id=thread.id,
+        role="user",
+        content="Explain a black hole to me in pure mathematical terms",
+        assistant_id=assistant.id
+    )
+
+    # Create a run
+    run = client.runs.create_run(
+        assistant_id=assistant.id,
+        thread_id=thread.id
+    )
+```
+
+### Stream the Assistant's Response
+
+```python
+
+    # --------------------------------------
+    # 
+    # Setup synchronous streaming
+    #
+    #-----------------------------------------
+    sync_stream = client.synchronous_inference_stream
+    sync_stream.setup(
+        user_id=user_id,
+        thread_id=thread.id,
+        assistant_id=assistant.id,
+        message_id=message.id,
+        run_id=run.id,
+        api_key=API_KEY
+    )
+
+    # Stream the assistant's response
+    
+    
+    try:
+        for chunk in sync_stream.stream_chunks(
+            provider=PROVIDER,
+            model=MODEL,
+            timeout_per_chunk=60.0,
+            suppress_fc=True,
+        ):
+            content = chunk.get("content", "")
+            if content:
+                print(content, end="", flush=True)
+        print("\n--- End of Stream ---")
+    except Exception as e:
+        print(f"Stream Error: {e}")
+
+if __name__ == "__main__":
+    main()
+
+```

{projectdavid-1.33.21 → projectdavid-1.39.3}/docs/runs.md

@@ -36,14 +36,18 @@ run = client.run_service.create_run(thread_id='some_thread_id',
                                     assistant_id='some_assistant_id')
 
 
+
+
 ```
 ---
 
 **Retrieve a Run**
 ```python
 print(get_run.dict())
+
 id='run_t16pOsi0Y2a3PXuPjcrjko' assistant_id='user_2uMMGBpU4H7dcZieeOahNv' cancelled_at=None completed_at=None created_at=1726617356 expires_at=1726620956 failed_at=None incomplete_details=None instructions='' last_error=None max_completion_tokens=1000 max_prompt_tokens=500 meta_data={} model='gpt-4' object='run' parallel_tool_calls=False required_action=None response_format='text' started_at=None status='queued' thread_id='thread_Ww3UGvvKkrxFfHD1hNFQVX' tool_choice='none' tools=[] truncation_strategy={} usage=None temperature=1.0 top_p=1.0 tool_resources={} actions=[]
 {'id': 'run_xsDpDica9weXH4eSfsRcPd', 'assistant_id': 'user_0D1D7j6UkZUsa9Gm7GdkU1', 'cancelled_at': None, 'completed_at': None, 'created_at': 1726620075, 'expires_at': 1726623675, 'failed_at': None, 'incomplete_details': None, 'instructions': '', 'last_error': None, 'max_completion_tokens': 1000, 'max_prompt_tokens': 500, 'meta_data': {}, 'model': 'gpt-4', 'object': 'run', 'parallel_tool_calls': False, 'required_action': None, 'response_format': 'text', 'started_at': None, 'status': 'queued', 'thread_id': 'thread_VaTTuMUa8EHtkr60hZGkju', 'tool_choice': 'none', 'tools': [], 'truncation_strategy': {}, 'usage': None, 'temperature': 1.0, 'top_p': 1.0, 'tool_resources': {}, 'actions': []}
+
 ```
 ---
 

{projectdavid-1.33.21 → projectdavid-1.39.3}/docs/threads.md

@@ -17,7 +17,7 @@ client = Entity()
 
 user = client.users.create_user(name='My test user')
 
-thread = client.threads.create_thread(participant_ids=user.id)
+thread = client.threads.create_thread()
 
 print(thread.id)