#   Copyright (C) 2023-2024 Credit Mutuel Arkea
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#
"""Model for creating BaseGuardrailSetting."""

from typing import Optional

from pydantic import BaseModel, Field

from gen_ai_orchestrator.models.guardrail.guardrail_provider import (
    GuardrailProvider,
)


class BaseGuardrailSetting(BaseModel):
    """A base class for Guardrail Model Setting."""

    provider: GuardrailProvider = Field(
        description='The guardrail provider.',
        examples=[GuardrailProvider.BLOOMZ],
    )
    max_score: Optional[float] = Field(
        description='The maximum acceptable toxicity score, applied to each output labels (evaluated scores) of the '
                    'guardrail. If at least one of those score (evaluated label) is higher the generated answer will '
                    'be rejected.', default=0.3
    )
