Create a trained model | Elasticsearch API documentation (v8)

Path parameters

model_idstring Required
The unique identifier of the trained model.

Query parameters

defer_definition_decompressionboolean
If set to true and a compressed_definition is provided, the request defers definition decompression and skips relevant validations.
wait_for_completionboolean
Whether to wait for all child operations (e.g. model download) to complete.

application/json

BodyRequired

compressed_definitionstring
The compressed (GZipped and Base64 encoded) inference definition of the model. If compressed_definition is specified, then definition cannot be specified.
definitionobject
Hide definition attributes Show definition attributes object
- preprocessorsarray[object]
  Collection of preprocessors
  Hide preprocessors attributes Show preprocessors attributes object
  frequency_encodingobject
  Hide frequency_encoding attributes Show frequency_encoding attributes object
  fieldstring Required
  feature_namestring Required
  frequency_mapobject Required
  Hide frequency_map attribute Show frequency_map attribute object
  *number Additional properties
  one_hot_encodingobject
  Hide one_hot_encoding attributes Show one_hot_encoding attributes object
  fieldstring Required
  hot_mapobject Required
  Hide hot_map attribute Show hot_map attribute object
  *string Additional properties
  target_mean_encodingobject
  Hide target_mean_encoding attributes Show target_mean_encoding attributes object
  fieldstring Required
  feature_namestring Required
  target_mapobject Required
  Hide target_map attribute Show target_map attribute object
  *number Additional properties
  default_valuenumber Required
- trained_modelobject Required
  Hide trained_model attributes Show trained_model attributes object
  treeobject
  Hide tree attributes Show tree attributes object
  classification_labelsarray[string]
  feature_namesarray[string] Required
  target_typestring
  tree_structurearray[object] Required
  Hide tree_structure attributes Show tree_structure attributes object
  decision_typestring
  default_leftboolean
  leaf_valuenumber
  left_childnumber
  node_indexnumber Required
  right_childnumber
  split_featurenumber
  split_gainnumber
  thresholdnumber
  tree_nodeobject
  Hide tree_node attributes Show tree_node attributes object
  decision_typestring
  default_leftboolean
  leaf_valuenumber
  left_childnumber
  node_indexnumber Required
  right_childnumber
  split_featurenumber
  split_gainnumber
  thresholdnumber
  ensembleobject
  Hide ensemble attributes Show ensemble attributes object
  aggregate_outputobject
  Hide aggregate_output attributes Show aggregate_output attributes object
  logistic_regressionobject
  Hide logistic_regression attribute Show logistic_regression attribute object
  weightsnumber Required
  weighted_sumobject
  Hide weighted_sum attribute Show weighted_sum attribute object
  weightsnumber Required
  weighted_modeobject
  Hide weighted_mode attribute Show weighted_mode attribute object
  weightsnumber Required
  exponentobject
  Hide exponent attribute Show exponent attribute object
  weightsnumber Required
  classification_labelsarray[string]
  feature_namesarray[string]
  target_typestring
  trained_modelsarray[object] Required
descriptionstring
A human-readable description of the inference trained model.
inference_configobject
Inference configuration provided when storing the model config
Hide inference_config attributes Show inference_config attributes object
- regressionobject
  Hide regression attributes Show regression attributes object
  results_fieldstring
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  num_top_feature_importance_valuesnumber
  Specifies the maximum number of feature importance values per document.
- classificationobject
  Hide classification attributes Show classification attributes object
  num_top_classesnumber
  Specifies the number of top class predictions to return. Defaults to 0.
  num_top_feature_importance_valuesnumber
  Specifies the maximum number of feature importance values per document.
  prediction_field_typestring
  Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  top_classes_results_fieldstring
  Specifies the field to which the top classes are written. Defaults to top_classes.
- text_classificationobject
  Hide text_classification attributes Show text_classification attributes object
  num_top_classesnumber
  Specifies the number of top class predictions to return. Defaults to 0.
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  classification_labelsarray[string]
  Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels
  vocabularyobject
  Hide vocabulary attribute Show vocabulary attribute object
  indexstring Required
