H2h2o

sample_request_model_sample_request_get

Builds a sample scoring request that would pass all validations.

get/model/sample_request

Request

Response

Successful Response

fieldsstring[] required

An array holding the names of fields in the order of appearance in the rows property. The length of fields has to match length of each row in rows. No duplicates are allowed.

noFieldNamesInOutputboolean

If set to true. The scorer will not fill response column names in the fields field. This is can be useful to maintain compatibility with older scorer versions or to save bandwidth.

requestPredictionIntervalsboolean

If set to true, the scorer will try to fill field predictionIntervals in response if it is supported.

includeFieldsInOutputstring[]

An array holding the list of field names to be copied from the input request row to the corresponding scoring output. It is an error to specify a field name not present in the fields property, except when it is equal to the idField property. In the latter case, the row id would be generated and returned in the response. Note that the order of items in includeFieldsInOutput is ignored and the specified fields are returned in the order of appearance in the input request row.

idFieldstring

Name of the field that holds a row id, e.g., a value that uniquely identifies each row of the request. The caller may specify a name of the field that is not present in fields. In which case, the scorer is allowed to generate a UUID to identify each row (e.g., for logging and monitoring purposes). To retrieve such a generated id as a part of the response, simply name it in the includeFieldsInOutput.

requestShapleyValueType'ORIGINAL' | 'TRANSFORMED' | 'NONE'

The string to say what type of Shap values are needed. ORIGINAL implies Shap values of original features are requested, TRANSFORMED implies that Shap values of transformed features are requested.

Changes

No recorded changes to this operation across all 1 revision of this API.