Add sparse_vector query to client specification

Author: kderusso

specification/_types/query_dsl/SparseVectorQuery.ts

@@ -0,0 +1,72 @@
+/*
+ * 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.
+ */
+
+import { Field, Id } from '@_types/common'
+import { QueryBase } from './abstractions'
+import { float } from '@_types/Numeric'
+import { Dictionary } from '@spec_utils/Dictionary'
+import { TokenPruningConfig } from './TokenPruningConfig'
+
+export class SparseVectorQuery extends QueryBase {
+  /**
+   * The name of the field that contains the token-weight pairs to be searched against.
+   * This field must be a mapped sparse_vector field.
+   */
+  field: Field
+
+  /**
+   * Dictionary of precomputed sparse vectors and their associated weights.
+   * Only one of inference_id or query_vector may be supplied in a request.
+   */
+  query_vector?: Dictionary<string, float>
+
+  /**
+   * The inference ID to use to convert the query text into token-weight pairs.
+   * It must be the same inference ID that was used to create the tokens from the input text.
+   * Only one of inference_id and query_vector is allowed.
+   * If inference_id is specified, query must also be specified.
+   * Only one of inference_id or query_vector may be supplied in a request.
+   */
+  inference_id?: Id
+
+  /**
+   * The query text you want to use for search.
+   * If inference_id is specified, query must also be specified.
+   */
+  query?: String
+
+  /**
+   * Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance.
+   * If prune is true but the pruning_config is not specified, pruning will occur but default values will be used.
+   * @default false
+   * @availability stack since=8.15.0 stability=experimental
+   * @availability serverless stability=experimental
+   */
+  prune?: Boolean
+
+  /**
+   * Optional pruning configuration.
+   * If enabled, this will omit non-significant tokens from the query in order to improve query performance.
+   * This is only used if prune is set to true.
+   * If prune is set to true but pruning_config is not specified, default values will be used.
+   * @availability stack since=8.15.0 stability=experimental
+   * @availability serverless stability=experimental
+   */
+  pruning_config?: TokenPruningConfig
+}

specification/_types/query_dsl/abstractions.ts

@@ -97,6 +97,7 @@ import { TextExpansionQuery } from './TextExpansionQuery'
 import { WeightedTokensQuery } from './WeightedTokensQuery'
 import { KnnQuery } from '@_types/Knn'
 import { SemanticQuery } from './SemanticQuery'
+import { SparseVectorQuery } from './SparseVectorQuery'
 
 /**
  * @variants container
@@ -364,6 +365,13 @@ export class QueryContainer {
    * @doc_id query-dsl-span-within-query
    */
   span_within?: SpanWithinQuery
+  /**
+   * Using input query vectors or a natural language processing model to convert a query into a list of token-weight pairs, queries against a sparse vector field.
+   * @availability stack since=8.15.0
+   * @availability serverless
+   * @doc_id query-dsl-sparse-vector-query
+   */
+  sparse_vector?: SparseVectorQuery
   /**
    * Returns documents that contain an exact term in a provided field.
    * To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
@@ -387,13 +395,15 @@ export class QueryContainer {
    * @availability stack since=8.8.0
    * @availability serverless
    * @doc_id query-dsl-text-expansion-query
+   * @deprecated 8.15.0
    */
   text_expansion?: SingleKeyDictionary<Field, TextExpansionQuery>
   /**
    * Supports returning text_expansion query results by sending in precomputed tokens with the query.
    * @availability stack since=8.13.0
    * @availability serverless
    * @doc_id query-dsl-weighted-tokens-query
+   * @deprecated 8.15.0
    */
   weighted_tokens?: SingleKeyDictionary<Field, WeightedTokensQuery>
   /**