# 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, StrictFloat, StrictInt, StrictStr, field_validator
from typing import Any, ClassVar, Dict, List, Optional, Union
from openapi_client.models.custom_word_filters import CustomWordFilters
from openapi_client.models.denied_topic import DeniedTopic
from openapi_client.models.guard_rail_filter_config import GuardRailFilterConfig
from openapi_client.models.sensitive_information_filters import SensitiveInformationFilters
from typing import Optional, Set
from typing_extensions import Self
[docs]
class GuardRailCreateRequest(BaseModel):
"""
Request body for creating a new guard rail.
""" # noqa: E501
guard_rail_name: StrictStr = Field(description="The name of the guard rail.", alias="GuardRailName")
description: StrictStr = Field(description="The description of the guard rail.", alias="Description")
blocked_message: Optional[StrictStr] = Field(default=None, description="The message to display when content is blocked.", alias="BlockedMessage")
filters_config: Optional[List[GuardRailFilterConfig]] = Field(default=None, description="Configuration for content filters.", alias="FiltersConfig")
denied_topics: Optional[List[DeniedTopic]] = Field(default=None, description="List of topics that are denied.", alias="DeniedTopics")
sensitive_information_filters: Optional[SensitiveInformationFilters] = Field(default=None, alias="SensitiveInformationFilters")
custom_word_filters: Optional[CustomWordFilters] = Field(default=None, alias="CustomWordFilters")
enable_contextual_grounding_check: Optional[StrictBool] = Field(default=None, description="Whether to enable contextual grounding check.", alias="EnableContextualGroundingCheck")
grounding_threshold: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The threshold for grounding check.", alias="GroundingThreshold")
relevance_threshold: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The threshold for relevance check.", alias="RelevanceThreshold")
tier: Optional[StrictStr] = Field(default=None, description="The tier of the guard rail (CLASSIC or STANDARD). Defaults to CLASSIC if not provided.", alias="Tier")
is_cross_region_enabled: Optional[StrictBool] = Field(default=None, description="Whether to enable cross-region configuration for the guard rail. If true, adds guardrailProfileIdentifier. STANDARD tier requires this to be true.", alias="IsCrossRegionEnabled")
scope: Optional[StrictStr] = Field(default=None, description="The scope of the guard rail (global or private). Defaults to private if not provided. Cannot be changed after creation.", alias="Scope")
__properties: ClassVar[List[str]] = ["GuardRailName", "Description", "BlockedMessage", "FiltersConfig", "DeniedTopics", "SensitiveInformationFilters", "CustomWordFilters", "EnableContextualGroundingCheck", "GroundingThreshold", "RelevanceThreshold", "Tier", "IsCrossRegionEnabled", "Scope"]
[docs]
@field_validator('tier')
def tier_validate_enum(cls, value):
"""Validates the enum"""
if value is None:
return value
if value not in set(['CLASSIC', 'STANDARD']):
raise ValueError("must be one of enum values ('CLASSIC', 'STANDARD')")
return value
[docs]
@field_validator('scope')
def scope_validate_enum(cls, value):
"""Validates the enum"""
if value is None:
return value
if value not in set(['global', 'private']):
raise ValueError("must be one of enum values ('global', 'private')")
return value
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 GuardRailCreateRequest 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 each item in filters_config (list)
_items = []
if self.filters_config:
for _item_filters_config in self.filters_config:
if _item_filters_config:
_items.append(_item_filters_config.to_dict())
_dict['FiltersConfig'] = _items
# override the default output from pydantic by calling `to_dict()` of each item in denied_topics (list)
_items = []
if self.denied_topics:
for _item_denied_topics in self.denied_topics:
if _item_denied_topics:
_items.append(_item_denied_topics.to_dict())
_dict['DeniedTopics'] = _items
# override the default output from pydantic by calling `to_dict()` of sensitive_information_filters
if self.sensitive_information_filters:
_dict['SensitiveInformationFilters'] = self.sensitive_information_filters.to_dict()
# override the default output from pydantic by calling `to_dict()` of custom_word_filters
if self.custom_word_filters:
_dict['CustomWordFilters'] = self.custom_word_filters.to_dict()
return _dict
[docs]
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"""Create an instance of GuardRailCreateRequest from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return cls.model_validate(obj)
_obj = cls.model_validate({
"GuardRailName": obj.get("GuardRailName"),
"Description": obj.get("Description"),
"BlockedMessage": obj.get("BlockedMessage"),
"FiltersConfig": [GuardRailFilterConfig.from_dict(_item) for _item in obj["FiltersConfig"]] if obj.get("FiltersConfig") is not None else None,
"DeniedTopics": [DeniedTopic.from_dict(_item) for _item in obj["DeniedTopics"]] if obj.get("DeniedTopics") is not None else None,
"SensitiveInformationFilters": SensitiveInformationFilters.from_dict(obj["SensitiveInformationFilters"]) if obj.get("SensitiveInformationFilters") is not None else None,
"CustomWordFilters": CustomWordFilters.from_dict(obj["CustomWordFilters"]) if obj.get("CustomWordFilters") is not None else None,
"EnableContextualGroundingCheck": obj.get("EnableContextualGroundingCheck"),
"GroundingThreshold": obj.get("GroundingThreshold"),
"RelevanceThreshold": obj.get("RelevanceThreshold"),
"Tier": obj.get("Tier"),
"IsCrossRegionEnabled": obj.get("IsCrossRegionEnabled"),
"Scope": obj.get("Scope")
})
return _obj