module Elasticsearch::API::Inference::Actions
Public Instance Methods
Delete an inference endpoint This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :inference_id The inference Id @option arguments [String] :task_type The task type @option arguments [Boolean] :dry_run If true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned. @option arguments [Boolean] :force If true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields). @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-inference-api.html
# File lib/elasticsearch/api/actions/inference/delete.rb, line 39 def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.delete' } defined_params = %i[inference_id task_type].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 'inference_id' missing" unless arguments[:inference_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _inference_id = arguments.delete(:inference_id) _task_type = arguments.delete(:task_type) method = Elasticsearch::API::HTTP_DELETE path = if _task_type && _inference_id "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}" else "_inference/#{Utils.__listify(_inference_id)}" end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get an inference endpoint This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :inference_id The inference Id @option arguments [String] :task_type The task type @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/get-inference-api.html
# File lib/elasticsearch/api/actions/inference/get.rb, line 37 def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.get' } defined_params = %i[inference_id task_type].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _inference_id = arguments.delete(:inference_id) _task_type = arguments.delete(:task_type) method = Elasticsearch::API::HTTP_GET path = if _task_type && _inference_id "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}" elsif _inference_id "_inference/#{Utils.__listify(_inference_id)}" else '_inference' end params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Perform inference This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :inference_id The inference Id @option arguments [String] :task_type The task type @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The inference payload
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/post-inference-api.html
# File lib/elasticsearch/api/actions/inference/inference.rb, line 38 def inference(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.inference' } defined_params = %i[inference_id task_type].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 'inference_id' missing" unless arguments[:inference_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _inference_id = arguments.delete(:inference_id) _task_type = arguments.delete(:task_type) method = Elasticsearch::API::HTTP_POST path = if _task_type && _inference_id "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}" else "_inference/#{Utils.__listify(_inference_id)}" end params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Configure an inference endpoint for use in the Inference
API
This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :inference_id The inference Id @option arguments [String] :task_type The task type @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The inference endpoint’s task and service settings
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/put-inference-api.html
# File lib/elasticsearch/api/actions/inference/put.rb, line 38 def put(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.put' } defined_params = %i[inference_id task_type].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 'inference_id' missing" unless arguments[:inference_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _inference_id = arguments.delete(:inference_id) _task_type = arguments.delete(:task_type) method = Elasticsearch::API::HTTP_PUT path = if _task_type && _inference_id "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}" else "_inference/#{Utils.__listify(_inference_id)}" end params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Perform streaming inference This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :inference_id The inference Id @option arguments [String] :task_type The task type @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The inference payload
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/post-stream-inference-api.html
# File lib/elasticsearch/api/actions/inference/stream_inference.rb, line 38 def stream_inference(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.stream_inference' } defined_params = %i[inference_id task_type].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 'inference_id' missing" unless arguments[:inference_id] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _inference_id = arguments.delete(:inference_id) _task_type = arguments.delete(:task_type) method = Elasticsearch::API::HTTP_POST path = if _task_type && _inference_id "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}/_stream" else "_inference/#{Utils.__listify(_inference_id)}/_stream" end params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end