GuardRailChatRequest¶
- pydantic model openapi_client.models.guard_rail_chat_request.GuardRailChatRequest¶
Request body for guard rail chat endpoint.
- Fields:
- field model_id: Optional[StrictStr] = None (alias 'ModelId')¶
Optional Bedrock model ID. When omitted, the chats component default model is used.
- field guard_rail_version: Optional[StrictStr] = None (alias 'GuardRailVersion')¶
Optional guard rail version for apply_guardrail. Defaults to the guard rail’s stored version (or DRAFT).
- field input_text: StrictStr [Required] (alias 'InputText')¶
The input text to be processed by the model.
- Constraints:
strict = True
- field invoke_model: Optional[StrictBool] = None (alias 'InvokeModel')¶
When true, invoke the model with the guard rail attached. When false or omitted, only apply_guardrail validation runs (default false).
- 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 GuardRailChatRequest 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 GuardRailChatRequest from a dict
- Return type:
Optional[Self]