Skip to content

JsonSchemaDefinition

Source code in docs_src/capo_bedrock_runtime/types/json_schema_definition.py 
 8
 9
10
11
12
13
14
class JsonSchemaDefinition(TypedDict, closed=True):
    schema: "str"
    """<p> The JSON schema to constrain the model's output. For more information, see <a href="https://json-schema.org/understanding-json-schema/reference">JSON Schema Reference</a>. </p>"""
    name: NotRequired["str"]
    """<p> The name of the JSON schema. </p>"""
    description: NotRequired["str"]
    """<p> A description of the JSON schema. </p>"""

description instance-attribute 

description: NotRequired[str]

A description of the JSON schema.

name instance-attribute 

name: NotRequired[str]

The name of the JSON schema.

schema instance-attribute 

schema: str

The JSON schema to constrain the model's output. For more information, see JSON Schema Reference.