Source code for openapi_client.models.guard_rail_chat_request

# coding: utf-8

"""
    Amorphic Data Platform

    Amorphic Data Platform - API Definition documentation

    The version of the OpenAPI document: 0.3.0
    Generated by OpenAPI Generator (https://openapi-generator.tech)

    Do not edit the class manually.
"""  # noqa: E501


from __future__ import annotations
import pprint
import re  # noqa: F401
import json

from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from openapi_client.models.guard_rail_chat_request_model_parameters import GuardRailChatRequestModelParameters
from typing import Optional, Set
from typing_extensions import Self


[docs]
class GuardRailChatRequest(BaseModel):
    """
    Request body for guard rail chat endpoint.
    """ # noqa: E501
    model_id: Optional[StrictStr] = Field(default=None, description="The ID of the AI model to use for response generation.", alias="ModelId")
    model_parameters: Optional[GuardRailChatRequestModelParameters] = Field(default=None, alias="ModelParameters")
    input_text: StrictStr = Field(description="The input text to be processed by the model.", alias="InputText")
    invoke_model: StrictBool = Field(description="Whether to invoke the model (true) or apply guard rail validation only (false).", alias="InvokeModel")
    __properties: ClassVar[List[str]] = ["ModelId", "ModelParameters", "InputText", "InvokeModel"]

    model_config = ConfigDict(
        populate_by_name=True,
        validate_assignment=True,
        protected_namespaces=(),
    )



[docs]
    def to_str(self) -> str:
        """Returns the string representation of the model using alias"""
        return pprint.pformat(self.model_dump(by_alias=True))



[docs]
    def to_json(self) -> str:
        """Returns the JSON representation of the model using alias"""
        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
        return json.dumps(self.to_dict())



[docs]
    @classmethod
    def from_json(cls, json_str: str) -> Optional[Self]:
        """Create an instance of GuardRailChatRequest from a JSON string"""
        return cls.from_dict(json.loads(json_str))



[docs]
    def to_dict(self) -> Dict[str, Any]:
        """Return the dictionary representation of the model using alias.

        This has the following differences from calling pydantic's
        `self.model_dump(by_alias=True)`:

        * `None` is only added to the output dict for nullable fields that
          were set at model initialization. Other fields with value `None`
          are ignored.
        """
        excluded_fields: Set[str] = set([
        ])

        _dict = self.model_dump(
            by_alias=True,
            exclude=excluded_fields,
            exclude_none=True,
        )
        # override the default output from pydantic by calling `to_dict()` of model_parameters
        if self.model_parameters:
            _dict['ModelParameters'] = self.model_parameters.to_dict()
        return _dict



[docs]
    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of GuardRailChatRequest from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        _obj = cls.model_validate({
            "ModelId": obj.get("ModelId"),
            "ModelParameters": GuardRailChatRequestModelParameters.from_dict(obj["ModelParameters"]) if obj.get("ModelParameters") is not None else None,
            "InputText": obj.get("InputText"),
            "InvokeModel": obj.get("InvokeModel")
        })
        return _obj