casedev 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

casedev/resources/vault/vault.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-from typing import Dict
 from typing_extensions import Literal
 
 import httpx
@@ -16,7 +15,7 @@ from .objects import (
     ObjectsResourceWithStreamingResponse,
     AsyncObjectsResourceWithStreamingResponse,
 )
-from ..._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given
+from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
 from ..._utils import maybe_transform, async_maybe_transform
 from .graphrag import (
     GraphragResource,
@@ -40,6 +39,7 @@ from ...types.vault_create_response import VaultCreateResponse
 from ...types.vault_ingest_response import VaultIngestResponse
 from ...types.vault_search_response import VaultSearchResponse
 from ...types.vault_upload_response import VaultUploadResponse
+from ...types.vault_retrieve_response import VaultRetrieveResponse
 
 __all__ = ["VaultResource", "AsyncVaultResource"]
 
@@ -78,6 +78,8 @@ class VaultResource(SyncAPIResource):
         name: str,
         description: str | Omit = omit,
         enable_graph: bool | Omit = omit,
+        enable_indexing: bool | Omit = omit,
+        metadata: object | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -88,15 +90,22 @@ class VaultResource(SyncAPIResource):
         """
         Creates a new secure vault with dedicated S3 storage and vector search
         capabilities. Each vault provides isolated document storage with semantic
-        search, OCR processing, and optional knowledge graph features for legal document
-        analysis and discovery.
+        search, OCR processing, and optional GraphRAG knowledge graph features for legal
+        document analysis and discovery.
 
         Args:
           name: Display name for the vault
 
           description: Optional description of the vault's purpose
 
-          enable_graph: Enable knowledge graph for entity relationship mapping
+          enable_graph: Enable knowledge graph for entity relationship mapping. Only applies when
+              enableIndexing is true.
+
+          enable_indexing: Enable vector indexing and search capabilities. Set to false for storage-only
+              vaults.
+
+          metadata: Optional metadata to attach to the vault (e.g., { containsPHI: true } for HIPAA
+              compliance tracking)
 
           extra_headers: Send extra headers
 
@@ -113,6 +122,8 @@ class VaultResource(SyncAPIResource):
                     "name": name,
                     "description": description,
                     "enable_graph": enable_graph,
+                    "enable_indexing": enable_indexing,
+                    "metadata": metadata,
                 },
                 vault_create_params.VaultCreateParams,
             ),
@@ -132,7 +143,7 @@ class VaultResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> None:
+    ) -> VaultRetrieveResponse:
         """
         Retrieve detailed information about a specific vault, including storage
         configuration, chunking strategy, and usage statistics. Returns vault metadata,
@@ -149,13 +160,12 @@ class VaultResource(SyncAPIResource):
         """
         if not id:
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._get(
             f"/vault/{id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=VaultRetrieveResponse,
         )
 
     def list(
@@ -171,7 +181,7 @@ class VaultResource(SyncAPIResource):
         """List all vaults for the authenticated organization.
 
         Returns vault metadata
-        including storage configuration and usage statistics.
+        including name, description, storage configuration, and usage statistics.
         """
         return self._get(
             "/vault",
@@ -194,10 +204,12 @@ class VaultResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> VaultIngestResponse:
         """
-        Triggers OCR ingestion workflow for a vault object to extract text, generate
-        chunks, and create embeddings. Processing happens asynchronously with GraphRAG
-        support if enabled on the vault. Returns immediately with workflow tracking
-        information.
+        Triggers ingestion workflow for a vault object to extract text, generate chunks,
+        and create embeddings. For supported file types (PDF, DOCX, TXT, RTF, XML,
+        audio, video), processing happens asynchronously. For unsupported types (images,
+        archives, etc.), the file is marked as completed immediately without text
+        extraction. GraphRAG indexing must be triggered separately via POST
+        /vault/:id/graphrag/:objectId.
 
         Args:
           extra_headers: Send extra headers
@@ -225,7 +237,7 @@ class VaultResource(SyncAPIResource):
         id: str,
         *,
         query: str,
-        filters: Dict[str, object] | Omit = omit,
+        filters: vault_search_params.Filters | Omit = omit,
         method: Literal["vector", "graph", "hybrid", "global", "local", "fast", "entity"] | Omit = omit,
         top_k: int | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -244,7 +256,7 @@ class VaultResource(SyncAPIResource):
         Args:
           query: Search query or question to find relevant documents
 
-          filters: Additional filters to apply to search results
+          filters: Filters to narrow search results to specific documents
 
           method: Search method: 'global' for comprehensive questions, 'entity' for specific
               entities, 'fast' for quick similarity search, 'hybrid' for combined approach
@@ -286,6 +298,7 @@ class VaultResource(SyncAPIResource):
         filename: str,
         auto_index: bool | Omit = omit,
         metadata: object | Omit = omit,
+        path: str | Omit = omit,
         size_bytes: float | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -309,6 +322,10 @@ class VaultResource(SyncAPIResource):
 
           metadata: Additional metadata to associate with the file
 
+          path: Optional folder path for hierarchy preservation. Allows integrations to maintain
+              source folder structure from systems like NetDocs, Clio, or Smokeball. Example:
+              '/Discovery/Depositions/2024'
+
           size_bytes: Estimated file size in bytes for cost calculation
 
           extra_headers: Send extra headers
@@ -329,6 +346,7 @@ class VaultResource(SyncAPIResource):
                     "filename": filename,
                     "auto_index": auto_index,
                     "metadata": metadata,
+                    "path": path,
                     "size_bytes": size_bytes,
                 },
                 vault_upload_params.VaultUploadParams,
