map_request_body: Identify data types for each column in an input data...
In tidymodels/vetiver: Version, Share, Deploy, and Monitor Models
View source: R/open-api-spec.R
map_request_body R Documentation
Identify data types for each column in an input data prototype
Description
The OpenAPI specification of a Plumber API created via plumber::pr() can
be modified via plumber::pr_set_api_spec(), and this helper function will
identify data types of predictors and create a list to use in this
specification. These are not R data types, but instead basic JSON data
types. For example, factors in R will be documented as strings in the
OpenAPI specification.
Usage
map_request_body(prototype)
Arguments
prototype
An input data prototype from a model
Details
This is a developer-facing function, useful for supporting new model types.
It is called by api_spec().
Value
A list to be used within plumber::pr_set_api_spec()
Examples
map_request_body(vctrs::vec_slice(chickwts, 0))
tidymodels/vetiver documentation built on Oct. 15, 2024, 4:16 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/open-api-spec.R
| map_request_body | R Documentation |
Identify data types for each column in an input data prototype
Description
The OpenAPI specification of a Plumber API created via plumber::pr() can
be modified via plumber::pr_set_api_spec(), and this helper function will
identify data types of predictors and create a list to use in this
specification. These are not R data types, but instead basic JSON data
types. For example, factors in R will be documented as strings in the
OpenAPI specification.
Usage
map_request_body(prototype)
Arguments
prototype |
An input data prototype from a model |
Details
This is a developer-facing function, useful for supporting new model types.
It is called by api_spec().
Value
A list to be used within plumber::pr_set_api_spec()
Examples
map_request_body(vctrs::vec_slice(chickwts, 0))
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.