- zero_shot_classificationobject
  Hide zero_shot_classification attributes Show zero_shot_classification attributes object
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  hypothesis_templatestring
  Hypothesis template used when tokenizing labels for prediction
  classification_labelsarray[string] Required
  The zero shot classification labels indicating entailment, neutral, and contradiction Must contain exactly and only entailment, neutral, and contradiction
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  multi_labelboolean
  Indicates if more than one true label exists.
  labelsarray[string]
  The labels to predict.
- fill_maskobject
  Hide fill_mask attributes Show fill_mask attributes object
  mask_tokenstring
  The string/token which will be removed from incoming documents and replaced with the inference prediction(s). In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests. However, if this field is present in a request, its value must match the predefined value for that model/tokenizer, otherwise the request will fail.
  num_top_classesnumber
  Specifies the number of top class predictions to return. Defaults to 0.
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  vocabularyobject Required
  Hide vocabulary attribute Show vocabulary attribute object
  indexstring Required
- learning_to_rankobject
  Hide learning_to_rank attributes Show learning_to_rank attributes object
  default_paramsobject
  Hide default_params attribute Show default_params attribute object
  *object Additional properties
  feature_extractorsarray[object]
  num_top_feature_importance_valuesnumber Required
- nerobject
  Hide ner attributes Show ner attributes object
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  classification_labelsarray[string]
  The token classification labels. Must be IOB formatted tags
  vocabularyobject
  Hide vocabulary attribute Show vocabulary attribute object
  indexstring Required
- pass_throughobject
  Hide pass_through attributes Show pass_through attributes object
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  vocabularyobject
  Hide vocabulary attribute Show vocabulary attribute object
  indexstring Required
- text_embeddingobject
  Hide text_embedding attributes Show text_embedding attributes object
  embedding_sizenumber
  The number of dimensions in the embedding output
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  vocabularyobject Required
  Hide vocabulary attribute Show vocabulary attribute object
  indexstring Required
- text_expansionobject
  Hide text_expansion attributes Show text_expansion attributes object
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  vocabularyobject Required
  Hide vocabulary attribute Show vocabulary attribute object
  indexstring Required
- question_answeringobject
  Hide question_answering attributes Show question_answering attributes object
  num_top_classesnumber
  Specifies the number of top class predictions to return. Defaults to 0.
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  max_answer_lengthnumber
  The maximum answer length to consider
inputobject
Hide input attribute Show input attribute object
- field_namesstring | array[string] Required
metadataobject
An object map that contains metadata about the model.
model_typestring
Values are tree_ensemble, lang_ident, or pytorch.
model_size_bytesnumber
The estimated memory usage in bytes to keep the trained model in memory. This property is supported only if defer_definition_decompression is true or the model definition is not supplied.
platform_architecturestring
The platform architecture (if applicable) of the trained mode. If the model only works on one platform, because it is heavily optimized for a particular processor architecture and OS combination, then this field specifies which. The format of the string must match the platform identifiers used by Elasticsearch, so one of, linux-x86_64, linux-aarch64, darwin-x86_64, darwin-aarch64, or windows-x86_64. For portable models (those that work independent of processor architecture or OS features), leave this field unset.
tagsarray[string]
An array of tags to organize the model.
prefix_stringsobject
Hide prefix_strings attributes Show prefix_strings attributes object
- ingeststring
  String prepended to input at ingest
- searchstring
  String prepended to input at search

Responses

200 application/json
Hide response attributes Show response attributes object
- model_idstring Required
- model_typestring
  Values are tree_ensemble, lang_ident, or pytorch.
- tagsarray[string] Required
  A comma delimited string of tags. A trained model can have many tags, or none.
- versionstring
- compressed_definitionstring
- created_bystring
  Information on the creator of the trained model.
- create_timestring | number
  A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
  One of:
  DateTimestring UnitMillisnumber
  Time unit for milliseconds
- default_field_mapobject
  Any field map described in the inference configuration takes precedence.
  Hide default_field_map attribute Show default_field_map attribute object
  *string Additional properties
- descriptionstring
  The free-text description of the trained model.
- estimated_heap_memory_usage_bytesnumber
  The estimated heap usage in bytes to keep the trained model in memory.
- estimated_operationsnumber
  The estimated number of operations to use the trained model.
- fully_definedboolean
  True if the full model definition is present.
