sarvamai 0.1.23a6__py3-none-any.whl → 0.1.23a8__py3-none-any.whl

sarvamai/types/doc_digitization_create_job_response.py

@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .doc_digitization_job_parameters import DocDigitizationJobParameters
+from .doc_digitization_job_state import DocDigitizationJobState
+from .storage_container_type import StorageContainerType
+
+
+class DocDigitizationCreateJobResponse(UniversalBaseModel):
+    job_id: str = pydantic.Field()
+    """
+    Unique job identifier (UUID)
+    """
+
+    storage_container_type: StorageContainerType = pydantic.Field()
+    """
+    Storage Container Type
+    """
+
+    job_parameters: DocDigitizationJobParameters = pydantic.Field()
+    """
+    Job configuration parameters
+    """
+
+    job_state: DocDigitizationJobState
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

sarvamai/types/doc_digitization_download_files_response.py

@@ -0,0 +1,47 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .doc_digitization_job_state import DocDigitizationJobState
+from .file_signed_url_details import FileSignedUrlDetails
+from .storage_container_type import StorageContainerType
+
+
+class DocDigitizationDownloadFilesResponse(UniversalBaseModel):
+    """
+    Response for download-files endpoint.
+    """
+
+    job_id: str = pydantic.Field()
+    """
+    Job identifier (UUID)
+    """
+
+    job_state: DocDigitizationJobState = pydantic.Field()
+    """
+    Current job state
+    """
+
+    storage_container_type: StorageContainerType = pydantic.Field()
+    """
+    Storage backend type
+    """
+
+    download_urls: typing.Dict[str, FileSignedUrlDetails] = pydantic.Field()
+    """
+    Map of filename to presigned download URL details
+    """
+
+    error_code: typing.Optional[str] = None
+    error_message: typing.Optional[str] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

sarvamai/types/doc_digitization_error_code.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+DocDigitizationErrorCode = typing.Union[
+    typing.Literal[
+        "invalid_request_error",
+        "internal_server_error",
+        "insufficient_quota_error",
+        "invalid_api_key_error",
+        "rate_limit_exceeded_error",
+        "high_load_error",
+    ],
+    typing.Any,
+]

sarvamai/types/doc_digitization_error_details.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .doc_digitization_error_code import DocDigitizationErrorCode
+
+
+class DocDigitizationErrorDetails(UniversalBaseModel):
+    message: str = pydantic.Field()
+    """
+    Message describing the error
+    """
+
+    code: DocDigitizationErrorCode = pydantic.Field()
+    """
+    Error code for the specific error that has occurred.
+    """
+
+    request_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier for the request. Format: date_UUID4
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

sarvamai/types/doc_digitization_error_message.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .doc_digitization_error_details import DocDigitizationErrorDetails
+
+
+class DocDigitizationErrorMessage(UniversalBaseModel):
+    error: DocDigitizationErrorDetails = pydantic.Field()
+    """
+    Error details
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

sarvamai/types/doc_digitization_job_detail.py

@@ -0,0 +1,74 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .doc_digitization_job_detail_state import DocDigitizationJobDetailState
+from .doc_digitization_page_error import DocDigitizationPageError
+from .task_file_details import TaskFileDetails
+
+
+class DocDigitizationJobDetail(UniversalBaseModel):
+    """
+    Processing details for a single input file with page-level metrics.
+    """
+
+    inputs: typing.List[TaskFileDetails] = pydantic.Field()
+    """
+    Input file(s) for this task
+    """
+
+    outputs: typing.List[TaskFileDetails] = pydantic.Field()
+    """
+    Output file(s) produced
+    """
+
+    state: DocDigitizationJobDetailState = pydantic.Field()
+    """
+    Processing state for this file
+    """
+
+    total_pages: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Total pages/images in the input file
+    """
+
+    pages_processed: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of pages processed so far
+    """
+
+    pages_succeeded: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of pages successfully processed
+    """
+
+    pages_failed: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of pages that failed processing
+    """
+
+    error_message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message if processing failed
+    """
+
+    error_code: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Standardized error code if failed
+    """
+
+    page_errors: typing.Optional[typing.List[DocDigitizationPageError]] = pydantic.Field(default=None)
+    """
+    Detailed errors for each failed page
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

sarvamai/types/doc_digitization_job_detail_state.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+DocDigitizationJobDetailState = typing.Union[
+    typing.Literal["Pending", "Running", "Success", "PartialSuccess", "Failed"], typing.Any
+]

