[9.1] Add Sparse Vector Index Options for Token Pruning to Specification (#4761)

specification/_types/mapping/SparseVectorIndexOptions.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 { TokenPruningConfig } from '@_types/TokenPruningConfig'
+
+export class SparseVectorIndexOptions {
+  /**
+   * 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.19.0
+   * @availability serverless
+   * @variant container_property
+   */
+  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.19.0
+   * @availability serverless
+   * @variant container_property
+   */
+  pruning_config?: TokenPruningConfig
+}

specification/_types/mapping/core.ts

@@ -40,6 +40,7 @@ import { NumericFielddata } from '@indices/_types/NumericFielddata'
 import { Dictionary } from '@spec_utils/Dictionary'
 import { ChunkingSettings } from './ChunkingSettings'
 import { Property, PropertyBase } from './Property'
+import { SparseVectorIndexOptions } from './SparseVectorIndexOptions'
 import { TermVectorOption } from './TermVectorOption'
 import { TimeSeriesMetricType } from './TimeSeriesMetricType'
 
@@ -225,6 +226,13 @@ export class RankVectorProperty extends PropertyBase {
 export class SparseVectorProperty extends PropertyBase {
   store?: boolean
   type: 'sparse_vector'
+  /**
+   * Additional index options for the sparse vector field that controls the
+   * token pruning behavior of the sparse vector field.
+   * @availability stack since=8.19.0
+   * @availability serverless
+   */
+  index_options?: SparseVectorIndexOptions
 }
 
 export class SemanticTextProperty {

specification/_types/query_dsl/SparseVectorQuery.ts

@@ -20,8 +20,8 @@
 import { Field, Id } from '@_types/common'
 import { float } from '@_types/Numeric'
 import { Dictionary } from '@spec_utils/Dictionary'
+import { TokenPruningConfig } from '../TokenPruningConfig'
 import { QueryBase } from './abstractions'
-import { TokenPruningConfig } from './TokenPruningConfig'
 
 /**
  * @variants container

specification/_types/query_dsl/TextExpansionQuery.ts

@@ -17,8 +17,8 @@
  * under the License.
  */
 
+import { TokenPruningConfig } from '../TokenPruningConfig'
 import { QueryBase } from './abstractions'
-import { TokenPruningConfig } from './TokenPruningConfig'
 
 /**
  * @ext_doc_id query-dsl-text-expansion-query

specification/_types/query_dsl/WeightedTokensQuery.ts

@@ -19,8 +19,8 @@
 
 import { float } from '@_types/Numeric'
 import { Dictionary } from '@spec_utils/Dictionary'
+import { TokenPruningConfig } from '../TokenPruningConfig'
 import { QueryBase } from './abstractions'
-import { TokenPruningConfig } from './TokenPruningConfig'
 
 /**
  * @ext_doc_id query-dsl-weighted-tokens-query