GuardRailCreateRequest

class openapi_client.models.guard_rail_create_request.GuardRailCreateRequest(**data)

Bases: BaseModel

Request body for creating a new guard rail.

guard_rail_name: StrictStr

description: StrictStr

blocked_message: Optional[StrictStr]

filters_config: Optional[List[GuardRailFilterConfig]]

denied_topics: Optional[List[DeniedTopic]]

sensitive_information_filters: Optional[SensitiveInformationFilters]

custom_word_filters: Optional[CustomWordFilters]

enable_contextual_grounding_check: Optional[StrictBool]

grounding_threshold: Optional[Union[StrictFloat, StrictInt]]

relevance_threshold: Optional[Union[StrictFloat, StrictInt]]

tier: Optional[StrictStr]

is_cross_region_enabled: Optional[StrictBool]

scope: Optional[StrictStr]

classmethod tier_validate_enum(value)

Validates the enum

classmethod scope_validate_enum(value)

Validates the enum

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of GuardRailCreateRequest from a JSON string

Return type:

Optional[Self]

to_dict()

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.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of GuardRailCreateRequest from a dict

Return type:

Optional[Self]

model_fields: ClassVar[dict[str, FieldInfo]] = {'blocked_message': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='BlockedMessage', alias_priority=2, description='The message to display when content is blocked.'), 'custom_word_filters': FieldInfo(annotation=Union[CustomWordFilters, NoneType], required=False, alias='CustomWordFilters', alias_priority=2), 'denied_topics': FieldInfo(annotation=Union[List[DeniedTopic], NoneType], required=False, alias='DeniedTopics', alias_priority=2, description='List of topics that are denied.'), 'description': FieldInfo(annotation=str, required=True, alias='Description', alias_priority=2, description='The description of the guard rail.', metadata=[Strict(strict=True)]), 'enable_contextual_grounding_check': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='EnableContextualGroundingCheck', alias_priority=2, description='Whether to enable contextual grounding check.'), 'filters_config': FieldInfo(annotation=Union[List[GuardRailFilterConfig], NoneType], required=False, alias='FiltersConfig', alias_priority=2, description='Configuration for content filters.'), 'grounding_threshold': FieldInfo(annotation=Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType], required=False, alias='GroundingThreshold', alias_priority=2, description='The threshold for grounding check.'), 'guard_rail_name': FieldInfo(annotation=str, required=True, alias='GuardRailName', alias_priority=2, description='The name of the guard rail.', metadata=[Strict(strict=True)]), 'is_cross_region_enabled': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsCrossRegionEnabled', alias_priority=2, description='Whether to enable cross-region configuration for the guard rail. If true, adds guardrailProfileIdentifier. STANDARD tier requires this to be true.'), 'relevance_threshold': FieldInfo(annotation=Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType], required=False, alias='RelevanceThreshold', alias_priority=2, description='The threshold for relevance check.'), 'scope': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Scope', alias_priority=2, description='The scope of the guard rail (global or private). Defaults to private if not provided. Cannot be changed after creation.'), 'sensitive_information_filters': FieldInfo(annotation=Union[SensitiveInformationFilters, NoneType], required=False, alias='SensitiveInformationFilters', alias_priority=2), 'tier': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Tier', alias_priority=2, description='The tier of the guard rail (CLASSIC or STANDARD). Defaults to CLASSIC if not provided.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(__context)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self (BaseModel) – The BaseModel instance.

• __context (Any) – The context.

Return type:

None