For the complete documentation index, see llms.txt. Markdown versions of all pages are available by appending .md to any URL (e.g. /get-started.md).

Python class

JsonSchemaField

JsonSchemaField

class max.pipelines.request.JsonSchemaField(*, type='json_schema', json_schema, name=None, description=None, strict=None)

source

Bases: BaseModel

JSON schema response format.

Parameters:

• type (Literal['json_schema'])
• json_schema (dict[str, Any])
• name (str | None)
• description (str | None)
• strict (bool | None)

description

description: str | None

source

json_schema

json_schema: dict[str, Any]

source

model_config

model_config: ClassVar[ConfigDict] = {'frozen': True}

source

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name

name: str | None

source

strict

strict: bool | None

source

type

type: Literal['json_schema']

source