Path parameters

• transform_id string Required

  Identifier for the transform.

Query parameters

• defer_validation boolean

  When true, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the transform is created.

• timeout string

  Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • authorization object
    Hide authorization attributes Show authorization attributes object

    • api_key object
      Hide api_key attributes Show api_key attributes object

      • id string Required

        The identifier for the API key.

      • name string Required

        The name of the API key.

    • roles array[string]

      If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response.

    • service_account string

      If a service account was used for the most recent update to the transform, the account name is listed in the response.

  • create_time number Required
  • description string Required
  • dest object Required
    Hide dest attributes Show dest attributes object

    • index string Required
    • op_type string

      Values are index or create.

    • pipeline string

      The name of the pipeline to use.

    • routing string
    • version_type string

      Values are internal, external, external_gte, or force.

  • frequency string

    A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • id string Required
  • latest object
    Hide latest attributes Show latest attributes object

    • sort string Required

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • unique_key array[string] Required

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

  • pivot object
    Hide pivot attributes Show pivot attributes object

    • aggregations object

      Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation, min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted average.

    • group_by object
      Hide group_by attributes Show group_by attributes object

      • Additional properties
      • date_histogram object
        Hide date_histogram attributes Show date_histogram attributes object

        • calendar_interval string

          Values are second, 1s, minute, 1m, hour, 1h, day, 1d, week, 1w, month, 1M, quarter, 1q, year, or 1y.

        • extended_bounds object
        • hard_bounds object
        • field string

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • fixed_interval string

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • format string

          The date format used to format key_as_string in the response. If no format is specified, the first date format specified in the field mapping is used.

        • interval string

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • min_doc_count number

          Only returns buckets that have min_doc_count number of documents. By default, all buckets between the first bucket that matches documents and the last one are returned.

        • missing
        • offset string

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • order
        • params object
        • script object
        • time_zone string
        • keyed boolean

          Set to true to associate a unique string key with each bucket and return the ranges as a hash rather than an array.

      • geotile_grid object
        Hide geotile_grid attributes Show geotile_grid attributes object

        • field string

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • precision number
        • shard_size number

          Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returning max(10,(size x number-of-shards)) buckets from each shard.

        • size number

          The maximum number of buckets to return.

        • bounds
      • histogram object
        Hide histogram attributes Show histogram attributes object

        • extended_bounds object
        • hard_bounds object
        • field string

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • interval number

          The interval for the buckets. Must be a positive decimal.

        • min_doc_count number

          Only returns buckets that have min_doc_count number of documents. By default, the response will fill gaps in the histogram with empty buckets.

        • missing number

          The value to apply to documents that do not have a value. By default, documents without a value are ignored.

        • offset number

          By default, the bucket keys start with 0 and then continue in even spaced steps of interval. The bucket boundaries can be shifted by using the offset option.

        • order
        • script object
        • format string
        • keyed boolean

          If true, returns buckets as a hash instead of an array, keyed by the bucket keys.

      • terms object
        Hide terms attributes Show terms attributes object

        • collect_mode string

          Values are depth_first or breadth_first.

        • exclude
        • execution_hint string

          Values are map, global_ordinals, global_ordinals_hash, or global_ordinals_low_cardinality.

        • field string

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • include
        • min_doc_count number

          Only return values that are found in more than min_doc_count hits.

        • missing
        • missing_order string

          Values are first, last, or default.

        • missing_bucket boolean
        • value_type string

          Coerced unmapped fields into the specified type.

        • order
        • script object
        • shard_min_doc_count number

          Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count.

        • shard_size number

          The number of candidate terms produced by each shard. By default, shard_size will be automatically estimated based on the number of shards and the size parameter.

        • show_term_doc_count_error boolean

          Set to true to return the doc_count_error_upper_bound, which is an upper bound to the error on the doc_count returned by each shard.

        • size number

          The number of buckets returned out of the overall terms list.

        • format string
  • retention_policy object
    Hide retention_policy attribute Show retention_policy attribute object

    • time object
      Hide time attributes Show time attributes object

      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • max_age string Required

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • settings object Required
    Hide settings attributes Show settings attributes object

    • align_checkpoints boolean

      Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align checkpoint ranges with the date histogram interval when date histogram is specified as a group source in the transform config. As a result, less document updates in the destination index will be performed thus improving overall performance.

    • dates_as_epoch_millis boolean

      Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was the default for transforms created before version 7.11. For compatible output set this value to true.

    • deduce_mappings boolean

      Specifies whether the transform should deduce the destination index mappings from the transform configuration.

    • docs_per_second number

      Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a wait time between search requests. The default value is null, which disables throttling.

    • max_page_search_size number

      Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is 10 and the maximum is 65,536.

    • unattended boolean

      If true, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails. Setting the number of retries other than infinite fails in validation.

  • source object Required
    Hide source attributes Show source attributes object

    • index string | array[string] Required
    • query object
      Hide query attributes Show query attributes object

      • bool object
        Hide bool attributes Show bool attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string

        • filter object | array[object]

          The clause (query) must appear in matching documents. However, unlike must, the score of the query will be ignored.

          One of:

          query_dsl:QueryContainer object array-2 array[object]

        • minimum_should_match number | string

          The minimum number of terms that should match as integer, percentage or range

          One of:

          _types:MinimumShouldMatch number _types:MinimumShouldMatch string

        • must object | array[object]

          The clause (query) must appear in matching documents and will contribute to the score.

          One of:

          query_dsl:QueryContainer object array-2 array[object]

        • must_not object | array[object]

          The clause (query) must not appear in the matching documents. Because scoring is ignored, a score of 0 is returned for all documents.

          One of:

          query_dsl:QueryContainer object array-2 array[object]

        • should object | array[object]

          The clause (query) should appear in the matching document.

          One of:

          query_dsl:QueryContainer object array-2 array[object]
      • boosting object
        Hide boosting attributes Show boosting attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • negative_boost number Required

          Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the negative query.

        • negative object Required
        • positive object Required
      • common object Deprecated
      • combined_fields object
        Hide combined_fields attributes Show combined_fields attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • fields array[string] Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • query string Required

          Text to search for in the provided fields. The combined_fields query analyzes the provided text before performing a search.

        • auto_generate_synonyms_phrase_query boolean

          If true, match phrase queries are automatically created for multi-term synonyms.

        • operator string

          Values are or or and.

        • minimum_should_match number | string

          The minimum number of terms that should match as integer, percentage or range

          One of:

          _types:MinimumShouldMatch number _types:MinimumShouldMatch string
        • zero_terms_query string

          Values are none or all.

      • constant_score object
        Hide constant_score attributes Show constant_score attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • filter object Required
      • dis_max object
        Hide dis_max attributes Show dis_max attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • queries array[object] Required

          One or more query clauses. Returned documents must match one or more of these queries. If a document matches multiple queries, Elasticsearch uses the highest relevance score.
        • tie_breaker number

          Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses.

      • distance_feature object

        One of:

        query_dsl:UntypedDistanceFeatureQuery object query_dsl:GeoDistanceFeatureQuery object query_dsl:DateDistanceFeatureQuery object
      • exists object
        Hide exists attributes Show exists attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • function_score object
        Hide function_score attributes Show function_score attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • boost_mode string

          Values are multiply, replace, sum, avg, max, or min.

        • functions array[object]

          One or more functions that compute a new score for each document returned by the query.

        • max_boost number

          Restricts the new score to not exceed the provided limit.

        • min_score number

          Excludes documents that do not meet the provided score threshold.

        • query object
        • score_mode string

          Values are multiply, sum, avg, first, max, or min.

      • fuzzy object

        Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.

      • geo_bounding_box object
        Hide geo_bounding_box attributes Show geo_bounding_box attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • type string

          Values are memory or indexed.

        • validation_method string

          Values are coerce, ignore_malformed, or strict.

        • ignore_unmapped boolean

          Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.

      • geo_distance object
        Hide geo_distance attributes Show geo_distance attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • distance string Required
        • distance_type string

          Values are arc or plane.

        • validation_method string

          Values are coerce, ignore_malformed, or strict.

        • ignore_unmapped boolean

          Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.

      • geo_polygon object
        Hide geo_polygon attributes Show geo_polygon attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • validation_method string

          Values are coerce, ignore_malformed, or strict.

        • ignore_unmapped boolean
      • geo_shape object
        Hide geo_shape attributes Show geo_shape attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • ignore_unmapped boolean

          Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.

      • has_child object
        Hide has_child attributes Show has_child attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • ignore_unmapped boolean

          Indicates whether to ignore an unmapped type and not return any documents instead of an error.

        • inner_hits object
          Hide inner_hits attributes Show inner_hits attributes object

          • name string
          • size number

            The maximum number of hits to return per inner_hits.

          • from number

            Inner hit starting document offset.

          • collapse object
          • docvalue_fields array[object]
          • explain boolean
          • highlight
          • ignore_unmapped boolean
          • script_fields
          • seq_no_primary_term boolean
          • fields string | array[string]
          • sort
          • _source
          • stored_fields string | array[string]
          • track_scores boolean
          • version boolean
        • max_children number

          Maximum number of child documents that match the query allowed for a returned parent document. If the parent document exceeds this limit, it is excluded from the search results.

        • min_children number

          Minimum number of child documents that match the query required to match the query for a returned parent document. If the parent document does not meet this limit, it is excluded from the search results.

        • query object Required
        • score_mode string

          Values are none, avg, sum, max, or min.

        • type string Required
      • has_parent object
        Hide has_parent attributes Show has_parent attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • ignore_unmapped boolean

          Indicates whether to ignore an unmapped parent_type and not return any documents instead of an error. You can use this parameter to query multiple indices that may not contain the parent_type.

        • inner_hits object
          Hide inner_hits attributes Show inner_hits attributes object

          • name string
          • size number

            The maximum number of hits to return per inner_hits.

          • from number

            Inner hit starting document offset.

          • collapse object
          • docvalue_fields array[object]
          • explain boolean
          • highlight
          • ignore_unmapped boolean
          • script_fields
          • seq_no_primary_term boolean
          • fields string | array[string]
          • sort
          • _source
          • stored_fields string | array[string]
          • track_scores boolean
          • version boolean
        • parent_type string Required
        • query object Required
        • score boolean

          Indicates whether the relevance score of a matching parent document is aggregated into its child documents.

      • ids object
        Hide ids attributes Show ids attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string

        • values string | array[string]

          One of:

          _types:Id string _types:Ids array[string]
      • intervals object

        Returns documents based on the order and proximity of matching terms.

      • knn object
        Hide knn attributes Show knn attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • query_vector array[number]
        • query_vector_builder object
          Hide query_vector_builder attribute Show query_vector_builder attribute object

          • text_embedding object
        • num_candidates number

          The number of nearest neighbor candidates to consider per shard

        • k number

          The final number of nearest neighbors to return as top hits

        • filter object | array[object]

          Filters for the kNN search query

          One of:

          query_dsl:QueryContainer object array-2 array[object]
        • similarity number

          The minimum similarity for a vector to be considered a match

      • match object

        Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.

      • match_all object
        Hide match_all attributes Show match_all attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
      • match_bool_prefix object

        Analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

      • match_none object
        Hide match_none attributes Show match_none attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
      • match_phrase object

        Analyzes the text and creates a phrase query out of the analyzed text.

      • match_phrase_prefix object

        Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.

      • more_like_this object
        Hide more_like_this attributes Show more_like_this attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • analyzer string

          The analyzer that is used to analyze the free form text. Defaults to the analyzer associated with the first field in fields.

        • boost_terms number

          Each term in the formed query could be further boosted by their tf-idf score. This sets the boost factor to use when using this feature. Defaults to deactivated (0).

        • fail_on_unsupported_field boolean

          Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (text or keyword).

        • fields array[string]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • include boolean

          Specifies whether the input documents should also be included in the search results returned.

        • like array[string | object] Required
        • max_doc_freq number

          The maximum document frequency above which the terms are ignored from the input document.

        • max_query_terms number

          The maximum number of query terms that can be selected.

        • max_word_length number

          The maximum word length above which the terms are ignored. Defaults to unbounded (0).

        • min_doc_freq number

          The minimum document frequency below which the terms are ignored from the input document.

        • minimum_should_match number | string

          The minimum number of terms that should match as integer, percentage or range

          One of:

          _types:MinimumShouldMatch number _types:MinimumShouldMatch string
        • min_term_freq number

          The minimum term frequency below which the terms are ignored from the input document.

        • min_word_length number

          The minimum word length below which the terms are ignored.

        • routing string

        • stop_words string | array[string]

          Language value, such as arabic or thai. Defaults to english. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words.

          One of:

          analysis:StopWords string analysis:StopWords array[string]
        • unlike array[string | object]
        • version number
        • version_type string

          Values are internal, external, external_gte, or force.

      • multi_match object
        Hide multi_match attributes Show multi_match attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • analyzer string

          Analyzer used to convert the text in the query value into tokens.

        • auto_generate_synonyms_phrase_query boolean

          If true, match phrase queries are automatically created for multi-term synonyms.

        • cutoff_frequency number Deprecated
        • fields string | array[string]

        • fuzziness string | number

          One of:

          _types:Fuzziness string _types:Fuzziness number
        • fuzzy_rewrite string
        • fuzzy_transpositions boolean

          If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba). Can be applied to the term subqueries constructed for all terms but the final term.

        • lenient boolean

          If true, format-based errors, such as providing a text query value for a numeric field, are ignored.

        • max_expansions number

          Maximum number of terms to which the query will expand.

        • minimum_should_match number | string

          The minimum number of terms that should match as integer, percentage or range

          One of:

          _types:MinimumShouldMatch number _types:MinimumShouldMatch string
        • operator string

          Values are and, AND, or, or OR.

        • prefix_length number

          Number of beginning characters left unchanged for fuzzy matching.

        • query string Required

          Text, number, boolean value or date you wish to find in the provided field.

        • slop number

          Maximum number of positions allowed between matching tokens.

        • tie_breaker number

          Determines how scores for each per-term blended query and scores across groups are combined.

        • type string

          Values are best_fields, most_fields, cross_fields, phrase, phrase_prefix, or bool_prefix.

        • zero_terms_query string

          Values are all or none.

      • nested object
        Hide nested attributes Show nested attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • ignore_unmapped boolean

          Indicates whether to ignore an unmapped path and not return any documents instead of an error.

        • inner_hits object
          Hide inner_hits attributes Show inner_hits attributes object

          • name string
          • size number

            The maximum number of hits to return per inner_hits.

          • from number

            Inner hit starting document offset.

          • collapse object
          • docvalue_fields array[object]
          • explain boolean
          • highlight
          • ignore_unmapped boolean
          • script_fields
          • seq_no_primary_term boolean
          • fields string | array[string]
          • sort
          • _source
          • stored_fields string | array[string]
          • track_scores boolean
          • version boolean
        • path string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • query object Required
        • score_mode string

          Values are none, avg, sum, max, or min.

      • parent_id object
        Hide parent_id attributes Show parent_id attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • id string
        • ignore_unmapped boolean

          Indicates whether to ignore an unmapped type and not return any documents instead of an error.

        • type string
      • percolate object
        Hide percolate attributes Show percolate attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • document object

          The source of the document being percolated.

        • documents array[object]

          An array of sources of the documents being percolated.
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • id string
        • index string
        • name string

          The suffix used for the _percolator_document_slot field when multiple percolate queries are specified.

        • preference string

          Preference used to fetch document to percolate.

        • routing string
        • version number
      • pinned object
        Hide pinned attributes Show pinned attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • organic object Required
        • ids array[string]

          Document IDs listed in the order they are to appear in results. Required if docs is not specified.

        • docs array[object]

          Documents listed in the order they are to appear in results. Required if ids is not specified.

      • prefix object

        Returns documents that contain a specific prefix in a provided field.

      • query_string object
        Hide query_string attributes Show query_string attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • allow_leading_wildcard boolean

          If true, the wildcard characters * and ? are allowed as the first character of the query string.

        • analyzer string

          Analyzer used to convert text in the query string into tokens.

        • analyze_wildcard boolean

          If true, the query attempts to analyze wildcard terms in the query string.

        • auto_generate_synonyms_phrase_query boolean

          If true, match phrase queries are automatically created for multi-term synonyms.

        • default_field string

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • default_operator string

          Values are and, AND, or, or OR.

        • enable_position_increments boolean

          If true, enable position increments in queries constructed from a query_string search.

        • escape boolean
        • fields array[string]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • fuzziness string | number

          One of:

          _types:Fuzziness string _types:Fuzziness number
        • fuzzy_max_expansions number

          Maximum number of terms to which the query expands for fuzzy matching.

        • fuzzy_prefix_length number

          Number of beginning characters left unchanged for fuzzy matching.

        • fuzzy_rewrite string
        • fuzzy_transpositions boolean

          If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba).

        • lenient boolean

          If true, format-based errors, such as providing a text value for a numeric field, are ignored.

        • max_determinized_states number

          Maximum number of automaton states required for the query.

        • minimum_should_match number | string

          The minimum number of terms that should match as integer, percentage or range

          One of:

          _types:MinimumShouldMatch number _types:MinimumShouldMatch string
        • phrase_slop number

          Maximum number of positions allowed between matching tokens for phrases.

        • query string Required

          Query string you wish to parse and use for search.

        • quote_analyzer string

          Analyzer used to convert quoted text in the query string into tokens. For quoted text, this parameter overrides the analyzer specified in the analyzer parameter.

        • quote_field_suffix string

          Suffix appended to quoted text in the query string. You can use this suffix to use a different analysis method for exact matches.

        • rewrite string
        • tie_breaker number

          How to combine the queries generated from the individual search terms in the resulting dis_max query.

        • time_zone string
        • type string

          Values are best_fields, most_fields, cross_fields, phrase, phrase_prefix, or bool_prefix.

      • range object

        Returns documents that contain terms within a provided range.

      • rank_feature object
        Hide rank_feature attributes Show rank_feature attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • saturation object
        • log object
        • linear object
        • sigmoid object
      • regexp object

        Returns documents that contain terms matching a regular expression.

      • rule object
        Hide rule attributes Show rule attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • organic object Required
        • ruleset_ids array[string] Required
        • match_criteria object Required
      • script object
        Hide script attributes Show script attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • script object Required
          Hide script attributes Show script attributes object

          • source string

            The script source.

          • id string
          • params object

            Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          • lang
          • options object
      • script_score object
        Hide script_score attributes Show script_score attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • min_score number

          Documents with a score lower than this floating point number are excluded from the search results.

        • query object Required
        • script object Required
          Hide script attributes Show script attributes object

          • source string

            The script source.

          • id string
          • params object

            Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          • lang
          • options object
      • semantic object
        Hide semantic attributes Show semantic attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • field string Required

          The field to query, which must be a semantic_text field type

        • query string Required

          The query text

      • shape object
        Hide shape attributes Show shape attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • ignore_unmapped boolean

          When set to true the query ignores an unmapped field and will not match any documents.

      • simple_query_string object
        Hide simple_query_string attributes Show simple_query_string attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • analyzer string

          Analyzer used to convert text in the query string into tokens.

        • analyze_wildcard boolean

          If true, the query attempts to analyze wildcard terms in the query string.

        • auto_generate_synonyms_phrase_query boolean

          If true, the parser creates a match_phrase query for each multi-position token.

        • default_operator string

          Values are and, AND, or, or OR.

        • fields array[string]

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • flags
        • fuzzy_max_expansions number

          Maximum number of terms to which the query expands for fuzzy matching.

        • fuzzy_prefix_length number

          Number of beginning characters left unchanged for fuzzy matching.

        • fuzzy_transpositions boolean

          If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba).

        • lenient boolean

          If true, format-based errors, such as providing a text value for a numeric field, are ignored.

        • minimum_should_match number | string

          The minimum number of terms that should match as integer, percentage or range

          One of:

          _types:MinimumShouldMatch number _types:MinimumShouldMatch string
        • query string Required

          Query string in the simple query string syntax you wish to parse and use for search.

        • quote_field_suffix string

          Suffix appended to quoted text in the query string.

      • span_containing object
        Hide span_containing attributes Show span_containing attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • big object Required
          Hide big attributes Show big attributes object

          • span_containing
          • span_field_masking
          • span_first
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_multi
          • span_near
          • span_not
          • span_or
          • span_term object

            The equivalent of the term query but for use with other span queries.

          • span_within
        • little object Required
          Hide little attributes Show little attributes object

          • span_containing
          • span_field_masking
          • span_first
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_multi
          • span_near
          • span_not
          • span_or
          • span_term object

            The equivalent of the term query but for use with other span queries.

          • span_within
      • span_field_masking object
        Hide span_field_masking attributes Show span_field_masking attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • query object Required
          Hide query attributes Show query attributes object

          • span_containing
          • span_field_masking
          • span_first
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_multi
          • span_near
          • span_not
          • span_or
          • span_term object

            The equivalent of the term query but for use with other span queries.

          • span_within
      • span_first object
        Hide span_first attributes Show span_first attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • end number Required

          Controls the maximum end position permitted in a match.

        • match object Required
          Hide match attributes Show match attributes object

          • span_containing
          • span_field_masking
          • span_first
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_multi
          • span_near
          • span_not
          • span_or
          • span_term object

            The equivalent of the term query but for use with other span queries.

          • span_within
      • span_multi object
        Hide span_multi attributes Show span_multi attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • match object Required
      • span_near object
        Hide span_near attributes Show span_near attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • clauses array[object] Required

          Array of one or more other span type queries.
        • in_order boolean

          Controls whether matches are required to be in-order.

        • slop number

          Controls the maximum number of intervening unmatched positions permitted.

      • span_not object
        Hide span_not attributes Show span_not attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • dist number

          The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both pre and post.

        • exclude object Required
          Hide exclude attributes Show exclude attributes object

          • span_containing
          • span_field_masking
          • span_first
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_multi
          • span_near
          • span_not
          • span_or
          • span_term object

            The equivalent of the term query but for use with other span queries.

          • span_within
        • include object Required
          Hide include attributes Show include attributes object

          • span_containing
          • span_field_masking
          • span_first
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_multi
          • span_near
          • span_not
          • span_or
          • span_term object

            The equivalent of the term query but for use with other span queries.

          • span_within
        • post number

          The number of tokens after the include span that can’t have overlap with the exclude span.

        • pre number

          The number of tokens before the include span that can’t have overlap with the exclude span.

      • span_or object
        Hide span_or attributes Show span_or attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • clauses array[object] Required

          Array of one or more other span type queries.
      • span_term object

        Matches spans containing a term.

      • span_within object
        Hide span_within attributes Show span_within attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • big object Required
          Hide big attributes Show big attributes object

          • span_containing
          • span_field_masking
          • span_first
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_multi
          • span_near
          • span_not
          • span_or
          • span_term object

            The equivalent of the term query but for use with other span queries.

          • span_within
        • little object Required
          Hide little attributes Show little attributes object

          • span_containing
          • span_field_masking
          • span_first
          • span_gap object

            Can only be used as a clause in a span_near query.

          • span_multi
          • span_near
          • span_not
          • span_or
          • span_term object

            The equivalent of the term query but for use with other span queries.

          • span_within
      • sparse_vector object
        Hide sparse_vector attributes Show sparse_vector attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • query string

          The query text you want to use for search. If inference_id is specified, query must also be specified.

        • prune boolean

          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

        • pruning_config object
        • query_vector object

          Dictionary of precomputed sparse vectors and their associated weights. Only one of inference_id or query_vector may be supplied in a request.

        • inference_id string
      • term object

        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.

      • terms object
        Hide terms attributes Show terms attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
      • terms_set object

        Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.

      • text_expansion object Deprecated

        Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.

      • weighted_tokens object Deprecated

        Supports returning text_expansion query results by sending in precomputed tokens with the query.

      • wildcard object

        Returns documents that contain terms matching a wildcard pattern.

      • wrapper object
        Hide wrapper attributes Show wrapper attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • query string Required

          A base64 encoded query. The binary data format can be any of JSON, YAML, CBOR or SMILE encodings

      • type object
        Hide type attributes Show type attributes object

        • boost number

          Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

        • _name string
        • value string Required
    • remote object
      Hide remote attributes Show remote attributes object

      • connect_timeout string

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

      • headers object

        An object containing the headers of the request.

        Hide headers attributes Show headers attributes object

        • Additional properties
        • key string
      • host string Required
      • username string
      • password string
      • socket_timeout string

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

    • size number

      The number of documents to index per batch. Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB.

    • slice object
      Hide slice attributes Show slice attributes object

      • field string

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • id string Required
      • max number Required

    • sort string | object | array[string | object]

      One of:

      _types:Field string _types:SortOptions object _types:Sort array[string | object]

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      Hide attributes Show attributes

      • _score object
        Hide _score attribute Show _score attribute object

        • order string

          Values are asc or desc.

      • _doc object
        Hide _doc attribute Show _doc attribute object

        • order string

          Values are asc or desc.

      • _geo_distance object
        Hide _geo_distance attributes Show _geo_distance attributes object

        • mode string

          Values are min, max, sum, avg, or median.

        • distance_type string

          Values are arc or plane.

        • ignore_unmapped boolean
        • order string

          Values are asc or desc.

        • unit string

          Values are in, ft, yd, mi, nmi, km, m, cm, or mm.

        • nested object
      • _script object
        Hide _script attributes Show _script attributes object

        • order string

          Values are asc or desc.

        • script object Required
        • type string

          Values are string, number, or version.

        • mode string

          Values are min, max, sum, avg, or median.

        • nested object

      One of:

      _types:Field string _types:SortOptions object

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      Hide attributes Show attributes

      • _score object
      • _doc object
      • _geo_distance object
      • _script object
    • _source string | array[string]
    • runtime_mappings object
      Hide runtime_mappings attributes Show runtime_mappings attributes object

      • Additional properties
      • fields object
        Hide fields attributes Show fields attributes object

        • Additional properties
        • type string Required

          Values are boolean, composite, date, double, geo_point, ip, keyword, long, or lookup.

      • fetch_fields array[object]

        For type lookup

        Hide fetch_fields attributes Show fetch_fields attributes object

        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • format string
      • format string

        A custom format for date type runtime fields.

      • input_field string

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • target_field string

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • target_index string
      • script object
        Hide script attributes Show script attributes object

        • source string

          The script source.

        • id string
        • params object

          Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          Hide params attributes Show params attributes object

          • Additional properties
          • key object

        • lang string

          Any of:

          _types:ScriptLanguage string _types:ScriptLanguage string

          Values are painless, expression, mustache, or java.
        • options object
          Hide options attributes Show options attributes object

          • Additional properties
          • key string
      • type string Required

        Values are boolean, composite, date, double, geo_point, ip, keyword, long, or lookup.

  • sync object
    Hide sync attribute Show sync attribute object

    • time object
      Hide time attributes Show time attributes object

      • delay string

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

  • version string Required
  • _meta object
    Hide _meta attributes Show _meta attributes object

    • Additional properties
    • key object