The field capabilities API returns the information about the capabilities of fields among multiple indices

GET /_field_caps

The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned as any other field that belongs to the keyword family.

Query parameters

  • allow_no_indices boolean

    If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

  • expand_wildcards string | array[string]

    Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

  • fields string | array[string]

    Comma-separated list of fields to retrieve capabilities for. Wildcard (*) expressions are supported.

  • ignore_unavailable boolean

    If true, missing or closed indices are not included in the response.

  • include_unmapped boolean

    If true, unmapped fields are included in the response.

  • filters string

    An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent

  • types array[string]

    Only return results for fields that have one of the types in the list

  • include_empty_fields boolean

    If false, empty fields are not included in the response.

application/json

Body

  • fields string | array[string]
  • index_filter object
    Hide index_filter attributes Show index_filter attributes
    • bool object
      Hide bool attributes Show bool attributes
    • boosting object
      Hide boosting attributes Show boosting attributes
      • 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
    • constant_score object
      Hide constant_score attributes Show constant_score attributes
      • 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
      • 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
      • 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
      • 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.

        Hide functions attributes Show functions attributes object
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
    • intervals object

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

    • knn object
      Hide knn attributes Show knn attributes
      • 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
      • 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
      • 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
      • 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
    • multi_match object
      Hide multi_match attributes Show multi_match attributes
    • nested object
      Hide nested attributes Show nested attributes
      • 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
      • 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
      • 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
      • 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
      • 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.

        Hide docs attributes Show docs attributes object
    • prefix object

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

    • query_string object
      Hide query_string attributes Show query_string attributes
    • range object

      Returns documents that contain terms within a provided range.

    • rank_feature object
      Hide rank_feature attributes Show rank_feature attributes
      • 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
        Hide saturation attribute Show saturation attribute
        • pivot number

          Configurable pivot value so that the result will be less than 0.5.

      • log object
        Hide log attribute Show log attribute
      • linear object
      • sigmoid object
        Hide sigmoid attributes Show sigmoid attributes
        • pivot number Required

          Configurable pivot value so that the result will be less than 0.5.

        • exponent number Required

          Configurable Exponent.

    • regexp object

      Returns documents that contain terms matching a regular expression.

    • rule object
      Hide rule attributes Show rule attributes
      • 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
    • script_score object
      Hide script_score attributes Show script_score attributes
      • 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
    • semantic object
      Hide semantic attributes Show semantic attributes
      • 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
      • 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
      • 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 string

        Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX

        One of:
        query_dsl:SimpleQueryStringFlags string query_dsl:SimpleQueryStringFlags string

        Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX

        Values are NONE, AND, NOT, OR, PREFIX, PHRASE, PRECEDENCE, ESCAPE, WHITESPACE, FUZZY, NEAR, SLOP, or ALL.

        Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX

      • 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
      • 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
        • span_containing
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes
          • 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
        • span_first object
          Hide span_first attributes Show span_first attributes
          • 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
        • span_gap object

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

          Hide span_gap attributes Show span_gap attributes
        • span_multi object
          Hide span_multi attributes Show span_multi attributes
          • 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
          • 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
          • 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
          • include object Required
          • 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
          • 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

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

        • span_within object
          Hide span_within attributes Show span_within attributes
          • 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
          • little object Required
      • little object Required
        Hide little attributes Show little attributes
        • span_containing
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes
          • 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
        • span_first object
          Hide span_first attributes Show span_first attributes
          • 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
        • span_gap object

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

          Hide span_gap attributes Show span_gap attributes
        • span_multi object
          Hide span_multi attributes Show span_multi attributes
          • 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
          • 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
          • 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
          • include object Required
          • 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
          • 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

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

        • span_within object
          Hide span_within attributes Show span_within attributes
          • 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
          • little object Required
    • span_field_masking object
      Hide span_field_masking attributes Show span_field_masking attributes
      • 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
        • span_containing object
          Hide span_containing attributes Show span_containing attributes
          • 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
          • little object Required
        • span_field_masking
        • span_first object
          Hide span_first attributes Show span_first attributes
          • 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
        • span_gap object

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

          Hide span_gap attributes Show span_gap attributes
        • span_multi object
          Hide span_multi attributes Show span_multi attributes
          • 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
          • 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
          • 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
          • include object Required
          • 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
          • 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

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

        • span_within object
          Hide span_within attributes Show span_within attributes
          • 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
          • little object Required
    • span_first object
      Hide span_first attributes Show span_first attributes
      • 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
        • span_containing object
          Hide span_containing attributes Show span_containing attributes
          • 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
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes
          • 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
        • span_first
        • span_gap object

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

          Hide span_gap attributes Show span_gap attributes
        • span_multi object
          Hide span_multi attributes Show span_multi attributes
          • 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
          • 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
          • 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
          • include object Required
          • 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
          • 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

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

        • span_within object
          Hide span_within attributes Show span_within attributes
          • 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
          • little object Required
    • span_multi object
      Hide span_multi attributes Show span_multi attributes
      • 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
    • span_not object
      Hide span_not attributes Show span_not attributes
      • 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
        • span_containing object
          Hide span_containing attributes Show span_containing attributes
          • 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
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes
          • 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
        • span_first object
          Hide span_first attributes Show span_first attributes
          • 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
        • span_gap object

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

          Hide span_gap attributes Show span_gap attributes
        • span_multi object
          Hide span_multi attributes Show span_multi attributes
          • 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
          • 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
        • span_or object
          Hide span_or attributes Show span_or attributes
          • 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

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

        • span_within object
          Hide span_within attributes Show span_within attributes
          • 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
          • little object Required
      • include object Required
        Hide include attributes Show include attributes
        • span_containing object
          Hide span_containing attributes Show span_containing attributes
          • 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
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes
          • 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
        • span_first object
          Hide span_first attributes Show span_first attributes
          • 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
        • span_gap object

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

          Hide span_gap attributes Show span_gap attributes
        • span_multi object
          Hide span_multi attributes Show span_multi attributes
          • 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
          • 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
        • span_or object
          Hide span_or attributes Show span_or attributes
          • 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

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

        • span_within object
          Hide span_within attributes Show span_within attributes
          • 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
          • little object Required
      • 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
    • span_term object

      Matches spans containing a term.

    • span_within object
      Hide span_within attributes Show span_within attributes
      • 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
        • span_containing object
          Hide span_containing attributes Show span_containing attributes
          • 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
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes
          • 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
        • span_first object
          Hide span_first attributes Show span_first attributes
          • 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
        • span_gap object

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

          Hide span_gap attributes Show span_gap attributes
        • span_multi object
          Hide span_multi attributes Show span_multi attributes
          • 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
          • 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
          • 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
          • include object Required
          • 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
          • 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

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

        • span_within
      • little object Required
        Hide little attributes Show little attributes
        • span_containing object
          Hide span_containing attributes Show span_containing attributes
          • 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
          • little object Required
        • span_field_masking object
          Hide span_field_masking attributes Show span_field_masking attributes
          • 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
        • span_first object
          Hide span_first attributes Show span_first attributes
          • 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
        • span_gap object

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

          Hide span_gap attributes Show span_gap attributes
        • span_multi object
          Hide span_multi attributes Show span_multi attributes
          • 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
          • 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
          • 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
          • include object Required
          • 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
          • 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

          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
      • 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
        Hide pruning_config attributes Show pruning_config attributes
        • tokens_freq_ratio_threshold number

          Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned.

        • tokens_weight_threshold number

          Tokens whose weight is less than this threshold are considered nonsignificant and pruned.

        • only_score_pruned_tokens boolean

          Whether to only score pruned tokens, vs only scoring kept tokens.

      • 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.

        Hide query_vector attributes Show query_vector attributes
      • 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
      • 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
      • 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
      • 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
  • runtime_mappings object
    Hide runtime_mappings attributes Show runtime_mappings attributes

Responses

GET /_field_caps 
curl \
 -X GET http://api.example.com/_field_caps \
 -H "Content-Type: application/json" \
 -d '{"fields":"string","index_filter":{"":{"boost":42.0,"_name":"string","value":"string"},"common":{},"fuzzy":{},"intervals":{},"match":{},"match_bool_prefix":{},"match_phrase":{},"match_phrase_prefix":{},"prefix":{},"range":{},"regexp":{},"span_term":{},"term":{},"terms_set":{},"text_expansion":{},"weighted_tokens":{},"wildcard":{}},"":{"fetch_fields":[{"field":"string","format":"string"}],"format":"string","input_field":"string","target_field":"string","target_index":"string","script":{"source":"string","id":"string","params":{"key":{}},"":"painless","options":{"key":"string"}},"type":"boolean"}}'