Method: Elasticsearch::API::MachineLearning::Actions#infer_trained_model

Defined in:
lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb

#infer_trained_model(arguments = {}) ⇒ Object

Evaluate a trained model.

*Deprecation notice*: /_ml/trained_models/model_id/deployment/_infer is deprecated. Use /_ml/trained_models/model_id/_infer instead Deprecated since version 8.3.0

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :model_id (String) —

    The unique identifier of the trained model. (Required)

  • :timeout (Time) —

    Controls the amount of time to wait for inference results.

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The docs to apply inference on and inference configuration overrides (Required)

Raises:

  • (ArgumentError)

See Also:


39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb', line 39

def infer_trained_model(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ml.infer_trained_model' }

  defined_params = [:model_id].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _model_id = arguments.delete(:model_id)

  method = Elasticsearch::API::HTTP_POST
  path   = ("_ml/trained_models/#{Utils.__listify(_model_id)}/deployment/_infer" if _model_id)
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end