unique_toolkit 1.3.0__tar.gz → 1.3.1__tar.gz

{unique_toolkit-1.3.0 → unique_toolkit-1.3.1}/CHANGELOG.md

@@ -5,6 +5,10 @@ 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).
 
+
+## [1.3.1] - 2025-09-29
+- More documentation on referencing
+
 ## [1.3.0] - 2025-09-28
 - Add utilitiy to enhance pydantic model with metadata
 - Add capability to collect this metadata with same hierarchy as nested pydantic models

{unique_toolkit-1.3.0 → unique_toolkit-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 1.3.0
+Version: 1.3.1
 Summary: 
 License: Proprietary
 Author: Cedric Klinkert
@@ -118,6 +118,10 @@ 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).
 
+
+## [1.3.1] - 2025-09-29
+- More documentation on referencing
+
 ## [1.3.0] - 2025-09-28
 - Add utilitiy to enhance pydantic model with metadata
 - Add capability to collect this metadata with same hierarchy as nested pydantic models

{unique_toolkit-1.3.0 → unique_toolkit-1.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unique_toolkit"
-version = "1.3.0"
+version = "1.3.1"
 description = ""
 authors = [
     "Cedric Klinkert <cedric.klinkert@unique.ch>",

{unique_toolkit-1.3.0 → unique_toolkit-1.3.1}/unique_toolkit/content/schemas.py

@@ -26,15 +26,41 @@ class ContentMetadata(BaseModel):
 
 class ContentChunk(BaseModel):
     model_config = model_config
-    id: str
-    text: str
-    order: int
-    key: str | None = None
-    chunk_id: str | None = None
-    url: str | None = None
-    title: str | None = None
-    start_page: int | None = None
-    end_page: int | None = None
+    id: str = Field(
+        default="",
+        description="The id of the content this chunk belongs to. The id starts with 'cont_' followed by an alphanumeric string of length 24.",
+        examples=["cont_abcdefgehijklmnopqrstuvwx"],
+    )
+    text: str = Field(default="", description="The text content of the chunk.")
+    order: int = Field(
+        default=0,
+        description="The order of the chunk in the original content. Concatenating the chunks in order will give the original content.",
+    )
+    key: str | None = Field(
+        default=None,
+        description="The key of the chunk. For document chunks this is the the filename",
+    )
+    chunk_id: str | None = Field(
+        default=None,
+        description="The id of the chunk. The id starts with 'chunk_' followed by an alphanumeric string of length 24.",
+        examples=["chunk_abcdefgehijklmnopqrstuv"],
+    )
+    url: str | None = Field(
+        default=None,
+        description="For chunk retrieved from the web this is the url of the chunk.",
+    )
+    title: str | None = Field(
+        default=None,
+        description="The title of the chunk. For document chunks this is the title of the document.",
+    )
+    start_page: int | None = Field(
+        default=None,
+        description="The start page of the chunk. For document chunks this is the start page of the document.",
+    )
+    end_page: int | None = Field(
+        default=None,
+        description="The end page of the chunk. For document chunks this is the end page of the document.",
+    )
 
     object: str | None = None
     metadata: ContentMetadata | None = None
@@ -45,9 +71,19 @@ class ContentChunk(BaseModel):
 
 class Content(BaseModel):
     model_config = model_config
-    id: str
-    key: str
-    title: str | None = None
+    id: str = Field(
+        default="",
+        description="The id of the content. The id starts with 'cont_' followed by an alphanumeric string of length 24.",
+        examples=["cont_abcdefgehijklmnopqrstuvwx"],
+    )
+    key: str = Field(
+        default="",
+        description="The key of the content. For documents this is the the filename",
+    )
+    title: str | None = Field(
+        default=None,
+        description="The title of the content. For documents this is the title of the document.",
+    )
     url: str | None = None
     chunks: list[ContentChunk] = []
     write_url: str | None = None