DeniedTopic

pydantic model openapi_client.models.denied_topic.DeniedTopic

A topic that is denied by the guard rail.

Fields:
field topic_name: StrictStr [Required] (alias 'TopicName')

The name of the denied topic.

Constraints:

  • strict = True

field topic_definition: StrictStr [Required] (alias 'TopicDefinition')

The definition of the denied topic.

Constraints:

  • strict = True

field example_phrases: Optional[List[StrictStr]] = None (alias 'ExamplePhrases')

Example phrases that would trigger this topic.

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

Return type:

Optional[Self]