Path parameters

• id string Required

  The identifier for the stored script or search template.

Query parameters

• master_timeout string

  The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout.

  Values are -1 or 0.

Responses

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

  • _id string Required
  • found boolean Required
  • script object
    Hide script attributes Show script attributes object

    • lang string Required

      Any of:

      ScriptLanguage string ScriptLanguage string

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

      • * string Additional properties

    • source string | object Required

      One of:

      ScriptSource string SearchRequestBody object

      Hide attributes Show attributes

      • aggregations object

        Defines the aggregations that are run as part of the search request.

        External documentation
      • collapse object
        External documentation
      • explain boolean

        If true, the request returns detailed information about score computation as part of a hit.

      • ext object

        Configuration of search extensions defined by Elasticsearch plugins.

        Hide ext attribute Show ext attribute object

        • * object Additional properties
      • from number

        The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

      • highlight object
        Hide highlight attributes Show highlight attributes object

        • type
        • boundary_chars string

          A string that contains each boundary character.

        • boundary_max_scan number

          How far to scan for boundary characters.

        • boundary_scanner string

          Values are chars, sentence, or word.

        • boundary_scanner_locale string

          Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP".

        • force_source boolean Deprecated
        • fragmenter string

          Values are simple or span.

        • fragment_size number

          The size of the highlighted fragment in characters.

        • highlight_filter boolean
        • highlight_query object

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        • max_fragment_length number
        • max_analyzed_offset number

          If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting.

        • no_match_size number

          The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.

        • number_of_fragments number

          The maximum number of fragments to return. If the number of fragments is set to 0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If number_of_fragments is 0, fragment_size is ignored.

        • options object
        • order string

          Value is score.

        • phrase_limit number

          Controls the number of matching phrases in a document that are considered. Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the fvh highlighter.

        • post_tags array[string]

          Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

        • pre_tags array[string]

          Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in <em> and </em> tags.

        • require_field_match boolean

          By default, only fields that contains a query match are highlighted. Set to false to highlight all fields.

        • tags_schema string

          Value is styled.

        • encoder string

          Values are default or html.

        • fields object Required
      • track_total_hits boolean | number

        Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.

      • indices_boost array[object]

        Boost the _score of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.

        External documentation
        Hide indices_boost attribute Show indices_boost attribute object

        • * number Additional properties
      • docvalue_fields array[object]

        An array of wildcard (*) field patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.

        External documentation
        Hide docvalue_fields attributes Show docvalue_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

          The format in which the values are returned.

        • include_unmapped boolean

      • knn object | array[object]

        The approximate kNN search to run.

        One of:

        KnnSearch object array-2 array[object]

        Hide attributes Show attributes

        • 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
        • k number

          The final number of nearest neighbors to return as top hits

        • num_candidates number

          The number of nearest neighbor candidates to consider per shard

        • boost number

          Boost value to apply to kNN scores

        • filter
        • similarity number

          The minimum similarity for a vector to be considered a match

        • inner_hits object
        • rescore_vector object

        External documentation
      • rank object
        Hide rank attribute Show rank attribute object

        • rrf object
      • min_score number

        The minimum _score for matching documents. Documents with a lower _score are not included in search results or results collected by aggregations.

      • post_filter object

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        External documentation
      • profile boolean

        Set to true to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.

      • query object

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        External documentation

      • rescore object | array[object]

        Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the query and post_filter phases.

        One of:

        Rescore object array-2 array[object]
      • retriever object
        Hide retriever attributes Show retriever attributes object

        • standard object
        • knn object
        • rrf object
        • text_similarity_reranker object
        • rule object
        • rescorer object
        • linear object
        • pinned object
      • script_fields object

        Retrieve a script evaluation (based on different fields) for each hit.

        Hide script_fields attribute Show script_fields attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • script object Required
          • ignore_failure boolean
      • search_after array[number | string | boolean | null]

        A field value.

      • size number

        The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after property.

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

        Field string SortOptions object Sort array[string | object]

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

      • _source boolean | object

        Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.

        One of:

        SourceConfig boolean SourceFilter object

        Hide attributes Show attributes

        • excludes string | array[string]
        • includes string | array[string]
      • fields array[object]

        An array of wildcard (*) field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.

        Hide fields attributes Show 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

          The format in which the values are returned.

        • include_unmapped boolean
      • suggest object
        Hide suggest attribute Show suggest attribute object

        • text string

          Global suggest text, to avoid repetition when the same text is used in several suggesters

      • terminate_after number

        The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.

        IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.

        If set to 0 (default), the query does not terminate early.

      • timeout string

        The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.

      • track_scores boolean

        If true, calculate and return document scores, even if the scores are not used for sorting.

      • version boolean

        If true, the request returns the document version as part of a hit.

      • seq_no_primary_term boolean

        If true, the request returns sequence number and primary term of the last modification of each hit.

        External documentation
      • stored_fields string | array[string]
      • pit object
        Hide pit attributes Show pit attributes object

        • id string Required
        • keep_alive 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.

      • runtime_mappings object
        Hide runtime_mappings attribute Show runtime_mappings attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • fields object

            For type composite

          • fetch_fields array[object]

            For type lookup

          • 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
          • type string Required

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

      • stats array[string]

        The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.