@elastic/elasticsearch 9.5.0 → 9.5.1

package/esm/api/types.d.ts

@@ -5757,9 +5757,15 @@ export type InlineGet<TDocument = unknown> = InlineGetKeys<TDocument> & {
     [property: string]: any;
 };
 export interface InnerRetriever {
+    /** The nested retriever configuration. */
     retriever: RetrieverContainer;
-    weight: float;
-    normalizer: ScoreNormalizer;
+    /** Weight multiplier for this retriever's contribution to the linear combination.
+      * Must be non-negative. */
+    weight?: float;
+    /** Score normalizer to apply to this retriever's results before weighting.
+      * Falls back to the top-level `normalizer` on the linear retriever if unset,
+      * then to `none` (identity) if neither is set. */
+    normalizer?: ScoreNormalizer;
 }
 export type Ip = string;
 export type KnnEmbeddingInput = string | InferenceStringGroup;
@@ -5793,7 +5799,7 @@ export interface KnnRetriever extends RetrieverBase {
     /** Number of nearest neighbors to return as top hits. */
     k: integer;
     /** Number of nearest neighbor candidates to consider per shard. */
-    num_candidates: integer;
+    num_candidates?: integer;
     /** The percentage of vectors to explore per shard while doing knn search with bbq_disk */
     visit_percentage?: float;
     /** The minimum similarity required for a document to be considered a match. */
@@ -9478,9 +9484,32 @@ export interface MappingDenseVectorIndexOptions {
       * search. `-1` (default) defers to format defaults: `300` for `bbq_hnsw`, `150` for `hnsw`, `int8_hnsw`, and
       * `int4_hnsw`. `0` always builds the graph. A positive value overrides the format default.
       *
-      * Only applicable to `hnsw`, `int8_hnsw`, `int4_hnsw`, and `bbq_hnsw` index types.
+      * Only applicable to `hnsw`, `int8_hnsw`, `int4_hnsw`, `bbq_hnsw`, and `bbq_disk` index types.
       * @remarks This property is not supported on Elastic Cloud Serverless. */
     flat_index_threshold?: integer;
+    /** Only applicable to `bbq_disk`. The number of vectors per cluster. Must be between 64 and 65536.
+      * @remarks This property is not supported on Elastic Cloud Serverless. */
+    cluster_size?: integer;
+    /** Only applicable to `bbq_disk`. The percentage of clusters to visit during search. Must be between 0 and 100.
+      * A value of 0 defaults to using `num_candidates` for calculating the visit percentage.
+      * @remarks This property is not supported on Elastic Cloud Serverless. */
+    default_visit_percentage?: float;
+    /** Only applicable to `bbq_disk`. The number of bits per dimension for quantization encoding.
+      * Valid values are `1`, `2`, `4`, or `7`. When no `rescore_vector` is explicitly set,
+      * the default oversampling is automatically adjusted based on the bits value.
+      * This setting can be changed without reindexing.
+      * @remarks This property is not supported on Elastic Cloud Serverless. */
+    bits?: integer;
+    /** Only applicable to `bbq_disk`. When `true`, transforms indexed vectors using a random orthogonal
+      * projection before quantization, which can improve accuracy when vector components are not normally
+      * distributed. Cannot be changed after the field is created.
+      * @remarks This property is not supported on Elastic Cloud Serverless. */
+    precondition?: boolean;
+    /** Only applicable to `bbq_disk`. When `true`, Elasticsearch automatically selects the optimal
+      * quantization encoding, oversampling factor, and preconditioning for each merged segment based
+      * on estimated recall characteristics. Cannot be changed after the field is created.
+      * @remarks This property is not supported on Elastic Cloud Serverless. */
+    auto_calibrate?: boolean;
 }
 export interface MappingDenseVectorIndexOptionsRescoreVector {
     /** The oversampling factor to use when searching for the nearest neighbor. This is only applicable to the quantized formats: `bbq_*`, `int4_*`, and `int8_*`.
@@ -9871,7 +9900,9 @@ export interface MappingSemanticTextProperty {
     meta?: Record<string, string>;
     /** Inference endpoint that will be used to generate embeddings for the field.
       * This parameter cannot be updated. Use the Create inference API to create the endpoint.
-      * If `search_inference_id` is specified, the inference endpoint will only be used at index time. */
+      * If `search_inference_id` is specified, the inference endpoint will only be used at index time.
+      * If the `inference_id` is not specified, it will default to `.jina-embeddings-v5-text-small` if the cluster is authorized to use the Elastic Inference Service,
+      * otherwise it will default to `.elser-2-elasticsearch`. The `.elser-2-elasticsearch` inference endpoint relies on a local ML node to run the ELSER model. */
     inference_id?: Id;
     /** Inference endpoint that will be used to generate embeddings at query time.
       * You can update this parameter by using the Update mapping API. Use the Create inference API to create the endpoint.
@@ -9908,7 +9939,7 @@ export interface MappingSourceField {
     includes?: string[];
     mode?: MappingSourceFieldMode;
 }
-export type MappingSourceFieldMode = 'disabled' | 'stored' | 'synthetic';
+export type MappingSourceFieldMode = 'disabled' | 'stored' | 'columnar_stored' | 'synthetic';
 export interface MappingSparseVectorIndexOptions {
     /** 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.
@@ -47066,9 +47097,24 @@ export interface TransformDestination {
       * fields when possible. If alternate mappings are required, use the create index API prior to starting the
       * transform. */
     index?: IndexName;
+    /** The aliases that the destination index for the transform should have.
+      * Aliases are manipulated using the stored credentials of the transform, which means the secondary credentials
+      * supplied at creation time (if both primary and secondary credentials are specified).
+      *
+      * The destination index is added to the aliases regardless of whether the destination index was created by the
+      * transform or pre-created by the user. */
+    aliases?: TransformDestinationAlias[];
     /** The unique identifier for an ingest pipeline. */
     pipeline?: string;
 }
+export interface TransformDestinationAlias {
+    /** The name of the alias. */
+    alias: IndexAlias;
+    /** Whether the destination index should be the only index in this alias.
+      * If `true`, all the other indices will be removed from this alias before adding the destination index to this
+      * alias. This does not delete the removed indices; it only removes them from the alias. */
+    move_on_creation?: boolean;
+}
 export interface TransformLatest {
     /** Specifies the date field that is used to identify the latest documents. */
     sort: Field;
@@ -47292,7 +47338,7 @@ export interface TransformGetTransformTransformSummary {
     /** Free text description of the transform. */
     description?: string;
     /** The destination for the transform. */
-    dest: ReindexDestination;
+    dest: TransformDestination;
     frequency?: Duration;
     id: Id;
     latest?: TransformLatest;
@@ -47797,7 +47843,7 @@ export interface TransformUpdateTransformResponse {
     authorization?: MlTransformAuthorization;
     create_time: long;
     description: string;
-    dest: ReindexDestination;
+    dest: TransformDestination;
     frequency?: Duration;
     id: Id;
     latest?: TransformLatest;