sarvamai/types/doc_digitization_job_parameters.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .doc_digitization_output_format import DocDigitizationOutputFormat
+from .doc_digitization_supported_language import DocDigitizationSupportedLanguage
+
+
+class DocDigitizationJobParameters(UniversalBaseModel):
+    """
+    Job parameters for document digitization.
+    """
+
+    language: typing.Optional[DocDigitizationSupportedLanguage] = pydantic.Field(default=None)
+    """
+    ISO language code for the document
+    """
+
+    output_format: typing.Optional[DocDigitizationOutputFormat] = pydantic.Field(default=None)
+    """
+    Output format: html or md
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

sarvamai/types/doc_digitization_job_state.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+DocDigitizationJobState = typing.Union[
+    typing.Literal["Accepted", "Pending", "Running", "Completed", "PartiallyCompleted", "Failed"], typing.Any
+]

sarvamai/types/doc_digitization_job_status_response.py

@@ -0,0 +1,75 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .doc_digitization_job_detail import DocDigitizationJobDetail
+from .doc_digitization_job_state import DocDigitizationJobState
+from .storage_container_type import StorageContainerType
+
+
+class DocDigitizationJobStatusResponse(UniversalBaseModel):
+    """
+    Response model for job status endpoint.
+    """
+
+    job_id: str = pydantic.Field()
+    """
+    Job identifier (UUID)
+    """
+
+    job_state: DocDigitizationJobState = pydantic.Field()
+    """
+    Current job state
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Job creation timestamp (ISO 8601)
+    """
+
+    updated_at: dt.datetime = pydantic.Field()
+    """
+    Last update timestamp (ISO 8601)
+    """
+
+    storage_container_type: StorageContainerType = pydantic.Field()
+    """
+    Storage backend type
+    """
+
+    total_files: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Total input files (always 1)
+    """
+
+    successful_files_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Files that completed successfully
+    """
+
+    failed_files_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Files that failed
+    """
+
+    error_message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Job-level error message
+    """
+
+    job_details: typing.Optional[typing.List[DocDigitizationJobDetail]] = pydantic.Field(default=None)
+    """
+    Per-file processing details with page metrics
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

sarvamai/types/doc_digitization_output_format.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+DocDigitizationOutputFormat = typing.Union[typing.Literal["html", "md"], typing.Any]

sarvamai/types/doc_digitization_page_error.py

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class DocDigitizationPageError(UniversalBaseModel):
+    """
+    Error details for a specific page.
+    """
+
+    page_number: int = pydantic.Field()
+    """
+    Page number that failed
+    """
+
+    error_code: str = pydantic.Field()
+    """
+    Standardized error code
+    """
+
+    error_message: str = pydantic.Field()
+    """
+    Human-readable error description
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

sarvamai/types/doc_digitization_supported_language.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+DocDigitizationSupportedLanguage = typing.Union[
+    typing.Literal[
+        "hi",
+        "en",
+        "bn",
+        "gu",
+        "kn",
+        "ml",
+        "mr",
+        "or",
+        "pa",
+        "ta",
+        "te",
+        "ur",
+        "as",
+        "bodo",
+        "doi",
+        "ks",
+        "kok",
+        "mai",
+        "mni",
+        "ne",
+        "sa",
+        "sat",
+        "sd",
+    ],
+    typing.Any,
+]

sarvamai/types/doc_digitization_upload_files_response.py

@@ -0,0 +1,44 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .doc_digitization_job_state import DocDigitizationJobState
+from .file_signed_url_details import FileSignedUrlDetails
+from .storage_container_type import StorageContainerType
+
+
+class DocDigitizationUploadFilesResponse(UniversalBaseModel):
+    """
+    Response with presigned upload URLs
+    """
+
+    job_id: str = pydantic.Field()
+    """
+    Job identifier
+    """
+
+    job_state: DocDigitizationJobState = pydantic.Field()
+    """
+    Current job state
+    """
+
+    upload_urls: typing.Dict[str, FileSignedUrlDetails] = pydantic.Field()
+    """
+    Map of filename to presigned upload URL details
+    """
+
+    storage_container_type: StorageContainerType = pydantic.Field()
+    """
+    Storage backend type
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

sarvamai/types/doc_digitization_webhook_callback.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class DocDigitizationWebhookCallback(UniversalBaseModel):
+    """
+    Webhook configuration for job completion notification
+    """
+
+    url: str = pydantic.Field()
+    """
+    HTTPS webhook URL to call upon job completion (HTTP not allowed)
+    """
+
+    auth_token: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Authorization token sent as X-SARVAM-JOB-CALLBACK-TOKEN header
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

sarvamai/types/speech_to_text_language.py

@@ -4,30 +4,7 @@ import typing
 
 SpeechToTextLanguage = typing.Union[
     typing.Literal[
-        "unknown",
-        "hi-IN",
-        "bn-IN",
-        "kn-IN",
-        "ml-IN",
-        "mr-IN",
-        "od-IN",
-        "pa-IN",
-        "ta-IN",
-        "te-IN",
-        "en-IN",
-        "gu-IN",
-        "as-IN",
-        "ur-IN",
-        "ne-IN",
-        "kok-IN",
-        "ks-IN",
-        "sd-IN",
-        "sa-IN",
-        "sat-IN",
-        "mni-IN",
-        "brx-IN",
-        "mai-IN",
-        "doi-IN",
+        "unknown", "hi-IN", "bn-IN", "kn-IN", "ml-IN", "mr-IN", "od-IN", "pa-IN", "ta-IN", "te-IN", "en-IN", "gu-IN"
     ],
     typing.Any,
 ]