- inference_configobject
  Inference configuration provided when storing the model config
  Hide inference_config attributes Show inference_config attributes object
  regressionobject
  Hide regression attributes Show regression attributes object
  results_fieldstring
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  num_top_feature_importance_valuesnumber
  Specifies the maximum number of feature importance values per document.
  classificationobject
  Hide classification attributes Show classification attributes object
  num_top_classesnumber
  Specifies the number of top class predictions to return. Defaults to 0.
  num_top_feature_importance_valuesnumber
  Specifies the maximum number of feature importance values per document.
  prediction_field_typestring
  Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  top_classes_results_fieldstring
  Specifies the field to which the top classes are written. Defaults to top_classes.
  text_classificationobject
  Hide text_classification attributes Show text_classification attributes object
  num_top_classesnumber
  Specifies the number of top class predictions to return. Defaults to 0.
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  classification_labelsarray[string]
  Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels
  vocabularyobject
  Hide vocabulary attribute Show vocabulary attribute object
  indexstring Required
  zero_shot_classificationobject
  Hide zero_shot_classification attributes Show zero_shot_classification attributes object
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  hypothesis_templatestring
  Hypothesis template used when tokenizing labels for prediction
  classification_labelsarray[string] Required
  The zero shot classification labels indicating entailment, neutral, and contradiction Must contain exactly and only entailment, neutral, and contradiction
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  multi_labelboolean
  Indicates if more than one true label exists.
  labelsarray[string]
  The labels to predict.
  fill_maskobject
  Hide fill_mask attributes Show fill_mask attributes object
  mask_tokenstring
  The string/token which will be removed from incoming documents and replaced with the inference prediction(s). In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests. However, if this field is present in a request, its value must match the predefined value for that model/tokenizer, otherwise the request will fail.
  num_top_classesnumber
  Specifies the number of top class predictions to return. Defaults to 0.
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  vocabularyobject Required
  Hide vocabulary attribute Show vocabulary attribute object
  indexstring Required
  learning_to_rankobject
  Hide learning_to_rank attributes Show learning_to_rank attributes object
  default_paramsobject
  Hide default_params attribute Show default_params attribute object
  *object Additional properties
  feature_extractorsarray[object]
  num_top_feature_importance_valuesnumber Required
  nerobject
  Hide ner attributes Show ner attributes object
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  classification_labelsarray[string]
  The token classification labels. Must be IOB formatted tags
  vocabularyobject
  Hide vocabulary attribute Show vocabulary attribute object
  indexstring Required
  pass_throughobject
  Hide pass_through attributes Show pass_through attributes object
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  vocabularyobject
  Hide vocabulary attribute Show vocabulary attribute object
  indexstring Required
  text_embeddingobject
  Hide text_embedding attributes Show text_embedding attributes object
  embedding_sizenumber
  The number of dimensions in the embedding output
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  vocabularyobject Required
  Hide vocabulary attribute Show vocabulary attribute object
  indexstring Required
  text_expansionobject
  Hide text_expansion attributes Show text_expansion attributes object
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  vocabularyobject Required
  Hide vocabulary attribute Show vocabulary attribute object
  indexstring Required
  question_answeringobject
  Hide question_answering attributes Show question_answering attributes object
  num_top_classesnumber
  Specifies the number of top class predictions to return. Defaults to 0.
  tokenizationobject
  Tokenization options stored in inference configuration
  Hide tokenization attributes Show tokenization attributes object
  bertobject
  Hide bert attributes Show bert attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  bert_jaobject
  Hide bert_ja attributes Show bert_ja attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  mpnetobject
  Hide mpnet attributes Show mpnet attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  robertaobject
  Hide roberta attributes Show roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  add_prefix_spaceboolean
  Should the tokenizer prefix input with a space character
  xlm_robertaobject
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  do_lower_caseboolean
  Should the tokenizer lower case the text
  max_sequence_lengthnumber
  Maximum input sequence length for the model
  spannumber
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  truncatestring
  Values are first, second, or none.
  with_special_tokensboolean
  Is tokenization completed with special tokens
  results_fieldstring
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  max_answer_lengthnumber
  The maximum answer length to consider
- inputobject Required
  Hide input attribute Show input attribute object
  field_namesarray[string] Required
  An array of input field names for the model.
- license_levelstring
  The license level of the trained model.
- metadataobject
  Hide metadata attributes Show metadata attributes object