@@ -374,6 +392,8 @@ class AsyncVaultResource(AsyncAPIResource):
         name: str,
         description: str | Omit = omit,
         enable_graph: bool | Omit = omit,
+        enable_indexing: bool | Omit = omit,
+        metadata: object | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -384,15 +404,22 @@ class AsyncVaultResource(AsyncAPIResource):
         """
         Creates a new secure vault with dedicated S3 storage and vector search
         capabilities. Each vault provides isolated document storage with semantic
-        search, OCR processing, and optional knowledge graph features for legal document
-        analysis and discovery.
+        search, OCR processing, and optional GraphRAG knowledge graph features for legal
+        document analysis and discovery.
 
         Args:
           name: Display name for the vault
 
           description: Optional description of the vault's purpose
 
-          enable_graph: Enable knowledge graph for entity relationship mapping
+          enable_graph: Enable knowledge graph for entity relationship mapping. Only applies when
+              enableIndexing is true.
+
+          enable_indexing: Enable vector indexing and search capabilities. Set to false for storage-only
+              vaults.
+
+          metadata: Optional metadata to attach to the vault (e.g., { containsPHI: true } for HIPAA
+              compliance tracking)
 
           extra_headers: Send extra headers
 
@@ -409,6 +436,8 @@ class AsyncVaultResource(AsyncAPIResource):
                     "name": name,
                     "description": description,
                     "enable_graph": enable_graph,
+                    "enable_indexing": enable_indexing,
+                    "metadata": metadata,
                 },
                 vault_create_params.VaultCreateParams,
             ),
@@ -428,7 +457,7 @@ class AsyncVaultResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> None:
+    ) -> VaultRetrieveResponse:
         """
         Retrieve detailed information about a specific vault, including storage
         configuration, chunking strategy, and usage statistics. Returns vault metadata,
@@ -445,13 +474,12 @@ class AsyncVaultResource(AsyncAPIResource):
         """
         if not id:
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._get(
             f"/vault/{id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=VaultRetrieveResponse,
         )
 
     async def list(
@@ -467,7 +495,7 @@ class AsyncVaultResource(AsyncAPIResource):
         """List all vaults for the authenticated organization.
 
         Returns vault metadata
-        including storage configuration and usage statistics.
+        including name, description, storage configuration, and usage statistics.
         """
         return await self._get(
             "/vault",
@@ -490,10 +518,12 @@ class AsyncVaultResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> VaultIngestResponse:
         """