sarvamai/types/speech_to_text_response.py

@@ -4,22 +4,30 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .diarized_transcript import DiarizedTranscript
+from .timestamps_model import TimestampsModel
 
 
 class SpeechToTextResponse(UniversalBaseModel):
-    request_id: str = pydantic.Field()
+    request_id: typing.Optional[str] = None
+    transcript: str = pydantic.Field()
     """
-    Unique identifier for the request
+    The transcribed text from the provided audio file.
     """
 
-    transcript: str = pydantic.Field()
+    timestamps: typing.Optional[TimestampsModel] = pydantic.Field(default=None)
     """
-    The transcribed text from the provided audio file.
+    Contains timestamps for the transcribed text. This field is included only if with_timestamps is set to true
+    """
+
+    diarized_transcript: typing.Optional[DiarizedTranscript] = pydantic.Field(default=None)
+    """
+    Diarized transcript of the provided speech
     """
 
-    language_code: str = pydantic.Field()
+    language_code: typing.Optional[str] = pydantic.Field(default=None)
     """
-    The BCP-47 code of language spoken in the input (e.g., hi-IN, en-IN). If multiple languages are detected, returns the most predominant spoken language.
+    This will return the BCP-47 code of language spoken in the input. If multiple languages are detected, this will return language code of most predominant spoken language. If no language is detected, this will be null
     """
 
     if IS_PYDANTIC_V2:

sarvamai/types/speech_to_text_transcription_data.py

@@ -33,20 +33,6 @@ class SpeechToTextTranscriptionData(UniversalBaseModel):
     BCP-47 code of detected language
     """
 
-    language_probability: typing.Optional[float] = pydantic.Field(default=None)
-    """
-    Float value (0.0 to 1.0) indicating the probability of the detected language being correct. Higher values indicate higher confidence.
-    
-    **When it returns a value:**
-    - When `language_code` is not provided in the request
-    - When `language_code` is set to `unknown`
-    
-    **When it returns null:**
-    - When a specific `language_code` is provided (language detection is skipped)
-    
-    The parameter is always present in the response.
-    """
-
     metrics: TranscriptionMetrics
 
     if IS_PYDANTIC_V2:

sarvamai/types/speech_to_text_translate_language.py

@@ -3,30 +3,6 @@
 import typing
 
 SpeechToTextTranslateLanguage = typing.Union[
-    typing.Literal[
-        "hi-IN",
-        "bn-IN",
-        "kn-IN",
-        "ml-IN",
-        "mr-IN",
-        "od-IN",
-        "pa-IN",
-        "ta-IN",
-        "te-IN",
-        "gu-IN",
-        "en-IN",
-        "as-IN",
-        "ur-IN",
-        "ne-IN",
-        "kok-IN",
-        "ks-IN",
-        "sd-IN",
-        "sa-IN",
-        "sat-IN",
-        "mni-IN",
-        "brx-IN",
-        "mai-IN",
-        "doi-IN",
-    ],
+    typing.Literal["hi-IN", "bn-IN", "kn-IN", "ml-IN", "mr-IN", "od-IN", "pa-IN", "ta-IN", "te-IN", "gu-IN", "en-IN"],
     typing.Any,
 ]

sarvamai/types/speech_to_text_translate_response.py

@@ -4,22 +4,25 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .diarized_transcript import DiarizedTranscript
+from .speech_to_text_translate_language import SpeechToTextTranslateLanguage
 
 
 class SpeechToTextTranslateResponse(UniversalBaseModel):
-    request_id: str = pydantic.Field()
+    request_id: typing.Optional[str] = None
+    transcript: str = pydantic.Field()
     """
-    Unique identifier for the request
+    Transcript of the provided speech
     """
 
-    transcript: str = pydantic.Field()
+    language_code: typing.Optional[SpeechToTextTranslateLanguage] = pydantic.Field(default=None)
     """
-    English translation of the provided speech
+    This will return the BCP-47 code of language spoken in the input. If multiple languages are detected, this will return language code of most predominant spoken language. If no language is detected, this will be null
     """
 
-    language_code: str = pydantic.Field()
+    diarized_transcript: typing.Optional[DiarizedTranscript] = pydantic.Field(default=None)
     """
-    The BCP-47 code of the detected source language spoken in the input (e.g., hi-IN, kn-IN).
+    Diarized transcript of the provided speech
     """
 
     if IS_PYDANTIC_V2: