Guardrail

pydantic model openapi_client.models.guardrail.Guardrail

A guard rail reference. Id and Version are required by knowledge-base create/update when GuardRails is supplied; Name is optional and typically filled from stored metadata.

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

Unique identifier of the guard rail.

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

Guard rail version to apply (for example DRAFT or a numeric version).

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

Guard rail name. Optional on request; returned from stored metadata.

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

Return type:

Optional[Self]