Source code for nv_ingest_api.internal.schemas.extract.extract_audio_schema

# SPDX-FileCopyrightText: Copyright (c) 2024, NVIDIA CORPORATION & AFFILIATES.
# All rights reserved.
# SPDX-License-Identifier: Apache-2.0


import logging
from typing import Optional
from typing import Tuple

from pydantic import BaseModel, Field
from pydantic import root_validator

logger = logging.getLogger(__name__)




class AudioConfigSchema(BaseModel):
    """
    Configuration schema for audio extraction endpoints and options.

    Parameters
    ----------
    auth_token : Optional[str], default=None
        Authentication token required for secure services.

    audio_endpoints : Tuple[str, str]
        A tuple containing the gRPC and HTTP services for the audio_retriever endpoint.
        Either the gRPC or HTTP service can be empty, but not both.

    Methods
    -------
    validate_endpoints(values)
        Validates that at least one of the gRPC or HTTP services is provided for each endpoint.

    Raises
    ------
    ValueError
        If both gRPC and HTTP services are empty for any endpoint.

    Config
    ------
    extra : str
        Pydantic config option to forbid extra fields.
    """

    auth_token: Optional[str] = Field(default=None, repr=False)
    audio_endpoints: Tuple[Optional[str], Optional[str]] = (None, None)
    audio_infer_protocol: Optional[str] = None
    function_id: Optional[str] = None
    use_ssl: Optional[bool] = None
    ssl_cert: Optional[str] = Field(default=None, repr=False)
    segment_audio: Optional[bool] = None



    @root_validator(pre=True)
    def validate_endpoints(cls, values):
        """
        Validates the gRPC and HTTP services for all endpoints.

        Parameters
        ----------
        values : dict
            Dictionary containing the values of the attributes for the class.

        Returns
        -------
        dict
            The validated dictionary of values.

        Raises
        ------
        ValueError
            If both gRPC and HTTP services are empty for any endpoint.
        """

        def clean_service(service):
            """Set service to None if it's an empty string or contains only spaces or quotes."""
            if service is None or not service.strip() or service.strip(" \"'") == "":
                return None
            return service

        endpoint_name = "audio_endpoints"
        grpc_service, http_service = values.get(endpoint_name)
        grpc_service = clean_service(grpc_service)
        http_service = clean_service(http_service)

        if not grpc_service and not http_service:
            raise ValueError(f"Both gRPC and HTTP services cannot be empty for {endpoint_name}.")

        values[endpoint_name] = (grpc_service, http_service)

        protocol_name = "audio_infer_protocol"
        protocol_value = values.get(protocol_name)

        if not protocol_value:
            protocol_value = "http" if http_service else "grpc" if grpc_service else ""

        protocol_value = protocol_value.lower()
        values[protocol_name] = protocol_value

        return values




    class Config:
        extra = "forbid"






class AudioExtractorSchema(BaseModel):
    """
    Configuration schema for the PDF extractor settings.

    Parameters
    ----------
    max_queue_size : int, default=1
        The maximum number of items allowed in the processing queue.

    n_workers : int, default=16
        The number of worker threads to use for processing.

    raise_on_failure : bool, default=False
        A flag indicating whether to raise an exception on processing failure.

    audio_extraction_config: Optional[AudioConfigSchema], default=None
        Configuration schema for the audio extraction stage.
    """

    max_queue_size: int = 1
    n_workers: int = 16
    raise_on_failure: bool = False

    audio_extraction_config: Optional[AudioConfigSchema] = None



    class Config:
        extra = "forbid"