GuardRailChatResponse

pydantic model openapi_client.models.guard_rail_chat_response.GuardRailChatResponse

Response from guard rail chat endpoint. Apply-only path returns boolean intervention and string ModelResponse; invoke path may return “N/A” for intervention fields and a non-string ModelResponse.

Fields:
field guard_rail_intervention: GuardRailChatResponseGuardRailIntervention [Required] (alias 'GuardRailIntervention')
field guard_rail_intervention_reason: StrictStr [Required] (alias 'GuardRailInterventionReason')

Reason for guard rail intervention if intervention occurred; empty string on apply path with no intervention, or “N/A” on invoke path when unavailable.

Constraints:
  • strict = True

field model_response: GuardRailChatResponseModelResponse [Required] (alias 'ModelResponse')
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 GuardRailChatResponse 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 GuardRailChatResponse from a dict

Return type:

Optional[Self]