-        Triggers OCR ingestion workflow for a vault object to extract text, generate
-        chunks, and create embeddings. Processing happens asynchronously with GraphRAG
-        support if enabled on the vault. Returns immediately with workflow tracking
-        information.
+        Triggers ingestion workflow for a vault object to extract text, generate chunks,
+        and create embeddings. For supported file types (PDF, DOCX, TXT, RTF, XML,
+        audio, video), processing happens asynchronously. For unsupported types (images,
+        archives, etc.), the file is marked as completed immediately without text
+        extraction. GraphRAG indexing must be triggered separately via POST
+        /vault/:id/graphrag/:objectId.
 
         Args:
           extra_headers: Send extra headers
@@ -521,7 +551,7 @@ class AsyncVaultResource(AsyncAPIResource):
         id: str,
         *,
         query: str,
-        filters: Dict[str, object] | Omit = omit,
+        filters: vault_search_params.Filters | Omit = omit,
         method: Literal["vector", "graph", "hybrid", "global", "local", "fast", "entity"] | Omit = omit,
         top_k: int | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -540,7 +570,7 @@ class AsyncVaultResource(AsyncAPIResource):
         Args:
           query: Search query or question to find relevant documents
 
-          filters: Additional filters to apply to search results
+          filters: Filters to narrow search results to specific documents
 
           method: Search method: 'global' for comprehensive questions, 'entity' for specific
               entities, 'fast' for quick similarity search, 'hybrid' for combined approach
@@ -582,6 +612,7 @@ class AsyncVaultResource(AsyncAPIResource):
         filename: str,
         auto_index: bool | Omit = omit,
         metadata: object | Omit = omit,
+        path: str | Omit = omit,
         size_bytes: float | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -605,6 +636,10 @@ class AsyncVaultResource(AsyncAPIResource):
 
           metadata: Additional metadata to associate with the file
 
+          path: Optional folder path for hierarchy preservation. Allows integrations to maintain
+              source folder structure from systems like NetDocs, Clio, or Smokeball. Example:
+              '/Discovery/Depositions/2024'
+
           size_bytes: Estimated file size in bytes for cost calculation
 
           extra_headers: Send extra headers
@@ -625,6 +660,7 @@ class AsyncVaultResource(AsyncAPIResource):
                     "filename": filename,
                     "auto_index": auto_index,
                     "metadata": metadata,
+                    "path": path,
                     "size_bytes": size_bytes,
                 },
                 vault_upload_params.VaultUploadParams,

casedev/resources/voice/streaming.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 import httpx
 
-from ..._types import Body, Query, Headers, NoneType, NotGiven, not_given
+from ..._types import Body, Query, Headers, NotGiven, not_given
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
 from ..._response import (
@@ -14,6 +14,7 @@ from ..._response import (
     async_to_streamed_response_wrapper,
 )
 from ..._base_client import make_request_options
+from ...types.voice.streaming_get_url_response import StreamingGetURLResponse
 
 __all__ = ["StreamingResource", "AsyncStreamingResource"]
 
@@ -47,7 +48,7 @@ class StreamingResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> None:
+    ) -> StreamingGetURLResponse:
         """
         Returns the WebSocket URL and connection details for real-time audio
         transcription. The returned URL can be used to establish a WebSocket connection
@@ -61,13 +62,12 @@ class StreamingResource(SyncAPIResource):
 
         **Pricing:** $0.30 per minute ($18.00 per hour)
         """
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._get(
             "/voice/streaming/url",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=StreamingGetURLResponse,
         )
 
 
@@ -100,7 +100,7 @@ class AsyncStreamingResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> None:
+    ) -> StreamingGetURLResponse:
         """
         Returns the WebSocket URL and connection details for real-time audio
         transcription. The returned URL can be used to establish a WebSocket connection
@@ -114,13 +114,12 @@ class AsyncStreamingResource(AsyncAPIResource):
 
         **Pricing:** $0.30 per minute ($18.00 per hour)
         """
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._get(
             "/voice/streaming/url",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=StreamingGetURLResponse,
         )
 
 

casedev/resources/voice/transcription.py