- model_size_bytesnumber | string
  One of:
  ByteSizenumber ByteSizestring
- model_packageobject
  Hide model_package attributes Show model_package attributes object
  create_timenumber
  Time unit for milliseconds
  descriptionstring
  inference_configobject
  Hide inference_config attribute Show inference_config attribute object
  *object Additional properties
  metadataobject
  Hide metadata attribute Show metadata attribute object
  minimum_versionstring
  model_repositorystring
  model_typestring
  packaged_model_idstring Required
  platform_architecturestring
  prefix_stringsobject
  Hide prefix_strings attributes Show prefix_strings attributes object
  ingeststring
  String prepended to input at ingest
  searchstring
  String prepended to input at search
  sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  sha256string
  tagsarray[string]
  vocabulary_filestring
- locationobject
  Hide location attribute Show location attribute object
  indexobject Required
  Hide index attribute Show index attribute object
  namestring Required
- platform_architecturestring
- prefix_stringsobject
  Hide prefix_strings attributes Show prefix_strings attributes object
  ingeststring
  String prepended to input at ingest
  searchstring
  String prepended to input at search

PUT /_ml/trained_models/{model_id}

curl \
 --request PUT 'http://api.example.com/_ml/trained_models/{model_id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"compressed_definition":"string","definition":{"preprocessors":[{"frequency_encoding":{"field":"string","feature_name":"string","frequency_map":{"additionalProperty1":42.0,"additionalProperty2":42.0}},"one_hot_encoding":{"field":"string","hot_map":{"additionalProperty1":"string","additionalProperty2":"string"}},"target_mean_encoding":{"field":"string","feature_name":"string","target_map":{"additionalProperty1":42.0,"additionalProperty2":42.0},"default_value":42.0}}],"trained_model":{"tree":{"classification_labels":["string"],"feature_names":["string"],"target_type":"string","tree_structure":[{"decision_type":"string","default_left":true,"leaf_value":42.0,"left_child":42.0,"node_index":42.0,"right_child":42.0,"split_feature":42.0,"split_gain":42.0,"threshold":42.0}]},"tree_node":{"decision_type":"string","default_left":true,"leaf_value":42.0,"left_child":42.0,"node_index":42.0,"right_child":42.0,"split_feature":42.0,"split_gain":42.0,"threshold":42.0},"ensemble":{"aggregate_output":{"logistic_regression":{"weights":42.0},"weighted_sum":{"weights":42.0},"weighted_mode":{"weights":42.0},"exponent":{"weights":42.0}},"classification_labels":["string"],"feature_names":["string"],"target_type":"string","trained_models":[{}]}}},"description":"string","inference_config":{"regression":{"results_field":"string","num_top_feature_importance_values":42.0},"classification":{"num_top_classes":42.0,"num_top_feature_importance_values":42.0,"prediction_field_type":"string","results_field":"string","top_classes_results_field":"string"},"text_classification":{"num_top_classes":42.0,"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"results_field":"string","classification_labels":["string"],"vocabulary":{"index":"string"}},"zero_shot_classification":{"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"hypothesis_template":"string","classification_labels":["string"],"results_field":"string","multi_label":true,"labels":["string"]},"fill_mask":{"mask_token":"string","num_top_classes":42.0,"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"results_field":"string","vocabulary":{"index":"string"}},"learning_to_rank":{"default_params":{"additionalProperty1":{},"additionalProperty2":{}},"feature_extractors":[{}],"num_top_feature_importance_values":42.0},"ner":{"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"results_field":"string","classification_labels":["string"],"vocabulary":{"index":"string"}},"pass_through":{"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"results_field":"string","vocabulary":{"index":"string"}},"text_embedding":{"embedding_size":42.0,"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"results_field":"string","vocabulary":{"index":"string"}},"text_expansion":{"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"results_field":"string","vocabulary":{"index":"string"}},"question_answering":{"num_top_classes":42.0,"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"results_field":"string","max_answer_length":42.0}},"input":{"field_names":"string"},"metadata":{},"model_type":"tree_ensemble","model_size_bytes":42.0,"platform_architecture":"string","tags":["string"],"prefix_strings":{"ingest":"string","search":"string"}}'

Path parameters

Query parameters

BodyRequired

Responses

create_timestring | number

model_size_bytesnumber | string

sizenumber | string