vocalstack 1.0.0a2__tar.gz → 1.0.0a3__tar.gz

{vocalstack-1.0.0a2 → vocalstack-1.0.0a3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: vocalstack
-Version: 1.0.0a2
+Version: 1.0.0a3
 Summary: VocalStack speech API SDK (asyncio): one client grouped by resource, typed models from the API contract, realtime WebSocket streaming.
 Project-URL: Homepage, https://vocalstack.com
 License-Expression: MIT
@@ -48,7 +48,6 @@ pip install vocalstack
 - [Quickstart](https://github.com/vocalstack/python-sdk/blob/main/docs/quickstart.md): An API key, the SDK, and your first transcript in a dozen lines.
 - [Transcribe a file](https://github.com/vocalstack/python-sdk/blob/main/docs/transcribe-a-file.md): Upload a file, wait for its job, read the transcript and export it. Asynchronous; nothing to keep open.
 - [Transcribe a link](https://github.com/vocalstack/python-sdk/blob/main/docs/transcribe-a-link.md): The server fetches a public URL, a YouTube video or a recording on a video or audio site, then transcribes it like a file. Asynchronous, with a fetch phase first.
-- [Transcribe a batch of files](https://github.com/vocalstack/python-sdk/blob/main/docs/transcribe-a-batch.md): Send many files or links as one batch, start it once, and read every transcript when it is done. Cheaper than one transcription per file.
 - [Search your transcriptions](https://github.com/vocalstack/python-sdk/blob/main/docs/search-transcriptions.md): Find transcriptions by words in their name or link, site, language, kind, tag and date, keep the shared ones, and play each with its share code.
 - [Stream a microphone](https://github.com/vocalstack/python-sdk/blob/main/docs/stream-a-microphone.md): Live audio in, transcript events out, over one WebSocket. Drafts replace the live tail; commits append.
 - [Stream a file at full speed](https://github.com/vocalstack/python-sdk/blob/main/docs/stream-a-file.md): Send a file's bytes through a realtime session and read the transcript as fast as the server makes it. Nothing is stored.
@@ -69,7 +68,6 @@ pip install vocalstack
 | transcription | a file, link, microphone or stream, transcribed and stored | `vs.transcriptions` |
 | recording | one take inside a broadcast or a transcription | `vs.recordings` |
 | job | a file or link recording's transcription work | `vs.jobs` |
-| batch | many files transcribed together, for less than one transcription each | `vs.batches` |
 
 The other groups: `vs.corrections`, `vs.share_links`, `vs.voices`,
 `vs.search`, `vs.me`, `vs.languages`, `vs.rtmp`, `vs.events`, `vs.meta`.

{vocalstack-1.0.0a2 → vocalstack-1.0.0a3}/README.md

@@ -35,7 +35,6 @@ pip install vocalstack
 - [Quickstart](https://github.com/vocalstack/python-sdk/blob/main/docs/quickstart.md): An API key, the SDK, and your first transcript in a dozen lines.
 - [Transcribe a file](https://github.com/vocalstack/python-sdk/blob/main/docs/transcribe-a-file.md): Upload a file, wait for its job, read the transcript and export it. Asynchronous; nothing to keep open.
 - [Transcribe a link](https://github.com/vocalstack/python-sdk/blob/main/docs/transcribe-a-link.md): The server fetches a public URL, a YouTube video or a recording on a video or audio site, then transcribes it like a file. Asynchronous, with a fetch phase first.
-- [Transcribe a batch of files](https://github.com/vocalstack/python-sdk/blob/main/docs/transcribe-a-batch.md): Send many files or links as one batch, start it once, and read every transcript when it is done. Cheaper than one transcription per file.
 - [Search your transcriptions](https://github.com/vocalstack/python-sdk/blob/main/docs/search-transcriptions.md): Find transcriptions by words in their name or link, site, language, kind, tag and date, keep the shared ones, and play each with its share code.
 - [Stream a microphone](https://github.com/vocalstack/python-sdk/blob/main/docs/stream-a-microphone.md): Live audio in, transcript events out, over one WebSocket. Drafts replace the live tail; commits append.
 - [Stream a file at full speed](https://github.com/vocalstack/python-sdk/blob/main/docs/stream-a-file.md): Send a file's bytes through a realtime session and read the transcript as fast as the server makes it. Nothing is stored.
@@ -56,7 +55,6 @@ pip install vocalstack
 | transcription | a file, link, microphone or stream, transcribed and stored | `vs.transcriptions` |
 | recording | one take inside a broadcast or a transcription | `vs.recordings` |
 | job | a file or link recording's transcription work | `vs.jobs` |
-| batch | many files transcribed together, for less than one transcription each | `vs.batches` |
 
 The other groups: `vs.corrections`, `vs.share_links`, `vs.voices`,
 `vs.search`, `vs.me`, `vs.languages`, `vs.rtmp`, `vs.events`, `vs.meta`.

{vocalstack-1.0.0a2 → vocalstack-1.0.0a3}/SKILL.md

@@ -20,9 +20,6 @@ labels and translation. The `vocalstack` package has one asyncio client,
 - A **job** is a file or link recording's transcription work:
   `await vs.jobs.wait(recording_id)` polls it until it is `done` or `failed`
   (`on_progress=lambda job: ...` sees each read: `job.state`, `job.progress.pct`).
-- A **batch** is many files transcribed together for less than one
-  transcription each: `vs.batches.create()`, `add_file`/`add_url` per file,
-  `start`, then `wait` (section 6).
 - A **broadcast** is a link listeners open to follow a live recording.
 - A **realtime session** (`vs.realtime`) is a socket you stream audio into and
   read the transcript from. Nothing is stored. "Session" means only this.
@@ -196,32 +193,6 @@ for h in res.hits:
     print(f"{h.similarity:.2f}", h.passage.media_start, h.passage.text)
 ```
 
-## 6. A batch of files
-
-Many files at once cost less as a batch: one create, one minimum charge for
-the whole batch. Its files get transcripts, exports and speaker labels (when
-`settings.speakerLabels` asks), never a summary, title, share link or voices.
-
-```python
-import asyncio, os, sys
-from vocalstack import VocalStack
-
-async def main(paths):
-    async with VocalStack(os.environ.get("VOCALSTACK_BASE_URL"), api_key=os.environ["VOCALSTACK_API_KEY"]) as vs:
-        batch = await vs.batches.create(name="Interviews", settings={"spokenLanguage": "en"})
-        for path in paths:
-            await vs.batches.add_file(batch.id, file=path)  # or add_url(batch.id, url)
-        await vs.batches.start(batch.id)
-        done = await vs.batches.wait(batch.id)  # done (or stopped); check done.counts.failed
-        for tx in done.files or []:
-            if tx.job and tx.job.state == "done":
-                snap = await vs.recordings.transcript(tx.job.recording_id)
-                print(tx.name, " ".join(s.text for s in snap.sentences))
-        # vs.batches.export(batch.id, "srt") is every finished transcript in one zip.
-
-asyncio.run(main(sys.argv[1:]))
-```
-
 ## Errors
 
 A failed call raises `vocalstack.VocalStackError` with `.code`, `.message`,
@@ -257,8 +228,7 @@ except VocalStackError as e:
 - The other groups: `vs.transcriptions` (`list`, `get`, `update`, `archive`,
   `restore`, `purge`, `list_share_links`, `create_share_link`), `vs.recordings`
   (`get`, `summarize`, `summary`, `translation`, `audio_url`, `subscribe`),
-  `vs.batches` (`create`, `add_file`, `add_url`, `start`, `wait`, `get`, `list`,
-  `export`, `stop`, `delete`), `vs.corrections`, `vs.share_links`, `vs.voices`, `vs.broadcasts`,
+  `vs.corrections`, `vs.share_links`, `vs.voices`, `vs.broadcasts`,
   `vs.me` (`get`, `usage`), `vs.languages`, `vs.rtmp`, `vs.events`, `vs.meta`.
   Each method is its operation's name in the OpenAPI document, in snake_case
   (`transcriptions.create` is `POST /v1/transcriptions`).

{vocalstack-1.0.0a2 → vocalstack-1.0.0a3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "vocalstack"
-version = "1.0.0a2"
+version = "1.0.0a3"
 description = "VocalStack speech API SDK (asyncio): one client grouped by resource, typed models from the API contract, realtime WebSocket streaming."
 readme = "README.md"
 license = "MIT"

{vocalstack-1.0.0a2 → vocalstack-1.0.0a3}/skills/vocalstack/SKILL.md

@@ -20,9 +20,6 @@ labels and translation. The `vocalstack` package has one asyncio client,
 - A **job** is a file or link recording's transcription work:
   `await vs.jobs.wait(recording_id)` polls it until it is `done` or `failed`
   (`on_progress=lambda job: ...` sees each read: `job.state`, `job.progress.pct`).
-- A **batch** is many files transcribed together for less than one
-  transcription each: `vs.batches.create()`, `add_file`/`add_url` per file,
-  `start`, then `wait` (section 6).
 - A **broadcast** is a link listeners open to follow a live recording.
 - A **realtime session** (`vs.realtime`) is a socket you stream audio into and
   read the transcript from. Nothing is stored. "Session" means only this.
@@ -196,32 +193,6 @@ for h in res.hits:
     print(f"{h.similarity:.2f}", h.passage.media_start, h.passage.text)
 ```
 
-## 6. A batch of files
-
-Many files at once cost less as a batch: one create, one minimum charge for
-the whole batch. Its files get transcripts, exports and speaker labels (when
-`settings.speakerLabels` asks), never a summary, title, share link or voices.
-
-```python
-import asyncio, os, sys
-from vocalstack import VocalStack
-
-async def main(paths):
-    async with VocalStack(os.environ.get("VOCALSTACK_BASE_URL"), api_key=os.environ["VOCALSTACK_API_KEY"]) as vs:
-        batch = await vs.batches.create(name="Interviews", settings={"spokenLanguage": "en"})
-        for path in paths:
-            await vs.batches.add_file(batch.id, file=path)  # or add_url(batch.id, url)
-        await vs.batches.start(batch.id)
-        done = await vs.batches.wait(batch.id)  # done (or stopped); check done.counts.failed
-        for tx in done.files or []:
-            if tx.job and tx.job.state == "done":
-                snap = await vs.recordings.transcript(tx.job.recording_id)
-                print(tx.name, " ".join(s.text for s in snap.sentences))
-        # vs.batches.export(batch.id, "srt") is every finished transcript in one zip.
-
-asyncio.run(main(sys.argv[1:]))
-```
-
 ## Errors
 
 A failed call raises `vocalstack.VocalStackError` with `.code`, `.message`,
@@ -257,8 +228,7 @@ except VocalStackError as e:
 - The other groups: `vs.transcriptions` (`list`, `get`, `update`, `archive`,
   `restore`, `purge`, `list_share_links`, `create_share_link`), `vs.recordings`
   (`get`, `summarize`, `summary`, `translation`, `audio_url`, `subscribe`),
-  `vs.batches` (`create`, `add_file`, `add_url`, `start`, `wait`, `get`, `list`,
-  `export`, `stop`, `delete`), `vs.corrections`, `vs.share_links`, `vs.voices`, `vs.broadcasts`,
+  `vs.corrections`, `vs.share_links`, `vs.voices`, `vs.broadcasts`,
   `vs.me` (`get`, `usage`), `vs.languages`, `vs.rtmp`, `vs.events`, `vs.meta`.
   Each method is its operation's name in the OpenAPI document, in snake_case
   (`transcriptions.create` is `POST /v1/transcriptions`).

{vocalstack-1.0.0a2 → vocalstack-1.0.0a3}/src/vocalstack/__init__.py

@@ -30,7 +30,7 @@ from .errors import VocalStackError
 from .realtime import RealtimeTranscript
 from .realtime import RealtimeSession, pace_realtime
 
-__version__ = "1.0.0a2"
+__version__ = "1.0.0a3"
 
 __all__ = [
     "DEFAULT_BASE_URL",

{vocalstack-1.0.0a2 → vocalstack-1.0.0a3}/src/vocalstack/_models.py

@@ -26,12 +26,6 @@ AudioSourceState = Literal["ready", "error"]
 
 RecordingState = Literal["pending", "live", "paused", "processing", "ended", "finalized"]
 
-QueueReason = Literal["concurrency"]
-
-SourceKind = Literal["file", "url"]
-
-JobState = Literal["queued", "fetching", "transcribing", "done", "failed", "cropping", "stopped"]
-
 Lifecycle = Literal["active", "archived", "purged"]
 
 LatencyMode = Literal["auto", "fast", "accuracy"]
@@ -58,6 +52,10 @@ IngestState = Literal["connecting", "streaming", "reconnecting", "stopped", "fai
 
 InputKind = Literal["live", "file", "url", "stream"]
 
+QueueReason = Literal["concurrency"]
+
+JobState = Literal["queued", "fetching", "transcribing", "done", "failed", "cropping", "stopped"]
+
 LanguageStatusState = Literal["matches", "mismatch", "unknown", "change_unsupported"]
 
 LinkKind = Literal["live", "file", "unknown"]
@@ -68,6 +66,8 @@ LoadingStage = Literal["download", "model"]
 
 RecordingKind = Literal["live", "upload"]
 
+SourceKind = Literal["file", "url"]
+
 PullState = Literal["connecting", "streaming", "reconnecting", "failed"]
 
 SentenceStatus = Literal["open", "closed", "dropped"]
@@ -236,225 +236,6 @@ class AutoTopUpView(_Base):
     threshold: Optional[float] = None
 
 
-class BatchCounts(_Base):
-    """How many of a batch's files are in each state."""
-
-    done: int
-    failed: int
-    queued: int
-    running: int
-    stopped: int
-
-
-class Blocked(_Base):
-    at: str
-    contact: str
-    reason: str
-
-
-class BroadcastRef(_Base):
-    """A broadcast a live transcription feeds (`Transcription.broadcasts`)."""
-
-    access: Access
-    code: str
-    id: str
-    name: str
-    share_url: str = Field(alias="shareUrl")
-
-
-class CurrentRecording(_Base):
-    """The recording in flight (`currentRecording`): on a transcription, its
-open recording; on a broadcast, the open recording
-of a live transcription feeding it, which is what its listeners are sent."""
-
-    recording_id: str = Field(alias="recordingId")
-    started_at: Optional[str] = Field(default=None, alias="startedAt")
-    state: RecordingState
-    transcription_id: Optional[str] = Field(default=None, alias="transcriptionId")
-
-
-class CropWindow(_Base):
-    """A window of the source, in seconds into it.  `end_s` absent = to the end."""
-
-    end_s: Optional[float] = Field(default=None, alias="endS")
-    start_s: float = Field(alias="startS")
-
-
-class JobProgress(_Base):
-    fetch_total_bytes: Optional[int] = Field(default=None, alias="fetchTotalBytes")
-    fetched_bytes: Optional[int] = Field(default=None, alias="fetchedBytes")
-    pct: int
-    phase: Optional[str] = None
-    phase_pct: Optional[int] = Field(default=None, alias="phasePct")
-    processed_s: float = Field(alias="processedS")
-    segments_done: int = Field(alias="segmentsDone")
-    segments_total: Optional[int] = Field(default=None, alias="segmentsTotal")
-    total_s: Optional[float] = Field(default=None, alias="totalS")
-
-
-class JobQueue(_Base):
-    """Why a `queued` job is waiting, and where it stands (`Job.queue`)."""
-
-    position: int
-    reason: QueueReason
-
-
-class SourceInfo(_Base):
-    """What the recording was made from (design `j.meta`: "M4A · 34.2 MB",
-"Video URL")."""
-
-    bytes: Optional[int] = None
-    duration_s: Optional[float] = Field(default=None, alias="durationS")
-    embed_id: Optional[str] = Field(default=None, alias="embedId")
-    format: Optional[str] = None
-    kind: SourceKind
-    mime: Optional[str] = None
-    name: str
-    site: Optional[str] = None
-    thumbnail_url: Optional[str] = Field(default=None, alias="thumbnailUrl")
-    url: Optional[str] = None
-
-
-class TranscriptionJob(_Base):
-    attempts: int
-    created_at: str = Field(alias="createdAt")
-    crop: Optional["CropWindow"] = None
-    error: Optional[str] = None
-    error_code: Optional[str] = Field(default=None, alias="errorCode")
-    finished_at: Optional[str] = Field(default=None, alias="finishedAt")
-    has_audio: bool = Field(alias="hasAudio")
-    has_video: Optional[bool] = Field(default=None, alias="hasVideo")
-    peaks: Optional[List[float]] = None
-    preview: Optional[bool] = None
-    progress: "JobProgress"
-    queue: Optional["JobQueue"] = None
-    recording_id: str = Field(alias="recordingId")
-    source: Optional["SourceInfo"] = None
-    started_at: Optional[str] = Field(default=None, alias="startedAt")
-    state: JobState
-    transcription_id: str = Field(alias="transcriptionId")
-
-
-class LastRecording(_Base):
-    """A live transcription's newest recording (`lastRecording`): what
-its row in a list reads from — how long it ran, when, and whether it is
-still running — and the recording a tap on that row opens."""
-
-    duration_s: Optional[float] = Field(default=None, alias="durationS")
-    recording_id: str = Field(alias="recordingId")
-    started_at: Optional[str] = Field(default=None, alias="startedAt")
-    state: RecordingState
-    title: Optional[str] = None
-    transcription_id: Optional[str] = Field(default=None, alias="transcriptionId")
-
-
-class ConfidencePolicy(_Base):
-    """Env defaults, overridden per broadcast, transcription or recording."""
-
-    hide_below: Optional[float] = Field(default=None, alias="hideBelow")
-    low_threshold: Optional[float] = Field(default=None, alias="lowThreshold")
-    suppress_count: Optional[int] = Field(default=None, alias="suppressCount")
-
-
-class Settings(_Base):
-    """A broadcast's, transcription's or recording's capture settings (the
-design's settings sheet): what a recording made in it starts with."""
-
-    confidence: Optional["ConfidencePolicy"] = None
-    latency_mode: Optional[LatencyMode] = Field(default=None, alias="latencyMode")
-    max_duration_s: Optional[int] = Field(default=None, alias="maxDurationS")
-    max_pause_s: Optional[int] = Field(default=None, alias="maxPauseS")
-    silence_auto_pause_s: Optional[int] = Field(default=None, alias="silenceAutoPauseS")
-    speaker_labels: Optional[SpeakerLabels] = Field(default=None, alias="speakerLabels")
-    spoken_language: Optional[str] = Field(default=None, alias="spokenLanguage")
-    summary: Optional[bool] = None
-    summary_translations: Optional[bool] = Field(default=None, alias="summaryTranslations")
-    title: Optional[bool] = None
-    voice: Optional[bool] = None
-    voice_by_lang: Optional[Dict[str, str]] = Field(default=None, alias="voiceByLang")
-    voice_cloning: Optional[bool] = Field(default=None, alias="voiceCloning")
-    voice_cloning_consent: Optional[bool] = Field(default=None, alias="voiceCloningConsent")
-
-
-class TagRef(_Base):
-    """A tag as a transcription lists it."""
-
-    color: Literal["coral", "amber", "lime", "green", "teal", "blue", "violet", "pink"]
-    id: str
-    name: str
-
-
-class Transcription(_Base):
-    """A transcription: a file, a link (with its `transcription` job), or
-something captured as it is spoken (`live: true`: a microphone, a
-stream, an RTMP encoder), which may feed broadcasts (`broadcasts`)."""
-
-    archived_at: Optional[str] = Field(default=None, alias="archivedAt")
-    batch_id: Optional[str] = Field(default=None, alias="batchId")
-    blocked: Optional["Blocked"] = None
-    broadcasts: Optional[List["BroadcastRef"]] = None
-    code: str
-    created_at: str = Field(alias="createdAt")
-    created_by_api_key_id: Optional[str] = Field(default=None, alias="createdByApiKeyId")
-    current_recording: Optional["CurrentRecording"] = Field(default=None, alias="currentRecording")
-    id: str
-    job: Optional["TranscriptionJob"] = None
-    kind: Literal["transcription"] = "transcription"
-    last_recorded_at: Optional[str] = Field(default=None, alias="lastRecordedAt")
-    last_recording: Optional["LastRecording"] = Field(default=None, alias="lastRecording")
-    lifecycle: Lifecycle
-    live: Optional[bool] = None
-    locked: Optional[bool] = None
-    name: str
-    origin: Literal["dashboard", "api", "extension", "desktop_app", "obs", "wordpress", "payload", "strapi", "sanity", "contentful", "mcp", "batch_api", "broadcast", "unknown"]
-    owner_principal_id: str = Field(alias="ownerPrincipalId")
-    purge_after: Optional[str] = Field(default=None, alias="purgeAfter")
-    recording_count: int = Field(alias="recordingCount")
-    settings: "Settings"
-    share_code: Optional[str] = Field(default=None, alias="shareCode")
-    share_url: str = Field(alias="shareUrl")
-    source: "CaptureSource"
-    tags: Optional[List["TagRef"]] = None
-    updated_at: str = Field(alias="updatedAt")
-
-
-class BatchSettings(_Base):
-    """What every file of a batch runs with.  Summary, title, voices and the
-share link are never made for a batch file, so they are not here.
-Voice cloning is (design 120: the New transcription form asks it for
-every file it starts, one file or several)."""
-
-    latency_mode: Optional[LatencyMode] = Field(default=None, alias="latencyMode")
-    speaker_labels: Optional[SpeakerLabels] = Field(default=None, alias="speakerLabels")
-    spoken_language: Optional[str] = Field(default=None, alias="spokenLanguage")
-    voice_cloning: Optional[bool] = Field(default=None, alias="voiceCloning")
-    voice_cloning_consent: Optional[bool] = Field(default=None, alias="voiceCloningConsent")
-
-
-class Batch(_Base):
-    """A batch of files."""
-
-    counts: "BatchCounts"
-    created_at: str = Field(alias="createdAt")
-    created_by_api_key_id: Optional[str] = Field(default=None, alias="createdByApiKeyId")
-    file_count: int = Field(alias="fileCount")
-    files: Optional[List["Transcription"]] = None
-    files_per_batch: Optional[int] = Field(default=None, alias="filesPerBatch")
-    finished_at: Optional[str] = Field(default=None, alias="finishedAt")
-    id: str
-    name: str
-    settings: "BatchSettings"
-    started_at: Optional[str] = Field(default=None, alias="startedAt")
-    state: str
-
-
-class BatchPage(_Base):
-    """`GET /v1/batches`: one page, newest first."""
-
-    batches: List["Batch"]
-    next_cursor: Optional[str] = Field(default=None, alias="nextCursor")
-
-
 class BillingDetails(_Base):
     """`GET / PUT /v1/billing/details`."""
 
@@ -488,7 +269,6 @@ class Limits2(_Base):
     concurrent_transcriptions: Optional[int] = Field(default=None, alias="concurrentTranscriptions")
     creates_per_hour: Optional[int] = Field(default=None, alias="createsPerHour")
     creates_per_hour_unpaid: Optional[int] = Field(default=None, alias="createsPerHourUnpaid")
-    files_per_batch: Optional[int] = Field(default=None, alias="filesPerBatch")
     max_file_bytes: Optional[int] = Field(default=None, alias="maxFileBytes")
     max_live_seconds: Optional[int] = Field(default=None, alias="maxLiveSeconds")
     questions_per_day: Optional[int] = Field(default=None, alias="questionsPerDay")
@@ -533,7 +313,6 @@ class Rates(_Base):
     """The rate card of a version: dollars per hour, and the least a
 transcription is billed."""
 
-    batch_file_minimum_seconds: Optional[int] = Field(default=None, alias="batchFileMinimumSeconds")
     file_per_hour: float = Field(alias="filePerHour")
     live_per_hour: float = Field(alias="livePerHour")
     minimum_seconds: int = Field(alias="minimumSeconds")
@@ -646,6 +425,64 @@ running transcriptions go on below zero, never how far."""
     top_up_url: str = Field(alias="topUpUrl")
 
 
+class Blocked(_Base):
+    at: str
+    contact: str
+    reason: str
+
+
+class CurrentRecording(_Base):
+    """The recording in flight (`currentRecording`): on a transcription, its
+open recording; on a broadcast, the open recording
+of a live transcription feeding it, which is what its listeners are sent."""
+
+    recording_id: str = Field(alias="recordingId")
+    started_at: Optional[str] = Field(default=None, alias="startedAt")
+    state: RecordingState
+    transcription_id: Optional[str] = Field(default=None, alias="transcriptionId")
+
+
+class LastRecording(_Base):
+    """A live transcription's newest recording (`lastRecording`): what
+its row in a list reads from — how long it ran, when, and whether it is
+still running — and the recording a tap on that row opens."""
+
+    duration_s: Optional[float] = Field(default=None, alias="durationS")
+    recording_id: str = Field(alias="recordingId")
+    started_at: Optional[str] = Field(default=None, alias="startedAt")
+    state: RecordingState
+    title: Optional[str] = None
+    transcription_id: Optional[str] = Field(default=None, alias="transcriptionId")
+
+
+class ConfidencePolicy(_Base):
+    """Env defaults, overridden per broadcast, transcription or recording."""
+
+    hide_below: Optional[float] = Field(default=None, alias="hideBelow")
+    low_threshold: Optional[float] = Field(default=None, alias="lowThreshold")
+    suppress_count: Optional[int] = Field(default=None, alias="suppressCount")
+
+
+class Settings(_Base):
+    """A broadcast's, transcription's or recording's capture settings (the
+design's settings sheet): what a recording made in it starts with."""
+
+    confidence: Optional["ConfidencePolicy"] = None
+    latency_mode: Optional[LatencyMode] = Field(default=None, alias="latencyMode")
+    max_duration_s: Optional[int] = Field(default=None, alias="maxDurationS")
+    max_pause_s: Optional[int] = Field(default=None, alias="maxPauseS")
+    silence_auto_pause_s: Optional[int] = Field(default=None, alias="silenceAutoPauseS")
+    speaker_labels: Optional[SpeakerLabels] = Field(default=None, alias="speakerLabels")
+    spoken_language: Optional[str] = Field(default=None, alias="spokenLanguage")
+    summary: Optional[bool] = None
+    summary_translations: Optional[bool] = Field(default=None, alias="summaryTranslations")
+    title: Optional[bool] = None
+    voice: Optional[bool] = None
+    voice_by_lang: Optional[Dict[str, str]] = Field(default=None, alias="voiceByLang")
+    voice_cloning: Optional[bool] = Field(default=None, alias="voiceCloning")
+    voice_cloning_consent: Optional[bool] = Field(default=None, alias="voiceCloningConsent")
+
+
 class TranscriptionRef(_Base):
     """A live transcription feeding a broadcast (`Broadcast.transcriptions`)."""
 
@@ -686,6 +523,16 @@ those live transcriptions."""
     updated_at: str = Field(alias="updatedAt")
 
 
+class BroadcastRef(_Base):
+    """A broadcast a live transcription feeds (`Transcription.broadcasts`)."""
+
+    access: Access
+    code: str
+    id: str
+    name: str
+    share_url: str = Field(alias="shareUrl")
+
+
 class Limits(_Base):
     audio_buffer_s: int = Field(alias="audioBufferS")
     max_duration_s: int = Field(alias="maxDurationS")
@@ -862,13 +709,6 @@ class CreateAudioSource(_Base):
     url: str
 
 
-class CreateBatch(_Base):
-    """`POST /v1/batches`."""
-
-    name: Optional[str] = None
-    settings: Optional["BatchSettings"] = None
-
-
 class CreateBroadcast(_Base):
     """`POST /v1/broadcasts`."""
 
@@ -999,6 +839,13 @@ class CropRange(_Base):
     start_s: Optional[float] = Field(default=None, alias="startS")
 
 
+class CropWindow(_Base):
+    """A window of the source, in seconds into it.  `end_s` absent = to the end."""
+
+    end_s: Optional[float] = Field(default=None, alias="endS")
+    start_s: float = Field(alias="startS")
+
+
 class DraftSegment(_Base):
     speaker: int
     start: float
@@ -1031,6 +878,25 @@ class InputOptions(_Base):
     url: Optional[str] = None
 
 
+class JobProgress(_Base):
+    fetch_total_bytes: Optional[int] = Field(default=None, alias="fetchTotalBytes")
+    fetched_bytes: Optional[int] = Field(default=None, alias="fetchedBytes")
+    pct: int
+    phase: Optional[str] = None
+    phase_pct: Optional[int] = Field(default=None, alias="phasePct")
+    processed_s: float = Field(alias="processedS")
+    segments_done: int = Field(alias="segmentsDone")
+    segments_total: Optional[int] = Field(default=None, alias="segmentsTotal")
+    total_s: Optional[float] = Field(default=None, alias="totalS")
+
+
+class JobQueue(_Base):
+    """Why a `queued` job is waiting, and where it stands (`Job.queue`)."""
+
+    position: int
+    reason: QueueReason
+
+
 class KnownVoice(_Base):
     """One voice a realtime session may recognise a speaker as.
 
@@ -1309,6 +1175,22 @@ class PublisherInfo(_Base):
     machine_id: Optional[str] = Field(default=None, alias="machineId")
 
 
+class SourceInfo(_Base):
+    """What the recording was made from (design `j.meta`: "M4A · 34.2 MB",
+"Video URL")."""
+
+    bytes: Optional[int] = None
+    duration_s: Optional[float] = Field(default=None, alias="durationS")
+    embed_id: Optional[str] = Field(default=None, alias="embedId")
+    format: Optional[str] = None
+    kind: SourceKind
+    mime: Optional[str] = None
+    name: str
+    site: Optional[str] = None
+    thumbnail_url: Optional[str] = Field(default=None, alias="thumbnailUrl")
+    url: Optional[str] = None
+
+
 class Recording(_Base):
     created_at: str = Field(alias="createdAt")
     end_reason: Optional[str] = Field(default=None, alias="endReason")
@@ -1551,6 +1433,26 @@ Flattened into its owner."""
     views: int
 
 
+class TranscriptionJob(_Base):
+    attempts: int
+    created_at: str = Field(alias="createdAt")
+    crop: Optional["CropWindow"] = None
+    error: Optional[str] = None
+    error_code: Optional[str] = Field(default=None, alias="errorCode")
+    finished_at: Optional[str] = Field(default=None, alias="finishedAt")
+    has_audio: bool = Field(alias="hasAudio")
+    has_video: Optional[bool] = Field(default=None, alias="hasVideo")
+    peaks: Optional[List[float]] = None
+    preview: Optional[bool] = None
+    progress: "JobProgress"
+    queue: Optional["JobQueue"] = None
+    recording_id: str = Field(alias="recordingId")
+    source: Optional["SourceInfo"] = None
+    started_at: Optional[str] = Field(default=None, alias="startedAt")
+    state: JobState
+    transcription_id: str = Field(alias="transcriptionId")
+
+
 class SharedTranscript(_Base):
     """What the public page learns from a code: the transcript's name, who
 shared it (display name only), what the link allows, and the recording
@@ -1624,6 +1526,14 @@ class TagList(_Base):
     tags: List["Tag"]
 
 
+class TagRef(_Base):
+    """A tag as a transcription lists it."""
+
+    color: Literal["coral", "amber", "lime", "green", "teal", "blue", "violet", "pink"]
+    id: str
+    name: str
+
+
 class TagTranscriptions(_Base):
     """Transcriptions to put the tag on and to take it off, by id."""
 
@@ -1644,6 +1554,39 @@ class TranscriptSnapshot(_Base):
     translation_pending: Optional[bool] = Field(default=None, alias="translationPending")
 
 
+class Transcription(_Base):
+    """A transcription: a file, a link (with its `transcription` job), or
+something captured as it is spoken (`live: true`: a microphone, a
+stream, an RTMP encoder), which may feed broadcasts (`broadcasts`)."""
+
+    archived_at: Optional[str] = Field(default=None, alias="archivedAt")
+    blocked: Optional["Blocked"] = None
+    broadcasts: Optional[List["BroadcastRef"]] = None
+    code: str
+    created_at: str = Field(alias="createdAt")
+    created_by_api_key_id: Optional[str] = Field(default=None, alias="createdByApiKeyId")
+    current_recording: Optional["CurrentRecording"] = Field(default=None, alias="currentRecording")
+    id: str
+    job: Optional["TranscriptionJob"] = None
+    kind: Literal["transcription"] = "transcription"
+    last_recorded_at: Optional[str] = Field(default=None, alias="lastRecordedAt")
+    last_recording: Optional["LastRecording"] = Field(default=None, alias="lastRecording")
+    lifecycle: Lifecycle
+    live: Optional[bool] = None
+    locked: Optional[bool] = None
+    name: str
+    origin: Literal["dashboard", "api", "extension", "desktop_app", "obs", "wordpress", "payload", "strapi", "sanity", "contentful", "mcp", "broadcast", "unknown"]
+    owner_principal_id: str = Field(alias="ownerPrincipalId")
+    purge_after: Optional[str] = Field(default=None, alias="purgeAfter")
+    recording_count: int = Field(alias="recordingCount")
+    settings: "Settings"
+    share_code: Optional[str] = Field(default=None, alias="shareCode")
+    share_url: str = Field(alias="shareUrl")
+    source: "CaptureSource"
+    tags: Optional[List["TagRef"]] = None
+    updated_at: str = Field(alias="updatedAt")
+
+
 class TranscriptionLookup(_Base):
     transcription: Optional["Transcription"] = None
 
@@ -1902,6 +1845,14 @@ class SessionLoading(_Base):
     type: Literal["session.loading"] = "session.loading"
 
 
+class SessionQueued(_Base):
+    buffered_s: Optional[float] = Field(default=None, alias="bufferedS")
+    dropped_s: Optional[float] = Field(default=None, alias="droppedS")
+    position: Optional[int] = None
+    type: Literal["session.queued"] = "session.queued"
+    waited_s: float = Field(alias="waitedS")
+
+
 class SessionReady(_Base):
     type: Literal["session.ready"] = "session.ready"
 
@@ -2080,7 +2031,7 @@ class ErrorFrame(_Base):
     type: Literal["error"] = "error"
 
 
-ServerFrame = Annotated[Union[SessionLoading, SessionReady, TranscriptCommitted, TranscriptDraft, TranscriptWords, TranscriptAmended, TranscriptLatency, TranscriptSpeaker, TranscriptSpeakerGender, TranscriptSpeakerIdentified, TranscriptSpeakerNumbers, TranscriptSentence, TranscriptTranslated, TranscriptVoice, TranscriptVoiceStatus, TranscriptLanguageStatus, TranscriptRetracted, TranscriptHeld, TranscriptProgress, StreamPull, SourceProgress, SourcePrepared, SessionDone, ErrorFrame], Field(discriminator="type")]
+ServerFrame = Annotated[Union[SessionLoading, SessionQueued, SessionReady, TranscriptCommitted, TranscriptDraft, TranscriptWords, TranscriptAmended, TranscriptLatency, TranscriptSpeaker, TranscriptSpeakerGender, TranscriptSpeakerIdentified, TranscriptSpeakerNumbers, TranscriptSentence, TranscriptTranslated, TranscriptVoice, TranscriptVoiceStatus, TranscriptLanguageStatus, TranscriptRetracted, TranscriptHeld, TranscriptProgress, StreamPull, SourceProgress, SourcePrepared, SessionDone, ErrorFrame], Field(discriminator="type")]
 
 class SubscribeUpdate(_Base):
     audio: Optional[bool] = None
@@ -2226,7 +2177,7 @@ class SubscribeGap(_Base):
 
 SubscriberFrame = Annotated[Union[SubscribeReady, RecordingState, RecordingSettings, RecordingSilence, RecordingExpiring, TranscriptCorrected, TranscriptSpeakerGender, TranscriptSpeakerIdentified, TranscriptSpeakerNamed, TranscriptSpeakerNumbers, RecordingStarted, JobProgress, StreamIngest, RecordingEnded, Audience, SubscribeGap], Field(discriminator="type")]
 
-SERVER_FRAME_TYPES = frozenset(["session.loading", "session.ready", "transcript.committed", "transcript.draft", "transcript.words", "transcript.amended", "transcript.latency", "transcript.speaker", "transcript.speakerGender", "transcript.speakerIdentified", "transcript.speakerNumbers", "transcript.sentence", "transcript.translated", "transcript.voice", "transcript.voiceStatus", "transcript.languageStatus", "transcript.retracted", "transcript.held", "transcript.progress", "stream.pull", "source.progress", "source.prepared", "session.done", "error"])
+SERVER_FRAME_TYPES = frozenset(["session.loading", "session.queued", "session.ready", "transcript.committed", "transcript.draft", "transcript.words", "transcript.amended", "transcript.latency", "transcript.speaker", "transcript.speakerGender", "transcript.speakerIdentified", "transcript.speakerNumbers", "transcript.sentence", "transcript.translated", "transcript.voice", "transcript.voiceStatus", "transcript.languageStatus", "transcript.retracted", "transcript.held", "transcript.progress", "stream.pull", "source.progress", "source.prepared", "session.done", "error"])
 
 _server_frame_adapter: TypeAdapter[ServerFrame] = TypeAdapter(ServerFrame)
 

{vocalstack-1.0.0a2 → vocalstack-1.0.0a3}/src/vocalstack/client.py

@@ -28,7 +28,6 @@ import httpx
 from ._http import DEFAULT_BASE_URL, Transport
 from .realtime import Realtime
 from .resources import (
-    Batches,
     Billing,
     Broadcasts,
     Connect,
@@ -84,7 +83,6 @@ class VocalStack:
         self.realtime = Realtime(t, ready_deadline_s)
         self.broadcasts = Broadcasts(t)
         self.transcriptions = Transcriptions(t)
-        self.batches = Batches(t)
         self.recordings = Recordings(t, ready_deadline_s)
         self.jobs = Jobs(t)
         self.corrections = Corrections(t)

{vocalstack-1.0.0a2 → vocalstack-1.0.0a3}/src/vocalstack/realtime.py

@@ -382,7 +382,7 @@ async def pace_realtime(
     speed: float = 1.0,
 ) -> None:
     """Feed a whole PCM buffer at ``speed``× realtime, then ``eof()``.
-    Convenience for file/batch sources against the realtime API."""
+    Convenience for file sources against the realtime API."""
     bytes_per_second = 16000 * 4
     chunk = max(4, int(bytes_per_second * chunk_seconds) & ~3)
     start = time.monotonic()

{vocalstack-1.0.0a2 → vocalstack-1.0.0a3}/src/vocalstack/resources.py

@@ -349,115 +349,6 @@ class Transcriptions(_ParentResource):
         return _one(m.Transcription, data)
 
 
-class Batches(_Group):
-    """``vs.batches``: several files transcribed together, for less than a
-    transcription each (one create, one minimum charge). Create a batch, add
-    each file or link with ``add_file``, then ``start`` it; ``get`` shows its
-    files (each a transcription with its job) and their counts. A batch's
-    files get no summary, title, share link or spoken translations."""
-
-    @staticmethod
-    def _path(id: str, rest: str = "") -> str:
-        return f"/v1/batches/{_p(id)}{rest}"
-
-    async def create(self, *, idempotency_key: Optional[str] = None, **fields: Any) -> m.Batch:
-        """An open batch, ready for files (``name`` defaults to "Batch of
-        <date>"; ``settings``: ``spoken_language``, ``speaker_labels``,
-        ``latency_mode`` for every file)."""
-        body = _body(m.CreateBatch, fields)
-        return _one(m.Batch, await self._t.json("POST", "/v1/batches", json_body=body, idempotency_key=idempotency_key))
-
-    async def list(self) -> List[m.Batch]:
-        """Every batch, newest first (every page of ``list_page``); each with its counts, not its files."""
-        items = await _all_pages(lambda c: self._t.json("GET", "/v1/batches", query={"cursor": c}), "batches")
-        return [m.Batch.model_validate(x) for x in items]
-
-    async def list_page(self, *, cursor: Optional[str] = None, limit: Optional[int] = None) -> m.BatchPage:
-        """One page of batches, newest first; ``cursor`` is the previous page's ``next_cursor``."""
-        return _one(m.BatchPage, await self._t.json("GET", "/v1/batches", query={"cursor": cursor, "limit": limit}))
-
-    async def get(self, id: str) -> m.Batch:
-        """A batch with its files (``files``, each a transcription with its job), in the order they were added."""
-        return _one(m.Batch, await self._t.json("GET", self._path(id)))
-
-    async def delete(self, id: str) -> None:
-        """Discard a batch that was never started, with its files (nothing was charged)."""
-        await self._t.json("DELETE", self._path(id))
-
-    async def add_file(
-        self,
-        id: str,
-        *,
-        file: Optional[Upload] = None,
-        file_name: Optional[str] = None,
-        idempotency_key: Optional[str] = None,
-        **fields: Any,
-    ) -> m.Transcription:
-        """Add one file (``file``: a path, bytes or an open binary file) or
-        public link (``url=...``) to an open batch: a transcription of its
-        own (``batch_id``), waiting for the batch's ``start``. Of the
-        transcription options it takes ``name``, ``start_s``, ``end_s`` and
-        ``duration_s`` (the settings are the batch's)."""
-        options = _body(m.CreateTranscription, fields)
-        if file is None:
-            data = await self._t.json("POST", self._path(id, "/files"), json_body=options, idempotency_key=idempotency_key)
-        else:
-            part = await asyncio.to_thread(_file_part, file, file_name, "upload")
-            data = await self._t.json(
-                "POST",
-                self._path(id, "/files"),
-                data={"options": json.dumps(options)},
-                files={"file": part},
-                idempotency_key=idempotency_key,
-            )
-        return _one(m.Transcription, data)
-
-    async def add_url(self, id: str, url: str, **fields: Any) -> m.Transcription:
-        """``add_file(id, url=url, ...)``."""
-        return await self.add_file(id, url=url, **fields)
-
-    async def start(self, id: str, *, idempotency_key: Optional[str] = None) -> m.Batch:
-        """Seal the batch and queue its files, longest first; ``wait`` follows it to the end."""
-        return _one(m.Batch, await self._t.json("POST", self._path(id, "/start"), idempotency_key=idempotency_key))
-
-    async def export(self, id: str, format: str) -> bytes:
-        """Every finished file's transcript in one ``format`` (``json``,
-        ``srt``, ``xlsx`` or ``pdf``, as ``recordings.export`` makes one), in
-        one zip: its bytes. Files still running or failed are left out."""
-        resp = await self._t.raw("GET", self._path(id, "/export"), headers={"accept": "*/*"}, query={"format": format})
-        return resp.content
-
-    async def stop(self, id: str) -> m.Batch:
-        """Stop every file not finished yet: queued files never start, a
-        running one is cancelled and billed for what it transcribed."""
-        return _one(m.Batch, await self._t.json("POST", self._path(id, "/stop")))
-
-    async def wait(
-        self,
-        id: str,
-        *,
-        interval_s: float = 5.0,
-        timeout_s: Optional[float] = None,
-        on_progress: Optional[Callable[[m.Batch], None]] = None,
-    ) -> m.Batch:
-        """Poll a started batch until it is ``done`` (every file finished or
-        failed) or ``stopped``, and return it with its files. It does not
-        raise on a failed file: check ``counts.failed`` and each file's
-        ``job.state``. ``on_progress`` sees every read, the last one included."""
-        deadline = None if timeout_s is None else time.monotonic() + timeout_s
-        while True:
-            batch = await self.get(id)
-            if on_progress is not None:
-                on_progress(batch)
-            if batch.state in ("done", "stopped") and batch.finished_at:
-                return batch
-            if batch.state == "open":
-                raise VocalStackError("invalid_state", "the batch is open: start it before waiting for it")
-            if deadline is not None and time.monotonic() + interval_s > deadline:
-                raise VocalStackError("timeout", f"batch still {batch.state} after {timeout_s}s", retryable=True)
-            await asyncio.sleep(interval_s)
-
-
 class Recordings(_Group):
     """``vs.recordings``: one take, live or uploaded."""