@@ -2,9 +2,11 @@
 
 from __future__ import annotations
 
+from typing_extensions import Literal
+
 import httpx
 
-from ..._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given
+from ..._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
 from ..._utils import maybe_transform, async_maybe_transform
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -16,6 +18,7 @@ from ..._response import (
 )
 from ...types.voice import transcription_create_params
 from ..._base_client import make_request_options
+from ...types.voice.transcription_create_response import TranscriptionCreateResponse
 from ...types.voice.transcription_retrieve_response import TranscriptionRetrieveResponse
 
 __all__ = ["TranscriptionResource", "AsyncTranscriptionResource"]
@@ -44,35 +47,49 @@ class TranscriptionResource(SyncAPIResource):
     def create(
         self,
         *,
-        audio_url: str,
+        audio_url: str | Omit = omit,
         auto_highlights: bool | Omit = omit,
+        boost_param: Literal["low", "default", "high"] | Omit = omit,
         content_safety_labels: bool | Omit = omit,
+        format: Literal["json", "text"] | Omit = omit,
         format_text: bool | Omit = omit,
         language_code: str | Omit = omit,
         language_detection: bool | Omit = omit,
+        object_id: str | Omit = omit,
         punctuate: bool | Omit = omit,
         speaker_labels: bool | Omit = omit,
+        speakers_expected: int | Omit = omit,
+        vault_id: str | Omit = omit,
+        word_boost: SequenceNotStr[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> None:
+    ) -> TranscriptionCreateResponse:
         """Creates an asynchronous transcription job for audio files.
 
-        Supports various
-        audio formats and advanced features like speaker identification, content
-        moderation, and automatic highlights. Returns a job ID for checking
-        transcription status and retrieving results.
+        Supports two modes:
+
+        **Vault-based (recommended)**: Pass `vault_id` and `object_id` to transcribe
+        audio from your vault. The transcript will automatically be saved back to the
+        vault when complete.
+
+        **Direct URL (legacy)**: Pass `audio_url` for direct transcription without
+        automatic storage.
 
         Args:
-          audio_url: URL of the audio file to transcribe
+          audio_url: URL of the audio file to transcribe (legacy mode, no auto-storage)
 
           auto_highlights: Automatically extract key phrases and topics
 
+          boost_param: How much to boost custom vocabulary
+
           content_safety_labels: Enable content moderation and safety labeling
 
+          format: Output format for the transcript when using vault mode
+
           format_text: Format text with proper capitalization
 
           language_code: Language code (e.g., 'en_us', 'es', 'fr'). If not specified, language will be
@@ -80,10 +97,18 @@ class TranscriptionResource(SyncAPIResource):
 
           language_detection: Enable automatic language detection
 
+          object_id: Object ID of the audio file in the vault (use with vault_id)
+
           punctuate: Add punctuation to the transcript
 
           speaker_labels: Enable speaker identification and labeling
 
+          speakers_expected: Expected number of speakers (improves accuracy when known)
+
+          vault_id: Vault ID containing the audio file (use with object_id)
+
+          word_boost: Custom vocabulary words to boost (e.g., legal terms)
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -92,26 +117,31 @@ class TranscriptionResource(SyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._post(
             "/voice/transcription",
             body=maybe_transform(
                 {
                     "audio_url": audio_url,
                     "auto_highlights": auto_highlights,
+                    "boost_param": boost_param,
                     "content_safety_labels": content_safety_labels,
+                    "format": format,
                     "format_text": format_text,
                     "language_code": language_code,
                     "language_detection": language_detection,
+                    "object_id": object_id,
                     "punctuate": punctuate,
                     "speaker_labels": speaker_labels,
+                    "speakers_expected": speakers_expected,
+                    "vault_id": vault_id,
+                    "word_boost": word_boost,
                 },
                 transcription_create_params.TranscriptionCreateParams,
             ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=TranscriptionCreateResponse,
         )
 
     def retrieve(
@@ -127,8 +157,9 @@ class TranscriptionResource(SyncAPIResource):
     ) -> TranscriptionRetrieveResponse:
         """Retrieve the status and result of an audio transcription job.
 
-        Returns the
-        transcription text when complete, or status information for pending jobs.
+        For vault-based
+        jobs, returns status and result_object_id when complete. For legacy direct URL
+        jobs, returns the full transcription data.
 
         Args:
           extra_headers: Send extra headers
@@ -173,35 +204,49 @@ class AsyncTranscriptionResource(AsyncAPIResource):
     async def create(
         self,
         *,
-        audio_url: str,
+        audio_url: str | Omit = omit,
         auto_highlights: bool | Omit = omit,
+        boost_param: Literal["low", "default", "high"] | Omit = omit,
         content_safety_labels: bool | Omit = omit,
+        format: Literal["json", "text"] | Omit = omit,
         format_text: bool | Omit = omit,
         language_code: str | Omit = omit,
         language_detection: bool | Omit = omit,
+        object_id: str | Omit = omit,
         punctuate: bool | Omit = omit,
         speaker_labels: bool | Omit = omit,
+        speakers_expected: int | Omit = omit,
+        vault_id: str | Omit = omit,
+        word_boost: SequenceNotStr[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> None:
+    ) -> TranscriptionCreateResponse:
         """Creates an asynchronous transcription job for audio files.
 
-        Supports various
-        audio formats and advanced features like speaker identification, content
-        moderation, and automatic highlights. Returns a job ID for checking
-        transcription status and retrieving results.
+        Supports two modes:
+
+        **Vault-based (recommended)**: Pass `vault_id` and `object_id` to transcribe
+        audio from your vault. The transcript will automatically be saved back to the
+        vault when complete.
+
+        **Direct URL (legacy)**: Pass `audio_url` for direct transcription without
+        automatic storage.
 
         Args:
-          audio_url: URL of the audio file to transcribe
+          audio_url: URL of the audio file to transcribe (legacy mode, no auto-storage)
 
           auto_highlights: Automatically extract key phrases and topics
 
+          boost_param: How much to boost custom vocabulary
+
           content_safety_labels: Enable content moderation and safety labeling
 
+          format: Output format for the transcript when using vault mode
+
           format_text: Format text with proper capitalization
 
           language_code: Language code (e.g., 'en_us', 'es', 'fr'). If not specified, language will be
@@ -209,10 +254,18 @@ class AsyncTranscriptionResource(AsyncAPIResource):
 
           language_detection: Enable automatic language detection
 
+          object_id: Object ID of the audio file in the vault (use with vault_id)
+
           punctuate: Add punctuation to the transcript
 
           speaker_labels: Enable speaker identification and labeling
 
+          speakers_expected: Expected number of speakers (improves accuracy when known)
+
+          vault_id: Vault ID containing the audio file (use with object_id)
+
+          word_boost: Custom vocabulary words to boost (e.g., legal terms)
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -221,26 +274,31 @@ class AsyncTranscriptionResource(AsyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._post(
             "/voice/transcription",
             body=await async_maybe_transform(
                 {
                     "audio_url": audio_url,
                     "auto_highlights": auto_highlights,
+                    "boost_param": boost_param,
                     "content_safety_labels": content_safety_labels,
+                    "format": format,
                     "format_text": format_text,
                     "language_code": language_code,
                     "language_detection": language_detection,
+                    "object_id": object_id,
                     "punctuate": punctuate,
                     "speaker_labels": speaker_labels,
+                    "speakers_expected": speakers_expected,
+                    "vault_id": vault_id,
+                    "word_boost": word_boost,
                 },
                 transcription_create_params.TranscriptionCreateParams,
             ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=TranscriptionCreateResponse,
         )
 
     async def retrieve(
@@ -256,8 +314,9 @@ class AsyncTranscriptionResource(AsyncAPIResource):
     ) -> TranscriptionRetrieveResponse:
         """Retrieve the status and result of an audio transcription job.
 
-        Returns the
-        transcription text when complete, or status information for pending jobs.
+        For vault-based
+        jobs, returns status and result_object_id when complete. For legacy direct URL
+        jobs, returns the full transcription data.
 
         Args:
           extra_headers: Send extra headers