get_model_template¶
Operation¶
get_model_template
¶
get_model_template(request: GetModelTemplateInput | GetModelTemplateInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetModelTemplateInputDict]) -> GetModelTemplateOutput
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetModelTemplateInput | GetModelTemplateInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetModelTemplateInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetModelTemplateOutput
|
An instance of |
get_model_template
async
¶
get_model_template(request: GetModelTemplateInput | GetModelTemplateInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetModelTemplateInputDict]) -> GetModelTemplateOutput
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetModelTemplateInput | GetModelTemplateInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetModelTemplateInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetModelTemplateOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
GetModelTemplateOutput
dataclass
¶
Bases: _SerdeShape
Represents a mapping template used to transform a payload.