GuardRailDetail

class openapi_client.models.guard_rail_detail.GuardRailDetail(**data)

Bases: BaseModel

Detailed information about a guard rail.

guard_rail_id: Optional[StrictStr]

guard_rail_version: Optional[StrictStr]

guard_rail_name: Optional[StrictStr]

description: Optional[StrictStr]

creation_time: Optional[datetime]

created_by: Optional[StrictStr]

last_modified_time: Optional[datetime]

last_modified_by: Optional[StrictStr]

tier: Optional[StrictStr]

is_cross_region_enabled: Optional[StrictBool]

scope: Optional[StrictStr]

owner: Optional[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]]

access_type: Optional[StrictStr]

is_default: Optional[StrictBool]

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 GuardRailDetail 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 GuardRailDetail from a dict

Return type:

Optional[Self]

model_fields: ClassVar[dict[str, FieldInfo]] = {'access_type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='AccessType', alias_priority=2, description='The access type of the guard rail.'), '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.'), 'created_by': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='CreatedBy', alias_priority=2, description='The user who created the guard rail.'), 'creation_time': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='CreationTime', alias_priority=2, description='The timestamp when the guard rail was created.'), '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=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Description', alias_priority=2, description='The description of the guard rail.'), '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_id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='GuardRailId', alias_priority=2, description='The unique identifier of the guard rail.'), 'guard_rail_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='GuardRailName', alias_priority=2, description='The name of the guard rail.'), 'guard_rail_version': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='GuardRailVersion', alias_priority=2, description='The version of the guard rail (e.g., DRAFT, PUBLISHED).'), 'is_cross_region_enabled': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsCrossRegionEnabled', alias_priority=2, description='Whether cross-region configuration is enabled for the guard rail.'), 'is_default': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsDefault', alias_priority=2, description='Whether the guard rail is the default guard rail.'), 'last_modified_by': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='LastModifiedBy', alias_priority=2, description='The user who last modified the guard rail.'), 'last_modified_time': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='LastModifiedTime', alias_priority=2, description='The timestamp when the guard rail was last modified.'), 'owner': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Owner', alias_priority=2, description='The owner of the guard rail (user ID for private, system user for global scope).'), '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).'), '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).')}

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