AiProjectGuardRail

pydantic model openapi_client.models.ai_project_guard_rail.AiProjectGuardRail

Guard rail applied to the project’s conversations. Sent as a plain Id string on create and update, but always returned as this object.

Fields:
field id: Optional[StrictStr] = None (alias 'Id')

Guard rail identifier.

field name: Optional[StrictStr] = None (alias 'Name')

Guard rail name.

field version: Optional[StrictStr] = None (alias 'Version')

Guard rail version; DRAFT when supplied by Id alone.

field is_default: Optional[StrictBool] = None (alias 'IsDefault')

Whether this is the default guard rail for the chats component.

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

Return type:

Optional[Self]