sf-queue-sdk 0.4.0b131__tar.gz → 0.5.0b4__tar.gz

{sf_queue_sdk-0.4.0b131 → sf_queue_sdk-0.5.0b4}/.gitignore

@@ -59,3 +59,9 @@ TODO-document-upload-queue.md
 # Local pipeline test output
 scripts/.env
 scripts/local-pdfs/
+scripts/mp3/
+scripts/ppt/
+scripts/docx/
+scripts/mp3-results/
+scripts/studyset/.env
+scripts/studyset/downloads/

sf_queue_sdk-0.4.0b131/README.md → sf_queue_sdk-0.5.0b4/PKG-INFO

@@ -1,3 +1,11 @@
+Metadata-Version: 2.5
+Name: sf-queue-sdk
+Version: 0.5.0b4
+Summary: Python SDK for sf-queue - Redis-based queue system
+Requires-Python: >=3.11
+Requires-Dist: redis>=5.0.0
+Description-Content-Type: text/markdown
+
 # sf-queue-sdk
 
 Python SDK for sf-queue. Enqueues emails via Redis Streams with optional blocking confirmation from the Go consumer service.
@@ -591,7 +599,7 @@ result = client.document_upload.send(
 | `generate_notes` | `bool` | Yes | Whether to generate study notes |
 | `generate_study_path` | `bool` | Yes | Whether to generate a study path |
 | `splitting` | `str` | No | Splitting strategy for sources with at least 40,000 tokens (default: `"auto"`). Smaller sources always persist as one material after per-topic note generation. |
-| `language` | `str` | No | Target language code (default: `"en"`) |
+| `language` | `str` | No | Output language as an app ISO code, e.g. `"de"` — not a locale like `"de-DE"`. Note the non-standard `cz` (Czech) and `gr` (Greek). (default: `"en"`) |
 | `use_markdown_ocr` | `bool` | No | Use Markdown OCR for image interpretation (default: `False`) |
 | `flashcard_amount` | `int` | No | Number of flashcards to generate (default: `12`) |
 | `new_url` | `Optional[str]` | No | Alternative URL if file was re-uploaded |
@@ -605,6 +613,13 @@ result = client.document_upload.send(
 | `youtube_title` | `Optional[str]` | No | Title override for YouTube video transcripts |
 | `skip_material_creation` | `Optional[bool]` | No | Skip folder and material creation when the material already exists (e.g. live lectures) |
 | `existing_material_id` | `Optional[str]` | No | ID of an existing material to link to topics instead of creating new ones (used with `skip_material_creation`) |
+| `params` | `Optional[dict]` | No | Typed extensible flags for pipeline behavior (see below) |
+
+#### `params` fields
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `liveLecture` | `bool` | When true, forces `generateNotes=false` and `skipMaterialCreation=true` in the pipeline. Clustering still runs to produce sections/topics for study path generation. Use with `existing_material_id` and `extracted_content`. |
 
 ### Response Type
 
@@ -787,7 +802,7 @@ result = client.document_persist.send(
 | `study_set_id` | `str` | Yes | Study set to persist materials into |
 | `user_id` | `str` | Yes | User who uploaded the document |
 | `stash_key` | `str` | Yes | GCS key of the clustering stash JSON |
-| `language` | `str` | No | Target language code (default: `"en"`) |
+| `language` | `str` | No | Output language as an app ISO code, e.g. `"de"` — not a locale like `"de-DE"`. Note the non-standard `cz` (Czech) and `gr` (Greek). (default: `"en"`) |
 | `callback_url` | `Optional[str]` | No | URL to POST results to after persistence |
 | `callback_api_key` | `Optional[str]` | No | Auth key for the callback |
 | `approved_topic_ids` | `Optional[list[str]]` | No | Filter to only these topic IDs from the stash (omit to persist all) |

sf_queue_sdk-0.4.0b131/PKG-INFO → sf_queue_sdk-0.5.0b4/README.md

@@ -1,11 +1,3 @@
-Metadata-Version: 2.4
-Name: sf-queue-sdk
-Version: 0.4.0b131
-Summary: Python SDK for sf-queue - Redis-based queue system
-Requires-Python: >=3.11
-Requires-Dist: redis>=5.0.0
-Description-Content-Type: text/markdown
-
 # sf-queue-sdk
 
 Python SDK for sf-queue. Enqueues emails via Redis Streams with optional blocking confirmation from the Go consumer service.
@@ -599,7 +591,7 @@ result = client.document_upload.send(
 | `generate_notes` | `bool` | Yes | Whether to generate study notes |
 | `generate_study_path` | `bool` | Yes | Whether to generate a study path |
 | `splitting` | `str` | No | Splitting strategy for sources with at least 40,000 tokens (default: `"auto"`). Smaller sources always persist as one material after per-topic note generation. |
-| `language` | `str` | No | Target language code (default: `"en"`) |
+| `language` | `str` | No | Output language as an app ISO code, e.g. `"de"` — not a locale like `"de-DE"`. Note the non-standard `cz` (Czech) and `gr` (Greek). (default: `"en"`) |
 | `use_markdown_ocr` | `bool` | No | Use Markdown OCR for image interpretation (default: `False`) |
 | `flashcard_amount` | `int` | No | Number of flashcards to generate (default: `12`) |
 | `new_url` | `Optional[str]` | No | Alternative URL if file was re-uploaded |
@@ -613,6 +605,13 @@ result = client.document_upload.send(
 | `youtube_title` | `Optional[str]` | No | Title override for YouTube video transcripts |
 | `skip_material_creation` | `Optional[bool]` | No | Skip folder and material creation when the material already exists (e.g. live lectures) |
 | `existing_material_id` | `Optional[str]` | No | ID of an existing material to link to topics instead of creating new ones (used with `skip_material_creation`) |
+| `params` | `Optional[dict]` | No | Typed extensible flags for pipeline behavior (see below) |
+
+#### `params` fields
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `liveLecture` | `bool` | When true, forces `generateNotes=false` and `skipMaterialCreation=true` in the pipeline. Clustering still runs to produce sections/topics for study path generation. Use with `existing_material_id` and `extracted_content`. |
 
 ### Response Type
 
@@ -795,7 +794,7 @@ result = client.document_persist.send(
 | `study_set_id` | `str` | Yes | Study set to persist materials into |
 | `user_id` | `str` | Yes | User who uploaded the document |
 | `stash_key` | `str` | Yes | GCS key of the clustering stash JSON |
-| `language` | `str` | No | Target language code (default: `"en"`) |
+| `language` | `str` | No | Output language as an app ISO code, e.g. `"de"` — not a locale like `"de-DE"`. Note the non-standard `cz` (Czech) and `gr` (Greek). (default: `"en"`) |
 | `callback_url` | `Optional[str]` | No | URL to POST results to after persistence |
 | `callback_api_key` | `Optional[str]` | No | Auth key for the callback |
 | `approved_topic_ids` | `Optional[list[str]]` | No | Filter to only these topic IDs from the stash (omit to persist all) |

{sf_queue_sdk-0.4.0b131 → sf_queue_sdk-0.5.0b4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sf-queue-sdk"
-version = "0.4.0b131"
+version = "0.5.0b4"
 description = "Python SDK for sf-queue - Redis-based queue system"
 readme = "README.md"
 requires-python = ">=3.11"

{sf_queue_sdk-0.4.0b131 → sf_queue_sdk-0.5.0b4}/queue_sdk/__init__.py

@@ -1,6 +1,6 @@
 """sf-queue Python SDK - Redis-based queue system."""
 
-__version__ = "0.4.0b131"
+__version__ = "0.5.0b4"
 
 from queue_sdk.client import QueueClient
 from queue_sdk.query import QueryClient

{sf_queue_sdk-0.4.0b131 → sf_queue_sdk-0.5.0b4}/queue_sdk/queues/document_upload_queue.py

@@ -52,6 +52,7 @@ class DocumentUploadQueue(BaseQueue):
         study_plan_hook: Optional[bool] = None,
         skip_material_creation: Optional[bool] = None,
         existing_material_id: Optional[str] = None,
+        params: Optional[dict] = None,
     ) -> SendResult:
         """Enqueue a document upload processing request (fire and forget)."""
         self._validate(uploaded_file_id, study_set_id, user_id, pdf_s3_key, filename)
@@ -88,6 +89,7 @@ class DocumentUploadQueue(BaseQueue):
             study_plan_hook=study_plan_hook,
             skip_material_creation=skip_material_creation,
             existing_material_id=existing_material_id,
+            params=params,
         )
         message_id = self._enqueue(payload)
         self._set_initial_status(message_id)
@@ -174,6 +176,7 @@ class DocumentUploadQueue(BaseQueue):
         study_plan_hook: Optional[bool],
         skip_material_creation: Optional[bool],
         existing_material_id: Optional[str],
+        params: Optional[dict],
     ) -> dict[str, Any]:
         """Build the document upload payload (snake_case -> camelCase)."""
         payload: dict[str, Any] = {
@@ -227,6 +230,8 @@ class DocumentUploadQueue(BaseQueue):
             payload["skipMaterialCreation"] = skip_material_creation
         if existing_material_id is not None:
             payload["existingMaterialId"] = existing_material_id
+        if params is not None:
+            payload["params"] = params
 
         return payload
 

{sf_queue_sdk-0.4.0b131 → sf_queue_sdk-0.5.0b4}/queue_sdk/types.py

@@ -173,6 +173,13 @@ class BatchRecommendationResponse:
     processed_at: Optional[str] = None
 
 
+@dataclass
+class DocumentUploadParams:
+    """Extensible flags for pipeline behavior."""
+
+    live_lecture: Optional[bool] = None
+
+
 @dataclass
 class DocumentUploadData:
     """Data for a document upload processing request."""
@@ -206,6 +213,7 @@ class DocumentUploadData:
     callback_url: Optional[str] = None
     callback_api_key: Optional[str] = None
     study_plan_hook: Optional[bool] = None
+    params: Optional[DocumentUploadParams] = None
 
 
 @dataclass