diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb index 950b956e0a..d285551186 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb @@ -32,7 +32,8 @@ module Actions # It is valid only for the CSV format. # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. # If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. - # @option arguments [String] :format A short version of the Accept header, for example `json` or `yaml`. + # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.For async requests, nothing will be returned if the async query doesn't finish within the timeout. + # The query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb index 9e34919f38..48e87913e7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb @@ -28,7 +28,7 @@ module Actions # minor version, meaning that your referencing code may break when this # library is upgraded. # - # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml. + # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response. # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format. # @option arguments [Boolean] :drop_null_columns Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results? # Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb index 9f9c86a981..4753927c69 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb @@ -29,6 +29,7 @@ module Actions # The following integrations are available through the inference API. You can find the available task types next to the integration name: # * AlibabaCloud AI Search (`completion`, `rerank`, `sparse_embedding`, `text_embedding`) # * Amazon Bedrock (`completion`, `text_embedding`) + # * Amazon SageMaker (`chat_completion`, `completion`, `rerank`, `sparse_embedding`, `text_embedding`) # * Anthropic (`completion`) # * Azure AI Studio (`completion`, `text_embedding`) # * Azure OpenAI (`completion`, `text_embedding`) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb new file mode 100644 index 0000000000..43c06f9b47 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb @@ -0,0 +1,82 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create an Amazon SageMaker inference endpoint. + # Create an inference endpoint to perform an inference task with the `amazon_sagemaker` service. + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) + # @option arguments [String] :amazonsagemaker_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"exists_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-amazonsagemaker + # + def put_amazonsagemaker(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_amazonsagemaker' } + + defined_params = [:task_type, :amazonsagemaker_inference_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 'task_type' missing" unless arguments[:task_type] + + unless arguments[:amazonsagemaker_inference_id] + raise ArgumentError, + "Required argument 'amazonsagemaker_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _amazonsagemaker_inference_id = arguments.delete(:amazonsagemaker_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_amazonsagemaker_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/version.rb b/elasticsearch-api/lib/elasticsearch/api/version.rb index 88ce61e3de..cf2f6d16f2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/version.rb +++ b/elasticsearch-api/lib/elasticsearch/api/version.rb @@ -18,6 +18,6 @@ module Elasticsearch module API VERSION = '9.1.0'.freeze - ES_SPECIFICATION_COMMIT = '4f3be59696b7f349bfd270a485fe538fc75e4cd6'.freeze + ES_SPECIFICATION_COMMIT = '93d1b5e58d7f47ac3591df5f085b50f0e472b2eb'.freeze end end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_amazonsagemaker_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_amazonsagemaker_spec.rb new file mode 100644 index 0000000000..2d5a686e43 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_amazonsagemaker_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_amazonsagemaker' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { amazonsagemaker_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_amazonsagemaker' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_amazonsagemaker(task_type: 'foo', amazonsagemaker_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end