|
| 1 | +# Licensed to Elasticsearch B.V. under one or more contributor |
| 2 | +# license agreements. See the NOTICE file distributed with |
| 3 | +# this work for additional information regarding copyright |
| 4 | +# ownership. Elasticsearch B.V. licenses this file to you under |
| 5 | +# the Apache License, Version 2.0 (the "License"); you may |
| 6 | +# not use this file except in compliance with the License. |
| 7 | +# You may obtain a copy of the License at |
| 8 | +# |
| 9 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +# |
| 11 | +# Unless required by applicable law or agreed to in writing, |
| 12 | +# software distributed under the License is distributed on an |
| 13 | +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 14 | +# KIND, either express or implied. See the License for the |
| 15 | +# specific language governing permissions and limitations |
| 16 | +# under the License. |
| 17 | +# |
| 18 | +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 |
| 19 | +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec |
| 20 | +# |
| 21 | +module Elasticsearch |
| 22 | + module API |
| 23 | + module Inference |
| 24 | + module Actions |
| 25 | + # Perform sparse embedding inference |
| 26 | + # |
| 27 | + # @option arguments [String] :inference_id The inference Id |
| 28 | + # @option arguments [Hash] :headers Custom HTTP headers |
| 29 | + # @option arguments [Hash] :body The inference payload |
| 30 | + # |
| 31 | + # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/post-inference-api.html |
| 32 | + # |
| 33 | + def sparse_embedding(arguments = {}) |
| 34 | + request_opts = { endpoint: arguments[:endpoint] || 'inference.sparse_embedding' } |
| 35 | + |
| 36 | + defined_params = [:inference_id].each_with_object({}) do |variable, set_variables| |
| 37 | + set_variables[variable] = arguments[variable] if arguments.key?(variable) |
| 38 | + end |
| 39 | + request_opts[:defined_params] = defined_params unless defined_params.empty? |
| 40 | + |
| 41 | + raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id] |
| 42 | + |
| 43 | + arguments = arguments.clone |
| 44 | + headers = arguments.delete(:headers) || {} |
| 45 | + |
| 46 | + body = arguments.delete(:body) |
| 47 | + |
| 48 | + _inference_id = arguments.delete(:inference_id) |
| 49 | + |
| 50 | + method = Elasticsearch::API::HTTP_POST |
| 51 | + path = "_inference/sparse_embedding/#{Utils.__listify(_inference_id)}" |
| 52 | + params = {} |
| 53 | + |
| 54 | + Elasticsearch::API::Response.new( |
| 55 | + perform_request(method, path, params, body, headers, request_opts) |
| 56 | + ) |
| 57 | + end |
| 58 | + end |
| 59 | + end |
| 60 | + end |
| 61 | +end |
0 commit comments